move run_tool startup and action logic back to the dcc and separate run tool and subscribe action in client

Author: lluisCM

libs/framework-core/source/ftrack_framework_core/client/__init__.py

@@ -405,7 +405,45 @@ def _on_launch_action_callback(self, event):
         options = event['data']['options']
         options['event_data'] = {'selection': selection}
 
-        self.run_tool(name, label, True, False, dialog_name, options)
+        self.run_tool(name, dialog_name, options)
+
+    def subscribe_action_tool(
+        self,
+        name,
+        label=None,
+        dialog_name=None,
+        options=None,
+        session_identifier_func=None,
+    ):
+        '''
+        Subscribe the given tool to the ftrack.action.discover and
+        ftrack.action.launch events.
+        '''
+        if not options:
+            options = dict()
+        # TODO: we don't support dock_fn in here because is not serializable
+        self.remote_session.event_hub.subscribe(
+            u'topic=ftrack.action.discover and '
+            u'source.user.username="{0}"'.format(self.session.api_user),
+            partial(
+                self._on_discover_action_callback,
+                name,
+                label,
+                dialog_name,
+                options,
+                session_identifier_func,
+            ),
+        )
+
+        self.remote_session.event_hub.subscribe(
+            u'topic=ftrack.action.launch and '
+            u'data.name={0} and '
+            u'source.user.username="{1}" and '
+            u'data.host_id={2}'.format(
+                name, self.session.api_user, self.host_id
+            ),
+            self._on_launch_action_callback,
+        )
 
     @track_framework_usage(
         'FRAMEWORK_RUN_TOOL',
@@ -415,13 +453,9 @@ def _on_launch_action_callback(self, event):
     def run_tool(
         self,
         name,
-        label=None,
-        run=False,
-        action=False,
         dialog_name=None,
         options=None,
         dock_func=False,
-        session_identifier_func=None,
     ):
         '''
         Client runs the tool passed from the DCC config, can run run_dialog
@@ -432,35 +466,6 @@ def run_tool(
         if not options:
             options = dict()
 
-        if action:
-            # TODO: we don't support dock_fn in here because is not serializable
-            self.remote_session.event_hub.subscribe(
-                u'topic=ftrack.action.discover and '
-                u'source.user.username="{0}"'.format(self.session.api_user),
-                partial(
-                    self._on_discover_action_callback,
-                    name,
-                    label,
-                    dialog_name,
-                    options,
-                    session_identifier_func,
-                ),
-            )
-
-            self.remote_session.event_hub.subscribe(
-                u'topic=ftrack.action.launch and '
-                u'data.name={0} and '
-                u'source.user.username="{1}" and '
-                u'data.host_id={2}'.format(
-                    name, self.session.api_user, self.host_id
-                ),
-                self._on_launch_action_callback,
-            )
-
-        if not run:
-            return
-        # TODO: if run_on is not action, simply continue and execute the tool
-
         if dialog_name:
             self.run_dialog(
                 dialog_name,

projects/framework-maya/source/ftrack_framework_maya/__init__.py

@@ -98,21 +98,31 @@ def get_ftrack_menu(menu_name='ftrack', submenu_name=None):
 def on_run_tool_callback(
     client_instance,
     tool_name,
-    label,
-    run,
-    action,
     dialog_name=None,
-    options=dict,
+    options=None,
     maya_args=None,
 ):
     client_instance.run_tool(
         tool_name,
-        label,
-        run,
-        action,
         dialog_name,
         options,
         dock_func=dock_maya_right if dialog_name else None,
+    )
+
+
+@run_in_main_thread
+def on_subscribe_action_tool_callback(
+    client_instance,
+    tool_name,
+    label,
+    dialog_name=None,
+    options=None,
+):
+    client_instance.subscribe_action_tool(
+        tool_name,
+        label,
+        dialog_name,
+        options,
         session_identifier_func=get_maya_session_identifier,
     )
 
@@ -217,24 +227,27 @@ def bootstrap_integration(framework_extensions_path):
                         on_run_tool_callback,
                         client_instance,
                         tool.get('name'),
-                        label,
-                        True,
-                        action,
                         tool.get('dialog_name'),
                         tool['options'],
                     )
                 ),
                 image=":/{}.png".format(tool['icon']),
             )
-        on_run_tool_callback(
-            client_instance,
-            tool.get('name'),
-            label,
-            run_on == "startup",
-            action,
-            tool.get('dialog_name'),
-            tool['options'],
-        )
+        if run_on == "startup":
+            on_run_tool_callback(
+                client_instance,
+                tool.get('name'),
+                tool.get('dialog_name'),
+                tool['options'],
+            )
+        if action:
+            on_subscribe_action_tool_callback(
+                client_instance,
+                tool.get('name'),
+                label,
+                tool.get('dialog_name'),
+                tool['options'],
+            )
 
     return client_instance