feat: add scope authorization check to hs doctor #1367
Merged
Conversation
This file contains hidden or 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
b-ash
requested review from
brandenrodgers,
camden11,
kemmerle and
joe-yeager
as code owners
kemmerle
reviewed
Feb 4, 2025
joe-yeager
reviewed
Feb 4, 2025
added 7 commits
February 5, 2025 12:13
b-ash
force-pushed
the
bash/add-scope-authorization-check-to-doctor
branch
from
025451c to
9cd5148
Compare
joe-yeager
previously approved these changes
Feb 5, 2025
lang/en.lyaml
Outdated
| incomplete: | ||
| one: "Personal access key is valid. {{ count }} scope available, but not included in your key." | ||
| other: "Personal access key is valid. {{ count }} scopes available, but not included in your key." | ||
| incompleteSecondary: "To add the available scopes, run {{ command}} and re-authenticate your account with a new key that has those scopes. Visit hubspot.com to view selected and available scopes for your personal access key. {{ link }}" |
There was a problem hiding this comment.
We refer to it as " visit HubSpot" instead of "visit hubspot.com" (small change but worth the consistency)
There was a problem hiding this comment.
Understood (I thought the hubspot.com was a little wacky too). The existing copy for when you need to paste in your key is "Open hubspot.com to copy your personal access key?" - should we change that also? My thinking is yes, and there are a few others as well. I followed convention with mine 🤷♂️
There was a problem hiding this comment.
Good call, I didn't realize we had those inconsistencies tbh. But yeah it would be great to update that too if you don't mind! (not a blocker though)
brandenrodgers
previously approved these changes
Feb 5, 2025
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 and Context
Adds scope authorization checking to
hs doctor. The goal is to alert the user if there are potential issues we detect with their local configuration. In this situation, we're highlighting when the personal access key being used for auth has fewer scopes than the current user has access to. If so, we'll detail that in the doctor response.I'll add some tests before merging but wanted to get some eyes on the shape of things ahead of that.
Depends on HubSpot/hubspot-local-dev-lib#232