-
Notifications
You must be signed in to change notification settings - Fork 487
/
api_collector.go
417 lines (391 loc) · 13.3 KB
/
api_collector.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
/*
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"
"encoding/json"
"fmt"
"github.com/apache/incubator-devlake/errors"
"io"
"net/http"
"net/url"
"text/template"
"github.com/apache/incubator-devlake/plugins/core"
"github.com/apache/incubator-devlake/plugins/core/dal"
"github.com/apache/incubator-devlake/plugins/helper/common"
)
// Pager contains pagination information for a api request
type Pager struct {
Page int
Skip int
Size int
}
// RequestData is the input of `UrlTemplate` `Query` and `Header`, so we can generate them dynamically
type RequestData struct {
Pager *Pager
Params interface{}
Input interface{}
InputJSON []byte
}
// AsyncResponseHandler FIXME ...
type AsyncResponseHandler func(res *http.Response) error
// ApiCollectorArgs FIXME ...
type ApiCollectorArgs struct {
RawDataSubTaskArgs
// UrlTemplate is used to generate the final URL for Api Collector to request
// i.e. `api/3/issue/{{ .Input.IssueId }}/changelog`
// For detail of what variables can be used, please check `RequestData`
UrlTemplate string `comment:"GoTemplate for API url"`
// Query would be sent out as part of the request URL
Query func(reqData *RequestData) (url.Values, errors.Error) ``
// Header would be sent out along with request
Header func(reqData *RequestData) (http.Header, errors.Error)
// PageSize tells ApiCollector the page size
PageSize int
// Incremental indicate if this is a incremental collection, the existing data won't get deleted if it was true
Incremental bool `comment:"indicate if this collection is incremental update"`
// ApiClient is a asynchronize api request client with qps
ApiClient RateLimitedApiClient
// Input helps us collect data based on previous collected data, like collecting changelogs based on jira
// issue ids
Input Iterator
// GetTotalPages is to tell `ApiCollector` total number of pages based on response of the first page.
// so `ApiCollector` could collect those pages in parallel for us
GetTotalPages func(res *http.Response, args *ApiCollectorArgs) (int, errors.Error)
// Concurrency specify qps for api that doesn't return total number of pages/records
// NORMALLY, DO NOT SPECIFY THIS PARAMETER, unless you know what it means
Concurrency int
ResponseParser func(res *http.Response) ([]json.RawMessage, errors.Error)
AfterResponse common.ApiClientAfterResponse
RequestBody func(reqData *RequestData) map[string]interface{}
Method string
}
// ApiCollector FIXME ...
type ApiCollector struct {
*RawDataSubTask
args *ApiCollectorArgs
urlTemplate *template.Template
}
// NewApiCollector allocates a new ApiCollector with the given args.
// ApiCollector can help us collecting data from api with ease, pass in a AsyncApiClient and tell it which part
// of response we want to save, ApiCollector will collect them from remote server and store them into database.
func NewApiCollector(args ApiCollectorArgs) (*ApiCollector, errors.Error) {
// process args
rawDataSubTask, err := NewRawDataSubTask(args.RawDataSubTaskArgs)
if err != nil {
return nil, errors.Default.Wrap(err, "Couldn't resolve raw subtask args")
}
// TODO: check if args.Table is valid when this is a http GET request
if args.UrlTemplate == "" && args.Method == "" {
return nil, errors.Default.New("UrlTemplate is required")
}
tpl, err := errors.Convert01(template.New(args.Table).Parse(args.UrlTemplate))
if err != nil {
return nil, errors.Default.Wrap(err, "Failed to compile UrlTemplate")
}
if args.ApiClient == nil {
return nil, errors.Default.New("ApiClient is required")
}
if args.ResponseParser == nil {
return nil, errors.Default.New("ResponseParser is required")
}
apiCollector := &ApiCollector{
RawDataSubTask: rawDataSubTask,
args: &args,
urlTemplate: tpl,
}
if args.AfterResponse != nil {
apiCollector.SetAfterResponse(args.AfterResponse)
} else {
apiCollector.SetAfterResponse(func(res *http.Response) errors.Error {
if res.StatusCode == http.StatusUnauthorized || res.StatusCode == http.StatusUnprocessableEntity {
return errors.Unauthorized.New("authentication failed, please check your AccessToken")
}
return nil
})
}
return apiCollector, nil
}
// Execute will start collection
func (collector *ApiCollector) Execute() errors.Error {
logger := collector.args.Ctx.GetLogger()
logger.Info("start api collection")
// make sure table is created
db := collector.args.Ctx.GetDal()
err := db.AutoMigrate(&RawData{}, dal.From(collector.table))
if err != nil {
return errors.Default.Wrap(err, "error auto-migrating collector")
}
// flush data if not incremental collection
if !collector.args.Incremental {
err = db.Delete(&RawData{}, dal.From(collector.table), dal.Where("params = ?", collector.params))
if err != nil {
return errors.Default.Wrap(err, "error deleting data from collector")
}
}
collector.args.Ctx.SetProgress(0, -1)
if collector.args.Input != nil {
iterator := collector.args.Input
defer iterator.Close()
apiClient := collector.args.ApiClient
if apiClient == nil {
return errors.Default.New("api_collector can not Execute with nil apiClient")
}
for {
if !iterator.HasNext() || apiClient.HasError() {
err = collector.args.ApiClient.WaitAsync()
if err != nil {
return err
}
if !iterator.HasNext() || apiClient.HasError() {
break
}
}
var input interface{}
input, err = iterator.Fetch()
if err != nil {
break
}
collector.exec(input)
}
} else {
// or we just did it once
collector.exec(nil)
}
if err != nil {
return errors.Default.Wrap(err, "error executing collector")
}
logger.Debug("wait for all async api to be finished")
err = collector.args.ApiClient.WaitAsync()
if err != nil {
logger.Error(err, "end api collection error")
err = errors.Default.Wrap(err, "Error waiting for async Collector execution")
} else {
logger.Info("end api collection without error")
}
return err
}
func (collector *ApiCollector) exec(input interface{}) {
inputJson, err := json.Marshal(input)
if err != nil {
panic(err)
}
reqData := new(RequestData)
reqData.Input = input
reqData.InputJSON = inputJson
reqData.Pager = &Pager{
Page: 1,
Size: collector.args.PageSize,
}
if collector.args.PageSize <= 0 {
collector.fetchAsync(reqData, nil)
} else if collector.args.GetTotalPages != nil {
collector.fetchPagesDetermined(reqData)
} else {
collector.fetchPagesUndetermined(reqData)
}
}
// fetchPagesDetermined fetches data of all pages for APIs that return paging information
func (collector *ApiCollector) fetchPagesDetermined(reqData *RequestData) {
// fetch first page
collector.fetchAsync(reqData, func(count int, body []byte, res *http.Response) errors.Error {
totalPages, err := collector.args.GetTotalPages(res, collector.args)
if err != nil {
return errors.Default.Wrap(err, "fetchPagesDetermined get totalPages failed")
}
// spawn a none blocking go routine to fetch other pages
collector.args.ApiClient.NextTick(func() errors.Error {
for page := 2; page <= totalPages; page++ {
reqDataTemp := &RequestData{
Pager: &Pager{
Page: page,
Skip: collector.args.PageSize * (page - 1),
Size: collector.args.PageSize,
},
Input: reqData.Input,
InputJSON: reqData.InputJSON,
}
collector.fetchAsync(reqDataTemp, nil)
}
return nil
})
return nil
})
}
// fetchPagesUndetermined fetches data of all pages for APIs that do NOT return paging information
func (collector *ApiCollector) fetchPagesUndetermined(reqData *RequestData) {
//logger := collector.args.Ctx.GetLogger()
//logger.Debug("fetch all pages in parallel with specified concurrency: %d", collector.args.Concurrency)
// if api doesn't return total number of pages, employ a step concurrent technique
// when `Concurrency` was set to 3:
// goroutine #1 fetches pages 1/4/7..
// goroutine #2 fetches pages 2/5/8...
// goroutine #3 fetches pages 3/6/9...
apiClient := collector.args.ApiClient
concurrency := collector.args.Concurrency
if concurrency == 0 {
// normally when a multi-pages api depends on a another resource, like jira changelogs depend on issue ids
// it tend to have less page, like 1 or 2 pages in total
if collector.args.Input != nil {
concurrency = 2
} else {
concurrency = apiClient.GetNumOfWorkers() / 10
if concurrency < 10 {
concurrency = 10
}
}
}
for i := 0; i < concurrency; i++ {
reqDataCopy := RequestData{
Pager: &Pager{
Page: i + 1,
Size: collector.args.PageSize,
Skip: collector.args.PageSize * (i),
},
Input: reqData.Input,
InputJSON: reqData.InputJSON,
}
var collect func() errors.Error
collect = func() errors.Error {
collector.fetchAsync(&reqDataCopy, func(count int, body []byte, res *http.Response) errors.Error {
if count < collector.args.PageSize {
return nil
}
apiClient.NextTick(func() errors.Error {
reqDataCopy.Pager.Skip += collector.args.PageSize * concurrency
reqDataCopy.Pager.Page += concurrency
return collect()
})
return nil
})
return nil
}
apiClient.NextTick(collect)
}
}
func (collector *ApiCollector) generateUrl(pager *Pager, input interface{}) (string, errors.Error) {
var buf bytes.Buffer
err := collector.urlTemplate.Execute(&buf, &RequestData{
Pager: pager,
Params: collector.args.Params,
Input: input,
})
if err != nil {
return "", errors.Convert(err)
}
return buf.String(), nil
}
// GetAfterResponse return apiClient's afterResponseFunction
func (collector *ApiCollector) GetAfterResponse() common.ApiClientAfterResponse {
return collector.args.ApiClient.GetAfterFunction()
}
// SetAfterResponse set apiClient's afterResponseFunction
func (collector *ApiCollector) SetAfterResponse(f common.ApiClientAfterResponse) {
collector.args.ApiClient.SetAfterFunction(f)
}
func (collector *ApiCollector) fetchAsync(reqData *RequestData, handler func(int, []byte, *http.Response) errors.Error) {
if reqData.Pager == nil {
reqData.Pager = &Pager{
Page: 1,
Size: 100,
Skip: 0,
}
}
apiUrl, err := collector.generateUrl(reqData.Pager, reqData.Input)
if err != nil {
panic(err)
}
var apiQuery url.Values
if collector.args.Query != nil {
apiQuery, err = collector.args.Query(reqData)
if err != nil {
panic(err)
}
}
var reqBody interface{}
if collector.args.RequestBody != nil {
reqBody = collector.args.RequestBody(reqData)
if err != nil {
panic(err)
}
}
apiHeader := (http.Header)(nil)
if collector.args.Header != nil {
apiHeader, err = collector.args.Header(reqData)
if err != nil {
panic(err)
}
}
logger := collector.args.Ctx.GetLogger()
logger.Debug("fetchAsync <<< enqueueing for %s %v", apiUrl, apiQuery)
responseHandler := func(res *http.Response) errors.Error {
defer logger.Debug("fetchAsync >>> done for %s %v %v", apiUrl, apiQuery, collector.args.RequestBody)
logger := collector.args.Ctx.GetLogger()
// read body to buffer
body, err := io.ReadAll(res.Body)
if err != nil {
return errors.Default.Wrap(err, fmt.Sprintf("error reading response from %s", apiUrl))
}
res.Body.Close()
res.Body = io.NopCloser(bytes.NewBuffer(body))
// convert body to array of RawJSON
items, err := collector.args.ResponseParser(res)
if err != nil {
if errors.Is(err, ErrFinishCollect) {
logger.Info("a fetch stop by parser, reqInput: #%d", reqData.Params)
handler = nil
} else {
return errors.Default.Wrap(err, fmt.Sprintf("error parsing response from %s", apiUrl))
}
}
// save to db
count := len(items)
if count == 0 {
collector.args.Ctx.IncProgress(1)
return nil
}
db := collector.args.Ctx.GetDal()
urlString := res.Request.URL.String()
rows := make([]*RawData, count)
for i, msg := range items {
rows[i] = &RawData{
Params: collector.params,
Data: msg,
Url: urlString,
Input: reqData.InputJSON,
}
}
err = db.Create(rows, dal.From(collector.table))
if err != nil {
return errors.Default.Wrap(err, fmt.Sprintf("error inserting raw rows into %s", collector.table))
}
logger.Debug("fetchAsync === total %d rows were saved into database", count)
// increase progress only when it was not nested
collector.args.Ctx.IncProgress(1)
if handler != nil {
// trigger next fetch, but return if ErrFinishCollect got from ResponseParser
res.Body = io.NopCloser(bytes.NewBuffer(body))
return handler(count, body, res)
}
return nil
}
if collector.args.Method == http.MethodPost {
collector.args.ApiClient.DoPostAsync(apiUrl, apiQuery, reqBody, apiHeader, responseHandler)
} else {
collector.args.ApiClient.DoGetAsync(apiUrl, apiQuery, apiHeader, responseHandler)
}
logger.Debug("fetchAsync === enqueued for %s %v", apiUrl, apiQuery)
}
var _ core.SubTask = (*ApiCollector)(nil)