Function GetScopes

pkg/cmd/auth/shared/oauth_scopes.go:35–57

GetScopes performs a GitHub API request and returns the value of the X-Oauth-Scopes header. The token is passed explicitly because this runs before the token is stored in config, so the transport has nothing to attach. The transport only sets Authorization when it is absent, so the header set here

(httpClient *http.Client, hostname, authToken string)

// the transport has nothing to attach. The transport only sets Authorization when it is
// absent, so the header set here wins.
func GetScopes(httpClient *http.Client, hostname, authToken string) (string, error) {
	// TODO(api-client-rollout)
	// This line of code is part of a mechanical roll out of the api client.
	// As a follow up, consider whether the api client can be injected to this call site, rather than constructed
	res, err := api.NewClientFromHTTP(httpClient).Request(hostname, http.MethodGet, safeurl.NewImmutableSafeURL("").String(), nil,
		api.WithHeader("Authorization", "token "+authToken))
	if err != nil {
		return "", err
	}

	defer func() {
		// Ensure the response body is fully read and closed
		// before we reconnect, so that we reuse the same TCPconnection.
		_, _ = io.Copy(io.Discard, res.Body)
		res.Body.Close()
	}()

	if res.StatusCode != 200 {
		return "", api.UnexpectedStatusError(res)
	}

	return res.Header.Get("X-Oauth-Scopes"), nil
}

// HasMinimumScopes performs a GitHub API request and returns an error if the token used in the request
// lacks the minimum required scopes for performing API operations with gh.