From b70ef1796ad69cbbb9c7f09587b5bcb99ba7dd77 Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Mon, 9 Jan 2023 13:02:34 -0500 Subject: [PATCH 01/10] Update process_models_controller to include `fault_or_suspend_on_exception` and `exception_notification_addresses` for Process Model create/update --- src/spiffworkflow_backend/routes/process_models_controller.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/spiffworkflow_backend/routes/process_models_controller.py b/src/spiffworkflow_backend/routes/process_models_controller.py index 1709357a..f50089dc 100644 --- a/src/spiffworkflow_backend/routes/process_models_controller.py +++ b/src/spiffworkflow_backend/routes/process_models_controller.py @@ -49,6 +49,8 @@ def process_model_create( "primary_process_id", "description", "metadata_extraction_paths", + "fault_or_suspend_on_exception", + "exception_notification_addresses", ] body_filtered = { include_item: body[include_item] @@ -100,6 +102,8 @@ def process_model_update( "primary_process_id", "description", "metadata_extraction_paths", + "fault_or_suspend_on_exception", + "exception_notification_addresses", ] body_filtered = { include_item: body[include_item] From 1181d419161e914e4cf3af839df1f167f31d2441 Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Tue, 10 Jan 2023 08:44:53 -0500 Subject: [PATCH 02/10] Work on System Notification handler --- src/spiffworkflow_backend/config/default.py | 3 + .../services/error_handling_service.py | 123 ++++++++++++------ 2 files changed, 86 insertions(+), 40 deletions(-) diff --git a/src/spiffworkflow_backend/config/default.py b/src/spiffworkflow_backend/config/default.py index d0d6a401..1a2f7504 100644 --- a/src/spiffworkflow_backend/config/default.py +++ b/src/spiffworkflow_backend/config/default.py @@ -74,3 +74,6 @@ SPIFF_DATABASE_TYPE = environ.get( SPIFFWORKFLOW_BACKEND_DATABASE_URI = environ.get( "SPIFFWORKFLOW_BACKEND_DATABASE_URI", default=None ) +SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID = environ.get( + "SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID", default="Message_SystemMessageNotification" +) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index 1e8b38f2..1c8e66a3 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -1,4 +1,9 @@ """Error_handling_service.""" +import json + +from flask import g +from flask import current_app +from flask.wrappers import Response from typing import Any from typing import List from typing import Union @@ -6,9 +11,15 @@ from typing import Union from flask_bpmn.api.api_error import ApiError from flask_bpmn.models.db import db +from spiffworkflow_backend.models.message_model import MessageModel +from spiffworkflow_backend.models.message_triggerable_process_model import ( + MessageTriggerableProcessModel, +) from spiffworkflow_backend.models.process_instance import ProcessInstanceModel +from spiffworkflow_backend.models.process_instance import ProcessInstanceModelSchema from spiffworkflow_backend.models.process_instance import ProcessInstanceStatus from spiffworkflow_backend.services.email_service import EmailService +from spiffworkflow_backend.services.message_service import MessageService from spiffworkflow_backend.services.process_instance_processor import ( ProcessInstanceProcessor, ) @@ -37,6 +48,7 @@ class ErrorHandlingService: process_model = ProcessModelService.get_process_model( _processor.process_model_identifier ) + # First, suspend or fault the instance if process_model.fault_or_suspend_on_exception == "suspend": self.set_instance_status( _processor.process_instance_model.id, @@ -49,57 +61,88 @@ class ErrorHandlingService: ProcessInstanceStatus.error.value, ) + # Second, call the System Notification Process + # Note that this isn't the best way to do this. + # The configs are all in the model. + # Maybe we can move some of this to the notification process, or dmn tables. if len(process_model.exception_notification_addresses) > 0: try: - # some notification method (waku?) - self.handle_email_notification( - _processor, _error, process_model.exception_notification_addresses - ) + self.handle_system_notification(_error, process_model.exception_notification_addresses) except Exception as e: # hmm... what to do if a notification method fails. Probably log, at least print(e) @staticmethod - def hanle_sentry_notification(_error: ApiError, _recipients: List) -> None: - """SentryHandler.""" - ... - - @staticmethod - def handle_email_notification( - processor: ProcessInstanceProcessor, + def handle_system_notification( error: Union[ApiError, Exception], recipients: List, - ) -> None: - """EmailHandler.""" - subject = "Unexpected error in app" - if isinstance(error, ApiError): - content = f"{error.message}" - else: - content = str(error) - content_html = content - - EmailService.add_email( - subject, - "sender@company.com", - recipients, - content, - content_html, - cc=None, - bcc=None, - reply_to=None, - attachment_files=None, + ): + message_payload = { + 'my_var': 'my_value', + 'error': error.__repr__(), + 'recipients': recipients + } + message_identifier = current_app.config["SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID"] + message_model = MessageModel.query.filter_by(identifier=message_identifier).first() + message_triggerable_process_model = ( + MessageTriggerableProcessModel.query.filter_by( + message_model_id=message_model.id + ).first() + ) + process_instance = MessageService.process_message_triggerable_process_model( + message_triggerable_process_model, + message_identifier, + message_payload, + g.user ) - @staticmethod - def handle_waku_notification(_error: ApiError, _recipients: List) -> Any: - """WakuHandler.""" - # class WakuMessage: - # """WakuMessage.""" - # - # payload: str - # contentTopic: str # Optional - # version: int # Optional - # timestamp: int # Optional + return Response( + json.dumps(ProcessInstanceModelSchema().dump(process_instance)), + status=200, + mimetype="application/json", + ) + + # @staticmethod + # def handle_sentry_notification(_error: ApiError, _recipients: List) -> None: + # """SentryHandler.""" + # ... + # + # @staticmethod + # def handle_email_notification( + # processor: ProcessInstanceProcessor, + # error: Union[ApiError, Exception], + # recipients: List, + # ) -> None: + # """EmailHandler.""" + # subject = "Unexpected error in app" + # if isinstance(error, ApiError): + # content = f"{error.message}" + # else: + # content = str(error) + # content_html = content + # + # EmailService.add_email( + # subject, + # "sender@company.com", + # recipients, + # content, + # content_html, + # cc=None, + # bcc=None, + # reply_to=None, + # attachment_files=None, + # ) + # + # @staticmethod + # def handle_waku_notification(_error: ApiError, _recipients: List) -> Any: + # """WakuHandler.""" + # # class WakuMessage: + # # """WakuMessage.""" + # # + # # payload: str + # # contentTopic: str # Optional + # # version: int # Optional + # # timestamp: int # Optional class FailingService: From b31f04a658feeb59b089926fb28374135b723285 Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Tue, 10 Jan 2023 16:33:51 -0500 Subject: [PATCH 03/10] Removed test for email error handler. Added stub for testing system handler process --- .../integration/test_process_api.py | 57 ++----------------- 1 file changed, 4 insertions(+), 53 deletions(-) diff --git a/tests/spiffworkflow_backend/integration/test_process_api.py b/tests/spiffworkflow_backend/integration/test_process_api.py index f5248050..efc22ab5 100644 --- a/tests/spiffworkflow_backend/integration/test_process_api.py +++ b/tests/spiffworkflow_backend/integration/test_process_api.py @@ -2160,59 +2160,10 @@ class TestProcessApi(BaseTest): assert process is not None assert process.status == "suspended" - def test_error_handler_with_email( - self, - app: Flask, - client: FlaskClient, - with_db_and_bpmn_file_cleanup: None, - with_super_admin_user: UserModel, - ) -> None: - """Test_error_handler.""" - process_group_id = "data" - process_model_id = "error" - bpmn_file_name = "error.bpmn" - bpmn_file_location = "error" - process_model_identifier = self.create_group_and_model_with_bpmn( - client, - with_super_admin_user, - process_group_id=process_group_id, - process_model_id=process_model_id, - bpmn_file_name=bpmn_file_name, - bpmn_file_location=bpmn_file_location, - ) - - process_instance_id = self.setup_testing_instance( - client, process_model_identifier, with_super_admin_user - ) - - process_model = ProcessModelService.get_process_model(process_model_identifier) - ProcessModelService.update_process_model( - process_model, - {"exception_notification_addresses": ["with_super_admin_user@example.com"]}, - ) - - mail = app.config["MAIL_APP"] - with mail.record_messages() as outbox: - response = client.post( - f"/v1.0/process-instances/{self.modify_process_identifier_for_path_param(process_model_identifier)}/{process_instance_id}/run", - headers=self.logged_in_headers(with_super_admin_user), - ) - assert response.status_code == 400 - assert len(outbox) == 1 - message = outbox[0] - assert message.subject == "Unexpected error in app" - assert ( - message.body == 'TypeError:can only concatenate str (not "int") to str' - ) - assert message.recipients == process_model.exception_notification_addresses - - process = ( - db.session.query(ProcessInstanceModel) - .filter(ProcessInstanceModel.id == process_instance_id) - .first() - ) - assert process is not None - assert process.status == "error" + def test_error_handler_system_notification(self): + """Test_error_handler_system_notification.""" + # TODO: make sure the system notification process is run on exceptions + ... def test_task_data_is_set_even_if_process_instance_errors( self, From 999b19062fad3ca19f4c09c5660a089828d0effe Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Wed, 11 Jan 2023 17:46:39 -0500 Subject: [PATCH 04/10] mypy --- src/spiffworkflow_backend/services/error_handling_service.py | 2 +- tests/spiffworkflow_backend/integration/test_process_api.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index 1c8e66a3..5d6346d7 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -76,7 +76,7 @@ class ErrorHandlingService: def handle_system_notification( error: Union[ApiError, Exception], recipients: List, - ): + ) -> Response: message_payload = { 'my_var': 'my_value', 'error': error.__repr__(), diff --git a/tests/spiffworkflow_backend/integration/test_process_api.py b/tests/spiffworkflow_backend/integration/test_process_api.py index efc22ab5..d4e630f3 100644 --- a/tests/spiffworkflow_backend/integration/test_process_api.py +++ b/tests/spiffworkflow_backend/integration/test_process_api.py @@ -2160,7 +2160,7 @@ class TestProcessApi(BaseTest): assert process is not None assert process.status == "suspended" - def test_error_handler_system_notification(self): + def test_error_handler_system_notification(self) -> None: """Test_error_handler_system_notification.""" # TODO: make sure the system notification process is run on exceptions ... From fa299f412aa71072c47d05c6b79740b0912c7f97 Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Wed, 11 Jan 2023 18:12:18 -0500 Subject: [PATCH 05/10] Precommit --- src/spiffworkflow_backend/services/error_handling_service.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index 5d6346d7..b700e781 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -4,7 +4,7 @@ import json from flask import g from flask import current_app from flask.wrappers import Response -from typing import Any +# from typing import Any from typing import List from typing import Union @@ -18,7 +18,7 @@ from spiffworkflow_backend.models.message_triggerable_process_model import ( from spiffworkflow_backend.models.process_instance import ProcessInstanceModel from spiffworkflow_backend.models.process_instance import ProcessInstanceModelSchema from spiffworkflow_backend.models.process_instance import ProcessInstanceStatus -from spiffworkflow_backend.services.email_service import EmailService +# from spiffworkflow_backend.services.email_service import EmailService from spiffworkflow_backend.services.message_service import MessageService from spiffworkflow_backend.services.process_instance_processor import ( ProcessInstanceProcessor, @@ -77,6 +77,7 @@ class ErrorHandlingService: error: Union[ApiError, Exception], recipients: List, ) -> Response: + """Handle_system_notification.""" message_payload = { 'my_var': 'my_value', 'error': error.__repr__(), From e7ab8f8b8a171a8d4f9a9dc35affedaaafd70db2 Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Thu, 12 Jan 2023 07:13:35 -0500 Subject: [PATCH 06/10] Cleaned up the message text --- .../services/error_handling_service.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index b700e781..4b203e34 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -18,6 +18,7 @@ from spiffworkflow_backend.models.message_triggerable_process_model import ( from spiffworkflow_backend.models.process_instance import ProcessInstanceModel from spiffworkflow_backend.models.process_instance import ProcessInstanceModelSchema from spiffworkflow_backend.models.process_instance import ProcessInstanceStatus +from spiffworkflow_backend.models.process_model import ProcessModelInfo # from spiffworkflow_backend.services.email_service import EmailService from spiffworkflow_backend.services.message_service import MessageService from spiffworkflow_backend.services.process_instance_processor import ( @@ -67,7 +68,7 @@ class ErrorHandlingService: # Maybe we can move some of this to the notification process, or dmn tables. if len(process_model.exception_notification_addresses) > 0: try: - self.handle_system_notification(_error, process_model.exception_notification_addresses) + self.handle_system_notification(_error, process_model) except Exception as e: # hmm... what to do if a notification method fails. Probably log, at least print(e) @@ -75,12 +76,13 @@ class ErrorHandlingService: @staticmethod def handle_system_notification( error: Union[ApiError, Exception], - recipients: List, + process_model: ProcessModelInfo ) -> Response: """Handle_system_notification.""" + recipients = process_model.exception_notification_addresses + message_text = f"There was an exception running process {process_model.id}.\nOriginal Error:\n{error.__repr__()}" message_payload = { - 'my_var': 'my_value', - 'error': error.__repr__(), + 'message_text': message_text, 'recipients': recipients } message_identifier = current_app.config["SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID"] From c67872354abd3f932eb8d31bda3ad4e38ebb9c17 Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Fri, 13 Jan 2023 08:40:56 -0500 Subject: [PATCH 07/10] unused imports --- src/spiffworkflow_backend/services/error_handling_service.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index f655ff73..e2c93b5d 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -2,10 +2,7 @@ import json from flask import g -from flask import current_app from flask.wrappers import Response -# from typing import Any -from typing import List from typing import Union from flask import current_app @@ -20,7 +17,6 @@ from spiffworkflow_backend.models.process_instance import ProcessInstanceModel from spiffworkflow_backend.models.process_instance import ProcessInstanceModelSchema from spiffworkflow_backend.models.process_instance import ProcessInstanceStatus from spiffworkflow_backend.models.process_model import ProcessModelInfo -# from spiffworkflow_backend.services.email_service import EmailService from spiffworkflow_backend.services.message_service import MessageService from spiffworkflow_backend.services.process_instance_processor import ( ProcessInstanceProcessor, From c5332852374a22f862e30f6e8176f0b68a8a715f Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Fri, 13 Jan 2023 08:52:43 -0500 Subject: [PATCH 08/10] import order --- .../services/error_handling_service.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index e2c93b5d..f5119b83 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -2,10 +2,9 @@ import json from flask import g -from flask.wrappers import Response -from typing import Union - from flask import current_app +from flask.wrappers import Response + from flask_bpmn.api.api_error import ApiError from flask_bpmn.models.db import db @@ -23,6 +22,8 @@ from spiffworkflow_backend.services.process_instance_processor import ( ) from spiffworkflow_backend.services.process_model_service import ProcessModelService +from typing import Union + class ErrorHandlingService: """ErrorHandlingService.""" From 5bf49c386dca1ed9f05357f17152f0bc6c60618b Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Fri, 13 Jan 2023 09:03:17 -0500 Subject: [PATCH 09/10] reorder imports --- .../services/error_handling_service.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index f5119b83..a161f251 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -1,13 +1,12 @@ """Error_handling_service.""" import json +from typing import Union -from flask import g from flask import current_app +from flask import g from flask.wrappers import Response - from flask_bpmn.api.api_error import ApiError from flask_bpmn.models.db import db - from spiffworkflow_backend.models.message_model import MessageModel from spiffworkflow_backend.models.message_triggerable_process_model import ( MessageTriggerableProcessModel, @@ -22,8 +21,6 @@ from spiffworkflow_backend.services.process_instance_processor import ( ) from spiffworkflow_backend.services.process_model_service import ProcessModelService -from typing import Union - class ErrorHandlingService: """ErrorHandlingService.""" From 57249528da6bc0faef07fef3a9155afa3230c41e Mon Sep 17 00:00:00 2001 From: mike cullerton Date: Fri, 13 Jan 2023 11:50:36 -0500 Subject: [PATCH 10/10] run_pyl changes --- src/spiffworkflow_backend/config/default.py | 3 ++- .../services/error_handling_service.py | 24 +++++++++++-------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/src/spiffworkflow_backend/config/default.py b/src/spiffworkflow_backend/config/default.py index 431947fc..80cfb919 100644 --- a/src/spiffworkflow_backend/config/default.py +++ b/src/spiffworkflow_backend/config/default.py @@ -78,5 +78,6 @@ SPIFFWORKFLOW_BACKEND_DATABASE_URI = environ.get( "SPIFFWORKFLOW_BACKEND_DATABASE_URI", default=None ) SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID = environ.get( - "SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID", default="Message_SystemMessageNotification" + "SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID", + default="Message_SystemMessageNotification", ) diff --git a/src/spiffworkflow_backend/services/error_handling_service.py b/src/spiffworkflow_backend/services/error_handling_service.py index a161f251..51f402fa 100644 --- a/src/spiffworkflow_backend/services/error_handling_service.py +++ b/src/spiffworkflow_backend/services/error_handling_service.py @@ -7,6 +7,7 @@ from flask import g from flask.wrappers import Response from flask_bpmn.api.api_error import ApiError from flask_bpmn.models.db import db + from spiffworkflow_backend.models.message_model import MessageModel from spiffworkflow_backend.models.message_triggerable_process_model import ( MessageTriggerableProcessModel, @@ -70,18 +71,21 @@ class ErrorHandlingService: @staticmethod def handle_system_notification( - error: Union[ApiError, Exception], - process_model: ProcessModelInfo + error: Union[ApiError, Exception], process_model: ProcessModelInfo ) -> Response: """Handle_system_notification.""" recipients = process_model.exception_notification_addresses - message_text = f"There was an exception running process {process_model.id}.\nOriginal Error:\n{error.__repr__()}" - message_payload = { - 'message_text': message_text, - 'recipients': recipients - } - message_identifier = current_app.config["SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID"] - message_model = MessageModel.query.filter_by(identifier=message_identifier).first() + message_text = ( + f"There was an exception running process {process_model.id}.\nOriginal" + f" Error:\n{error.__repr__()}" + ) + message_payload = {"message_text": message_text, "recipients": recipients} + message_identifier = current_app.config[ + "SYSTEM_NOTIFICATION_PROCESS_MODEL_MESSAGE_ID" + ] + message_model = MessageModel.query.filter_by( + identifier=message_identifier + ).first() message_triggerable_process_model = ( MessageTriggerableProcessModel.query.filter_by( message_model_id=message_model.id @@ -91,7 +95,7 @@ class ErrorHandlingService: message_triggerable_process_model, message_identifier, message_payload, - g.user + g.user, ) return Response(