FEAT: Enhance API Deployment Validation to Return 4xx Instead of 500 for Errors

[pk-zipstack]

What

• Refactored WorkflowHelper to handle execution errors: Added explicit exception handling for non-existent execution_id
• Updated serializers.py: Added validation for execution_id to ensure it adheres to a valid UUID format.
• Enhanced error management in api_deployment_views.py:
  • Explicitly handle errors using new custom exceptions.
  • Return appropriate HTTP status codes and error messages for better clarity.
• Introduced custom exceptions in exceptions.py:
  • ExecutionDoesNotExistError

Why

• Clarity in error handling: Users should receive specific and actionable error messages, e.g., whether an execution_id is invalid or doesn't exist in the database.
• Better debugging: Enhanced logging and HTTP responses allow for easier identification and resolution of issues.

How

• In serializers.py:
  • Added validation to enforce execution_id as a UUID.
  • Trimmed trailing spaces.
• In api_deployment_views.py:
  • Ensured all exceptions from the helper are mapped to appropriate HTTP responses.
• In exceptions.py:
  • Centralized error definitions for cleaner management.

Notes on Testing

• Tested error scenarios:
  • Invalid execution_id format: Raises InvalidExecutionIDError.
  • Non-existent execution_id: Raises WorkflowDoesNotExistError.

Relates Issue

#1818

Screenshots

1. Error for invalid execution_id format

   

2. Error for non-existent execution_id
   

3. Trailing Spaces
   

Checklist

I have read and understood the Contribution Guidelines.

[CLAassistant]

All committers have signed the CLA.

[chandrasekharan-zipstack]

LGTM - make sure to resolve conflicts @pk-zipstack

[github-actions]

filepath	function	$$\textcolor{#23d18b}{\tt{passed}}$$	SUBTOTAL
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_logs}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_cleanup}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_cleanup\_skip}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_client\_init}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image\_exists}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_container\_run\_config}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_container\_run\_config\_without\_mount}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{worker/src/unstract/worker/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_run\_container}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{TOTAL}}$$		$$\textcolor{#23d18b}{\tt{9}}$$	$$\textcolor{#23d18b}{\tt{9}}$$

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud