review feedback

- rename `RequireAccessToken` to `checkIfCIAccessTokenRequired`
- provide more context in error on why it happened

Author: burmudar

cmd/src/main.go

@@ -178,14 +178,14 @@ func (c *config) requireCIAccessToken() error {
 // apiClient returns an api.Client built from the configuration.
 func (c *config) apiClient(flags *api.Flags, out io.Writer) api.Client {
 	opts := api.ClientOpts{
-		EndpointURL:        c.endpointURL,
-		AccessToken:        c.accessToken,
-		AdditionalHeaders:  c.additionalHeaders,
-		Flags:              flags,
-		Out:                out,
-		ProxyURL:           c.proxyURL,
-		ProxyPath:          c.proxyPath,
-		RequireAccessToken: c.InCI(),
+		EndpointURL:            c.endpointURL,
+		AccessToken:            c.accessToken,
+		AdditionalHeaders:      c.additionalHeaders,
+		Flags:                  flags,
+		Out:                    out,
+		ProxyURL:               c.proxyURL,
+		ProxyPath:              c.proxyPath,
+		RequireAccessTokenInCI: c.InCI(),
 	}
 
 	// Only use OAuth if we do not have SRC_ACCESS_TOKEN set

internal/api/api.go

@@ -71,10 +71,10 @@ type request struct {
 
 // ClientOpts encapsulates the options given to NewClient.
 type ClientOpts struct {
-	EndpointURL        *url.URL
-	AccessToken        string
-	AdditionalHeaders  map[string]string
-	RequireAccessToken bool
+	EndpointURL            *url.URL
+	AccessToken            string
+	AdditionalHeaders      map[string]string
+	RequireAccessTokenInCI bool
 
 	// Flags are the standard API client flags provided by NewFlags. If nil,
 	// default values will be used.
@@ -139,20 +139,20 @@ func NewClient(opts ClientOpts) Client {
 
 	return &client{
 		opts: ClientOpts{
-			EndpointURL:        opts.EndpointURL,
-			AccessToken:        opts.AccessToken,
-			AdditionalHeaders:  opts.AdditionalHeaders,
-			RequireAccessToken: opts.RequireAccessToken,
-			Flags:              flags,
-			Out:                opts.Out,
+			EndpointURL:            opts.EndpointURL,
+			AccessToken:            opts.AccessToken,
+			AdditionalHeaders:      opts.AdditionalHeaders,
+			RequireAccessTokenInCI: opts.RequireAccessTokenInCI,
+			Flags:                  flags,
+			Out:                    opts.Out,
 		},
 		httpClient: httpClient,
 	}
 }
 
-func (c *client) requireAccessToken() error {
-	if c.opts.RequireAccessToken && c.opts.AccessToken == "" {
-		return fmt.Errorf("SRC_ACCESS_TOKEN must be set in CI")
+func (c *client) checkIfCIAccessTokenRequired() error {
+	if c.opts.RequireAccessTokenInCI && c.opts.AccessToken == "" {
+		return fmt.Errorf("CI is true and no SRC_ACCESS_TOKEN is set. When running in CI OAuth tokens cannot be used, only SRC_ACCESS_TOKEN. Either set CI=false or define a SRC_ACCESS_TOKEN")
 	}
 
 	return nil
@@ -183,7 +183,7 @@ func (c *client) NewHTTPRequest(ctx context.Context, method, p string, body io.R
 }
 
 func (c *client) createHTTPRequest(ctx context.Context, method, p string, body io.Reader) (*http.Request, error) {
-	if err := c.requireAccessToken(); err != nil {
+	if err := c.checkIfCIAccessTokenRequired(); err != nil {
 		return nil, err
 	}
 
@@ -216,7 +216,7 @@ func (c *client) createHTTPRequest(ctx context.Context, method, p string, body i
 }
 
 func (r *request) do(ctx context.Context, result any) (bool, error) {
-	if err := r.client.requireAccessToken(); err != nil {
+	if err := r.client.checkIfCIAccessTokenRequired(); err != nil {
 		return false, err
 	}