-
Notifications
You must be signed in to change notification settings - Fork 0
/
base_client.go
465 lines (376 loc) · 13.4 KB
/
base_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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
// Referred https://github.com/manicminer/hamilton
// Apache License 2.0 https://github.com/manicminer/hamilton/blob/main/LICENSE
package jamf
import (
"bytes"
"context"
"fmt"
"io"
"net/http"
"net/url"
"github.com/hashicorp/go-retryablehttp"
"github.com/kenchan0130/go-jamf-pro/utils"
)
const (
DefaultRetryMax = 6
)
// ConsistencyFailureFunc is a function that determines whether an HTTP request has failed due to eventual consistency and should be retried.
type ConsistencyFailureFunc func(*http.Response) bool
// RequestMiddlewareFunc is a function that modifies an HTTP request before it is sent.
type RequestMiddlewareFunc func(r *http.Request)
// ValidStatusFunc is a function that tests whether an HTTP response is considered valid for the particular request.
type ValidStatusFunc func(*http.Response) bool
// HttpRequestInput is any type that can validate the response to an HTTP request.
type HttpRequestInput interface {
GetRequestMiddlewareFunc() RequestMiddlewareFunc
GetConsistencyFailureFunc() ConsistencyFailureFunc
GetContentType(defaultType string) string
GetValidStatusCodes() []int
GetValidStatusFunc() ValidStatusFunc
}
type Uri struct {
Entity string
Params url.Values
}
// RetryableErrorHandler ensures that the response is returned after exhausting retries for a request
func RetryableErrorHandler(resp *http.Response, err error, numTries int) (*http.Response, error) {
return resp, nil
}
type BaseClient struct {
// BaseURL is the base endpoint for Jamf Pro, e.g. https://yourdomain.jamfcloud.com
BaseURL *url.URL
AuthorizationToken *string
DisableRetries bool
DefaultContentType string
// HttpClient is the underlying http.Client, which by default uses a retryable client
HttpClient *http.Client
RetryableClient *retryablehttp.Client
}
type Response struct {
*http.Response
}
func NewBaseClient(baseURL *url.URL) *BaseClient {
r := retryablehttp.NewClient()
r.ErrorHandler = RetryableErrorHandler
r.RetryMax = DefaultRetryMax
c := &BaseClient{
BaseURL: baseURL,
HttpClient: r.StandardClient(),
RetryableClient: r,
DisableRetries: false,
}
return c
}
func (c *BaseClient) buildUri(uri Uri) string {
newUrl := c.BaseURL.JoinPath(uri.Entity)
if uri.Params != nil {
newUrl.RawQuery = uri.Params.Encode()
}
return newUrl.String()
}
func (c *BaseClient) performRequest(req *http.Request, input HttpRequestInput) (*http.Response, int, error) {
var status int
if contentType := input.GetContentType(c.DefaultContentType); contentType != "" {
req.Header.Add("Content-Type", input.GetContentType(c.DefaultContentType))
}
if c.AuthorizationToken != nil {
req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", *c.AuthorizationToken))
}
f := input.GetRequestMiddlewareFunc()
if f != nil {
f(req)
}
c.RetryableClient.CheckRetry = func(ctx context.Context, resp *http.Response, err error) (bool, error) {
if resp != nil && !c.DisableRetries {
if resp.StatusCode == http.StatusFailedDependency {
return true, nil
}
f := input.GetConsistencyFailureFunc()
if f != nil && f(resp) {
return true, nil
}
}
//nolint:golint,wrapcheck // retryablehttp.DefaultRetryPolicy returns a non-wrapped error
return retryablehttp.DefaultRetryPolicy(ctx, resp, err)
}
resp, err := c.HttpClient.Do(req)
if err != nil {
return nil, status, fmt.Errorf("http.Client#Do(): %v", err)
}
if resp == nil {
return resp, status, fmt.Errorf("nil response received")
}
status = resp.StatusCode
if !containsStatusCode(input.GetValidStatusCodes(), status) {
f := input.GetValidStatusFunc()
if f != nil && f(resp) {
return resp, status, nil
}
defer utils.HandleCloseFunc(resp.Body, c.RetryableClient.Logger)
respBody, err := io.ReadAll(resp.Body)
if err != nil {
return nil, status, fmt.Errorf("unexpected status %d, could not read response body", status)
}
if len(respBody) == 0 {
return nil, status, fmt.Errorf("unexpected status %d received with no body", status)
}
errText := fmt.Sprintf("response: %s", respBody)
return nil, status, fmt.Errorf("unexpected status %d with %s", status, errText)
}
return resp, status, nil
}
func containsStatusCode(expected []int, actual int) bool {
for _, v := range expected {
if actual == v {
return true
}
}
return false
}
type DeleteHttpRequestInput struct {
ConsistencyFailureFunc ConsistencyFailureFunc
RequestMiddlewareFunc RequestMiddlewareFunc
ContentType string
Uri Uri
ValidStatusCodes []int
ValidStatusFunc ValidStatusFunc
}
// GetConsistencyFailureFunc returns a function used to evaluate whether a failed request is due to eventual consistency and should be retried.
func (i DeleteHttpRequestInput) GetConsistencyFailureFunc() ConsistencyFailureFunc {
return i.ConsistencyFailureFunc
}
// GetContentType returns the content type for the request.
func (i DeleteHttpRequestInput) GetContentType(defaultType string) string {
if i.ContentType != "" {
return i.ContentType
}
return defaultType
}
func (i DeleteHttpRequestInput) GetRequestMiddlewareFunc() RequestMiddlewareFunc {
return i.RequestMiddlewareFunc
}
// GetValidStatusCodes returns a []int of status codes considered valid for a DELETE request.
func (i DeleteHttpRequestInput) GetValidStatusCodes() []int {
return i.ValidStatusCodes
}
// GetValidStatusFunc returns a function used to evaluate whether the response to a DELETE request is considered valid.
func (i DeleteHttpRequestInput) GetValidStatusFunc() ValidStatusFunc {
return i.ValidStatusFunc
}
// Delete performs a DELETE request.
func (c *BaseClient) Delete(ctx context.Context, input DeleteHttpRequestInput) (*Response, int, error) {
var status int
u := c.buildUri(input.Uri)
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, u, http.NoBody)
if err != nil {
return nil, status, fmt.Errorf("http.NewRequestWithContext(): %v", err)
}
resp, status, err := c.performRequest(req, input)
if err != nil {
return nil, status, err
}
return &Response{resp}, status, nil
}
// GetHttpRequestInput configures a GET request.
type GetHttpRequestInput struct {
ConsistencyFailureFunc ConsistencyFailureFunc
ContentType string
RequestMiddlewareFunc RequestMiddlewareFunc
Uri Uri
ValidStatusCodes []int
ValidStatusFunc ValidStatusFunc
}
// GetConsistencyFailureFunc returns a function used to evaluate whether a failed request is due to eventual consistency and should be retried.
func (i GetHttpRequestInput) GetConsistencyFailureFunc() ConsistencyFailureFunc {
return i.ConsistencyFailureFunc
}
// GetContentType returns the content type for the request.
func (i GetHttpRequestInput) GetContentType(defaultType string) string {
if i.ContentType != "" {
return i.ContentType
}
return defaultType
}
func (i GetHttpRequestInput) GetRequestMiddlewareFunc() RequestMiddlewareFunc {
return i.RequestMiddlewareFunc
}
// GetValidStatusCodes returns a []int of status codes considered valid for a GET request.
func (i GetHttpRequestInput) GetValidStatusCodes() []int {
return i.ValidStatusCodes
}
// GetValidStatusFunc returns a function used to evaluate whether the response to a GET request is considered valid.
func (i GetHttpRequestInput) GetValidStatusFunc() ValidStatusFunc {
return i.ValidStatusFunc
}
// Get performs a GET request.
func (c *BaseClient) Get(ctx context.Context, input GetHttpRequestInput) (*Response, int, error) {
var status int
u := c.buildUri(input.Uri)
// Build a new request
req, err := http.NewRequestWithContext(ctx, http.MethodGet, u, http.NoBody)
if err != nil {
return nil, status, fmt.Errorf("http.NewRequestWithContext(): %v", err)
}
// Perform the request
resp, status, err := c.performRequest(req, input)
if err != nil {
return nil, status, err
}
return &Response{resp}, status, nil
}
// PatchHttpRequestInput configures a PATCH request.
type PatchHttpRequestInput struct {
Body *bytes.Buffer
ConsistencyFailureFunc ConsistencyFailureFunc
ContentType string
RequestMiddlewareFunc RequestMiddlewareFunc
Uri Uri
ValidStatusCodes []int
ValidStatusFunc ValidStatusFunc
}
// GetConsistencyFailureFunc returns a function used to evaluate whether a failed request is due to eventual consistency and should be retried.
func (i PatchHttpRequestInput) GetConsistencyFailureFunc() ConsistencyFailureFunc {
return i.ConsistencyFailureFunc
}
// GetContentType returns the content type for the request.
func (i PatchHttpRequestInput) GetContentType(defaultType string) string {
if i.ContentType != "" {
return i.ContentType
}
return defaultType
}
func (i PatchHttpRequestInput) GetRequestMiddlewareFunc() RequestMiddlewareFunc {
return i.RequestMiddlewareFunc
}
// GetValidStatusCodes returns a []int of status codes considered valid for a PATCH request.
func (i PatchHttpRequestInput) GetValidStatusCodes() []int {
return i.ValidStatusCodes
}
// GetValidStatusFunc returns a function used to evaluate whether the response to a PATCH request is considered valid.
func (i PatchHttpRequestInput) GetValidStatusFunc() ValidStatusFunc {
return i.ValidStatusFunc
}
// Patch performs a PATCH request.
func (c *BaseClient) Patch(ctx context.Context, input PatchHttpRequestInput) (*Response, int, error) {
var status int
u := c.buildUri(input.Uri)
var inputBody io.Reader
if input.Body == nil {
inputBody = http.NoBody
} else {
inputBody = input.Body
}
req, err := http.NewRequestWithContext(ctx, http.MethodPatch, u, inputBody)
if err != nil {
return nil, status, fmt.Errorf("http.NewRequestWithContext(): %v", err)
}
resp, status, err := c.performRequest(req, input)
if err != nil {
return nil, status, err
}
return &Response{resp}, status, nil
}
// PostHttpRequestInput configures a POST request.
type PostHttpRequestInput struct {
Body *bytes.Buffer
ContentType string
ConsistencyFailureFunc ConsistencyFailureFunc
RequestMiddlewareFunc RequestMiddlewareFunc
Uri Uri
ValidStatusCodes []int
ValidStatusFunc ValidStatusFunc
}
// GetConsistencyFailureFunc returns a function used to evaluate whether a failed request is due to eventual consistency and should be retried.
func (i PostHttpRequestInput) GetConsistencyFailureFunc() ConsistencyFailureFunc {
return i.ConsistencyFailureFunc
}
// GetContentType returns the content type for the request.
func (i PostHttpRequestInput) GetContentType(defaultType string) string {
if i.ContentType != "" {
return i.ContentType
}
return defaultType
}
func (i PostHttpRequestInput) GetRequestMiddlewareFunc() RequestMiddlewareFunc {
return i.RequestMiddlewareFunc
}
// GetValidStatusCodes returns a []int of status codes considered valid for a POST request.
func (i PostHttpRequestInput) GetValidStatusCodes() []int {
return i.ValidStatusCodes
}
// GetValidStatusFunc returns a function used to evaluate whether the response to a POST request is considered valid.
func (i PostHttpRequestInput) GetValidStatusFunc() ValidStatusFunc {
return i.ValidStatusFunc
}
// Post performs a POST request.
func (c *BaseClient) Post(ctx context.Context, input PostHttpRequestInput) (*Response, int, error) {
var status int
u := c.buildUri(input.Uri)
var inputBody io.Reader
if input.Body == nil {
inputBody = http.NoBody
} else {
inputBody = input.Body
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, u, inputBody)
if err != nil {
return nil, status, fmt.Errorf("http.NewRequestWithContext(): %v", err)
}
resp, status, err := c.performRequest(req, input)
if err != nil {
return nil, status, err
}
return &Response{resp}, status, nil
}
// PutHttpRequestInput configures a PUT request.
type PutHttpRequestInput struct {
Body *bytes.Buffer
ConsistencyFailureFunc ConsistencyFailureFunc
ContentType string
RequestMiddlewareFunc RequestMiddlewareFunc
Uri Uri
ValidStatusCodes []int
ValidStatusFunc ValidStatusFunc
}
// GetConsistencyFailureFunc returns a function used to evaluate whether a failed request is due to eventual consistency and should be retried.
func (i PutHttpRequestInput) GetConsistencyFailureFunc() ConsistencyFailureFunc {
return i.ConsistencyFailureFunc
}
// GetContentType returns the content type for the request.
func (i PutHttpRequestInput) GetContentType(defaultType string) string {
if i.ContentType != "" {
return i.ContentType
}
return defaultType
}
func (i PutHttpRequestInput) GetRequestMiddlewareFunc() RequestMiddlewareFunc {
return i.RequestMiddlewareFunc
}
// GetValidStatusCodes returns a []int of status codes considered valid for a PUT request.
func (i PutHttpRequestInput) GetValidStatusCodes() []int {
return i.ValidStatusCodes
}
// GetValidStatusFunc returns a function used to evaluate whether the response to a PUT request is considered valid.
func (i PutHttpRequestInput) GetValidStatusFunc() ValidStatusFunc {
return i.ValidStatusFunc
}
// Put performs a PUT request.
func (c *BaseClient) Put(ctx context.Context, input PutHttpRequestInput) (*Response, int, error) {
var status int
u := c.buildUri(input.Uri)
var inputBody io.Reader
if input.Body == nil {
inputBody = http.NoBody
} else {
inputBody = input.Body
}
req, err := http.NewRequestWithContext(ctx, http.MethodPut, u, inputBody)
if err != nil {
return nil, status, fmt.Errorf("http.NewRequestWithContext(): %v", err)
}
resp, status, err := c.performRequest(req, input)
if err != nil {
return nil, status, err
}
return &Response{resp}, status, nil
}