feat: Introduce a new standartized drf errors format #5223
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iskhakov
had a problem deploying
to
github-pages
GitHub Actions
Failure
iskhakov
had a problem deploying
to
github-pages
GitHub Actions
Failure
iskhakov
commented
Nov 1, 2024
Comment on lines
+16
to
+24
| def format_error_response(self, error_response: ErrorResponse): | ||
| old_error_response_data = drf_exception_handler(self.exc, self.context).data | ||
| # For the compatibility reasons, we are keeping the old format of error response | ||
| # and adding the new format of error response in the same response. | ||
| # This is done to avoid breaking the existing clients. | ||
| # New format uses the default error response format from drf_standardized_errors. | ||
| new_error_response_data = super().format_error_response(error_response) | ||
| data = {**old_error_response_data, "new_format_data": new_error_response_data} | ||
| return data |
There was a problem hiding this comment.
here is the main idea of the PR
iskhakov
commented
Nov 4, 2024
| @@ -2149,7 +2149,7 @@ def test_alert_group_resolve_resolution_note( | |||
| response = client.post(url, format="json", **make_user_auth_headers(user, token)) | |||
| # check that resolution note is required | |||
| assert response.status_code == status.HTTP_400_BAD_REQUEST | |||
| assert response.json()["code"] == AlertGroupAPIError.RESOLUTION_NOTE_REQUIRED.value | |||
| assert response.json()["code"] == str(AlertGroupAPIError.RESOLUTION_NOTE_REQUIRED.value) | |||
There was a problem hiding this comment.
As the error is raised as an exception, only string is possible
iskhakov
added
the
pr:no public docs
iskhakov
changed the title
|
some of the exceptions that are raised outside of drf are not handled by drf-standartized-errors handler, especially in middleware. We need to address that before rolling this pr. Closing the PR for now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
This pull request aims to standardize error handling in the Django Rest Framework by implementing the drf_standardized_errors package. The changes involve:
Which issue(s) this PR closes
Related to [issue link here]
Checklist
pr:no public docsPR label added if not required)release:). These labels dictate how your PR willshow up in the autogenerated release notes.