Merge pull request #1013 from or-shachar/f-1012

feat: default http client timeout override

api/header/global.go

@@ -1,5 +1,7 @@
 package header
 
+import "time"
+
 // When the CLI is initialized, we set this to a string of the current CLI subcommand
 // (e.g. `circleci orb list`) with no args or flags, so we include it as a header in API requests.
 var cliCommandStr string = ""
@@ -11,3 +13,9 @@ func SetCommandStr(commandStr string) {
 func GetCommandStr() string {
 	return cliCommandStr
 }
+
+const defaultTimeout = 60 * time.Second
+
+func GetDefaultTimeout() time.Duration {
+	return defaultTimeout
+}

api/rest/client.go

@@ -8,6 +8,7 @@ import (
 	"io"
 	"net/http"
 	"net/url"
+	"os"
 	"strings"
 	"time"
 
@@ -38,9 +39,17 @@ func NewFromConfig(host string, config *settings.Config) *Client {
 	}
 
 	baseURL, _ := url.Parse(host)
+	timeout := header.GetDefaultTimeout()
+	if timeoutEnv, ok := os.LookupEnv("CIRCLECI_CLI_TIMEOUT"); ok {
+		if parsedTimeout, err := time.ParseDuration(timeoutEnv); err == nil {
+			timeout = parsedTimeout
+		} else {
+			fmt.Printf("failed to parse CIRCLECI_CLI_TIMEOUT: %s\n", err.Error())
+		}
+	}
 
 	client := config.HTTPClient
-	client.Timeout = 10 * time.Second
+	client.Timeout = timeout
 
 	return New(
 		baseURL.ResolveReference(&url.URL{Path: endpoint}),

api/rest/client_test.go

@@ -6,15 +6,37 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"net/url"
+	"os"
 	"sync"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/CircleCI-Public/circleci-cli/api/header"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/version"
 )
 
+func TestNewFromConfigTimeout(t *testing.T) {
+	cfg := &settings.Config{
+		Debug:        false,
+		Token:        "fake-token",
+		RestEndpoint: "api/v2",
+		Endpoint:     "api/v2",
+		HTTPClient:   http.DefaultClient,
+	}
+	t.Run("create new client without custom timeout", func(t *testing.T) {
+		api := NewFromConfig("host", cfg)
+		assert.Equal(t, api.client.Timeout, header.GetDefaultTimeout())
+	})
+	t.Run("create new client with custom timeout", func(t *testing.T) {
+		customTimeout := 20 * time.Second
+		os.Setenv("CIRCLECI_CLI_TIMEOUT", customTimeout.String())
+		api := NewFromConfig("host", cfg)
+		assert.Equal(t, api.client.Timeout, customTimeout)
+	})
+}
 func TestClient_DoRequest(t *testing.T) {
 	t.Run("PUT with req and resp", func(t *testing.T) {
 		fix := &fixture{}

settings/settings.go

@@ -16,6 +16,7 @@ import (
 
 	yaml "gopkg.in/yaml.v3"
 
+	"github.com/CircleCI-Public/circleci-cli/api/header"
 	"github.com/CircleCI-Public/circleci-cli/data"
 	"github.com/spf13/afero"
 )
@@ -287,7 +288,7 @@ func (cfg *Config) WithHTTPClient() error {
 	customTransport.TLSClientConfig = tlsConfig
 
 	cfg.HTTPClient = &http.Client{
-		Timeout:   60 * time.Second,
+		Timeout:   header.GetDefaultTimeout(),
 		Transport: customTransport,
 	}