Merge pull request #86 from Project-OMOTES/85-propagating-informational-error-messages-from-workers-to-frontend

add esdl messages

Author: MarkTNO

dev-requirements.txt

@@ -80,9 +80,7 @@ coolprop==6.6.0
     #   -c requirements.txt
     #   mesido
 coverage[toml]==7.4.1
-    # via
-    #   coverage
-    #   pytest-cov
+    # via pytest-cov
 exceptiongroup==1.2.0
     # via pytest
 flake8==6.1.0
@@ -152,11 +150,11 @@ numpy==1.22.4
     #   pymoca
     #   rtc-tools
     #   scipy
-omotes-sdk-protocol==0.1.6
+omotes-sdk-protocol==0.1.13
     # via
     #   -c requirements.txt
     #   omotes-sdk-python
-omotes-sdk-python==3.2.4
+omotes-sdk-python==3.2.5
     # via
     #   -c requirements.txt
     #   omotes-grow-worker (pyproject.toml)

pyproject.toml

@@ -26,7 +26,7 @@ requires-python = ">=3.10"
 dependencies = [
     "python-dotenv ~= 1.0.0",
     "mesido ~= 0.1.8.2",
-    "omotes-sdk-python ~= 3.2.4"
+    "omotes-sdk-python ~= 3.2.5"
 ]
 
 [project.optional-dependencies]

requirements.txt

@@ -67,9 +67,9 @@ numpy==1.22.4
     #   pymoca
     #   rtc-tools
     #   scipy
-omotes-sdk-protocol==0.1.6
+omotes-sdk-protocol==0.1.13
     # via omotes-sdk-python
-omotes-sdk-python==3.2.4
+omotes-sdk-python==3.2.5
     # via omotes-grow-worker (pyproject.toml)
 ordered-set==4.1.0
     # via pyecore

src/grow_worker/worker.py

@@ -7,8 +7,13 @@
 from multiprocessing.process import current_process
 import os
 from pathlib import Path
-from typing import cast
+from typing import cast, Dict, List, Tuple, Optional
 
+from mesido.exceptions import MesidoAssetIssueError
+from omotes_sdk.internal.orchestrator_worker_events.esdl_messages import (
+    EsdlMessage,
+    MessageSeverity,
+)
 from omotes_sdk.internal.worker.worker import initialize_worker, UpdateProgressHandler
 from omotes_sdk.types import ProtobufDict
 from mesido.esdl.esdl_parser import ESDLStringParser
@@ -36,14 +41,14 @@ class EarlySystemExit(Exception):
     ...
 
 
-def run_mesido(input_esdl: str) -> str:
+def run_mesido(input_esdl: str) -> Tuple[Optional[str], List[EsdlMessage]]:
     """Run mesido using the specific workflow.
 
     Note: This is run without a subprocess! Casadi does not yield the GIL and therefore
     causes starved thread issues.
 
     :param input_esdl: The input ESDL XML string.
-    :return: GROW optimized or simulated ESDL
+    :return: GROW optimized or simulated ESDL and a list of ESDL feedback messages.
     """
     mesido_func = get_problem_function(GROW_TASK_TYPE)
     mesido_workflow = get_problem_type(GROW_TASK_TYPE)
@@ -75,10 +80,45 @@ def run_mesido(input_esdl: str) -> str:
             update_progress_function=None,
             profile_reader=InfluxDBProfileReader,
         )
+        esdl_str = cast(str, solution.optimized_esdl_string)
+        # TODO get esdl_messages from solution after mesido update.
+        esdl_messages = []
+    except MesidoAssetIssueError as mesido_issues_error:
+        esdl_str = None
+        esdl_messages = parse_mesido_esdl_messages(
+            mesido_issues_error.general_issue, mesido_issues_error.message_per_asset_id
+        )
     except SystemExit as e:
         raise EarlySystemExit(e)
 
-    return cast(str, solution.optimized_esdl_string)
+    return esdl_str, esdl_messages
+
+
+def parse_mesido_esdl_messages(
+    general_message: str, object_messages: Dict[str, str]
+) -> List[EsdlMessage]:
+    """Convert mesido messages to a list of esdl messages in omotes format.
+
+    :param general_message: general message (not related to a specific ESDL object).
+    :param object_messages: esdl object messages per object id.
+    :return: list of EsdlMessage dataclass objects.
+    """
+    # TODO get severity from esdl message and add list of general messages after mesido update.
+    esdl_messages = []
+
+    if general_message:
+        esdl_messages.append(
+            EsdlMessage(technical_message=general_message, severity=MessageSeverity.ERROR)
+        )
+    for object_id, message in object_messages.items():
+        esdl_messages.append(
+            EsdlMessage(
+                technical_message=message,
+                severity=MessageSeverity.ERROR,
+                esdl_object_id=object_id,
+            )
+        )
+    return esdl_messages
 
 
 def kill_pool(pool: multiprocessing.pool.Pool) -> None:
@@ -114,7 +154,7 @@ def kill_pool(pool: multiprocessing.pool.Pool) -> None:
 
 def grow_worker_task(
     input_esdl: str, workflow_config: ProtobufDict, update_progress_handler: UpdateProgressHandler
-) -> str:
+) -> Tuple[Optional[str], List[EsdlMessage]]:
     """Run the grow worker task and run configured specific problem type for this worker instance.
 
     Note: Be careful! This spawns within a subprocess and gains a copy of memory from parent
@@ -125,7 +165,7 @@ def grow_worker_task(
     :param input_esdl: The input ESDL XML string.
     :param workflow_config: Extra parameters to configure this run.
     :param update_progress_handler: Handler to notify of any progress changes.
-    :return: GROW optimized or simulated ESDL
+    :return: GROW optimized or simulated ESDL and a list of ESDL feedback messages.
     """
     # TODO Very nasty hack. Celery unfortunately starts the worker subprocesses as 'daemons'
     #  which prevents this process from creating any other subprocesses. Therefore, we
@@ -137,13 +177,13 @@ def grow_worker_task(
 
     with multiprocessing.Pool(1) as pool:
         try:
-            output_esdl = pool.map(run_mesido, [input_esdl])[0]
+            output = pool.map(run_mesido, [input_esdl])[0]
         except SystemExit as e:
             logger.warning("During pool the worker was requested to quit: %s %s", type(e), e)
             kill_pool(pool)
             raise
 
-    return output_esdl
+    return output
 
 
 if __name__ == "__main__":