-
Notifications
You must be signed in to change notification settings - Fork 2
/
client.go
319 lines (273 loc) · 8.76 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
package ghttp
import (
"compress/gzip"
"crypto/tls"
"crypto/x509"
"io"
"io/ioutil"
"net/http"
"net/http/cookiejar"
neturl "net/url"
"strings"
"time"
"golang.org/x/net/publicsuffix"
"golang.org/x/time/rate"
)
var (
// DefaultClient is a global Client used by the global methods such as Get, Post, etc.
DefaultClient = New()
// ProxyFromEnvironment is an alias of http.ProxyFromEnvironment.
ProxyFromEnvironment = http.ProxyFromEnvironment
)
// HTTP verbs via the global Client.
var (
Get = DefaultClient.Get
Head = DefaultClient.Head
Post = DefaultClient.Post
Put = DefaultClient.Put
Patch = DefaultClient.Patch
Delete = DefaultClient.Delete
Options = DefaultClient.Options
Send = DefaultClient.Send
)
type (
// Client is a wrapper around an http.Client.
Client struct {
*http.Client
beforeRequestCallbacks []BeforeRequestCallback
afterResponseCallbacks []AfterResponseCallback
}
)
// New returns a new Client.
func New() *Client {
jar, _ := cookiejar.New(&cookiejar.Options{
PublicSuffixList: publicsuffix.List,
})
client := &http.Client{
Transport: DefaultTransport(),
Jar: jar,
}
return &Client{
Client: client,
}
}
// NoRedirect is a redirect policy that makes the Client not follow redirects.
func NoRedirect(*http.Request, []*http.Request) error {
return http.ErrUseLastResponse
}
// MaxRedirects returns a redirect policy for limiting maximum redirects followed up by n.
func MaxRedirects(n int) func(req *http.Request, via []*http.Request) error {
return func(req *http.Request, via []*http.Request) error {
if len(via) >= n {
return http.ErrUseLastResponse
}
return nil
}
}
// ProxyURL returns a proxy function (for use in an http.Transport) given a URL.
func ProxyURL(url string) func(*http.Request) (*neturl.URL, error) {
return func(*http.Request) (*neturl.URL, error) {
return neturl.Parse(url)
}
}
// SetProxy specifies a function to return a proxy for a given Request while nil indicates no proxy.
// By default is ProxyFromEnvironment.
func (c *Client) SetProxy(proxy func(*http.Request) (*neturl.URL, error)) {
c.Transport.(*http.Transport).Proxy = proxy
}
// SetTLSClientConfig specifies the TLS configuration to use with tls.Client.
func (c *Client) SetTLSClientConfig(config *tls.Config) {
c.Transport.(*http.Transport).TLSClientConfig = config
}
// AddClientCerts adds client certificates to c.
func (c *Client) AddClientCerts(certs ...tls.Certificate) {
t := c.Transport.(*http.Transport)
if t.TLSClientConfig == nil {
t.TLSClientConfig = &tls.Config{}
}
t.TLSClientConfig.Certificates = append(t.TLSClientConfig.Certificates, certs...)
}
// AddRootCerts attempts to add root certificates to c from a series of PEM encoded certificates
// and reports whether any certificates were successfully added.
func (c *Client) AddRootCerts(pemCerts []byte) bool {
t := c.Transport.(*http.Transport)
if t.TLSClientConfig == nil {
t.TLSClientConfig = &tls.Config{}
}
if t.TLSClientConfig.RootCAs == nil {
t.TLSClientConfig.RootCAs = x509.NewCertPool()
}
return t.TLSClientConfig.RootCAs.AppendCertsFromPEM(pemCerts)
}
// DisableTLSVerify makes c not verify the server's TLS certificate.
func (c *Client) DisableTLSVerify() {
t := c.Transport.(*http.Transport)
if t.TLSClientConfig == nil {
t.TLSClientConfig = &tls.Config{}
}
t.TLSClientConfig.InsecureSkipVerify = true
}
// AddCookies adds cookies to send in a request for the given URL to cookie jar.
func (c *Client) AddCookies(url string, cookies ...*http.Cookie) {
u, err := neturl.Parse(url)
if err == nil {
c.Jar.SetCookies(u, cookies)
}
}
// Cookies returns the cookies to send in a request for the given URL from cookie jar.
func (c *Client) Cookies(url string) (cookies []*http.Cookie) {
u, err := neturl.Parse(url)
if err == nil {
cookies = c.Jar.Cookies(u)
}
return
}
// Cookie returns the named cookie to send in a request for the given URL from cookie jar.
// If multiple cookies match the given name, only one cookie will be returned.
func (c *Client) Cookie(url string, name string) (*http.Cookie, error) {
return findCookie(name, c.Cookies(url))
}
// RegisterBeforeRequestCallbacks appends c's before request callbacks.
func (c *Client) RegisterBeforeRequestCallbacks(callbacks ...BeforeRequestCallback) {
c.beforeRequestCallbacks = append(c.beforeRequestCallbacks, callbacks...)
}
// RegisterAfterResponseCallbacks appends c's after response callbacks.
func (c *Client) RegisterAfterResponseCallbacks(callbacks ...AfterResponseCallback) {
c.afterResponseCallbacks = append(c.afterResponseCallbacks, callbacks...)
}
// EnableRateLimiting adds a callback to c for limiting outbound requests
// given a rate.Limiter (provided by golang.org/x/time/rate package).
func (c *Client) EnableRateLimiting(limiter *rate.Limiter) {
c.RegisterBeforeRequestCallbacks(&rateLimiter{base: limiter})
}
// SetMaxConcurrency adds a callback to c for limiting the concurrent outbound requests up by n.
func (c *Client) SetMaxConcurrency(n int) {
callback := &concurrency{ch: make(chan struct{}, n)}
c.RegisterBeforeRequestCallbacks(callback)
c.RegisterAfterResponseCallbacks(callback)
}
// EnableDebugging adds a callback to c for debugging.
// ghttp will dump the request and response details to w, like "curl -v".
func (c *Client) EnableDebugging(w io.Writer, body bool) {
callback := &debugger{out: w, body: body}
c.RegisterBeforeRequestCallbacks(callback)
c.RegisterAfterResponseCallbacks(callback)
}
// Get makes a GET HTTP request.
func (c *Client) Get(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodGet, url, hooks...)
}
// Head makes a HEAD HTTP request.
func (c *Client) Head(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodHead, url, hooks...)
}
// Post makes a POST HTTP request.
func (c *Client) Post(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodPost, url, hooks...)
}
// Put makes a PUT HTTP request.
func (c *Client) Put(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodPut, url, hooks...)
}
// Patch makes a PATCH HTTP request.
func (c *Client) Patch(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodPatch, url, hooks...)
}
// Delete makes a DELETE HTTP request.
func (c *Client) Delete(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodDelete, url, hooks...)
}
// Options makes a OPTIONS HTTP request.
func (c *Client) Options(url string, hooks ...RequestHook) (*Response, error) {
return c.Send(MethodOptions, url, hooks...)
}
// Send makes an HTTP request using a particular method.
func (c *Client) Send(method string, url string, hooks ...RequestHook) (*Response, error) {
req, err := NewRequest(method, url)
if err == nil {
for _, hook := range hooks {
if err = hook(req); err != nil {
break
}
}
}
if err != nil {
return nil, err
}
return c.Do(req)
}
// Do sends a request and returns its response.
func (c *Client) Do(req *Request) (resp *Response, err error) {
if err = c.onBeforeRequest(req); err != nil {
return
}
if req.retrier != nil {
if err = req.retrier.modifyRequest(req); err != nil {
return
}
}
resp, err = c.doWithRetry(req)
c.onAfterResponse(resp, err)
return
}
func (c *Client) onBeforeRequest(req *Request) (err error) {
for _, callback := range c.beforeRequestCallbacks {
if err = callback.Enter(req); err != nil {
break
}
}
return
}
func (c *Client) doWithRetry(req *Request) (*Response, error) {
var err error
var sleep time.Duration
resp := new(Response)
for attemptNum := 0; ; attemptNum++ {
if req.clientTrace {
ct := &clientTrace{start: time.Now()}
ct.modifyRequest(req)
resp.clientTrace = ct
}
resp.Response, err = c.do(req.Request)
if req.clientTrace {
resp.clientTrace.done()
}
if req.retrier == nil || !req.retrier.on(req.Context(), attemptNum, resp, err) {
return resp, err
}
sleep = req.retrier.backoff.Wait(attemptNum, resp, err)
// Drain Response.Body to enable TCP/TLS connection reuse
if err == nil && drainBody(resp.Body, ioutil.Discard) != http.ErrBodyReadAfterClose {
resp.Body.Close()
}
if req.GetBody != nil {
req.Body, _ = req.GetBody()
}
select {
case <-time.After(sleep):
case <-req.Context().Done():
return resp, req.Context().Err()
}
}
}
func (c *Client) do(req *http.Request) (*http.Response, error) {
resp, err := c.Client.Do(req)
if err != nil {
return resp, err
}
if strings.EqualFold(resp.Header.Get("Content-Encoding"), "gzip") &&
!bodyEmpty(resp.Body) {
if _, ok := resp.Body.(*gzip.Reader); !ok {
body, err := gzip.NewReader(resp.Body)
resp.Body.Close()
resp.Body = body
return resp, err
}
}
return resp, nil
}
func (c *Client) onAfterResponse(resp *Response, err error) {
for _, callback := range c.afterResponseCallbacks {
callback.Exit(resp, err)
}
}