Fix authentication error payload #360
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
PaulAsjes
commented
Sep 9, 2024
| ) | ||
| except Exception as ex: | ||
| assert ex.__class__ == BadRequestException | ||
|
|
||
| def test_bad_request_exceptions_exclude_expected_request_data(self): |
There was a problem hiding this comment.
What we want is for everything in the return value to be added to exceptions, this test does the opposite.
gcarvelli
approved these changes
Sep 9, 2024
workos/exceptions.py
Outdated
| def __str__(self) -> str: | ||
| message = self.message or "No message" | ||
| exception = "(message=%s" % message | ||
| self.message = self.extractFromJson("message", "No message") |
There was a problem hiding this comment.
This is 100x nicer than except ValueError, good stuff
There was a problem hiding this comment.
Thanks! Also lol snake case
workos/exceptions.py
Outdated
| self.error = self.extractFromJson("error", None) | ||
| self.errors = self.extractFromJson("errors", None) | ||
| self.code = self.extractFromJson("code", None) | ||
| self.error_description = self.extractFromJson("error_description", None) |
There was a problem hiding this comment.
error and error_description previously defaulted to "Unknown" so this is a small change in behavior (line)
|
thank you! |
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.
Description
Exceptions were only returning specific hardcoded values, which isn't accurate any more since an error can have a plethora of parameters in it.
This fixes it by dumping the contents of the API response into the error object, giving the user all the information they need to fix the error.
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.