sartography/cr-connect-workflow
1
0
Fork 0
mirror of https://github.com/sartography/cr-connect-workflow.git synced 2025-02-20 11:48:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

This is a decent beginning framework for customer error messages.

Browse Source 
It is not complete, but is in a state where we can start to interact with the front end.
Two tests are failing.
Committing so I can work on an error for Alex.
This commit is contained in:
mike cullerton 2021-02-12 14:18:42 -05:00
parent 8a2a8b1443
commit 39eb5c5c21
4 changed files with 46 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crc/api/common.py
View File

@ -68,7 +68,7 @@ class ApiError(Exception):
class ApiErrorSchema(ma.Schema):
class Meta:
fields = ("code", "message", "workflow_name", "file_name", "task_name", "task_id",
"task_data", "task_user")
"task_data", "task_user", "hint")
@app.errorhandler(ApiError)

56
crc/services/error_service.py
View File

@ -4,9 +4,12 @@
# required_message - human readable message return to the user if error only occurs in required
# all_message -human readable message return to the user if error only occurs in all
#
known_errors = [{'key': 'Error is Non-default exclusive outgoing sequence flow without condition',
'message': 'Missing condition', 'hint': 'Add a Condition Type to your gateway path.'}]
# known_errors = [{'key': 'Error is Non-default exclusive outgoing sequence flow without condition',
# 'message': 'Missing condition', 'hint': 'Add a Condition Type to your gateway path.'}]
known_errors = {'Error is Non-default exclusive outgoing sequence flow without condition':
{'message': 'Missing condition', 'hint': 'Add a Condition Type to your gateway path.'}}
generic_message = """Workflow validation failed. For more information about the error, see below."""
# error_keys = [error['key'] for error in known_errors]
class ValidationErrorService(object):
@ -21,24 +24,37 @@ class ValidationErrorService(object):
def interpret_validation_errors(errors):
if len(errors) == 0:
return ()
hint = ''
# hint = ''
interpreted_errors = []
for known_error in known_errors:
if known_error['key'] in errors['all'].message:
for error_type in ['all', 'required']:
if error_type in errors:
hint = generic_message
for known_key in known_errors:
if known_key in errors[error_type].message:
if 'hint' in known_errors[known_key]:
hint = known_errors[known_key]['hint']
# else:
# hint = generic_message
errors[error_type].hint = hint
interpreted_errors.append(errors[error_type])
# in both error all and error required
if known_error['key'] in errors['required'].message:
if 'both_hint' in known_error.keys():
hint = known_error['both_hint']
if 'both_message' in known_error.keys():
message = known_error['both_message']
# for known_error in known_errors:
# if known_error['key'] in errors['all'].message:
#
# # in both error all and error required
# if known_error['key'] in errors['required'].message:
# if 'hint' in known_error.keys():
# hint = known_error['hint']
# else:
# hint = generic_message
#
# # just in error all
# else:
# pass
#
# # just in error required
# if known_error['key'] in errors['required'].message:
# pass
# just in error all
else:
pass
# just in error required
if known_error['key'] in errors['required'].message:
pass
return errors
return interpreted_errors

4
crc/services/workflow_processor.py
View File

@ -339,8 +339,8 @@ class WorkflowProcessor(object):
spec = parser.get_spec(process_id)
except ValidationException as ve:
raise ApiError(code="workflow_validation_error",
message="Failed to parse Workflow Specification '%s'" % workflow_spec_id +
"Error is %s" % str(ve),
message="Failed to parse Workflow Specification '%s'. \n" % workflow_spec_id +
"Error is %s. \n" % str(ve),
file_name=ve.filename,
task_id=ve.id,
tag=ve.tag)

8
tests/workflow/test_workflow_customer_error.py
View File

@ -1,14 +1,20 @@
from tests.base_test import BaseTest
from crc.services.workflow_service import WorkflowService
import json
class TestCustomerError(BaseTest):
def test_customer_error(self):
# workflow = self.create_workflow('failing_workflow')
# workflow_api = self.get_workflow_api(workflow)
# first_task = workflow_api.next_task
self.load_example_data()
spec_model = self.load_test_spec('failing_gateway_workflow')
# final_data = WorkflowService.test_spec(spec_model.id)
#
# spec_model = self.load_test_spec('failing_gateway_workflow')
rv = self.app.get('/v1.0/workflow-specification/%s/validate' % spec_model.id, headers=self.logged_in_headers())
json_data = json.loads(rv.get_data(as_text=True))
# json_data = json.loads(rv.get_data(as_text=True))
#
print('test_customer_error: ')