2021-02-17 11:47:24 +08:00
|
|
|
//
|
|
|
|
// Copyright 2021, Sander van Harmelen
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
//
|
|
|
|
|
2020-04-20 04:23:05 +08:00
|
|
|
package gitlab
|
|
|
|
|
|
|
|
import (
|
|
|
|
"net/http"
|
|
|
|
|
|
|
|
retryablehttp "github.com/hashicorp/go-retryablehttp"
|
|
|
|
)
|
|
|
|
|
2021-04-23 08:08:53 +08:00
|
|
|
// ClientOptionFunc can be used to customize a new GitLab API client.
|
2020-04-20 04:23:05 +08:00
|
|
|
type ClientOptionFunc func(*Client) error
|
|
|
|
|
|
|
|
// WithBaseURL sets the base URL for API requests to a custom endpoint.
|
|
|
|
func WithBaseURL(urlStr string) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
return c.setBaseURL(urlStr)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithCustomBackoff can be used to configure a custom backoff policy.
|
|
|
|
func WithCustomBackoff(backoff retryablehttp.Backoff) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.client.Backoff = backoff
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-07-04 10:06:10 +08:00
|
|
|
// WithCustomLeveledLogger can be used to configure a custom retryablehttp
|
|
|
|
// leveled logger.
|
2021-06-10 22:44:25 +08:00
|
|
|
func WithCustomLeveledLogger(leveledLogger retryablehttp.LeveledLogger) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.client.Logger = leveledLogger
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-06 23:37:53 +08:00
|
|
|
// WithCustomLimiter injects a custom rate limiter to the client.
|
|
|
|
func WithCustomLimiter(limiter RateLimiter) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.configureLimiterOnce.Do(func() {
|
|
|
|
c.limiter = limiter
|
|
|
|
})
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-07-04 10:06:10 +08:00
|
|
|
// WithCustomLogger can be used to configure a custom retryablehttp logger.
|
2021-06-10 22:44:25 +08:00
|
|
|
func WithCustomLogger(logger retryablehttp.Logger) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.client.Logger = logger
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-20 04:23:05 +08:00
|
|
|
// WithCustomRetry can be used to configure a custom retry policy.
|
|
|
|
func WithCustomRetry(checkRetry retryablehttp.CheckRetry) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.client.CheckRetry = checkRetry
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithHTTPClient can be used to configure a custom HTTP client.
|
|
|
|
func WithHTTPClient(httpClient *http.Client) ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.client.HTTPClient = httpClient
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithoutRetries disables the default retry logic.
|
|
|
|
func WithoutRetries() ClientOptionFunc {
|
|
|
|
return func(c *Client) error {
|
|
|
|
c.disableRetries = true
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|