Allow "0" to disable http_client_timeout

Author: jochenehret

alioss/README.md

@@ -20,6 +20,8 @@ The AliOSS client requires a JSON configuration file with the following structur
 }
 ```
 
+Set `http_request_timeout` to `"0"` to disable the HTTP client timeout explicitly.
+
 **Usage examples:**
 ``` bash
 # Upload a blob

alioss/config/config.go

@@ -46,6 +46,10 @@ func (c AliStorageConfig) HTTPRequestTimeoutSeconds() (int64, error) {
 		return defaultHTTPRequestTimeoutSeconds, nil
 	}
 
+	if c.HTTPRequestTimeout == "0" {
+		return 0, nil
+	}
+
 	httpRequestTimeout, err := time.ParseDuration(c.HTTPRequestTimeout)
 	if err != nil {
 		return 0, fmt.Errorf("invalid http_request_timeout: %w", err)

alioss/config/config_test.go

@@ -79,6 +79,21 @@ var _ = Describe("Config", func() {
 		Expect(err.Error()).To(ContainSubstring("invalid http_request_timeout"))
 	})
 
+	It("disables timeout when http_request_timeout is set to 0", func() {
+		configJson := []byte(`{"access_key_id": "foo_access_key_id",
+								"access_key_secret": "foo_access_key_secret",
+								"endpoint": "foo_endpoint",
+								"bucket_name": "foo_bucket_name",
+								"http_request_timeout": "0"}`)
+		configReader := bytes.NewReader(configJson)
+
+		cfg, err := config.NewFromReader(configReader)
+		Expect(err).ToNot(HaveOccurred())
+		timeoutSeconds, err := cfg.HTTPRequestTimeoutSeconds()
+		Expect(err).ToNot(HaveOccurred())
+		Expect(timeoutSeconds).To(BeZero())
+	})
+
 	It("returns an error when http_request_timeout is non-positive", func() {
 		configJson := []byte(`{"access_key_id": "foo_access_key_id",
 								"access_key_secret": "foo_access_key_secret",

gcs/README.md

@@ -23,6 +23,8 @@ The GCS client requires a JSON configuration file.
 }
 ```
 
+Set `http_request_timeout` to `"0"` to disable the HTTP client timeout explicitly.
+
 ### Credentials Source Types
 * **"":** specifies that credentials should be detected. Application Default Credentials will be used if avaliable. A read-only client will be used otherwise.
 * **"none":** specifies that credentials are explicitly empty and that the client should be restricted to a read-only scope.

gcs/config/config.go

@@ -134,6 +134,10 @@ func (c *GCSCli) HTTPRequestTimeoutValue() (time.Duration, error) {
 		return defaultHTTPRequestTimeout, nil
 	}
 
+	if c.HTTPRequestTimeout == "0" {
+		return 0, nil
+	}
+
 	requestTimeout, err := time.ParseDuration(c.HTTPRequestTimeout)
 	if err != nil {
 		return 0, fmt.Errorf("invalid http_request_timeout: %w", err)

gcs/config/config_test.go

@@ -208,6 +208,19 @@ var _ = Describe("BlobstoreClient configuration", func() {
 		})
 	})
 
+	Describe("when http_request_timeout is set to 0", func() {
+		dummyJSONBytes := []byte(`{"bucket_name": "some-bucket", "http_request_timeout":"0"}`)
+		dummyJSONReader := bytes.NewReader(dummyJSONBytes)
+
+		It("disables timeout", func() {
+			c, err := NewFromReader(dummyJSONReader)
+			Expect(err).To(BeNil())
+			requestTimeoutValue, err := c.HTTPRequestTimeoutValue()
+			Expect(err).To(BeNil())
+			Expect(requestTimeoutValue).To(BeZero())
+		})
+	})
+
 	Describe("when http_request_timeout is non-positive", func() {
 		dummyJSONBytes := []byte(`{"bucket_name": "some-bucket", "http_request_timeout":"0s"}`)
 		dummyJSONReader := bytes.NewReader(dummyJSONBytes)

s3/README.md

@@ -38,6 +38,8 @@ The S3 client requires a JSON configuration file with the following structure:
 }
 ```
 
+Set `http_request_timeout` to `"0"` to disable the HTTP client timeout explicitly.
+
 **Usage examples:**
 ```shell
 # Upload a file to S3

s3/config/config.go

@@ -269,6 +269,10 @@ func (c *S3Cli) HTTPRequestTimeoutValue() (time.Duration, error) {
 		return defaultHTTPRequestTimeout, nil
 	}
 
+	if c.HTTPRequestTimeout == "0" {
+		return 0, nil
+	}
+
 	httpRequestTimeout, err := time.ParseDuration(c.HTTPRequestTimeout)
 	if err != nil {
 		return 0, fmt.Errorf("invalid http_request_timeout: %w", err)

s3/config/config_test.go

@@ -421,6 +421,17 @@ var _ = Describe("BlobstoreClient configuration", func() {
 			Expect(timeout.Seconds()).To(Equal(45.0))
 		})
 
+		It("disables timeout when set to 0", func() {
+			dummyJSONBytes := []byte(`{"access_key_id":"id","secret_access_key":"key","bucket_name":"some-bucket","http_request_timeout":"0"}`)
+			dummyJSONReader := bytes.NewReader(dummyJSONBytes)
+
+			c, err := config.NewFromReader(dummyJSONReader)
+			Expect(err).ToNot(HaveOccurred())
+			timeout, err := c.HTTPRequestTimeoutValue()
+			Expect(err).ToNot(HaveOccurred())
+			Expect(timeout).To(BeZero())
+		})
+
 		It("rejects invalid duration formats", func() {
 			dummyJSONBytes := []byte(`{"access_key_id":"id","secret_access_key":"key","bucket_name":"some-bucket","http_request_timeout":"bananas"}`)
 			dummyJSONReader := bytes.NewReader(dummyJSONBytes)