ftrackhq · lluisCM · Jul 25, 2024 · Feb 7, 2024 · Feb 7, 2024 · Feb 7, 2024
@@ -2,6 +2,7 @@
 
 ## upcoming
 
+* [changed] Host; Remove with_new_session decorator and use current remote session directly.
 * [changed] EventManager; Remove the ability to connect to the event hub, instead assume that passed session argument is already connected.
 * [changed] EventManager; EventHubThread moved to ftrack_utils.
 * [new] Client, Host; Using delegate_to_main_thread_wrapper decorator to execute methods in main thread function provided as run_in_main_thread_wrapper argument when instantiating.
@@ -10,6 +11,7 @@
 ## v3.0.0rc1
 2024-07-17
 
+* [change] EventManager; Remove override mode.
 * [feature] Client, Engine, Dialog; Support tool config top level options.
 * [fix] Engine; Check enabled/disabled plugins.
 * [change] Client, Dialog; Support set_tool_config_option for any item in the tool_conifg.

@@ -62,6 +62,11 @@ def subscribe(self):
         '''
         return self._subscribe_instance
 
+    def close(self):
+        '''Close the event manager and disconnect from the event hub.'''
+        self.session.event_hub.disconnect()
+        self.session.close()
+
     def __init__(self, session, mode=constants.event.LOCAL_EVENT_MODE):
         self.logger = logging.getLogger(
             __name__ + '.' + self.__class__.__name__
@@ -81,20 +86,19 @@ def __init__(self, session, mode=constants.event.LOCAL_EVENT_MODE):
         self._publish_instance = Publish(self)
         self._subscribe_instance = Subscribe(self)
 
-    def _publish(self, event, callback=None, mode=None):
-        '''Emit *event* and provide *callback* function, in local or remote *mode*.'''
+        self.logger.debug(
+            f'Initialising event manager {self} with mode {self.mode}'
+        )
 
-        mode = mode or self.mode
+    def _publish(self, event, callback=None):
+        '''Emit *event* and provide *callback* function, in local or remote *remote*.'''
 
-        if mode is constants.event.LOCAL_EVENT_MODE:
+        if self.mode == constants.event.LOCAL_EVENT_MODE:
             result = self.session.event_hub.publish(
                 event,
                 synchronous=True,
             )
 
-            if result:
-                result = result
-
             # Mock async event reply.
             new_event = ftrack_api.event.base.Event(
                 topic='ftrack.meta.reply',
@@ -124,9 +128,6 @@ def unsubscribe(self, subscribe_id):
         release dangling callback reference in memory'''
         self.session.event_hub.unsubscribe(subscribe_id)
 
-    def available_framework_events(self):
-        pass
-
 
 class Publish(object):
     '''Class with all the events published by the framework'''
@@ -139,7 +140,7 @@ def __init__(self, event_manager):
         super(Publish, self).__init__()
         self._event_manager = event_manager
 
-    def _publish_event(self, event_topic, data, callback, mode=None):
+    def _publish_event(self, event_topic, data, callback):
         '''
         Common method that calls the private publish method from the
         event manager
@@ -148,7 +149,7 @@ def _publish_event(self, event_topic, data, callback, mode=None):
             topic=event_topic, data=data
         )
         publish_result = self.event_manager._publish(
-            publish_event, callback=callback, mode=mode
+            publish_event, callback=callback
         )
         return publish_result
 
@@ -157,7 +158,7 @@ def discover_host(self, callback=None):
         Publish an event with topic
         :const:`~ftrack_framework_core.constants.event.DISCOVER_HOST_TOPIC`
         '''
-
+        # TODO: review this implementation, for now this one can't never be remote as it goes into a loop.
         data = None
         event_topic = constants.event.DISCOVER_HOST_TOPIC
         return self._publish_event(event_topic, data, callback)
@@ -306,13 +307,7 @@ def client_notify_ui_hook_result(
         event_topic = constants.event.CLIENT_NOTIFY_UI_HOOK_RESULT_TOPIC
         return self._publish_event(event_topic, data, callback)
 
-    def host_verify_plugins(
-        self,
-        host_id,
-        plugin_names,
-        callback=None,
-        mode=constants.event.LOCAL_EVENT_MODE,
-    ):
+    def host_verify_plugins(self, host_id, plugin_names, callback=None):
         '''
         Publish an event with topic
         :const:`~ftrack_framework_core.constants.event.HOST_VERIFY_PLUGINS_TOPIC`
@@ -323,7 +318,7 @@ def host_verify_plugins(
         }
 
         event_topic = constants.event.HOST_VERIFY_PLUGINS_TOPIC
-        return self._publish_event(event_topic, data, callback, mode)
+        return self._publish_event(event_topic, data, callback)
 
 
 class Subscribe(object):

@@ -229,8 +229,7 @@ def _client_context_change_callback(self, event):
 
     # Run
     @delegate_to_main_thread_wrapper
-    @with_new_session
-    def run_tool_config_callback(self, event, session=None):
+    def run_tool_config_callback(self, event):
         '''
         Runs the data with the defined engine type of the given *event*
 
@@ -266,7 +265,7 @@ def run_tool_config_callback(self, event, session=None):
             )
             engine_instance = engine_registry['extension'](
                 self.registry,
-                session,
+                self.session,
                 self.context_id,
                 on_plugin_executed=self.on_plugin_executed_callback,
             )
@@ -296,8 +295,7 @@ def on_plugin_executed_callback(self, plugin_info):
         self.event_manager.publish.host_log_item_added(self.id, log_item)
 
     @delegate_to_main_thread_wrapper
