Chore: Use 'folderPath' instead of 'asset' during publishing #81

iLLiCiTiT · 2024-02-16T14:18:08Z

Changelog Description

Rename "asset" key used during publishing to "folderPath". This is first of many PRs changing asset naming to folder.

Additional info

I think resolve, hiero and traypublisher might not be converted correctly. Please @jakubjezek001 test them and if you find and issue try to fix it.

Testing notes:

Ideal test scenario:

Open a host with workfile that already did have created instances.
Use all possible creators.
Publish all the instances.
Everything is working and shiny.

I do expect that hosts using Publisher tool should not have any issues. Possible issues are with hosts using pyblish pype, automated publishin login and editorial.

moonyuet · 2024-02-16T15:01:23Z

I encountered this.

ayon-core/client/ayon_core/plugins/publish/collect_current_context.py

Line 47 in ecba1da

asset_name=context.data["asset"],

Should this line be asset_name=context.data["folderPath"], ?

iLLiCiTiT · 2024-02-16T15:09:24Z

Should this line be asset_name=context.data["folderPath"], ?

Yes, well spotted (I missed this because of other changes).

moonyuet · 2024-02-16T15:12:15Z

collect_workfile.py and collect_render.py in 3dsMax hosts have both context.data["asset"] and instance.data["asset"] assigned.
And also collect_anatomy_instance_data.py in plugins folder is still using instance.data["asset"]

simonebarbieri · 2024-02-16T15:54:50Z

I'm getting this in Blender:

Traceback (most recent call last):
  File "C:\Users\Simone\AppData\Local\Ynput\AYON\dependency_packages\ayon_2401161802_windows.zip\dependencies\pyblish\plugin.py", line 527, in __explicit_process
    runner(*args)
  File "C:\Dev\Ynput\ayon-core\client\ayon_core\plugins\publish\collect_anatomy_instance_data.py", line 54, in process
    self.fill_missing_asset_docs(context, project_name)
  File "C:\Dev\Ynput\ayon-core\client\ayon_core\plugins\publish\collect_anatomy_instance_data.py", line 71, in fill_missing_asset_docs
    _asset_name = instance.data["asset"]
KeyError: 'asset'

EDIT: ah, I missed that @moonyuet already mentioned this!

iLLiCiTiT · 2024-02-16T16:13:42Z

I had collapsed hosts when I've beek picking the lines to commit. Damn, should be fine now.

...I should not try to split the changes into multiple PRs in this case.

BigRoy · 2024-02-16T16:41:44Z

client/ayon_core/plugins/publish/collect_anatomy_instance_data.py

@@ -68,7 +68,7 @@ def fill_missing_asset_docs(self, context, project_name):
        instances_with_missing_asset_doc = collections.defaultdict(list)
        for instance in context:
            instance_asset_doc = instance.data.get("assetEntity")
-            _asset_name = instance.data["asset"]
+            _asset_name = instance.data["folderPath"]


Should we also be refactoring the variable names here so it's clear that these are now folder paths? There are quite a few still referring to asset and asset_name.

Yes, that's what I have prepared. But I wanted to keep this PR as simple as possible. Change of variables can then happen in per-host PRs. I think there will be sometimes things to change, which is not goal of this PR.

tokejepsen

Traceback (most recent call last):
  File "C:\Users\tokejepsen\AppData\Local\Ynput\AYON\dependency_packages\ayon_2402141620_windows.zip\dependencies\pyblish\plugin.py", line 527, in __explicit_process
    runner(*args)
  File "C:\Users\tokejepsen\ayon-core\client\ayon_core\hosts\maya\plugins\publish\collect_render.py", line 310, in process
    label = "{0} ({1})".format(layer_name, instance.data["asset"])
KeyError: 'asset'

moonyuet · 2024-02-19T09:16:16Z

Tested with 3dsmax, Looks okay now with all families.
EDIT. Not related to this PR but I encountered failed job when doing the deadline submission. It seems that avalon environment isn't set up correctly. (Or my plugin is not updated?)

