-
Notifications
You must be signed in to change notification settings - Fork 487
/
graphql_collector.go
370 lines (341 loc) · 12 KB
/
graphql_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
/*
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 (
"context"
"encoding/json"
"github.com/apache/incubator-devlake/errors"
"github.com/apache/incubator-devlake/models/common"
"github.com/apache/incubator-devlake/plugins/core"
"github.com/apache/incubator-devlake/plugins/core/dal"
"github.com/merico-dev/graphql"
"net/http"
"reflect"
)
// CursorPager contains pagination information for a graphql request
type CursorPager struct {
SkipCursor *string
Size int
}
// GraphqlRequestData is the input of `UrlTemplate` `BuildQuery` and `Header`, so we can generate them dynamically
type GraphqlRequestData struct {
Pager *CursorPager
Params interface{}
Input interface{}
InputJSON []byte
}
// GraphqlQueryPageInfo contains the pagination data
type GraphqlQueryPageInfo struct {
EndCursor string `json:"endCursor"`
HasNextPage bool `json:"hasNextPage"`
}
// GraphqlAsyncResponseHandler callback function to handle the Response asynchronously
type GraphqlAsyncResponseHandler func(res *http.Response) error
// GraphqlCollectorArgs arguments needed by GraphqlCollector
type GraphqlCollectorArgs struct {
RawDataSubTaskArgs
// BuildQuery would be sent out as part of the request URL
BuildQuery func(reqData *GraphqlRequestData) (query interface{}, variables map[string]interface{}, err error)
// PageSize tells ApiCollector the page size
PageSize int
// GraphqlClient is a asynchronize api request client with qps
GraphqlClient *GraphqlAsyncClient
// Input helps us collect data based on previous collected data, like collecting changelogs based on jira
// issue ids
Input Iterator
// how many times fetched from input, default 1 means only fetch once
// NOTICE: InputStep=1 will fill value as item and InputStep>1 will fill value as []item
InputStep 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"`
// GetPageInfo is to tell `GraphqlCollector` is page information
GetPageInfo func(query interface{}, args *GraphqlCollectorArgs) (*GraphqlQueryPageInfo, error)
BatchSize int
// one of ResponseParser and ResponseParserEvenWhenDataErrors is required to parse response
ResponseParser func(query interface{}, variables map[string]interface{}) ([]interface{}, error)
ResponseParserWithDataErrors func(query interface{}, variables map[string]interface{}, dataErrors []graphql.DataError) ([]interface{}, error)
}
// GraphqlCollector help you collect data from Graphql services
type GraphqlCollector struct {
*RawDataSubTask
args *GraphqlCollectorArgs
workerErrors []error
}
// ErrFinishCollect is a error which will finish this collector
var ErrFinishCollect = errors.Default.New("finish collect")
// NewGraphqlCollector allocates a new GraphqlCollector with the given args.
// GraphqlCollector can help us collect data from api with ease, pass in a AsyncGraphqlClient and tell it which part
// of response we want to save, GraphqlCollector will collect them from remote server and store them into database.
func NewGraphqlCollector(args GraphqlCollectorArgs) (*GraphqlCollector, errors.Error) {
// process args
rawDataSubTask, err := NewRawDataSubTask(args.RawDataSubTaskArgs)
if err != nil {
return nil, errors.Default.Wrap(err, "error processing raw subtask args")
}
if err != nil {
return nil, errors.Default.Wrap(err, "Failed to compile UrlTemplate")
}
if args.GraphqlClient == nil {
return nil, errors.Default.New("ApiClient is required")
}
if args.ResponseParser == nil && args.ResponseParserWithDataErrors == nil {
return nil, errors.Default.New("one of ResponseParser and ResponseParserWithDataErrors is required")
}
apiCollector := &GraphqlCollector{
RawDataSubTask: rawDataSubTask,
args: &args,
}
if args.BatchSize == 0 {
args.BatchSize = 500
}
if args.InputStep == 0 {
args.InputStep = 1
}
return apiCollector, nil
}
// Execute api collection
func (collector *GraphqlCollector) Execute() errors.Error {
logger := collector.args.Ctx.GetLogger()
logger.Info("start graphql 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 running auto-migrate")
}
// 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")
}
}
divider := NewBatchSaveDivider(collector.args.Ctx, collector.args.BatchSize, collector.table, collector.params)
collector.args.Ctx.SetProgress(0, -1)
if collector.args.Input != nil {
iterator := collector.args.Input
defer iterator.Close()
// the comment about difference is written at GraphqlCollectorArgs.InputStep
if collector.args.InputStep == 1 {
for iterator.HasNext() && !collector.HasError() {
input, err := iterator.Fetch()
if err != nil {
collector.checkError(err)
break
}
collector.exec(divider, input)
}
} else {
for !collector.HasError() {
var inputs []interface{}
for i := 0; i < collector.args.InputStep && iterator.HasNext(); i++ {
input, err := iterator.Fetch()
if err != nil {
collector.checkError(err)
break
}
inputs = append(inputs, input)
}
if inputs == nil {
break
}
collector.exec(divider, inputs)
}
}
} else {
// or we just did it once
collector.exec(divider, nil)
}
logger.Debug("wait for all async api to finished")
collector.args.GraphqlClient.Wait()
if collector.HasError() {
err = errors.Default.Combine(collector.workerErrors)
logger.Error(err, "ended Graphql collector execution with error")
logger.Error(collector.workerErrors[0], "the first error of them")
return err
} else {
logger.Info("ended api collection without error")
}
err = divider.Close()
return err
}
func (collector *GraphqlCollector) exec(divider *BatchSaveDivider, input interface{}) {
inputJson, err := json.Marshal(input)
if err != nil {
collector.checkError(errors.Default.Wrap(err, `input can not be marshal to json`))
}
reqData := new(GraphqlRequestData)
reqData.Input = input
reqData.InputJSON = inputJson
reqData.Pager = &CursorPager{
SkipCursor: nil,
Size: collector.args.PageSize,
}
if collector.args.GetPageInfo != nil {
collector.fetchOneByOne(divider, reqData)
} else {
collector.fetchAsync(divider, reqData, nil)
}
}
// fetchPagesDetermined fetches data of all pages for APIs that return paging information
func (collector *GraphqlCollector) fetchOneByOne(divider *BatchSaveDivider, reqData *GraphqlRequestData) {
// fetch first page
var fetchNextPage func(query interface{}) errors.Error
fetchNextPage = func(query interface{}) errors.Error {
pageInfo, err := collector.args.GetPageInfo(query, collector.args)
if err != nil {
return errors.Default.Wrap(err, "fetchPagesDetermined get totalPages failed")
}
if pageInfo == nil {
return errors.Default.New("fetchPagesDetermined got pageInfo is nil")
}
if pageInfo.HasNextPage {
collector.args.GraphqlClient.NextTick(func() errors.Error {
reqDataTemp := &GraphqlRequestData{
Pager: &CursorPager{
SkipCursor: &pageInfo.EndCursor,
Size: collector.args.PageSize,
},
Input: reqData.Input,
InputJSON: reqData.InputJSON,
}
collector.fetchAsync(divider, reqDataTemp, fetchNextPage)
return nil
}, collector.checkError)
}
return nil
}
collector.fetchAsync(divider, reqData, fetchNextPage)
}
func (collector *GraphqlCollector) fetchAsync(divider *BatchSaveDivider, reqData *GraphqlRequestData, handler func(query interface{}) errors.Error) {
if reqData.Pager == nil {
reqData.Pager = &CursorPager{
SkipCursor: nil,
Size: collector.args.PageSize,
}
}
query, variables, err := collector.args.BuildQuery(reqData)
if err != nil {
collector.checkError(errors.Default.Wrap(err, `graphql collector BuildQuery failed`))
return
}
logger := collector.args.Ctx.GetLogger()
dataErrors, err := collector.args.GraphqlClient.Query(query, variables)
if err != nil {
if err == context.Canceled {
// direct error message for error combine
collector.checkError(err)
} else {
collector.checkError(errors.Default.Wrap(err, `graphql query failed`))
}
return
}
if len(dataErrors) > 0 {
if collector.args.ResponseParserWithDataErrors == nil {
for _, dataError := range dataErrors {
collector.checkError(errors.Default.Wrap(dataError, `graphql query got error`))
}
return
}
// else: error will deal by ResponseParserWithDataErrors
}
defer logger.Debug("fetchAsync >>> done for %v %v", query, variables)
paramsBytes, err := json.Marshal(query)
if err != nil {
collector.checkError(errors.Default.Wrap(err, `graphql collector marshal query failed`))
return
}
db := collector.args.Ctx.GetDal()
queryStr, _ := graphql.ConstructQuery(query, variables)
variablesJson, err := json.Marshal(variables)
if err != nil {
collector.checkError(errors.Default.Wrap(err, `variables in graphql query can not marshal to json`))
return
}
row := &RawData{
Params: collector.params,
Data: paramsBytes,
Url: queryStr,
Input: variablesJson,
}
err = db.Create(row, dal.From(collector.table))
if err != nil {
collector.checkError(errors.Default.Wrap(err, `not created row table in graphql collector`))
return
}
var (
results []interface{}
)
if len(dataErrors) > 0 || collector.args.ResponseParser == nil {
results, err = collector.args.ResponseParserWithDataErrors(query, variables, dataErrors)
} else {
results, err = collector.args.ResponseParser(query, variables)
}
if err != nil {
if errors.Is(err, ErrFinishCollect) {
logger.Info("collector finish by parser, rawId: #%d", row.ID)
handler = nil
} else {
collector.checkError(errors.Default.Wrap(err, `not parsed response in graphql collector`))
return
}
}
RAW_DATA_ORIGIN := "RawDataOrigin"
// batch save divider
for _, result := range results {
// get the batch operator for the specific type
batch, err := divider.ForType(reflect.TypeOf(result))
if err != nil {
collector.checkError(err)
return
}
// set raw data origin field
origin := reflect.ValueOf(result).Elem().FieldByName(RAW_DATA_ORIGIN)
if origin.IsValid() {
origin.Set(reflect.ValueOf(common.RawDataOrigin{
RawDataTable: collector.table,
RawDataId: row.ID,
RawDataParams: row.Params,
}))
}
// records get saved into db when slots were max outed
err = batch.Add(result)
if err != nil {
collector.checkError(err)
return
}
collector.args.Ctx.IncProgress(1)
}
collector.args.Ctx.IncProgress(1)
if handler != nil {
// trigger next fetch, but return if ErrFinishCollect got from ResponseParser
err = handler(query)
if err != nil {
collector.checkError(errors.Default.Wrap(err, `handle failed in graphql collector`))
return
}
}
}
func (collector *GraphqlCollector) checkError(err error) {
if err == nil {
return
}
collector.workerErrors = append(collector.workerErrors, err)
}
// HasError return if any error occurred
func (collector *GraphqlCollector) HasError() bool {
return len(collector.workerErrors) > 0
}
var _ core.SubTask = (*GraphqlCollector)(nil)