merged in main and resolved conflicts

spiffworkflow-backend/src/spiffworkflow_backend/exceptions/api_error.py

@@ -149,7 +149,7 @@ class ApiError(Exception):
             # Note that WorkflowDataExceptions are also WorkflowTaskExceptions
             return ApiError.from_task(
                 error_code,
-                message,
+                message + ". " + str(exp),
                 exp.task,
                 line_number=exp.line_number,
                 offset=exp.offset,

spiffworkflow-backend/src/spiffworkflow_backend/models/message_instance.py

@@ -5,6 +5,7 @@ from typing import Any
 from typing import Optional
 from typing import TYPE_CHECKING
 
+from flask import current_app
 from SpiffWorkflow.bpmn.PythonScriptEngine import PythonScriptEngine  # type: ignore
 from sqlalchemy import ForeignKey
 from sqlalchemy.event import listens_for
@@ -135,10 +136,17 @@ class MessageInstanceModel(SpiffworkflowBaseDBModel):
                 result = expression_engine._evaluate(
                     correlation_key.retrieval_expression, payload
                 )
-            except Exception:
+            except Exception as e:
                 # the failure of a payload evaluation may not mean that matches for these
                 # message instances can't happen with other messages.  So don't error up.
                 # fixme:  Perhaps log some sort of error.
+                current_app.logger.warning(
+                    "Error evaluating correlation key when comparing send and receive"
+                    " messages."
+                    + f"Expression {correlation_key.retrieval_expression} failed with"
+                    " the error "
+                    + str(e)
+                )
                 return False
             if result != expected_value:
                 return False

spiffworkflow-backend/src/spiffworkflow_backend/models/process_model.py

@@ -38,9 +38,12 @@ class ProcessModelInfo:
     files: list[File] | None = field(default_factory=list[File])
     fault_or_suspend_on_exception: str = NotificationType.fault.value
     exception_notification_addresses: list[str] = field(default_factory=list)
-    parent_groups: list[ProcessGroupLite] | None = None
     metadata_extraction_paths: list[dict[str, str]] | None = None
 
+    # just for the API
+    parent_groups: list[ProcessGroupLite] | None = None
+    bpmn_version_control_identifier: str | None = None
+
     def __post_init__(self) -> None:
         """__post_init__."""
         self.sort_index = self.id

spiffworkflow-backend/src/spiffworkflow_backend/models/script_attributes_context.py

@@ -11,5 +11,5 @@ class ScriptAttributesContext:
 
     task: Optional[SpiffTask]
     environment_identifier: str
-    process_instance_id: int
-    process_model_identifier: str
+    process_instance_id: Optional[int]
+    process_model_identifier: Optional[str]

spiffworkflow-backend/src/spiffworkflow_backend/routes/process_models_controller.py

@@ -30,6 +30,7 @@ from spiffworkflow_backend.routes.process_api_blueprint import _get_process_mode
 from spiffworkflow_backend.routes.process_api_blueprint import (
     _un_modify_modified_process_model_id,
 )
+from spiffworkflow_backend.services.git_service import GitCommandError
 from spiffworkflow_backend.services.git_service import GitService
 from spiffworkflow_backend.services.git_service import MissingGitConfigsError
 from spiffworkflow_backend.services.process_instance_report_service import (
@@ -200,6 +201,12 @@ def process_model_show(
     process_model.parent_groups = ProcessModelService.get_parent_group_array(
         process_model.id
     )
+    try:
+        current_git_revision = GitService.get_current_revision()
+    except GitCommandError:
+        current_git_revision = ""
+
+    process_model.bpmn_version_control_identifier = current_git_revision
     return make_response(jsonify(process_model), 200)
 
 

spiffworkflow-backend/src/spiffworkflow_backend/scripts/markdown_file_download_link.py

@@ -36,12 +36,20 @@ class GetMarkdownFileDownloadLink(Script):
         digest = parts[2].split(",")[1][-64:]
         label = parts[1].split("=")[1]
         process_model_identifier = script_attributes_context.process_model_identifier
+        if process_model_identifier is None:
+            raise self.get_proces_model_identifier_is_missing_error(
+                "markdown_file_download_link"
+            )
         modified_process_model_identifier = (
             ProcessModelInfo.modify_process_identifier_for_path_param(
                 process_model_identifier
             )
         )
         process_instance_id = script_attributes_context.process_instance_id
+        if process_instance_id is None:
+            raise self.get_proces_instance_id_is_missing_error(
+                "save_process_instance_metadata"
+            )
         url = current_app.config["SPIFFWORKFLOW_BACKEND_URL"]
         url += (
             f"/v1.0/process-data-file-download/{modified_process_model_identifier}/"

spiffworkflow-backend/src/spiffworkflow_backend/scripts/save_process_instance_metadata.py

@@ -26,6 +26,10 @@ class SaveProcessInstanceMetadata(Script):
     ) -> Any:
         """Run."""
         metadata_dict = args[0]
+        if script_attributes_context.process_instance_id is None:
+            raise self.get_proces_instance_id_is_missing_error(
+                "save_process_instance_metadata"
+            )
         for key, value in metadata_dict.items():
             pim = ProcessInstanceMetadataModel.query.filter_by(
                 process_instance_id=script_attributes_context.process_instance_id,

spiffworkflow-backend/src/spiffworkflow_backend/scripts/script.py

@@ -26,6 +26,14 @@ class ScriptUnauthorizedForUserError(Exception):
     """ScriptUnauthorizedForUserError."""
 
 
+class ProcessInstanceIdMissingError(Exception):
+    pass
+
+
+class ProcessModelIdentifierMissingError(Exception):
+    pass
+
+
 class Script:
     """Provides an abstract class that defines how scripts should work, this must be extended in all Script Tasks."""
 
@@ -49,6 +57,26 @@ class Script:
             + "does not properly implement the run function.",
         )
 
+    def get_proces_instance_id_is_missing_error(
+        self, script_name: str
+    ) -> ProcessInstanceIdMissingError:
+        """Return the error so we can raise it from the script and mypy will be happy."""
+        raise ProcessInstanceIdMissingError(
+            "The process instance id was not given to script"
+            f" '{script_name}'. This script needs to be run from"
+            " within the context of a process instance."
+        )
+
+    def get_proces_model_identifier_is_missing_error(
+        self, script_name: str
+    ) -> ProcessModelIdentifierMissingError:
+        """Return the error so we can raise it from the script and mypy will be happy."""
+        return ProcessModelIdentifierMissingError(
+            "The process model identifier was not given to script"
+            f" '{script_name}'. This script needs to be run from"
+            " within the context of a process model."
+        )
+
     @staticmethod
     def requires_privileged_permissions() -> bool:
         """It seems safer to default to True and make safe functions opt in for any user to run them.

spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_processor.py

@@ -325,19 +325,14 @@ class CustomBpmnScriptEngine(PythonScriptEngine):  # type: ignore
 
     def __get_augment_methods(self, task: Optional[SpiffTask]) -> Dict[str, Callable]:
         """__get_augment_methods."""
-        tld = current_app.config["THREAD_LOCAL_DATA"]
-
-        if not hasattr(tld, "process_model_identifier"):
-            raise MissingProcessInfoError(
-                "Could not find process_model_identifier from app config"
-            )
-        if not hasattr(tld, "process_instance_id"):
-            raise MissingProcessInfoError(
-                "Could not find process_instance_id from app config"
-            )
-
-        process_model_identifier = tld.process_model_identifier
-        process_instance_id = tld.process_instance_id
+        tld = current_app.config.get("THREAD_LOCAL_DATA")
+        process_model_identifier = None
+        process_instance_id = None
+        if tld:
+            if hasattr(tld, "process_model_identifier"):
+                process_model_identifier = tld.process_model_identifier
+            if hasattr(tld, "process_instance_id"):
+                process_instance_id = tld.process_instance_id
         script_attributes_context = ScriptAttributesContext(
             task=task,
             environment_identifier=current_app.config["ENV_IDENTIFIER"],

spiffworkflow-frontend/src/interfaces.ts

@@ -171,6 +171,7 @@ export interface ProcessModel {
   metadata_extraction_paths?: MetadataExtractionPath[];
   fault_or_suspend_on_exception?: string;
   exception_notification_addresses?: string[];
+  bpmn_version_control_identifier?: string;
 }
 
 export interface ProcessGroup {

spiffworkflow-frontend/src/routes/ProcessModelShow.tsx

@@ -498,6 +498,9 @@ export default function ProcessModelShow() {
                   <span>
                     <Button size="sm" kind="ghost">
                       Files
+                      {processModel &&
+                        processModel.bpmn_version_control_identifier &&
+                        ` (revision ${processModel.bpmn_version_control_identifier})`}
                     </Button>
                   </span>
                 </Stack>

spiffworkflow-frontend/src/routes/TaskShow.tsx

@@ -269,7 +269,13 @@ export default function TaskShow() {
     }
     return (
       <div className="markdown">
-        <MDEditor.Markdown source={instructions} />
+        {/*
+          https://www.npmjs.com/package/@uiw/react-md-editor switches to dark mode by default by respecting @media (prefers-color-scheme: dark) 
+          This makes it look like our site is broken, so until the rest of the site supports dark mode, turn off dark mode for this component.
+        */}
+        <div data-color-mode="light">
+          <MDEditor.Markdown source={instructions} />
+        </div>
       </div>
     );
   };