feat: add TCP and TLS timeouts to HTTP client settings

- Add `TCPTimeout` and `TLSHandshakeTimeout` options to `HTTPClientSettings` - Set default values for `TCPTimeout` and `TLSHandshakeTimeout` if not provided - Update `newCustomDialer` and `newCustomTransport` to use `TCPTimeout` and `TLSHandshakeTimeout` respectively Signed-off-by: Corentin Barreau <[email protected]>
CorentinB · Jun 16, 2023 · 9b88877 · 9b88877
1 parent 1196190
commit 9b88877
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/client.go b/client.go
@@ -4,6 +4,7 @@ import (
 	"net/http"
 	"os"
 	"sync"
+	"time"
 
 	"github.com/paulbellamy/ratecounter"
 )
@@ -24,6 +25,8 @@ type HTTPClientSettings struct {
 	FullOnDisk            bool
 	MaxReadBeforeTruncate int
 	FollowRedirects       bool
+	TCPTimeout            time.Duration
+	TLSHandshakeTimeout   time.Duration
 }
 
 type CustomHTTPClient struct {
@@ -123,13 +126,22 @@ func NewWARCWritingHTTPClient(HTTPClientSettings HTTPClientSettings) (httpClient
 		}
 	}
 
+	// Verify timeouts and set default values
+	if HTTPClientSettings.TCPTimeout == 0 {
+		HTTPClientSettings.TCPTimeout = 10 * time.Second
+	}
+
+	if HTTPClientSettings.TLSHandshakeTimeout == 0 {
+		HTTPClientSettings.TLSHandshakeTimeout = 10 * time.Second
+	}
+
 	// Configure custom dialer / transport
-	customDialer, err := newCustomDialer(httpClient, HTTPClientSettings.Proxy)
+	customDialer, err := newCustomDialer(httpClient, HTTPClientSettings.Proxy, HTTPClientSettings.TCPTimeout)
 	if err != nil {
 		return nil, err
 	}
 
-	customTransport, err := newCustomTransport(customDialer, HTTPClientSettings.DecompressBody)
+	customTransport, err := newCustomTransport(customDialer, HTTPClientSettings.DecompressBody, HTTPClientSettings.TLSHandshakeTimeout)
 	if err != nil {
 		return nil, err
 	}

diff --git a/dialer.go b/dialer.go
@@ -26,10 +26,10 @@ type customDialer struct {
 	client      *CustomHTTPClient
 }
 
-func newCustomDialer(httpClient *CustomHTTPClient, proxyURL string) (d *customDialer, err error) {
+func newCustomDialer(httpClient *CustomHTTPClient, proxyURL string, TCPTimeout time.Duration) (d *customDialer, err error) {
 	d = new(customDialer)
 
-	d.Timeout = 5 * time.Second
+	d.Timeout = TCPTimeout
 	d.client = httpClient
 
 	if proxyURL != "" {

diff --git a/transport.go b/transport.go
@@ -34,7 +34,7 @@ func (t *customTransport) RoundTrip(req *http.Request) (resp *http.Response, err
 	return
 }
 
-func newCustomTransport(dialer *customDialer, decompressBody bool) (t *customTransport, err error) {
+func newCustomTransport(dialer *customDialer, decompressBody bool, TLSHandshakeTimeout time.Duration) (t *customTransport, err error) {
 	t = new(customTransport)
 
 	t.t = http.Transport{
@@ -45,7 +45,7 @@ func newCustomTransport(dialer *customDialer, decompressBody bool) (t *customTra
 		// disable keep alive
 		MaxConnsPerHost:       0,
 		IdleConnTimeout:       -1,
-		TLSHandshakeTimeout:   15 * time.Second,
+		TLSHandshakeTimeout:   TLSHandshakeTimeout,
 		ExpectContinueTimeout: 1 * time.Second,
 		TLSNextProto:          make(map[string]func(authority string, c *tls.Conn) http.RoundTripper),
 		DisableCompression:    true,