Addons: Preparation steps for child processes #781
Merged
+411
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Task linked: AY-6021 Addons initialization for child processes |
ynbot
added
size/S
type: feature
BigRoy
reviewed
Jul 17, 2024
BigRoy
reviewed
Jul 17, 2024
BigRoy
reviewed
Jul 17, 2024
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
…-child-processes # Conflicts: # client/ayon_core/addon/base.py
It's already marked "ready for review" no? So how to test? :) |
Ou, I did? Converting back. |
64qam
approved these changes
Aug 1, 2024
BigRoy
reviewed
Aug 1, 2024
BigRoy
reviewed
Aug 1, 2024
iLLiCiTiT
deleted the
feature/AY-6021_Addons-initialization-for-child-processes
branch
This was referenced Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog Description
Give addons option to initialize their environment before a pipeline process starts.
Additional info
The preparation can be used to make sure user is logged into some service and has set environment variables that are necessary. It is achived using simple mechanism by implementing
ensure_is_process_readymethod which expectsProcessContextas an argument.Right now process context contains information if is headless, which addon name and version triggered the request and which project name is used. All of the mentioned information are optional (maybe addon name and version should be required?). Using object gives option to improve what can be specified (we might also add version to
ProcessContextfor forwards/backwards compatibility?).All addon has to do is to call
ensure_addons_are_process_readywith object ofProcessContextto trigger the preparation. Addons can raiseProcessPreparationErrorwith human readable message, in that case user does not have option to see/copy detail (detail contains stdout/stderr with traceback).Testing notes:
At this moment the functionality is implemented only in ftrack addon and used by applications addon. For that is also required to use different AYON launcher.