Reformstudios patch fix shotgun descriptor incorrect system name behaviour #721
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
Update fork to latest official master
Adding a "system_name" field to the "shotgun" descriptor allows for overriding the default behaviour in the "get_system_name" method which returns the wrong name for use in hook templates where the {engine} tag is used.
eg, if a descriptor points to a toolkit bundle names "tk-houdini_release_v1.2.3", and a hook path is of the form "path: /some/path/to/{engine}/hook" then the {engine} field will be replaced by {entity_type}_{entity_id}, which will not point to the expected location of, for example, 'tl-houdini/hook' it will instead point to 'customNonProjectEntity01_104/hook'.
Adding an optional field to allow the user to set the "system_name" manually allows the default behaviour to be overridden where required without breaking existing expected behaviour.
This should resolve the issues raised on the community site on pages :-
- https://community.shotgunsoftware.com/t/possible-hook-path-bug/3365
- https://community.shotgunsoftware.com/t/names-for-apps-frameworks-specified-via-shotgun-descriptors/2989
Pull Request Test Coverage Report for Build 3052
💛 - Coveralls |
…-incorrect-system-name-behaviour
|
@eshokrgozar This bug has hit me again in another studio. Is there any chance this could get reviewed anytime soon? This PR is about 5yrs old now :). |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #721 +/- ##
==========================================
- Coverage 79.90% 73.75% -6.15%
==========================================
Files 198 198
Lines 20719 20722 +3
==========================================
- Hits 16555 15284 -1271
- Misses 4164 5438 +1274 ☔ View full report in Codecov by Sentry. |
Hi Patrick. I don't work at Autodesk anymore. I didn't realize this was still assigned to me and just removed the assignment. Hopefully someone at ADSK can pick it up and help you out. |
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.
Adding a "system_name" field to the "shotgun" descriptor allows for overriding the default behaviour in the "get_system_name" method which returns the wrong name for use in hook templates where the {engine} tag is used.
eg, if a descriptor points to a toolkit bundle names "tk-houdini_release_v1.2.3", and a hook path is of the form "path: /some/path/to/{engine}/hook" then the {engine} field will be replaced by {entity_type}_{entity_id}, which will not point to the expected location of, for example, 'tl-houdini/hook' it will instead point to 'customNonProjectEntity01_104/hook'.
Adding an optional field to allow the user to set the "system_name" manually allows the default behaviour to be overridden where required without breaking existing expected behaviour.
This should resolve the issues raised on the community site on pages :-