Suggest possible config fix when correct scopes aren't requested #721
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
If the hub config doesn't contain appropriate scopes to request from the provider, the token we retrieve may not have the key we are using as `username_claim`. This is the *most common* reason that `username_claim` is not present in the token. Add a simple debugging hint here to make lives of hub admins easier.
for more information, see https://pre-commit.ci
minrk
approved these changes
Feb 9, 2024
| @@ -770,7 +770,9 @@ def user_info_to_username(self, user_info): | |||
| """ | |||
| username = user_info.get(self.username_claim, None) | |||
| if not username: | |||
| message = (f"No {self.username_claim} found in {user_info}",) | |||
| message = ( | |||
| f"No {self.username_claim} found in {user_info}. Maybe the hub needs to be configured to request more scopes?", | |||
There was a problem hiding this comment.
Do you want to even suggest the config name {self.__class__.__name__}.scopes?
|
I think it's ok to just mention the concept, rather than the specific config. |
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.
If the hub config doesn't contain appropriate scopes to request from the provider, the token we retrieve may not have the key we are using as
username_claim. This is the most common reason thatusername_claimis not present in the token. Add a simple debugging hint here to make lives of hub admins easier.