WIP Backlog/framework loader

libs/constants/release_notes.md

@@ -1,5 +1,10 @@
 # ftrack Constants library release Notes
 
+## upcoming
+
+* [new] framework/event; FTRACK_ACTION_DISCOVER_TOPIC and FTRACK_ACTION_LAUNCH_TOPIC added.
+
+
 ## v2.0.0
 2024-02-12
 

libs/constants/source/ftrack_constants/event/__init__.py

@@ -0,0 +1,6 @@
+# :coding: utf-8
+# :copyright: Copyright (c) 2024 ftrack
+
+#: Ftrack general events
+FTRACK_ACTION_DISCOVER_TOPIC = 'ftrack.action.discover'
+FTRACK_ACTION_LAUNCH_TOPIC = 'ftrack.action.launch'

libs/framework-core/release_notes.md

@@ -1,7 +1,9 @@
 # ftrack Framework Core library release Notes
 
+
 ## upcoming
 
+* [new] Client; Discover and launch action overrides.
 * [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.

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

@@ -350,6 +350,53 @@ def reset_all_tool_configs(self):
         '''
         self.host_connection.reset_all_tool_configs()
 
+    @delegate_to_main_thread_wrapper
+    def on_discover_action_callback(
+        self,
+        action_name,
+        label,
+        dialog_name,
+        options,
+        session_identifier_func,
+        event,
+    ):
+        '''Discover *event*.'''
+        if session_identifier_func:
+            session_id = session_identifier_func()
+            label = label + " @" + session_id
+        selection = event['data'].get('selection', [])
+        if len(selection) == 1 and selection[0]['entityType'] == 'Component':
+            return {
+                'items': [
+                    {
+                        'action_name': action_name,
+                        'label': label,
+                        'subscriber_id': self.id,
+                        'dialog_name': dialog_name,
+                        'options': options,
+                    }
+                ]
+            }
+
+    @delegate_to_main_thread_wrapper
+    def on_launch_action_callback(self, event):
+        '''Handle *event*.
+
+        event['data'] should contain:
+
+            *applicationIdentifier* to identify which application to start.
+
+        '''
+        selection = event['data']['selection']
+
+        action_name = event['data']['action_name']
+        label = event['data']['label']
+        dialog_name = event['data']['dialog_name']
+        options = event['data']['options']
+        options['event_data'] = {'selection': selection}
+
+        self.run_tool(action_name, dialog_name, options)
+
     @track_framework_usage(
         'FRAMEWORK_RUN_TOOL',
         {'module': 'client'},
@@ -573,3 +620,7 @@ def verify_plugins(self, plugin_names):
             self.host_id, plugin_names
         )[0]
         return unregistered_plugins
+
+    def close(self):
+        self.logger.debug('Shutting down client')
+        # TODO: try self.event_manager.close() if needed and see if it works.

libs/utils/release_notes.md

@@ -3,6 +3,7 @@
 
 ## upcoming
 
+* [new] Actions, remote_actions; Add support to register remote actions.
 * [new] Session, ftrack_api_session; Added create_api_session utility to create the api session with an EventHubThread in case of auto_connect_event_hub is True.
 * [new] Dependency; Added dependency on ftrack-python-api.
 * [new] event_hub event_hub_thread; Added EventHubThread utility.

libs/utils/source/ftrack_utils/actions/__init__.py

@@ -0,0 +1,7 @@
+# :coding: utf-8
+# :copyright: Copyright (c) 2024 ftrack
+
+from ftrack_utils.actions.remote_actions import (
+    default_discover_action_callback,
+    register_remote_action,
+)

libs/utils/source/ftrack_utils/actions/remote_actions.py

@@ -0,0 +1,76 @@
+# :coding: utf-8
+# :copyright: Copyright (c) 2024 ftrack
+
+import logging
+import threading
+from functools import partial
+
+from ftrack_constants.event import (
+    FTRACK_ACTION_DISCOVER_TOPIC,
+    FTRACK_ACTION_LAUNCH_TOPIC,
+)
+
+logger = logging.getLogger('ftrack_utils:actions:remote_actions')
+
+
+def default_discover_action_callback(action_name, label, subscriber_id, event):
+    '''Discover *event*.'''
+    return {
+        'items': [
+            {
+                'action_name': action_name,
+                'label': label,
+                'subscriber_id': subscriber_id,
+            }
+        ]
+    }
+
+
+def register_remote_action(
+    session,
+    action_name,
+    label,
+    subscriber_id,
+    launch_callback,
+    discover_callback=None,
+):
+    """
+    Register a remote action with the given name and callbacks.
+
+    Parameters:
+        session (ftrack_api.Session): The session to use.
+        action_name (str): The name of the action.
+        discover_callback (callable): The callback to use for discovery.
+        launch_callback (callable): The callback to use for launching.
+        subscriber_id (str, optional): The subscriber id to use.
+
+    Returns:
+        None
+    """
+    # Check if session is connected to event hub
+    if not session.event_hub.connected:
+        logger.error(
+            'Session event hub is not connected.Please make sure to connect the event hub before registring remote actions. Example: session.event_hub.connect()'
+        )
+        return
+
+    # Use the default discover callback if not provided
+    if not discover_callback:
+        discover_callback = partial(
+            default_discover_action_callback, action_name, label, subscriber_id
+        )
+
+    # Subscribe to the discover event
+    discover_event_topic = f'{FTRACK_ACTION_DISCOVER_TOPIC} and source.user.username={session.api_user}'
+    discover_subscribe_id = session.event_hub.subscribe(
+        'topic={}'.format(discover_event_topic), discover_callback
+    )
+
+    # Subscribe to the launch event
+    launch_event_topic = f'{FTRACK_ACTION_LAUNCH_TOPIC} and data.action_name={action_name} and source.user.username={session.api_user} and data.subscriber_id={subscriber_id}'
+    launch_subscribe_id = session.event_hub.subscribe(
+        'topic={}'.format(launch_event_topic), launch_callback
+    )
+
+    # Return discover and launch subscription ids.
+    return discover_subscribe_id, launch_subscribe_id