-    @with_new_session
-    def run_ui_hook_callback(self, event, session=None):
+    def run_ui_hook_callback(self, event):
         '''
         Runs the data with the defined engine type of the given *event*
 
@@ -336,7 +334,7 @@ def run_ui_hook_callback(self, event, session=None):
             )
             engine_instance = engine_registry['extension'](
                 self.registry,
-                session,
+                self.session,
                 on_plugin_executed=partial(
                     self.on_ui_hook_executed_callback, plugin_reference
                 ),

@@ -28,6 +28,7 @@
 )
 
 from ftrack_utils.usage import set_usage_tracker, UsageTracker
+from ftrack_utils.session import create_api_session
 
 from ftrack_framework_harmony.utils import TCPRPCClient
 
@@ -97,7 +98,7 @@ def bootstrap_integration(framework_extensions_path):
         f' {framework_extensions_path}'
     )
     # Create ftrack session and instantiate event manager
-    session = ftrack_api.Session(auto_connect_event_hub=False)
+    session = create_api_session(auto_connect_event_hub=True)
     event_manager = EventManager(
         session=session, mode=constants.event.LOCAL_EVENT_MODE
     )

@@ -3,6 +3,7 @@
 
 ## upcoming
 
+* [changed] Init; Remove remote session and use only one session instead.
 * [changed] Init; Use create_api_session utility to create the api session.
 * [changed] Host, Client instance; Pass run_in_main_thread argument.
 * [fix] Init; Fix on_run_tool_callback options argument.

@@ -60,7 +60,7 @@
 client_instance = None
 photoshop_rpc_connection = None
 startup_tools = []
-remote_session = None
+session = None
 process_monitor = None
 
 # Create Qt application
@@ -140,7 +140,7 @@ def bootstrap_integration(framework_extensions_path):
     '''Initialise Photoshop Framework Python standalone part,
     with extensions defined @ *framework_extensions_path*'''
 
-    global client_instance, photoshop_rpc_connection, startup_tools, remote_session, process_monitor
+    global client_instance, photoshop_rpc_connection, startup_tools, session, process_monitor
 
     logger.debug(
         'Photoshop standalone integration initialising, extensions path:'
@@ -175,9 +175,6 @@ def bootstrap_integration(framework_extensions_path):
 
     logger.debug(f'Read DCC config: {dcc_config}')
 
-    # Init Photoshop connection
-    remote_session = ftrack_api.Session(auto_connect_event_hub=True)
-
     # Filter tools, extract the ones that are marked as startup tools
     panel_launchers = []
     for tool in dcc_config['tools']:
@@ -207,7 +204,7 @@ def bootstrap_integration(framework_extensions_path):
                 )
     photoshop_rpc_connection = JavascriptRPC(
         'photoshop',
-        remote_session,
+        session,
         client_instance,
         panel_launchers,
         on_connected_callback,
@@ -290,13 +287,13 @@ def bootstrap_integration(framework_extensions_path):
 def run_integration():
     '''Run Framework Python standalone as long as Photoshop is alive.'''
 
-    global remote_session
+    global session
 
     # Run until it's closed, or CTRL+C
     active_time = 0
     while True:
         app.processEvents()
-        remote_session.event_hub.wait(0.01)
+        session.event_hub.wait(0.01)
         active_time += 10
         if active_time % 10000 == 0:
             logger.info(

@@ -3,6 +3,7 @@
 
 ## upcoming
 
+* [changed] Init; Remove remote session and use only one session instead.
 * [changed] Init; Use create_api_session utility to create the api session.
 * [changed] Host, Client instance; Pass run_in_main_thread argument.
 * [fix] Init; Fix on_run_tool_callback options argument.

@@ -60,7 +60,7 @@
 client_instance = None
 premiere_rpc_connection = None
 startup_tools = []
-remote_session = None
+session = None
 process_monitor = None
 
 # Create Qt application
@@ -146,7 +146,7 @@ def bootstrap_integration(framework_extensions_path):
     '''Initialise Premiere Framework Python standalone part,
     with panels defined in *panel_launchers*'''
 
-    global client_instance, premiere_rpc_connection, startup_tools, remote_session, process_monitor
+    global client_instance, premiere_rpc_connection, startup_tools, session, process_monitor
 
     logger.debug(
         'Premiere standalone integration initialising, extensions path:'
@@ -181,9 +181,6 @@ def bootstrap_integration(framework_extensions_path):
 
     logger.debug(f'Read DCC config: {dcc_config}')
 
-    # Init Premiere connection
-    remote_session = ftrack_api.Session(auto_connect_event_hub=True)
-
     # Filter tools, extract the ones that are marked as startup tools
     panel_launchers = []
     for tool in dcc_config['tools']:
@@ -213,7 +210,7 @@ def bootstrap_integration(framework_extensions_path):
                 )
     premiere_rpc_connection = JavascriptRPC(
         'premiere',
-        remote_session,
+        session,
         client_instance,
         panel_launchers,
         on_connected_callback,
@@ -296,13 +293,13 @@ def bootstrap_integration(framework_extensions_path):
 def run_integration():
     '''Run Premiere Framework Python standalone part as long as Premiere is alive.'''
 
-    global remote_session
+    global session
 
     # Run until it's closed, or CTRL+C
     active_time = 0
     while True:
         app.processEvents()
-        remote_session.event_hub.wait(0.01)
+        session.event_hub.wait(0.01)
         active_time += 10
         if active_time % 10000 == 0:
             logger.info(

@@ -73,7 +73,7 @@
 WHAT = 'publisher'
 client_class.run_dialog(
     dialog_name=f'framework_standard_{WHAT}_dialog',
-    dialog_options={'tool_config_names': [f'standalone-file-{WHAT}']},
+    dialog_options={'tool_configs': [f'standalone-file-{WHAT}']},
 )
 
 sys.exit(app.exec_())