chore: Improve errors.py #100
Merged
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 will fix an error we have in our usage of this error.
bgrant
commented
Jun 13, 2022
| @@ -113,7 +112,7 @@ def __init__(self, additional_info=None): | |||
| http.client.responses.get(http.client.NOT_FOUND), | |||
| ) | |||
| if additional_info: | |||
| error_message += " : " + additional_info | |||
There was a problem hiding this comment.
This change (removing a space from the message to make it consistent with the other messages) requires a small test fix in our downstream service.
bgrant
commented
Jun 13, 2022
| @@ -170,7 +173,7 @@ def __init__(self, additional_info=None): | |||
| class ClientErrorResponseWrapper(ClientError): | |||
| def __init__(self, response): | |||
| error_code = response.status_code | |||
| error_message = response.content | |||
| error_message = response.content.decode() | |||
There was a problem hiding this comment.
error_message is bytestring unless we do this. Maybe this wasn't an issue until Python 3?
bgrant
commented
Jun 13, 2022
| @@ -84,7 +84,7 @@ | |||
| # | |||
| # This is also used if you do content translation via gettext catalogs. | |||
| # Usually you set "language" from the command line for these cases. | |||
| language = None | |||
| language = 'en' | |||
There was a problem hiding this comment.
Letting language be None causes an error with a new version of Sphinx.
dshafer
reviewed
Jun 13, 2022
| error_code, error_message = LOGGED_SERVER_ERROR | ||
| error_message = error_message.format(uuid.uuid4()) | ||
| if additional_info: | ||
| error_message += f": {additional_info}" |
There was a problem hiding this comment.
I believe that this error_message is returned directly to the client. Should we make it so that the additional_info only appears in logs, and the client only gets the opaque error UUID?
Requires running tests with logging on
bgrant
commented
Jun 14, 2022
| @@ -21,8 +21,6 @@ | |||
|
|
|||
| ROOT_URLCONF = "tests.urls" | |||
|
|
|||
| TEST_RUNNER = "tests.testutils.NoLoggingTestRunner" | |||
There was a problem hiding this comment.
I did this so I could test the logging on the ServerError
dshafer
approved these changes
Jun 16, 2022
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.
Let ServerError take an
additional_infoargumentUse f-strings throughout errors.py
Use enum value rather than bare int for an error code
Add some unit tests for errors.py to bump up coverage
Bump coverage check to 91%
Fix a Sphinx configuration error that appears with a new version of Sphinx (to get the PR checks to pass)
Update CHANGELOG.md
Update README.md (as needed)
New dependencies were added to
requirements.txtorrequirements-dev.txtpip installsucceeds with a clean virtualenvThere are new or modified tests that cover changes
Test coverage is maintained or expanded