Publisher: Enhance KnownPublishError visualisation

client/ayon_core/hosts/houdini/api/lib.py

@@ -948,7 +948,7 @@ def self_publish():
 
     Firstly, it gets the node and its dependencies.
     Then, it deactivates all other ROPs
-    And finaly, it triggers the publishing action.
+    And finally, it triggers the publishing action.
     """
 
     result, comment = hou.ui.readInput(
@@ -1076,4 +1076,4 @@ def prompt_reset_context():
     if options["instances"]:
         update_content_on_context_change()
 
-    dialog.deleteLater()
+    dialog.deleteLater()

client/ayon_core/pipeline/publish/publish_plugins.py

@@ -74,7 +74,9 @@ class KnownPublishError(Exception):
     Message will be shown in UI for artist.
     """
 
-    pass
+    def __init__(self, message, label=None):
+        self.message = message
+        self.label = label
 
 
 class AYONPyblishPluginMixin:

client/ayon_core/tools/publisher/control.py

@@ -423,7 +423,7 @@ class PublishPluginActionItem:
         action_id (str): Action id.
         plugin_id (str): Plugin id.
         active (bool): Action is active.
-        on_filter (str): Actions have 'on' attribte which define when can be
+        on_filter (str): Actions have 'on' attribute which define when can be
             action triggered (e.g. 'all', 'failed', ...).
         label (str): Action's label.
         icon (Union[str, None]) Action's icon.
@@ -1063,7 +1063,7 @@ def create(
     ):
         """Trigger creation by creator identifier.
 
-        Should also trigger refresh of instanes.
+        Should also trigger refresh of instances.
 
         Args:
             creator_identifier (str): Identifier of Creator plugin.
@@ -1194,6 +1194,18 @@ def publish_error_msg(self):
 
         pass
 
+    @property
+    @abstractmethod
+    def publish_error_label(self):
+        """Current error label which cause fail of publishing.
+
+        Returns:
+            Union[str, None]: Error Label which will be showed to artist or
+                None.
+        """
+
+        pass
+
     @abstractmethod
     def get_publish_report(self):
         pass
@@ -1317,6 +1329,7 @@ def __init__(self):
 
         # Any other exception that happened during publishing
         self._publish_error_msg = None
+        self._publish_error_label = None
         # Publishing is in progress
         self._publish_is_running = False
         # Publishing is over validation order
@@ -1369,6 +1382,7 @@ def event_system(self):
             "publish.is_running.changed" - Attr 'publish_is_running' changed.
             "publish.has_crashed.changed" - Attr 'publish_has_crashed' changed.
             "publish.publish_error.changed" - Attr 'publish_error'
+            publish.publish_error_label.changed  - Attr 'publish_error_label'
             "publish.has_validation_errors.changed" - Attr
                 'has_validation_errors' changed.
             "publish.max_progress.changed" - Attr 'publish_max_progress'
@@ -1485,6 +1499,14 @@ def _set_publish_error_msg(self, value):
             self._publish_error_msg = value
             self._emit_event("publish.publish_error.changed", {"value": value})
 
+    def _get_publish_error_label(self):
+        return self._publish_error_label
+
+    def _set_publish_error_label(self, value):
+        if self._publish_error_label != value:
+            self._publish_error_label = value
+            self._emit_event("publish.publish_error_label.changed", {"value": value})
+
     host_is_valid = property(
         _get_host_is_valid, _set_host_is_valid
     )
@@ -1515,6 +1537,9 @@ def _set_publish_error_msg(self, value):
     publish_error_msg = property(
         _get_publish_error_msg, _set_publish_error_msg
     )
+    publish_error_label = property(
+        _get_publish_error_label, _set_publish_error_label
+    )
 
     def _reset_attributes(self):
         """Reset most of attributes that can be reset."""
@@ -1527,6 +1552,7 @@ def _reset_attributes(self):
         self.publish_has_finished = False
 
         self.publish_error_msg = None
+        self.publish_error_label = None
         self.publish_progress = 0
 
     @property
@@ -2496,14 +2522,18 @@ def _process_and_continue(self, plugin, instance):
                 self._add_validation_error(result)
 
             else:
+                label = "Error happened"
                 if isinstance(exception, KnownPublishError):
-                    msg = str(exception)
+                    msg = exception.message
+                    if exception.label:
+                        label = exception.label
                 else:
                     msg = (
                         "Something went wrong. Send report"
                         " to your supervisor or Ynput team."
                     )
                 self.publish_error_msg = msg
+                self.publish_error_label = label
                 self.publish_has_crashed = True
 
             result["is_validation_error"] = has_validation_error

client/ayon_core/tools/publisher/widgets/publish_frame.py

@@ -409,7 +409,7 @@ def _set_stopped(self):
     def _set_error_msg(self):
         """Show error message to artist on publish crash."""
 
-        self._set_main_label("Error happened")
+        self._set_main_label(self._controller.publish_error_label)
 
         self._message_label_top.setText(self._controller.publish_error_msg)
 

client/ayon_core/tools/publisher/widgets/report_page.py

@@ -273,7 +273,7 @@ class ValidationErrorTitleWidget(QtWidgets.QWidget):
     changing style on selection/deselection.
 
     Has toggle button to show/hide instances on which validation error happened
-    if there is a list (Valdation error may happen on context).
+    if there is a list (Validation error may happen on context).
     """
 
     selected = QtCore.Signal(str)
@@ -870,7 +870,7 @@ def _mouse_release_callback(self):
 
 
 class PublishInstancesViewWidget(QtWidgets.QWidget):
-    # Sane minimum width of instance cards - size calulated using font metrics
+    # Sane minimum width of instance cards - size calculated using font metrics
     _min_width_measure_string = 24 * "O"
     selection_changed = QtCore.Signal()
 
@@ -1459,13 +1459,14 @@ class CrashWidget(QtWidgets.QWidget):
     def __init__(self, controller, parent):
         super(CrashWidget, self).__init__(parent)
 
-        main_label = QtWidgets.QLabel("This is not your fault", self)
+        main_label = QtWidgets.QLabel("Error Occurred!", self)
         main_label.setAlignment(QtCore.Qt.AlignCenter)
         main_label.setObjectName("PublishCrashMainLabel")
 
         report_label = QtWidgets.QLabel(
             (
-                "Please report the error to your pipeline support"
+                "Expand the orange error message below to find more info.\n"
+                "You can report the error to your pipeline support"
                 " using one of the options below."
             ),
             self

pyproject.toml

@@ -92,7 +92,7 @@ line-ending = "auto"
 
 [tool.codespell]
 # Ignore words that are not in the dictionary.
-ignore-words-list = "ayon,ynput"
+ignore-words-list = "ayon,ynput,hda,parms,parm,convertors,convertor"
 skip = "./.*,./package/*,*/vendor/*,*/unreal/integration/*,*/aftereffects/api/extension/js/libs/*"
 count = true
 quiet-level = 3