Summary

Enhanced GraphQL error handling to provide more user-friendly and actionable messages when a token lacks the necessary permissions. Instead of a verbose technical trace, users now receive a concise list of missing scopes and a direct command to resolve the issue via gh auth refresh.

Changes

• Modified handleResponse to intercept GraphQL errors and check for INSUFFICIENT_SCOPES types.
• Implemented GenerateScopeErrorForGQL to extract specific required scopes from the API response message.
• Added requiredScopesFromServerMessage using regex to parse scope requirements (e.g., project, repo) from the server's text.

Note

I basically replicated the logic being used for queries (handleError found in pkg/cmd/project/shared/queries/queries.go)

Example

Before (Raw GraphQL Trace):

GraphQL: Your token has not been granted the required scopes to execute this query. The 'addProjectV2ItemById' field requires one of the following scopes: ['project'], but your token has only been granted the: ['gist', 'read:org', 'read:project', 'repo', 'workflow'] scopes. Please modify your token's scopes at: https://github.com/settings/tokens.

Now (Clean CLI Error):

error: your authentication token is missing required scopes [project]
To request it, run:  gh auth refresh -s project

Test plan

• Added test cases for newly-created functions
• All existing tests pass

Fixes #12585