-
Notifications
You must be signed in to change notification settings - Fork 514
/
api_client.go
371 lines (333 loc) · 10.4 KB
/
api_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
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
*/
package helper
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"fmt"
"github.com/apache/incubator-devlake/errors"
"io"
"net/http"
"net/url"
"regexp"
"strings"
"time"
"unicode/utf8"
"github.com/apache/incubator-devlake/plugins/core"
"github.com/apache/incubator-devlake/plugins/helper/common"
"github.com/apache/incubator-devlake/utils"
)
// ErrIgnoreAndContinue is a error which should be ignored
var ErrIgnoreAndContinue = errors.Default.New("ignore and continue")
// ApiClient is designed for simple api requests
type ApiClient struct {
client *http.Client
endpoint string
headers map[string]string
beforeRequest common.ApiClientBeforeRequest
afterResponse common.ApiClientAfterResponse
ctx context.Context
logger core.Logger
}
// NewApiClient FIXME ...
func NewApiClient(
ctx context.Context,
endpoint string,
headers map[string]string,
timeout time.Duration,
proxy string,
br core.BasicRes,
) (*ApiClient, errors.Error) {
apiClient := &ApiClient{}
apiClient.Setup(
endpoint,
headers,
timeout,
)
// create the Transport
apiClient.client.Transport = &http.Transport{}
// set insecureSkipVerify
insecureSkipVerify, err := utils.StrToBoolOr(br.GetConfig("IN_SECURE_SKIP_VERIFY"), false)
if err != nil {
return nil, errors.Default.Wrap(err, "failed to parse IN_SECURE_SKIP_VERIFY")
}
if insecureSkipVerify {
apiClient.client.Transport.(*http.Transport).TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
}
if proxy != "" {
err = apiClient.SetProxy(proxy)
if err != nil {
return nil, errors.Convert(err)
}
// check connectivity
res, err := apiClient.Get("/", nil, nil)
if err != nil {
return nil, err
}
if res.StatusCode == http.StatusBadGateway {
return nil, errors.BadInput.New(fmt.Sprintf("fail to connect to %v via %v", endpoint, proxy))
}
} else {
// check connectivity
parsedUrl, err := url.Parse(endpoint)
if err != nil {
return nil, errors.BadInput.Wrap(err, fmt.Sprintf("Invalid URL: %s", endpoint))
}
if parsedUrl.Scheme == "" {
return nil, errors.BadInput.New("Invalid URL scheme")
}
err = utils.CheckDNS(parsedUrl.Hostname())
if err != nil {
return nil, errors.Default.Wrap(err, "Failed to resolve DNS")
}
port, err := utils.ResolvePort(parsedUrl.Port(), parsedUrl.Scheme)
if err != nil {
return nil, errors.Default.New("Failed to resolve Port")
}
err = utils.CheckNetwork(parsedUrl.Hostname(), port, 10*time.Second)
if err != nil {
return nil, errors.Default.Wrap(err, "Failed to connect")
}
}
apiClient.SetContext(ctx)
return apiClient, nil
}
// Setup FIXME ...
func (apiClient *ApiClient) Setup(
endpoint string,
headers map[string]string,
timeout time.Duration,
) {
apiClient.client = &http.Client{Timeout: timeout}
apiClient.SetEndpoint(endpoint)
apiClient.SetHeaders(headers)
}
// SetEndpoint FIXME ...
func (apiClient *ApiClient) SetEndpoint(endpoint string) {
apiClient.endpoint = endpoint
}
// GetEndpoint FIXME ...
func (apiClient *ApiClient) GetEndpoint() string {
return apiClient.endpoint
}
// SetTimeout FIXME ...
func (apiClient *ApiClient) SetTimeout(timeout time.Duration) {
apiClient.client.Timeout = timeout
}
// GetTimeout FIXME ...
func (apiClient *ApiClient) GetTimeout() time.Duration {
return apiClient.client.Timeout
}
// SetHeaders FIXME ...
func (apiClient *ApiClient) SetHeaders(headers map[string]string) {
apiClient.headers = headers
}
// GetHeaders FIXME ...
func (apiClient *ApiClient) GetHeaders() map[string]string {
return apiClient.headers
}
// GetBeforeFunction return beforeResponseFunction
func (apiClient *ApiClient) GetBeforeFunction() common.ApiClientBeforeRequest {
return apiClient.beforeRequest
}
// SetBeforeFunction will set beforeResponseFunction
func (apiClient *ApiClient) SetBeforeFunction(callback common.ApiClientBeforeRequest) {
apiClient.beforeRequest = callback
}
// GetAfterFunction return afterResponseFunction
func (apiClient *ApiClient) GetAfterFunction() common.ApiClientAfterResponse {
return apiClient.afterResponse
}
// SetAfterFunction will set afterResponseFunction
func (apiClient *ApiClient) SetAfterFunction(callback common.ApiClientAfterResponse) {
apiClient.afterResponse = callback
}
// SetContext FIXME ...
func (apiClient *ApiClient) SetContext(ctx context.Context) {
apiClient.ctx = ctx
}
// SetProxy FIXME ...
func (apiClient *ApiClient) SetProxy(proxyUrl string) errors.Error {
pu, err := url.Parse(proxyUrl)
if err != nil {
return errors.Convert(err)
}
if pu.Scheme == "http" || pu.Scheme == "socks5" {
apiClient.client.Transport.(*http.Transport).Proxy = http.ProxyURL(pu)
}
return nil
}
// SetLogger FIXME ...
func (apiClient *ApiClient) SetLogger(logger core.Logger) {
apiClient.logger = logger
}
func (apiClient *ApiClient) logDebug(format string, a ...interface{}) {
if apiClient.logger != nil {
apiClient.logger.Debug(format, a...)
}
}
func (apiClient *ApiClient) logError(err error, format string, a ...interface{}) {
if apiClient.logger != nil {
apiClient.logger.Error(err, format, a...)
}
}
// Do FIXME ...
func (apiClient *ApiClient) Do(
method string,
path string,
query url.Values,
body interface{},
headers http.Header,
) (*http.Response, errors.Error) {
uri, err := GetURIStringPointer(apiClient.endpoint, path, query)
if err != nil {
return nil, errors.Default.Wrap(err, fmt.Sprintf("Unable to construct URI from %s, %s, %s", apiClient.endpoint, path, query))
}
// process body
var reqBody io.Reader
if body != nil {
reqJson, err := json.Marshal(body)
if err != nil {
return nil, errors.Default.Wrap(err, fmt.Sprintf("unable to serialize API request body for %s", *uri))
}
reqBody = bytes.NewBuffer(reqJson)
}
var req *http.Request
if apiClient.ctx != nil {
req, err = errors.Convert01(http.NewRequestWithContext(apiClient.ctx, method, *uri, reqBody))
} else {
req, err = errors.Convert01(http.NewRequest(method, *uri, reqBody))
}
if err != nil {
return nil, errors.Default.Wrap(err, fmt.Sprintf("unable to create API request for %s", *uri))
}
req.Header.Set("Content-Type", "application/json")
// populate headers
if apiClient.headers != nil {
for name, value := range apiClient.headers {
req.Header.Set(name, value)
}
}
for name, values := range headers {
for _, value := range values {
req.Header.Add(name, value)
}
}
var res *http.Response
// before send
if apiClient.beforeRequest != nil {
err = apiClient.beforeRequest(req)
if err != nil {
return nil, errors.Default.Wrap(err, fmt.Sprintf("error running beforeRequest for %s", req.URL.String()))
}
}
apiClient.logDebug("[api-client] %v %v", method, *uri)
res, err = errors.Convert01(apiClient.client.Do(req))
if err != nil {
apiClient.logError(err, "[api-client] failed to request %s with error", req.URL.String())
return nil, errors.Default.Wrap(err, fmt.Sprintf("error requesting %s", req.URL.String()))
}
// after receive
if apiClient.afterResponse != nil {
err = apiClient.afterResponse(res)
if err == ErrIgnoreAndContinue {
res.Body.Close()
return res, err
}
if err != nil {
res.Body.Close()
return nil, errors.Default.Wrap(err, fmt.Sprintf("error running afterRequest for %s", req.URL.String()))
}
}
return res, nil
}
// Get FIXME ...
func (apiClient *ApiClient) Get(
path string,
query url.Values,
headers http.Header,
) (*http.Response, errors.Error) {
return apiClient.Do(http.MethodGet, path, query, nil, headers)
}
// Post FIXME ...
func (apiClient *ApiClient) Post(
path string,
query url.Values,
body interface{},
headers http.Header,
) (*http.Response, errors.Error) {
return apiClient.Do(http.MethodPost, path, query, body, headers)
}
// UnmarshalResponse FIXME ...
func UnmarshalResponse(res *http.Response, v interface{}) errors.Error {
defer res.Body.Close()
resBody, err := io.ReadAll(res.Body)
if err != nil {
return errors.Default.Wrap(err, fmt.Sprintf("error reading response from %s", res.Request.URL.String()))
}
err = errors.Convert(json.Unmarshal(resBody, &v))
if err != nil {
return errors.Default.Wrap(err, fmt.Sprintf("error decoding response from %s: raw response: %s", res.Request.URL.String(), string(resBody)))
}
return nil
}
// GetURIStringPointer FIXME ...
func GetURIStringPointer(baseUrl string, relativePath string, query url.Values) (*string, errors.Error) {
// If the base URL doesn't end with a slash, and has a relative path attached
// the values will be removed by the Go package, therefore we need to add a missing slash.
AddMissingSlashToURL(&baseUrl)
base, err := url.Parse(baseUrl)
if err != nil {
return nil, errors.Convert(err)
}
// If the relative path starts with a '/', we need to remove it or the values will be removed by the Go package.
relativePath = RemoveStartingSlashFromPath(relativePath)
u, err := url.Parse(relativePath)
if err != nil {
return nil, errors.Convert(err)
}
if query != nil {
queryString := u.Query()
for key, value := range query {
queryString.Set(key, strings.Join(value, ""))
}
u.RawQuery = queryString.Encode()
}
uri := base.ResolveReference(u).String()
return &uri, nil
}
// AddMissingSlashToURL FIXME ...
func AddMissingSlashToURL(baseUrl *string) {
pattern := `\/$`
isMatch, _ := regexp.Match(pattern, []byte(*baseUrl))
if !isMatch {
*baseUrl += "/"
}
}
// RemoveStartingSlashFromPath FIXME ...
func RemoveStartingSlashFromPath(relativePath string) string {
pattern := `^\/`
byteArrayOfPath := []byte(relativePath)
isMatch, _ := regexp.Match(pattern, byteArrayOfPath)
if isMatch {
// Remove the slash.
// This is basically the trimFirstRune function found: https://stackoverflow.com/questions/48798588/how-do-you-remove-the-first-character-of-a-string/48798712
_, i := utf8.DecodeRuneInString(relativePath)
return relativePath[i:]
}
return relativePath
}