AYON: Use folder path as unique identifier by iLLiCiTiT · Pull Request #5817 · ynput/OpenPype

iLLiCiTiT · 2023-10-25T09:32:53Z

Changelog Description

Use folder path instead of asset name as unique identifier, with OpenPype compatibility.

Additional info

Goal of this PR is to support duplicated folder names in a project for AYON mode. How it works? All places that have asset name as "unique identifier" and not as "name" value are using folder path now. Some places do/did use the value for other purposes, all of those places must use different approach.

What it affects

IMPORTANT FOR DEVELOPERS

get_current_asset_name returns path in AYON mode
os.environ["AVALON_ASSET"] and legacy_io.Session["AVALON_ASSET"] contains path in AYON mode
during publishing context.data["asset"] and instance.data["asset"] contains path in AYON mode
all pipeline functions that expect asset name as unique identifier (e.g. get_template_data_with_names) expect path instead of name in AYON mode
creators (except legacy creators) should use "folderPath" instead of "asset"
openpype.client functions expecting asset name are can handle folder path in AYON mode > the functions still can find by name
- get_assets
- get_archived_assets
- get_asset_by_name
- get_last_version_by_subset_name

TODOs

folder path will start with slash in future version of AYON server, so that must be changed acordingly
editorial publishing was not modified at all (I'm not capable of doing that)
- hiero
- flame
- resolve
- traypublisher
revisit Harmony openpype/hosts/harmony/plugins/load/load_template.py line 55 > There is passed asset name but I don't know what for
revisit ExtractUnrealSkeletalMeshFbx plugin in Maya which is using asset name and not sure for what
3dsmax has some mismatched data in CollectRender plugin (different PR to resolve [In progress])
houdini CreateHDA has one occation where it cannot work with current implementation
unreal has at multiple places mismatch with OpenPype asset name and Unreal asset name
host integrations without publisher (using legacy create tool) are not converted
- blender
- harmony

Testing notes:

Folder path have to start with slash in on AYON server

backend PR Prefix folder path with a slash ayon-backend#56

Allow to create duplicated names on WebUI

frontend branch enhancement/allow_duplicate_folders

Testing

Have AYON project which allows duplicated names.
- To allow this you have to modify database on running AYON docker stack
  a) Go to your ayon-docker repository.
  b) Run ./manage.ps1 dbshell or make dbshell
  c) Execute DROP INDEX project_{project name}.folder_unique_name; where {project name} is replaced by name of your project
Create duplicated names in the project hierarchy
Run DCCs on a folder with duplicated name

Try to use all creators and publish them, and validate the output ended up at correct places.
- Make sure the template of {asset} or {folder[name]} is NOT filled with path.
Validate all tools > visual aspects.
Report any issues (check if the issue was reported first).
open scene with created instances before this PR -> what happens in Publisher

Hosts

…ath in AYON mode and asset name in openpype

ynbot · 2023-10-25T09:32:57Z

Task linked: OP-7176 Use folder path as unique identifier

ynbot · 2023-10-25T09:32:57Z

Task linked: OP-7176 Use folder path as unique identifier

simonebarbieri · 2023-11-15T18:09:24Z

Creators don't work in Blender after last merge.

Need to change this:

OpenPype/openpype/hosts/blender/api/plugin.py

Line 228 in 6fece8f

name = asset_name(instance_data["asset"], subset_name)

to:

name = asset_name(instance_data["folderPath"], subset_name)

mkolar · 2023-11-15T21:22:17Z

Minor issue with the menu in nuke 14.1

Write creators are expeting asset in the data which is not being satisfied, hence Render, Image and Prerender createor fail

Creator: Render (write) (create_write_render)

Error: 'asset'

