sartography
/
cr-connect-workflow
mirror of https://github.com/sartography/cr-connect-workflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cr-connect-workflow/crc/api/common.py

45 lines
1.9 KiB
Python
Raw Normal View History

New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
from crc import ma, app
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
Provide a script for generating word documents from template files. Refractored file managment into a service to make it easier to programatically add files. Modified the workflow_processor to inject the study_id and workflow_id into the running workflow so that this meta-information is avialable at the task level.
2020-02-10 21:19:23 +00:00
class ApiError(Exception):
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
def __init__(self, code, message, status_code=400,
file_name="", task_id="", task_name="", tag=""):
New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
self.status_code = status_code
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
self.code = code # a short consistent string describing the error.
self.message = message # A detailed message that provides more information.
self.task_id = task_id or "" # OPTIONAL: The id of the task in the BPMN Diagram.
self.task_name = task_name or "" # OPTIONAL: The name of the task in the BPMN Diagram.
self.file_name = file_name or "" # OPTIONAL: The file that caused the error.
self.tag = tag or "" # OPTIONAL: The XML Tag that caused the issue.
Standardizing the script tasks that can be executed on the server, adding tons of error messages for when things go wrong. All scripts must exist in side of the crc/scripts directory. Adding a new script that script tasks can use to add in data about the study. Moving all the test workflow specifications out of the main load. fixing a pile of tests so they can find workflow specs that are now moved into the test directory.
2020-03-03 18:50:22 +00:00
Exception.__init__(self, self.message)
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
@classmethod
def from_task(cls, code, message, task, status_code=400):
"""Constructs an API Error with details pulled from the current task."""
instance = cls(code, message, status_code=status_code)
instance.task_id = task.task_spec.name or ""
instance.task_name = task.task_spec.description or ""
instance.file_name = task.workflow.spec.file or ""
return instance
@classmethod
def from_task_spec(cls, code, message, task_spec, status_code=400):
"""Constructs an API Error with details pulled from the current task."""
instance = cls(code, message, status_code=status_code)
instance.task_id = task_spec.name or ""
instance.task_name = task_spec.description or ""
if task_spec._wf_spec:
instance.file_name = task_spec._wf_spec.file
return instance
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
class ApiErrorSchema(ma.Schema):
class Meta:
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
fields = ("code", "message", "workflow_name", "file_name", "task_name", "task_id")
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
@app.errorhandler(ApiError)
def handle_invalid_usage(error):
response = ApiErrorSchema().dump(error)
return response, error.status_code