Add granularity for DID Token Errors #50
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 pull request has been linked to Shortcut Story #67980: Python Admin SDK - split DIDTokenError into 2 error types. |
ayv8er
reviewed
Jan 5, 2023
|
|
||
| Returns: | ||
| None. | ||
| """ | ||
| proof, claim = cls.decode(did_token) | ||
|
|
||
| if claim['ext'] is None: |
There was a problem hiding this comment.
Thank you for adding this to the validate method!
magic_admin/resources/token.py
Outdated
Comment on lines
145
to
147
| message='Given DID token cannot be used at this time. Please ' | ||
| 'check the "ext" field and regenerate a new token with a suitable ' | ||
| 'value.', |
There was a problem hiding this comment.
I think the first line could go away. The "at this time" makes me think of a temporal issue vs malformed.
There was a problem hiding this comment.
Good call - removed.
justinnout
deleted the
justinherrera-sc-67980-python-admin-sdk-split-didtokenerror-into
branch
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.
📦 Pull Request
The
DIDTokenErroris too vague so we split this up intoDIDTokenExpired,DIDTokenMalformed, andDIDTokenInvalid.DIDTokenMalformed: raised when DID token cannot be decoded or if required fields are missingDIDTokenExpired: raised when current time > DID Token expiration timeDIDTokenInvalid: raised when DID token can be decoded but does not pass validation (missing values, signature mismatch, etc.)🗜 Versioning
(Check one!)
✅ Fixed Issues
🚨 Test instructions
Tests pass with
make test.CHANGELOG.mdUpcoming Changessection ofCHANGELOG.mdwith context related to this Pull Request.