Traceback (most recent call last):
  File "/Users/milan/code/OpenPype/openpype/pipeline/create/context.py", line 2053, in _create_with_unified_error
    result = creator.create(*args, **kwargs)
  File "/Users/milan/code/OpenPype/openpype/hosts/nuke/plugins/create/create_write_render.py", line 93, in create
    instance_node = self.create_instance_node(
  File "/Users/milan/code/OpenPype/openpype/hosts/nuke/plugins/create/create_write_render.py", line 62, in create_instance_node
    created_node = napi.create_write_node(
  File "/Users/milan/code/OpenPype/openpype/hosts/nuke/api/lib.py", line 1292, in create_write_node
    anatomy_filled = format_anatomy(data)
  File "/Users/milan/code/OpenPype/openpype/hosts/nuke/api/lib.py", line 1129, in format_anatomy
    asset_name = data["asset"]
KeyError: 'asset'

iLLiCiTiT · 2023-11-16T09:30:37Z

Minor issue with the menu in nuke 14.1

Should be fixed with this PR #5887

Write creators are expeting asset in the data which is not being satisfied, hence Render, Image and Prerender createor fail

Should be fixed.

Need to change this:

~~There is a function called asset_name?~~ Fixed.

…-identifier

simonebarbieri · 2023-11-17T10:58:25Z

In Blender, I'm getting this error when loading a layout with a rig:

Traceback (most recent call last):
  File "C:\Dev\Ynput\OpenPype\openpype\hosts\blender\api\ops.py", line 113, in execute
    result = callback(*args, **kwargs)
  File "C:\Dev\Ynput\OpenPype\openpype\hosts\blender\api\plugin.py", line 476, in _load
    nodes = self.process_asset(
  File "C:\Dev\Ynput\OpenPype\openpype\hosts\blender\plugins\load\load_blend.py", line 149, in process_asset
    self._post_process_layout(container, asset, representation)
  File "C:\Dev\Ynput\OpenPype\openpype\hosts\blender\plugins\load\load_blend.py", line 69, in _post_process_layout
    create_context.create(
  File "C:\Dev\Ynput\OpenPype\openpype\pipeline\create\context.py", line 2029, in create
    return creator.create(
  File "C:\Dev\Ynput\OpenPype\openpype\hosts\blender\plugins\create\create_animation.py", line 18, in create
    collection = super().create(
  File "C:\Dev\Ynput\OpenPype\openpype\hosts\blender\api\plugin.py", line 229, in create
    asset_name = instance_data["folderPath"]
KeyError: 'folderPath'

It happens because when loading a layout with a rig, it will create an animation instance for each rig:

        # Create animation instances for each rig
        creator_identifier = "io.openpype.creators.blender.animation"
        host = registered_host()
        create_context = CreateContext(host)

        for rig in rigs:
            create_context.create(
                creator_identifier=creator_identifier,
                variant=rig.name.split(':')[-1],
                pre_create_data={
                    "use_selection": False,
                    "asset_group": rig
                }
            )

But when using the create from CreateContext, instance_data is defined as:

OpenPype/openpype/pipeline/create/context.py

Lines 2023 to 2028 in 79c0799

    
           instance_data = { 
        
               "asset": asset_doc["name"], 
        
               "task": task_name, 
        
               "family": creator.family, 
        
               "variant": variant 
        
           }

It's missing folderPath if AYON_SERVER_ENABLED.

iLLiCiTiT · 2023-11-17T11:36:55Z

In Blender, I'm getting this error when loading a layout with a rig:

Fixed.

simonebarbieri · 2023-11-20T11:22:18Z

After latest fix, everything seems to be working fine in Blender :)

…-identifier

LiborBatek

I have made tests in SubstancePainter and all working fine with paths as unique identifier.

All good.

* hiero: adding folderPath to creator - some minor typos fixes - modules sorting * Hiero: adding asset_name and processing folderPath - refactor labels * fixing extract hierarchy to ayon * hound * Update openpype/hosts/hiero/api/plugin.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * simplify expression --------- Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>

…th-as-identifier-in-traypublisher-editorial TrayPublisher: editorial with folder path

…s-identifier-Resolve-editorial AYON | Resolve: support for folder path

…ial' into feature/OP-7176_Use-folder-path-as-unique-identifier

Comments were addressed

iLLiCiTiT added 21 commits October 24, 2023 17:57

'get_assets' function can find folders by path and by name

a526260

added helper function 'get_asset_name_identifier' to receive folder p…

331c483

…ath in AYON mode and asset name in openpype

instances in AYON mode have 'folderPath' instead of 'asset'

4c6ec4b

use 'get_asset_name_identifier' in pipeline logic

0ddd95e

use 'get_asset_name_identifier' for 'AVALON_ASSET' on app start

922c481

use 'get_asset_name_identifier' in global plugins

f38c3f3

use folder path in ayon tools to define current context

c505513

use folder path in publisher

1ac6676

use 'get_asset_name_identifier' in aftereffecs

69792a5

use 'get_asset_name_identifier' in fusion

18fcfa4

use 'get_asset_name_identifier' in celaction

279ab08

modified maya to follow new usage of 'asset' value

a5056ea

modified houdini to follow new asset naming

82b1e0b

modified photoshop to follow new 'asset' name usage

23c41fe

modified substance to follow new 'asset' usage

7c7f9f1

modified most of code in traypublisher to follow new asset usage

7d36637

modified tvpaint to use new 'asset' handling

8360c32

modified some parts of hiero to follow new 'asset' handling

5ada46f

modified part of flame to follow new 'asset' naming

51bebd0

use only folder name to create instance name

9d617db

avoid unnecessary call to database

e34c0b9

ynbot added type: feature Larger, user affecting changes and completely new things size/M Denotes a PR changes 500-999 lines, ignoring general files host: After Effects host: CelAction CelAction 2d animation package host: Flame Autodesk Flame integration host: Fusion host: Hiero labels Oct 25, 2023

fix workfile create plugin in blender

6fece8f

iLLiCiTiT and others added 5 commits November 16, 2023 11:12

use folder path in AYON mode

4cd7d72

Merge branch 'develop' into feature/OP-7176_Use-folder-path-as-unique…

6e8f142

…-identifier

fix create logic in blender

e0790a1

🐛 fix asset path use in maya skeletal mesh

d9c8950

Merge branch 'develop' into feature/OP-7176_Use-folder-path-as-unique…

79c0799

…-identifier

fix 'create' from 'CreateContext'

f4d6199

Merge branch 'develop' into feature/OP-7176_Use-folder-path-as-unique…

bd41ad9

…-identifier

LiborBatek self-requested a review November 20, 2023 15:17

LiborBatek approved these changes Nov 20, 2023

View reviewed changes

iLLiCiTiT and others added 7 commits November 20, 2023 18:28

simplify expression

898f728

Merge pull request #5873 from ynput/enhancement/OP-7234_Use-folder-pa…

e18e950

…th-as-identifier-in-traypublisher-editorial TrayPublisher: editorial with folder path

Merge pull request #5892 from ynput/feature/OP-7238_Use-folder-path-a…

d7c1aba

…s-identifier-Resolve-editorial AYON | Resolve: support for folder path

Merge branch 'feature/OP-7190_Use-folder-path-as-identifier-in-editor…

ee85ee8

…ial' into feature/OP-7176_Use-folder-path-as-unique-identifier

use 'newAssetPublishing' instead of 'isEditorial'

a31214d

added harmony and flame to skipped addons

f78f9c9

iLLiCiTiT requested a review from mkolar November 21, 2023 17:26

mkolar approved these changes Nov 21, 2023

View reviewed changes

iLLiCiTiT merged commit 5721227 into develop Nov 21, 2023

iLLiCiTiT deleted the feature/OP-7176_Use-folder-path-as-unique-identifier branch November 21, 2023 17:30

ynbot added this to the next-patch milestone Nov 21, 2023

simonebarbieri mentioned this pull request Dec 18, 2023

Blender: Fix long names for instances #6070

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AYON: Use folder path as unique identifier#5817

AYON: Use folder path as unique identifier#5817
iLLiCiTiT merged 114 commits intodevelopfrom
feature/OP-7176_Use-folder-path-as-unique-identifier

iLLiCiTiT commented Oct 25, 2023 •

edited

Loading

Uh oh!

ynbot commented Oct 25, 2023

Uh oh!

ynbot commented Oct 25, 2023

Uh oh!

simonebarbieri commented Nov 15, 2023

Uh oh!

mkolar commented Nov 15, 2023

Uh oh!

iLLiCiTiT commented Nov 16, 2023 •

edited

Loading

Uh oh!

simonebarbieri commented Nov 17, 2023

Uh oh!

iLLiCiTiT commented Nov 17, 2023

Uh oh!

simonebarbieri commented Nov 20, 2023

Uh oh!

LiborBatek left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

Conversation

iLLiCiTiT commented Oct 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog Description

Additional info

What it affects

TODOs

Testing notes:

Folder path have to start with slash in on AYON server

Allow to create duplicated names on WebUI

Testing

Hosts

Uh oh!

ynbot commented Oct 25, 2023

Uh oh!

ynbot commented Oct 25, 2023

Uh oh!

simonebarbieri commented Nov 15, 2023

Uh oh!

mkolar commented Nov 15, 2023

Uh oh!

iLLiCiTiT commented Nov 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simonebarbieri commented Nov 17, 2023

Uh oh!

iLLiCiTiT commented Nov 17, 2023

Uh oh!

simonebarbieri commented Nov 20, 2023

Uh oh!

LiborBatek left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

iLLiCiTiT commented Oct 25, 2023 •

edited

Loading

iLLiCiTiT commented Nov 16, 2023 •

edited

Loading