Allow users to specify their own client implementation used by the library (#73)
* Allow users to specify their own client implementation used by the library * fix typos * add tests
This commit is contained in:
+48
-9
@@ -75,12 +75,20 @@ func sendRequest(c *http.Client, req *http.Request) (*http.Response, error) {
|
||||
}
|
||||
|
||||
type httpClientOption struct {
|
||||
logger *slog.Logger
|
||||
retryMax int
|
||||
retryWaitMax time.Duration
|
||||
logger *slog.Logger
|
||||
|
||||
// Options for built-in retryable HTTP client.
|
||||
// Ignored if a custom retryable HTTP client is provided via WithRetryableHTTPClint.
|
||||
retryMax int
|
||||
retryWaitMax time.Duration
|
||||
|
||||
// fields added to the transport if specified
|
||||
rootCAs *x509.CertPool
|
||||
tlsInsecureSkipVerify bool
|
||||
proxyFunc ProxyFunc
|
||||
timeout time.Duration
|
||||
|
||||
retryableHTTPClient *retryablehttp.Client
|
||||
}
|
||||
|
||||
func (o *httpClientOption) defaults() {
|
||||
@@ -93,14 +101,28 @@ func (o *httpClientOption) defaults() {
|
||||
if o.retryWaitMax == 0 {
|
||||
o.retryWaitMax = 30 * time.Second
|
||||
}
|
||||
if o.timeout == 0 {
|
||||
o.timeout = 5 * time.Minute
|
||||
}
|
||||
}
|
||||
|
||||
func (o *httpClientOption) newRetryableHTTPClient() (*retryablehttp.Client, error) {
|
||||
retryClient := retryablehttp.NewClient()
|
||||
retryClient.Logger = o.logger
|
||||
retryClient.RetryMax = o.retryMax
|
||||
retryClient.RetryWaitMax = o.retryWaitMax
|
||||
retryClient.HTTPClient.Timeout = 5 * time.Minute // timeout must be > 1m to accomodate long polling
|
||||
var retryClient *retryablehttp.Client
|
||||
if o.retryableHTTPClient != nil {
|
||||
retryClient = o.retryableHTTPClient
|
||||
} else {
|
||||
retryClient = retryablehttp.NewClient()
|
||||
retryClient.RetryMax = o.retryMax
|
||||
retryClient.RetryWaitMax = o.retryWaitMax
|
||||
}
|
||||
|
||||
if retryClient.HTTPClient.Timeout == 0 {
|
||||
retryClient.HTTPClient.Timeout = o.timeout
|
||||
}
|
||||
|
||||
if retryClient.Logger == nil {
|
||||
retryClient.Logger = o.logger
|
||||
}
|
||||
|
||||
transport, ok := retryClient.HTTPClient.Transport.(*http.Transport)
|
||||
if !ok {
|
||||
@@ -120,7 +142,9 @@ func (o *httpClientOption) newRetryableHTTPClient() (*retryablehttp.Client, erro
|
||||
transport.TLSClientConfig.InsecureSkipVerify = true
|
||||
}
|
||||
|
||||
transport.Proxy = o.proxyFunc
|
||||
if o.proxyFunc != nil {
|
||||
transport.Proxy = o.proxyFunc
|
||||
}
|
||||
|
||||
retryClient.HTTPClient.Transport = transport
|
||||
|
||||
@@ -145,6 +169,14 @@ func (c *commonClient) setUserAgent() {
|
||||
// HTTPOption defines a functional option for configuring the Client.
|
||||
type HTTPOption func(*httpClientOption)
|
||||
|
||||
// WithRetryableHTTPClint allows users to provide a custom retryable HTTP client.
|
||||
// If not set, a default client will be used with the specified retry and timeout settings.
|
||||
func WithRetryableHTTPClint(client *retryablehttp.Client) HTTPOption {
|
||||
return func(c *httpClientOption) {
|
||||
c.retryableHTTPClient = client
|
||||
}
|
||||
}
|
||||
|
||||
// WithLogger sets a custom logger for the Client.
|
||||
// If nil is passed, a discard logger will be used.
|
||||
func WithLogger(logger *slog.Logger) HTTPOption {
|
||||
@@ -190,3 +222,10 @@ func WithProxy(proxyFunc ProxyFunc) HTTPOption {
|
||||
c.proxyFunc = proxyFunc
|
||||
}
|
||||
}
|
||||
|
||||
// WithTimeout sets a timeout for the Client.
|
||||
func WithTimeout(duration time.Duration) HTTPOption {
|
||||
return func(c *httpClientOption) {
|
||||
c.timeout = duration
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user