Define custom exceptions for better handling error response #5899
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
------------------------------------------------------ This commit adds custom exception classes and error handling logic to the project. The new classes extend the `BaseException` class from `werkzeug.exceptions.HTTPException` and provide additional functionality for handling different types of errors. The custom exception classes included in this commit are: - `BadRequest`: Represents a bad request error (400). - `Unauthorized`: Represents an unauthorized access error (401). - `Forbidden`: Represents a forbidden access error (403). - `NotFound`: Represents a resource not found error (404). - `Conflict`: Represents a conflict error (409). Each exception class accepts optional parameters for sub-code, message, and additional details. If not provided, default values are used. The error messages are retrieved from the `ERROR_MESSAGES` dictionary defined in the `backend` module. The commit also includes the `to_dict()` method in the `BaseException` class, which converts the exception object to a dictionary representation containing error code, sub-code, message, and details. These custom exception classes enhance the error handling capabilities of the project and provide a standardized way to handle and communicate various types of errors.
---------------------------------------------------- As newly defined custom exceptions are not explicitly handled within the code (because Flask's error handler handles them as they are inherited from Werkzeug's HTTPException), they will be reported as unhandled errors in Sentry. This will result in a significant amount of noise on the Sentry dashboard. To reduce this noise, we need to ignore all these handled errors and exclude them from being reported to Sentry.
Aadesh-Baral
force-pushed
the
enhance/5197-backend-error-handling
branch
from
cd3d550
to
4376028
Compare
Aadesh-Baral
changed the title
Aadesh-Baral
force-pushed
the
enhance/5197-backend-error-handling
branch
3 times, most recently
from
d1ad302
to
f1cd93a
Compare
--------------------------------------- On the app, there may be some unhandled exceptions. A error handler is defined that collects all of these unhandled errors and returns the error message in the desired format.
Aadesh-Baral
force-pushed
the
enhance/5197-backend-error-handling
branch
from
f1cd93a
to
912f00f
Compare
eternaltyro
requested changes
Jun 14, 2023
|
Kudos, SonarCloud Quality Gate passed!
|
|
Merged. |
Aadesh-Baral
added a commit
that referenced
this pull request
Jun 21, 2023
------------------------------------ We defined custom HttpExceptions on #5899 to better handle errors but these exceptions were not used anywhere. This commit has replaced the previous NotFound custom exception which was simply a basic exceptio class with the new implementation.
Aadesh-Baral
added a commit
that referenced
this pull request
Jun 21, 2023
------------------------------------ We defined custom HttpExceptions on #5899 to better handle errors but these exceptions were not used anywhere. This commit has replaced the previous NotFound custom exception which was simply a basic exceptio class with the new implementation.
Aadesh-Baral
added a commit
that referenced
this pull request
Jul 18, 2023
------------------------------------ We defined custom HttpExceptions on #5899 to better handle errors but these exceptions were not used anywhere. This commit has replaced the previous NotFound custom exception which was simply a basic exceptio class with the new implementation.
4 tasks
Aadesh-Baral
added a commit
that referenced
this pull request
Aug 7, 2023
------------------------------------ We defined custom HttpExceptions on #5899 to better handle errors but these exceptions were not used anywhere. This commit has replaced the previous NotFound custom exception which was simply a basic exceptio class with the new implementation.
Aadesh-Baral
added a commit
that referenced
this pull request
Aug 7, 2023
------------------------------------ We defined custom HttpExceptions on #5899 to better handle errors but these exceptions were not used anywhere. This commit has replaced the previous NotFound custom exception which was simply a basic exceptio class with the new implementation.
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.
closes #5909
This pull request (PR) introduces the necessary infrastructure to enhance backend error handling in the project. It includes the implementation of custom exception classes that extend the
BaseExceptionclass fromwerkzeug.exceptions.HTTPException. These custom exceptions offer additional features for handling various types of errors effectively.Moreover, this PR also introduces a mechanism to separate error messages from the code. The error messages are now stored in a JSON file named "error_messages.json". This approach simplifies the management and updates of error messages independently, providing more flexibility in maintaining and modifying them
Example:
We can raise a NotFound Exception as:
This will return error response as:
{ "error": { "message": "The requested project was not found in the server." "code": 404, "sub_code": "PROJECT_NOT_FOUND", "details": {"project_id": 1} }For more info please have a look at individual commit messages.
NOTE: This PR mainly focuses on setting up the infrastructure in order to better error handling; Hence these custom exceptions aren't used to handle errors.