2024-02-19 17:22:51:  0: PYTHON: *** GlobalJobPreload start ...
2024-02-19 17:22:51:  0: PYTHON: >>> Getting job ...
2024-02-19 17:22:51:  0: PYTHON: >>> Injecting AYON environments ...
2024-02-19 17:22:51:  0: PYTHON: --- Ayon executable: D:\ayon_launcher\ayon-launcher\build\output\ayon_console.exe
2024-02-19 17:22:51:  0: PYTHON: >>> Temporary path: C:\Users\Kayla\AppData\Local\Temp\20240219092251386723_745ae9e2-cf08-11ee-b4db-d50b96553f92.json
2024-02-19 17:22:51:  0: PYTHON: Traceback (most recent call last):
2024-02-19 17:22:51:  0: PYTHON:   File "C:\ProgramData\Thinkbox\Deadline10\workers\DESKTOP-1U8VP0C\plugins\65d31de7ed35d15e0d48d0a5\GlobalJobPreLoad.py", line 488, in inject_ayon_environment
2024-02-19 17:22:51:  0: PYTHON:     raise RuntimeError((
2024-02-19 17:22:51:  0: PYTHON: RuntimeError: Missing required env vars: AVALON_PROJECT, AVALON_ASSET, AVALON_TASK, AVALON_APP_NAME
2024-02-19 17:22:51:  0: PYTHON: !!! Injection failed.
2024-02-19 17:22:51:  0: Done executing plugin command of type 'Start Job'

MustafaJafar · 2024-02-20T12:42:39Z

Everything still works as usual in Houdini.

instance.data["asset"] - These are wrong. Found 5 of these, and fixed them. If you find more, then report.

I found inst.data["asset"] here
https://github.com/ynput/ayon-core/blob/enhancement/OP-8208_Use-folderPath-during-publishing/client/ayon_core/hosts/houdini/plugins/publish/collect_usd_bootstrap.py

moonyuet · 2024-02-20T13:20:46Z

Tested in Substance Painter, works smoothly

- Corrected a typo in a data key from "folferPath" to "folderPath". - Updated the variable name from "asset" to "asset_name".

jakubjezek001

Traypublisher Editorial Simple is giving me following results

publish-report-240220-15-41.json

MustafaJafar

Tested in Houdini. Works as usual.
Thanks.

…-publishing # Conflicts: # client/ayon_core/hosts/max/plugins/publish/collect_workfile.py

64qam

all good in AE and PS

…-publishing

iLLiCiTiT added 2 commits February 16, 2024 14:45

use 'folderPath' instead of 'asset'

aafc647

changed docstrings

ecba1da

ynbot added size/XS type: enhancement Improvement of existing functionality or minor addition labels Feb 16, 2024

iLLiCiTiT requested review from m-u-r-p-h-y and simonebarbieri February 16, 2024 14:18

ynbot added host: Maya module: Deadline labels Feb 16, 2024

iLLiCiTiT requested review from kalisp and MustafaJafar February 16, 2024 14:18

ynbot added the module: RoyalRender label Feb 16, 2024

iLLiCiTiT requested review from 64qam, antirotor, jakubjezek001 and moonyuet February 16, 2024 14:18

iLLiCiTiT added the Backwards incompatible label Feb 16, 2024

fix used key in collect current context

4ab0591

use 'folderPath' in hosts

f5fb730

iLLiCiTiT added 2 commits February 16, 2024 17:14

fix collect anatomy instance data

eaf6e0d

fix precollect workfile in hiero

47f51af

BigRoy reviewed Feb 16, 2024

View reviewed changes

tokejepsen requested changes Feb 19, 2024

View reviewed changes

iLLiCiTiT added 2 commits February 19, 2024 10:26

file maya collectors

2cbbe4b

fix another maya plugins

9c22294

ynbot added host: CelAction host: Houdini host: Nuke host: Resolve host: TrayPublisher host: UE host: Substance Painter labels Feb 20, 2024

iLLiCiTiT added 3 commits February 20, 2024 14:04

fix collect usd bootstrap

ce6fc93

fix extract hierarchy to ayon

522e1b1

fix 'get_last_versions_for_instances'

229bd07

Fix typo in data key and update variable name.

e145b33

- Corrected a typo in a data key from "folferPath" to "folderPath". - Updated the variable name from "asset" to "asset_name".

jakubjezek001 requested changes Feb 20, 2024

View reviewed changes

MustafaJafar approved these changes Feb 20, 2024

View reviewed changes

fix traypublisher editorial

ebfa5a2

iLLiCiTiT requested a review from jakubjezek001 February 20, 2024 16:05

iLLiCiTiT added 2 commits February 21, 2024 10:32

Merge branch 'develop' into enhancement/OP-8208_Use-folderPath-during…

9677b16

…-publishing # Conflicts: # client/ayon_core/hosts/max/plugins/publish/collect_workfile.py

fix 'update_content_on_context_change' in maya

7e78937

64qam approved these changes Feb 21, 2024

View reviewed changes

Merge branch 'develop' into enhancement/OP-8208_Use-folderPath-during…

65006af

…-publishing

jakubjezek001 approved these changes Feb 21, 2024

View reviewed changes

iLLiCiTiT merged commit 3888307 into develop Feb 21, 2024
2 checks passed

iLLiCiTiT deleted the enhancement/OP-8208_Use-folderPath-during-publishing branch February 21, 2024 11:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: Use 'folderPath' instead of 'asset' during publishing #81

Chore: Use 'folderPath' instead of 'asset' during publishing #81

iLLiCiTiT commented Feb 16, 2024 •

edited

Loading

moonyuet commented Feb 16, 2024

iLLiCiTiT commented Feb 16, 2024

moonyuet commented Feb 16, 2024

simonebarbieri commented Feb 16, 2024 •

edited

Loading

iLLiCiTiT commented Feb 16, 2024 •

edited

Loading

BigRoy Feb 16, 2024

iLLiCiTiT Feb 19, 2024 •

edited

Loading

tokejepsen left a comment

moonyuet commented Feb 19, 2024 •

edited

Loading

MustafaJafar commented Feb 20, 2024 •

edited

Loading

moonyuet commented Feb 20, 2024

jakubjezek001 left a comment •

edited

Loading

MustafaJafar left a comment

64qam left a comment

Chore: Use 'folderPath' instead of 'asset' during publishing #81

Chore: Use 'folderPath' instead of 'asset' during publishing #81

Conversation

iLLiCiTiT commented Feb 16, 2024 • edited Loading

Changelog Description

Additional info

Testing notes:

moonyuet commented Feb 16, 2024

iLLiCiTiT commented Feb 16, 2024

moonyuet commented Feb 16, 2024

simonebarbieri commented Feb 16, 2024 • edited Loading

iLLiCiTiT commented Feb 16, 2024 • edited Loading

BigRoy Feb 16, 2024

Choose a reason for hiding this comment

iLLiCiTiT Feb 19, 2024 • edited Loading

Choose a reason for hiding this comment

tokejepsen left a comment

Choose a reason for hiding this comment

moonyuet commented Feb 19, 2024 • edited Loading

MustafaJafar commented Feb 20, 2024 • edited Loading

moonyuet commented Feb 20, 2024

jakubjezek001 left a comment • edited Loading

Choose a reason for hiding this comment

MustafaJafar left a comment

Choose a reason for hiding this comment

64qam left a comment

Choose a reason for hiding this comment

iLLiCiTiT commented Feb 16, 2024 •

edited

Loading

simonebarbieri commented Feb 16, 2024 •

edited

Loading

iLLiCiTiT commented Feb 16, 2024 •

edited

Loading

iLLiCiTiT Feb 19, 2024 •

edited

Loading

moonyuet commented Feb 19, 2024 •

edited

Loading

MustafaJafar commented Feb 20, 2024 •

edited

Loading

jakubjezek001 left a comment •

edited

Loading