Skip to content

WIP Backlog/framework loader #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 188 commits into
base: main
Choose a base branch
from
Open

Conversation

mlagergren
Copy link
Contributor

@mlagergren mlagergren commented Jun 28, 2024

WIP do not merge

Resolves :

  • I have added automatic tests where applicable.
  • The PR contains a description of what has been changed.
  • The description contains manual test instructions.
  • The PR contains update to the release notes.
  • The PR contains update to the documentation.

This PR has been tested on :

  • Windows.
  • MacOs.
  • Linux.

Overview

Purpose: Ftrack framework loader to be able to load components directly from the ftrack interface to the DCC.

Scope:

  • constants
  • framework-core/client and event_manager
  • framework-common-extensions

Implementation Details

Approach: Based on having one single session and one single event manager that allows users to decide wether they want to run a specifc event in remote or in local mode. That provide us the ability for the client to subscribe to ftrack default remote events like action_discover and action_launch.

  • client has now a new method (subscribe_action_tool) to subscribe to the action events for a specific tool
  • This will create an action in the ftrack server that is clickable by the user when querying actions from a component, once clicked, this action will rise the loader dialog (if provided) and with that execute the loader tool-config.

Reasoning:

  • Is the client that is registering the tools, so I think is ok to have the client subscribing to those ftrack action events and not a new “separated module” to do that, keeping it in the client seems easier to me to understand.

Changes:
Trade-offs:

Testing

Tests Added:

Manual Testing: Its very hard to manually test this PR alone. I have created the following branch to test it on maya with all the needed dependencies. experimental/test-loader
Don't worry about testing this, we need to first decide if the implementation is the way we want it to be. Then we will test this in the DCC specifc PRs.

Testing Environment:

Notes for Reviewers

Focus Areas:

  • Client; subscribe_action_tool
  • EventManager; new subscription events added

Dependencies: Highly dependant on:

Known Issues:

Base automatically changed from backlog/standalone-run-in-main-thread to main July 22, 2024 14:54
@lluisCM lluisCM changed the base branch from main to backlog/create_api_session_util July 24, 2024 10:16
result = {}
entities = options.get('selection', [])
if not entities:
raise PluginExecutionError('No entities selected!')
Copy link
Contributor Author

@mlagergren mlagergren Jul 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider removing the exlamation mark (!) and just use a dot: "No entities selected."
Git gives a bit more of a formal tone in the error messages.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, sorry I didn't saw it when reviewing the code. Changed now.

@lluisCM lluisCM marked this pull request as ready for review July 25, 2024 07:16
@lluisCM lluisCM requested a review from a team as a code owner July 25, 2024 07:16
Base automatically changed from backlog/create_api_session_util to main July 25, 2024 07:40
@lluisCM lluisCM added invalid This doesn't seem right connect3 PR for connect 3 experimental Experimental branches and removed invalid This doesn't seem right labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
connect3 PR for connect 3 experimental Experimental branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants