Error structure core components #986

silentninja · 2022-01-19T17:41:18Z

Fixes #983

It adds the necessary components required for

Custom error handler for capturing exceptions
Error structure based on NamedTuple
Unique Enum that contains the list of error codes
Logic to call respective parsers to convert non ApiException to proper ApiException

Checklist

My pull request has a descriptive title (not a vague title like Update index.md).
My pull request targets the master branch of the repository
My commit messages follow best practices.
My code follows the established code style of the repository.
I added tests for the changes I made (if applicable).
I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no
visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Add ErrorCodes Enum

1. To capture all exception and convert it to proper api error response 2. To check if error response are correct

mathesar/api/exceptions/exceptions.py

codecov-commenter · 2022-01-19T17:53:32Z

Codecov Report

Merging #986 (8052b4e) into master (0c0d30f) will decrease coverage by 0.83%.
The diff coverage is 17.14%.

@@            Coverage Diff             @@
##           master     #986      +/-   ##
==========================================
- Coverage   93.30%   92.46%   -0.84%     
==========================================
  Files          86       89       +3     
  Lines        3165     3200      +35     
==========================================
+ Hits         2953     2959       +6     
- Misses        212      241      +29

Flag	Coverage Δ
pytest-backend	`92.46% <17.14%> (-0.84%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
mathesar/api/exceptions/error_codes.py	`0.00% <0.00%> (ø)`
mathesar/api/exceptions/exceptions.py	`0.00% <0.00%> (ø)`
mathesar/exception_handlers.py	`54.54% <54.54%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0c0d30f...8052b4e. Read the comment docs.

mathesar/exception_handlers.py

kgodey

Some more style issues.

mathesar/exception_handlers.py

…re already caught. Add base Exception and Error classes which can be extended upon if needed

…o `APIExceptionClass`

… into error-structure_core_components

kgodey

This looks fine to me. It's hard to think about the structure without example exceptions implemented to think through, but we can figure that out in later PRs.

I added some minor comments, please fix and merge yourself, no need for me to re-review.

kgodey · 2022-01-20T18:21:39Z

mathesar/api/exceptions/exceptions.py

+
+from django.utils.encoding import force_str
+from rest_framework import status
+from rest_framework.exceptions import APIException as DRFApiException


this should be DRFAPIException or something like OriginalAPIException if the concatenated acronyms are hard to read, it's confusing to mix API and Api

kgodey · 2022-01-20T18:21:56Z

mathesar/api/exceptions/exceptions.py

+        self.status_code = status_code
+
+
+class GenericApiError(APIException):


This should also be API instead of Api

kgodey · 2022-01-20T18:25:10Z

mathesar/api/exceptions/error_codes.py

+
+@unique
+class ErrorCodes(Enum):
+    NonClassifiedError = 4999


I think UnknownError might be a bit clearer for this.

This is more like saying we are able to get the detail of the error but haven't specified any error code for it.

Maybe UnspecifiedCodeError, then?

That was my choice at first but felt like error code hasn't been classified yet made sense, UnspecifiedCodeError seems like error code has not been specified and there is an error related to that, but I think I will go with UnknownError seems neutral.

kgodey · 2022-01-20T18:26:05Z

mathesar/api/exceptions/exceptions.py

+    return APIException(exc, ErrorCodes.NonClassifiedError.value)
+
+
+class APIException(DRFApiException):


Can we call ours MathesarAPIException? It might be confusing to overload the original name for contributors who are used to working with DRF.

Rename `GenericApiError` to `GenericAPIError`

mathemancer

I think it makes sense. Like @kgodey , I'd need to see it in action to provide more feedback.

silentninja added 3 commits January 18, 2022 07:44

Add ExceptionBody named tuple to be used to create an exception body

198264e

Add ErrorCodes Enum

Add exception handler

dd60765

1. To capture all exception and convert it to proper api error response 2. To check if error response are correct

Rename exception_handler.py to exception_handlers.py

24a072e

silentninja requested a review from a team January 19, 2022 17:41

Merge branch 'master' into error-structure_core_components

9134e54

github-actions bot requested review from dmos62, eito-fis, kgodey, mathemancer and pavish January 19, 2022 17:41

silentninja added the status: draft label Jan 19, 2022

kgodey reviewed Jan 19, 2022

View reviewed changes

mathesar/api/exceptions/exceptions.py Outdated Show resolved Hide resolved

kgodey reviewed Jan 19, 2022

View reviewed changes

mathesar/exception_handlers.py Outdated Show resolved Hide resolved

kgodey requested changes Jan 19, 2022

View reviewed changes

mathesar/exception_handlers.py Outdated Show resolved Hide resolved

mathesar/exception_handlers.py Outdated Show resolved Hide resolved

mathesar/exception_handlers.py Outdated Show resolved Hide resolved

silentninja added 4 commits January 20, 2022 00:53

Change ExceptionBody to ErrorBody as it represents errors which a…

62cc86f

…re already caught. Add base Exception and Error classes which can be extended upon if needed

Remove error response check and rename ApiExceptionClass variable t…

b0d8379

…o `APIExceptionClass`

Merge remote-tracking branch 'origin/error-structure_core_components'…

501aa1a

… into error-structure_core_components

Fix lint errors

8d0ec01

silentninja marked this pull request as draft January 19, 2022 20:18

Revert lint default switch to false

5bca416

silentninja removed the status: draft label Jan 20, 2022

silentninja mentioned this pull request Jan 20, 2022

Convert API layer error responses into Errors that conform to the API spec #991

Merged

7 tasks

silentninja marked this pull request as ready for review January 20, 2022 01:38

Merge branch 'master' into error-structure_core_components

6f88ac3

github-actions bot requested a review from kgodey January 20, 2022 01:38

kgodey approved these changes Jan 20, 2022

View reviewed changes

Rename APIException to MathesarAPIException

5b8790d

Rename `GenericApiError` to `GenericAPIError`

silentninja requested a review from a team January 20, 2022 20:06

Merge branch 'master' into error-structure_core_components

b40e972

mathemancer approved these changes Jan 21, 2022

View reviewed changes

Merge branch 'master' into error-structure_core_components

8052b4e

kgodey merged commit d3263a3 into master Jan 21, 2022

kgodey deleted the error-structure_core_components branch January 21, 2022 19:53

silentninja mentioned this pull request Feb 14, 2022

Add Detailed Exception parsing for Custom API exception classes #1068

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Error structure core components #986

Error structure core components #986

silentninja commented Jan 19, 2022 •

edited

Loading

codecov-commenter commented Jan 19, 2022 •

edited

Loading

kgodey left a comment

kgodey left a comment

kgodey Jan 20, 2022

kgodey Jan 20, 2022

kgodey Jan 20, 2022

silentninja Jan 20, 2022

kgodey Jan 20, 2022

silentninja Jan 20, 2022

kgodey Jan 20, 2022

mathemancer left a comment

		self.status_code = status_code


		class GenericApiError(APIException):

		return APIException(exc, ErrorCodes.NonClassifiedError.value)


		class APIException(DRFApiException):

Error structure core components #986

Error structure core components #986

Conversation

silentninja commented Jan 19, 2022 • edited Loading

Checklist

Developer Certificate of Origin

codecov-commenter commented Jan 19, 2022 • edited Loading

Codecov Report

kgodey left a comment

Choose a reason for hiding this comment

kgodey left a comment

Choose a reason for hiding this comment

kgodey Jan 20, 2022

Choose a reason for hiding this comment

kgodey Jan 20, 2022

Choose a reason for hiding this comment

kgodey Jan 20, 2022

Choose a reason for hiding this comment

silentninja Jan 20, 2022

Choose a reason for hiding this comment

kgodey Jan 20, 2022

Choose a reason for hiding this comment

silentninja Jan 20, 2022

Choose a reason for hiding this comment

kgodey Jan 20, 2022

Choose a reason for hiding this comment

mathemancer left a comment

Choose a reason for hiding this comment

silentninja commented Jan 19, 2022 •

edited

Loading

codecov-commenter commented Jan 19, 2022 •

edited

Loading