Fixed invalid api key format raising 500

[pk-zipstack]

What

• Added API key format validation: Ensures the API key provided in the Authorization header is a valid UUID.
• Updated BaseAPIKeyValidator:
  • Modified the validate_api_key decorator to validate API key format using Python’s uuid module.
• Enhanced error messages: Returns a 400 BadRequest error when the API key format is invalid.
• New Approach:
  • Modified the validate_api_key function in key_helper.py to capture ValidationError and raise UnauthozisedKey() error.

Why

• Prevent errors due to invalid API key formats: An invalid API key format caused unnecessary 500 Internal Server Error responses.

How

• Changes in KeyHelper class:
  • Updated the static method validate_api_key to catch Django's ValidationError that occurs during UUID validation and raise an UnauthorizedKey exception, ensuring consistent error handling for invalid API key formats.

Can this PR break any existing features?

• No, this change only enhances API key validation. Existing workflows with valid API keys will remain unaffected.
• Why not? All existing keys follow the UUID format, ensuring backward compatibility.

Database Migrations

• None

Env Config

• None

Relevant Docs

• None

Related Issues or PRs

• https://zipstack.atlassian.net/browse/UN-1911?focusedCommentId=16014

Dependencies Versions

• None

Notes on Testing

• Verified proper validation of valid and invalid API keys.
• Confirmed correct error codes (400 Forbidden) for invalid formats.

Screenshots

1. Error for invalid API key format

Checklist

I have read and understood the Contribution Guidelines.

[github-actions]

filepath	function	$$\textcolor{#23d18b}{\tt{passed}}$$	SUBTOTAL
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_logs}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_cleanup}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_cleanup\_skip}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_client\_init}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image\_exists}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_container\_run\_config}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/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{runner/src/unstract/runner/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

[muhammad-ali-e]

LGTM