From a10bbbcc79b5a369d51bb4716164611edcb4dbfa Mon Sep 17 00:00:00 2001
From: Petr Kalis <petr.kalis@gmail.com>
Date: Wed, 1 Jun 2022 12:33:09 +0200
Subject: [PATCH] OP-3068 - better handling of legacy review subsets in Maya

Multiple reviews from a Maya workfile are blocked by legacy subset names without variant. These names could be used in later process so we cannot replace them.
Unique subset name validator was added, check for existing subset in DB too.
---
 .../maya/plugins/publish/collect_review.py    | 17 +++++----
 .../validate_review_subset_uniqueness.xml     | 28 +++++++++++++++
 .../validate_review_subset_uniqueness.py      | 36 +++++++++++++++++++
 3 files changed, 72 insertions(+), 9 deletions(-)
 create mode 100644 openpype/hosts/maya/plugins/publish/help/validate_review_subset_uniqueness.xml
 create mode 100644 openpype/hosts/maya/plugins/publish/validate_review_subset_uniqueness.py

diff --git a/openpype/hosts/maya/plugins/publish/collect_review.py b/openpype/hosts/maya/plugins/publish/collect_review.py
index 1af92c3bfc..e9e0d74c03 100644
--- a/openpype/hosts/maya/plugins/publish/collect_review.py
+++ b/openpype/hosts/maya/plugins/publish/collect_review.py
@@ -77,15 +77,14 @@ class CollectReview(pyblish.api.InstancePlugin):
                 instance.data['remove'] = True
                 self.log.debug('isntance data {}'.format(instance.data))
         else:
-            if self.legacy:
-                instance.data['subset'] = task + 'Review'
-            else:
-                subset = "{}{}{}".format(
-                    task,
-                    instance.data["subset"][0].upper(),
-                    instance.data["subset"][1:]
-                )
-                instance.data['subset'] = subset
+            legacy_subset_name = task + 'Review'
+            asset_doc_id = instance.context.data['assetEntity']["_id"]
+            subsets = legacy_io.find({"type": "subset",
+                                      "name": legacy_subset_name,
+                                      "parent": asset_doc_id}).distinct("_id")
+            if len(list(subsets)) > 0:
+                self.log.debug("Existing subsets found, keep legacy name.")
+                instance.data['subset'] = legacy_subset_name
 
             instance.data['review_camera'] = camera
             instance.data['frameStartFtrack'] = \
diff --git a/openpype/hosts/maya/plugins/publish/help/validate_review_subset_uniqueness.xml b/openpype/hosts/maya/plugins/publish/help/validate_review_subset_uniqueness.xml
new file mode 100644
index 0000000000..fd1bf4cbaa
--- /dev/null
+++ b/openpype/hosts/maya/plugins/publish/help/validate_review_subset_uniqueness.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+    <error id="main">
+        <title>Review subsets not unique</title>
+        <description>
+            ## Non unique subset name found
+
+            Non unique subset names: '{non_unique}'
+            <detail>
+                ### __Detailed Info__ (optional)
+
+                This might happen if you already published for this asset
+                review subset with legacy name {task}Review.
+                This legacy name limits possibility of publishing of multiple
+                reviews from a single workfile. Proper review subset name should
+                now
+                contain variant also (as 'Main', 'Default' etc.). That would
+                result in completely new subset though, so this situation must
+                be handled manually.
+            </detail>
+            ### How to repair?
+
+            Legacy subsets must be removed from Openpype DB, please ask admin
+            to do that. Please provide them asset and subset names.
+
+        </description>
+    </error>
+</root>
\ No newline at end of file
diff --git a/openpype/hosts/maya/plugins/publish/validate_review_subset_uniqueness.py b/openpype/hosts/maya/plugins/publish/validate_review_subset_uniqueness.py
new file mode 100644
index 0000000000..d70096ee45
--- /dev/null
+++ b/openpype/hosts/maya/plugins/publish/validate_review_subset_uniqueness.py
@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+import collections
+import pyblish.api
+import openpype.api
+from openpype.pipeline import PublishXmlValidationError
+
+
+class ValidateReviewSubsetUniqueness(pyblish.api.ContextPlugin):
+    """Validates that nodes has common root."""
+
+    order = openpype.api.ValidateContentsOrder
+    hosts = ["maya"]
+    families = ["review"]
+    label = "Validate Review Subset Unique"
+
+    def process(self, context):
+        subset_names = []
+
+        for instance in context:
+            self.log.info("instance:: {}".format(instance.data))
+            if instance.data.get('publish'):
+                subset_names.append(instance.data.get('subset'))
+
+        non_unique = \
+            [item
+             for item, count in collections.Counter(subset_names).items()
+             if count > 1]
+        msg = ("Instance subset names {} are not unique. ".format(non_unique) +
+               "Ask admin to remove subset from DB for multiple reviews.")
+        formatting_data = {
+            "non_unique": ",".join(non_unique)
+        }
+
+        if non_unique:
+            raise PublishXmlValidationError(self, msg,
+                                            formatting_data=formatting_data)