Add mechanism for displaying errors in loading workflow at application launch.

Author: hsorby

src/mapclient/application.py

@@ -41,6 +41,7 @@
 from mapclient.core.provenance import reproducibility_info
 from mapclient.core.utils import is_frozen, find_file
 from mapclient.core.workflow.workflowscene import create_from
+from mapclient.exceptions import ClientRuntimeError
 from mapclient.settings.definitions import INTERNAL_WORKFLOWS_ZIP, INTERNAL_WORKFLOWS_AVAILABLE, INTERNAL_WORKFLOW_DIR, UNSET_FLAG, PREVIOUS_WORKFLOW, AUTOLOAD_PREVIOUS_WORKFLOW
 from mapclient.settings.info import DEFAULT_WORKFLOW_PROJECT_FILENAME, APPLICATION_ENVIRONMENT_CONFIG_DIR_VARIABLE
 
@@ -192,19 +193,23 @@ def windows_main(workflow, execute_now):
         try:
             window.open_workflow(workflow)
         except IndexError as e:
-            logger.error('Failed to load workflow. ' + str(e))
+            window.add_delayed_error(ClientRuntimeError("Loading Workflow Error", str(e)))
         except Exception as e:
-            logger.error('Failed to load workflow. ' + str(e))
+            window.add_delayed_error(ClientRuntimeError("Loading Workflow Error", str(e)))
     elif workflow:
-        logger.info(f"Not opening workflow '{workflow}', this workflow is already in use.")
+        error_message = f"Not opening workflow '{workflow}', this workflow is already in use."
+        logger.info(error_message)
+        window.add_delayed_error(ClientRuntimeError("Loading Workflow Error", error_message))
 
     window.start_metrics()
     if execute_now:
         splash.showMessage('Executing workflow ...', 90)
         if wm.canExecute() == 0:
             window.execute()
         else:
-            logger.error(f'Could not execute workflow, reason: "{wm.execute_status_message()}"')
+            error_message = f'Could not execute workflow, reason: "{wm.execute_status_message()}"'
+            logger.error(error_message)
+            window.add_delayed_error(ClientRuntimeError("Executing Workflow Error", error_message))
 
     splash.showMessage('Ready ...', 100)
     splash.finish(window)

src/mapclient/view/mainwindow.py

@@ -20,7 +20,7 @@
 import logging
 import uuid
 
-from PySide6 import QtWidgets, QtGui
+from PySide6 import QtWidgets, QtGui, QtCore
 
 from mapclient import version
 from mapclient.core.utils import install_package
@@ -41,6 +41,10 @@
 ADMIN_MODE = False
 
 
+def _show_install_package_dialog():
+    install_package('rich')
+
+
 class MainWindow(QtWidgets.QMainWindow):
     """
     This is the main window for the MAP Client.
@@ -54,6 +58,7 @@ def __init__(self, model):
         self._ui.setupUi(self)
         self._setup_menus()
         self.setMenuBar(self._menu_bar)
+
         self._make_connections()
         self._dynamic_actions = []
 
@@ -233,9 +238,10 @@ def _make_connections(self):
         self._action_PluginWizard.triggered.connect(self._show_plugin_wizard_dialog)
         self._action_PMR.triggered.connect(self._show_pmr_tool)
         self._action_Annotation.triggered.connect(self._show_annotation_tool)
-        self._action_InstallPackage.triggered.connect(self._show_package_manager_dialog)
+        self._action_InstallPackage.triggered.connect(_show_install_package_dialog)
         self._action_RenamePlugin.triggered.connect(self._show_rename_plugin_dialog)
         self._action_UpdateWorkflow.triggered.connect(self._show_update_workflow_dialog)
+
         if ADMIN_MODE:
             self._action_MAPIcon.triggered.connect(self._show_map_icon_dialog)
 
@@ -424,6 +430,9 @@ def apply_permission_settings(self):
         om = self._model.optionsManager()
         metrics_logger.set_permission(om.getOption(METRICS_PERMISSION))
 
+    def add_delayed_error(self, error):
+        self._workflowWidget.add_delayed_error(error)
+
     def _show_package_manager_dialog(self):
         from mapclient.view.managers.package.packagemanagerdialog import PackageManagerDialog
         pm = self._model.package_manager()
@@ -562,9 +571,6 @@ def _show_annotation_tool(self):
         dlg.setModal(True)
         dlg.exec_()
 
-    def _show_package_manager_dialog(self):
-        install_package('rich')
-
     def _show_map_icon_dialog(self):
         from mapclient.tools.mapicon.mapicondialog import MAPIconDialog
         location = self._model.workflowManager().location()

src/mapclient/view/utils.py

@@ -107,6 +107,7 @@ def do_runtime_error(self, *a, **kw):
             QtWidgets.QApplication.setOverrideCursor(QtCore.Qt.CursorShape.ArrowCursor)
             logger.error('{0}: {1}'.format(e.title, e.description))
             ErrorDialog(e.title, e.description, self).exec()
+        finally:
             QtWidgets.QApplication.restoreOverrideCursor()
 
     return do_runtime_error

src/mapclient/view/workflow/workflowwidget.py

@@ -60,6 +60,8 @@ def __init__(self, main_window):
         self._ui = Ui_WorkflowWidget()
         self._ui.setupUi(self)
 
+        self._delayed_errors = []
+
         self._pluginUpdater = PluginUpdater()
 
         self._undoStack = QtGui.QUndoStack(self)
@@ -77,6 +79,10 @@ def __init__(self, main_window):
 
         self._graphicsScene.setWorkflowScene(self._workflowManager.scene())
 
+        self._delay_timer = QtCore.QTimer()
+        self._delay_timer.setSingleShot(True)
+        self._delay_timer.setInterval(300)
+
         self.action_Close = None  # Keep a handle to this for modifying the Ui.
         self._action_annotation = self._main_window.findChild(QtGui.QAction, "actionAnnotation")
         self._create_menu_items()
@@ -97,6 +103,7 @@ def _make_connections(self):
         self._graphicsScene.selectionChanged.connect(self._ui.graphicsView.selectionChanged)
         self._ui.executeButton.clicked.connect(self.executeWorkflow)
         self._undoStack.indexChanged.connect(self.undoStackIndexChanged)
+        self._delay_timer.timeout.connect(self._raise_delayed_errors)
 
     def model(self):
         return self._main_window.model()
@@ -154,12 +161,26 @@ def undoRedoStack(self):
 
     def showEvent(self, *args, **kwargs):
         self._update_ui()
+        self._delay_timer.start()
         return QtWidgets.QWidget.showEvent(self, *args, **kwargs)
 
     def hideEvent(self, *args, **kwargs):
         self._update_ui()
         return QtWidgets.QWidget.hideEvent(self, *args, **kwargs)
 
+    @handle_runtime_error
+    def _raise_delayed_error(self, error):
+        raise error
+
+    def _raise_delayed_errors(self):
+        for error in self._delayed_errors:
+            self._raise_delayed_error(error)
+
+        self._delayed_errors = []
+
+    def add_delayed_error(self, error):
+        self._delayed_errors.append(error)
+
     @handle_runtime_error
     def _abort_execution(self):
         self._main_window.abort_execution()