SHOT-4398: Fix proxy handling (#83)

* Handle proxy servers for socketio communication

* Add env var to optionally enable/disable proxy

Author: staceyoue

python/tk_framework_alias/server/alias_bridge.py

@@ -11,6 +11,7 @@
 import logging
 import os
 import subprocess
+import requests
 import sys
 import threading
 import pprint
@@ -55,6 +56,9 @@ def __init__(self):
         self.__default_port = 8000
         self.__max_retry_count = 25
         self.__server_socket = None
+        self.__proxy_trust_env = bool(
+            os.environ.get("ALIAS_PLUGIN_CLIENT_PROXY_TRUST_ENV")
+        )
 
         # Track the clients registered to the socketio server
         self.__clients = {}
@@ -86,9 +90,21 @@ def __init__(self):
         client_sio_logger = framework_utils.get_logger(
             self.__class__.__name__, "sio_client"
         )
-        self.__alias_events_client_sio = socketio.Client(
-            logger=client_sio_logger, engineio_logger=client_sio_logger
-        )
+
+        # Set up kwargs to pass to socketio Client
+        client_kwargs = {
+            "logger": client_sio_logger,
+            "engineio_logger": client_sio_logger,
+        }
+        if not self.__proxy_trust_env:
+            # Set up a session object to ignore any proxy settings specified in
+            # environment variables
+            session = requests.Session()
+            session.trust_env = False
+            client_kwargs["http_session"] = session
+
+        # Create the client to handle Alias events
+        self.__alias_events_client_sio = socketio.Client(**client_kwargs)
         self.__alias_events_client_sio.register_namespace(AliasEventsClientNamespace())
         self.__server_sio.register_namespace(AliasEventsServerNamespace())
 

python/tk_framework_alias_utils/startup.py

@@ -35,6 +35,7 @@ def get_plugin_environment(
     entity_id=None,
     hostname=None,
     port=None,
+    proxy_trust_env=False,
     debug="0",
     new_process=False,
 ):
@@ -64,6 +65,8 @@ def get_plugin_environment(
             for the Toolkit Manager to bootstrap the engine
         ALIAS_PLUGIN_CLIENT_SIO_HOSTNAME - the host for the socketio server to connect to
         ALIAS_PLUGIN_CLIENT_SIO_PORT - the port number for the socketio server to connect to
+        ALIAS_PLUGIN_CLIENT_PROXY_TRUST_ENV - set to trust the proxy environment variables else do not set to
+            ignore env variables for proxy settings
 
     :param alias_version: The Alias version that the plugin is running with.
     :type alias_version: str
@@ -76,6 +79,8 @@ def get_plugin_environment(
     :param python_exe: Option to specify a python.exe to run the client app with. Defaults
         to the sys.executable
     :type python_exe: str
+    :param proxy_trust_env: True to trust env vars for proxy settings else False to ignore
+    :type proxy_trust_env: bool
     :param debug: Set to "1" to run in debug mode, else "0" for non-debug mode.
     :type debug: str
 
@@ -113,6 +118,9 @@ def get_plugin_environment(
     if port is not None:
         env["ALIAS_PLUGIN_CLIENT_SIO_PORT"] = str(port)
 
+    if proxy_trust_env:
+        env["ALIAS_PLUGIN_CLIENT_PROXY_TRUST_ENV"] = "1"
+
     return env
 
 
@@ -756,6 +764,7 @@ def ensure_plugin_ready(
     pipeline_config_id=None,
     entity_type=None,
     entity_id=None,
+    proxy_trust_env=None,
     debug=None,
     logger=None,
 ):
@@ -807,6 +816,8 @@ def ensure_plugin_ready(
     :param entity_id: If the client is running within Flow Production Tracking, set the entity id used by
         the Toolkit Manager to bootstrap the engine from the plugin.
     :type entity_id: int
+    :param proxy_trust_env: True to use env vars for proxy settings else False to ignore
+    :type proxy_trust_env: bool
     :param debug: Set to True to turn on debugging for the plugin, else False.
     :type debug: bool
     :param logger: Set a logger object to capture output from this operation.
@@ -884,6 +895,7 @@ def ensure_plugin_ready(
         pipeline_config_id=pipeline_config_id,
         entity_type=entity_type,
         entity_id=entity_id,
+        proxy_trust_env=proxy_trust_env,
         debug=debug,
         server_python_exe=server_python_exe,
         new_process=new_process,