Merge pull request #165 from jsternberg/set-http-client

feat: allow overriding the http.Client for the http service

CHANGELOG.md

@@ -1,4 +1,5 @@
 ## 1.5.0 [In progress]
+1. [#165](https://github.com/influxdata/influxdb-client-go/pull/165) Allow overriding the http.Client for the http service.
 
 ## 1.4.0 [2020-07-17]
 ### Breaking changes

api/http/options.go

@@ -7,16 +7,51 @@ package http
 
 import (
 	"crypto/tls"
+	"net"
+	"net/http"
+	"time"
 )
 
 // Options holds http configuration properties for communicating with InfluxDB server
 type Options struct {
+	// HTTP client. Default is http.DefaultClient.
+	httpClient *http.Client
 	// TLS configuration for secure connection. Default nil
 	tlsConfig *tls.Config
 	// HTTP request timeout in sec. Default 20
 	httpRequestTimeout uint
 }
 
+// HTTPClient returns the http.Client that is configured to be used
+// for HTTP requests. It will return the one that has been set using
+// SetHTTPClient or it will construct a default client using the
+// other configured options.
+func (o *Options) HTTPClient() *http.Client {
+	if o.httpClient == nil {
+		o.httpClient = &http.Client{
+			Timeout: time.Second * time.Duration(o.HTTPRequestTimeout()),
+			Transport: &http.Transport{
+				DialContext: (&net.Dialer{
+					Timeout: 5 * time.Second,
+				}).DialContext,
+				TLSHandshakeTimeout: 5 * time.Second,
+				TLSClientConfig:     o.TLSConfig(),
+			},
+		}
+	}
+	return o.httpClient
+}
+
+// SetHTTPClient will configure the http.Client that is used
+// for HTTP requests. If set to nil, an HTTPClient will be
+// generated.
+//
+// Setting the HTTPClient will cause the other HTTP options
+// to be ignored.
+func (o *Options) SetHTTPClient(c *http.Client) {
+	o.httpClient = c
+}
+
 // TLSConfig returns tls.Config
 func (o *Options) TLSConfig() *tls.Config {
 	return o.tlsConfig

api/http/options_test.go

@@ -6,9 +6,12 @@ package http_test
 
 import (
 	"crypto/tls"
+	nethttp "net/http"
+	"testing"
+	"time"
+
 	"github.com/influxdata/influxdb-client-go/api/http"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestDefaultOptions(t *testing.T) {
@@ -26,4 +29,15 @@ func TestOptionsSetting(t *testing.T) {
 		SetHTTPRequestTimeout(50)
 	assert.Equal(t, tlsConfig, opts.TLSConfig())
 	assert.Equal(t, uint(50), opts.HTTPRequestTimeout())
+	if client := opts.HTTPClient(); assert.NotNil(t, client) {
+		assert.Equal(t, 50*time.Second, client.Timeout)
+		assert.Equal(t, tlsConfig, client.Transport.(*nethttp.Transport).TLSClientConfig)
+	}
+
+	client := &nethttp.Client{
+		Transport: &nethttp.Transport{},
+	}
+	opts = http.DefaultOptions()
+	opts.SetHTTPClient(client)
+	assert.Equal(t, client, opts.HTTPClient())
 }

internal/http/service.go

@@ -11,11 +11,9 @@ import (
 	"io"
 	"io/ioutil"
 	"mime"
-	"net"
 	"net/http"
 	"net/url"
 	"strconv"
-	"time"
 
 	http2 "github.com/influxdata/influxdb-client-go/api/http"
 )
@@ -61,16 +59,7 @@ func NewService(serverURL, authorization string, httpOptions *http2.Options) Ser
 		serverAPIURL:  serverAPIURL,
 		serverURL:     serverURL,
 		authorization: authorization,
-		client: &http.Client{
-			Timeout: time.Second * time.Duration(httpOptions.HTTPRequestTimeout()),
-			Transport: &http.Transport{
-				DialContext: (&net.Dialer{
-					Timeout: 5 * time.Second,
-				}).DialContext,
-				TLSHandshakeTimeout: 5 * time.Second,
-				TLSClientConfig:     httpOptions.TLSConfig(),
-			},
-		},
+		client: httpOptions.HTTPClient(),
 	}
 }
 

options.go

@@ -6,9 +6,11 @@ package influxdb2
 
 import (
 	"crypto/tls"
+	nethttp "net/http"
+	"time"
+
 	"github.com/influxdata/influxdb-client-go/api/http"
 	"github.com/influxdata/influxdb-client-go/api/write"
-	"time"
 )
 
 // Options holds configuration properties for communicating with InfluxDB server
@@ -110,6 +112,24 @@ func (o *Options) SetUseGZip(useGZip bool) *Options {
 	return o
 }
 
+// HTTPClient returns the http.Client that is configured to be used
+// for HTTP requests. It will return the one that has been set using
+// SetHTTPClient or it will construct a default client using the
+// other configured options.
+func (o *Options) HTTPClient() *nethttp.Client {
+	return o.httpOptions.HTTPClient()
+}
+
+// SetHTTPClient will configure the http.Client that is used
+// for HTTP requests. If set to nil, an HTTPClient will be
+// generated.
+//
+// Setting the HTTPClient will cause the other HTTP options
+// to be ignored.
+func (o *Options) SetHTTPClient(c *nethttp.Client) {
+	o.httpOptions.SetHTTPClient(c)
+}
+
 // TLSConfig returns TLS config
 func (o *Options) TLSConfig() *tls.Config {
 	return o.HTTPOptions().TLSConfig()

options_test.go

@@ -3,14 +3,15 @@ package influxdb2_test
 import (
 	"context"
 	"crypto/tls"
-	influxdb2 "github.com/influxdata/influxdb-client-go"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 	"net/http"
 	"net/http/httptest"
 	"strings"
 	"testing"
 	"time"
+
+	influxdb2 "github.com/influxdata/influxdb-client-go"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestDefaultOptions(t *testing.T) {
@@ -52,8 +53,18 @@ func TestSettingsOptions(t *testing.T) {
 	assert.Equal(t, uint(7), opts.MaxRetries())
 	assert.Equal(t, tlsConfig, opts.TLSConfig())
 	assert.Equal(t, uint(50), opts.HTTPRequestTimeout())
+	if client := opts.HTTPClient(); assert.NotNil(t, client) {
+		assert.Equal(t, 50*time.Second, client.Timeout)
+		assert.Equal(t, tlsConfig, client.Transport.(*http.Transport).TLSClientConfig)
+	}
 	assert.Equal(t, uint(3), opts.LogLevel())
 	assert.Len(t, opts.WriteOptions().DefaultTags(), 1)
+
+	client := &http.Client{
+		Transport: &http.Transport{},
+	}
+	opts.SetHTTPClient(client)
+	assert.Equal(t, client, opts.HTTPClient())
 }
 
 func TestTimeout(t *testing.T) {