-
Notifications
You must be signed in to change notification settings - Fork 514
/
graphql_collector.go
309 lines (283 loc) · 8.88 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
/*
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 (
"encoding/json"
"fmt"
"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
}
type GraphqlQueryPageInfo struct {
EndCursor string `json:"endCursor"`
HasNextPage bool `json:"hasNextPage"`
}
type GraphqlAsyncResponseHandler func(res *http.Response) error
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
IgnoreQueryErr bool
// GetPageInfo is to tell `GraphqlCollector` is page information
GetPageInfo func(query interface{}, args *GraphqlCollectorArgs) (*GraphqlQueryPageInfo, error)
BatchSize int
ResponseParser func(query interface{}, variables map[string]interface{}) ([]interface{}, error)
}
type GraphqlCollector struct {
*RawDataSubTask
args *GraphqlCollectorArgs
}
// 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, error) {
// process args
rawDataSubTask, err := newRawDataSubTask(args.RawDataSubTaskArgs)
if err != nil {
return nil, err
}
if err != nil {
return nil, fmt.Errorf("Failed to compile UrlTemplate: %w", err)
}
if args.GraphqlClient == nil {
return nil, fmt.Errorf("ApiClient is required")
}
if args.ResponseParser == nil {
return nil, fmt.Errorf("ResponseParser is required")
}
apicllector := &GraphqlCollector{
RawDataSubTask: rawDataSubTask,
args: &args,
}
if args.BatchSize == 0 {
args.BatchSize = 500
}
if args.InputStep == 0 {
args.InputStep = 1
}
//if args.AfterResponse != nil {
// apicllector.SetAfterResponse(args.AfterResponse)
//} else {
// apicllector.SetAfterResponse(func(res *http.Response) error {
// if res.StatusCode == http.StatusUnauthorized {
// return fmt.Errorf("authentication failed, please check your AccessToken")
// }
// return nil
// })
//}
return apicllector, nil
}
// Start collection
func (collector *GraphqlCollector) Execute() 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 err
}
// flush data if not incremental collection
err = db.Delete(&RawData{}, dal.From(collector.table), dal.Where("params = ?", collector.params))
if err != nil {
return err
}
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()
apiClient := collector.args.GraphqlClient
for iterator.HasNext() && !apiClient.HasError() {
if collector.args.InputStep == 1 {
input, err := iterator.Fetch()
if err != nil {
break
}
collector.exec(divider, input)
} else {
var inputs []interface{}
for i := 0; i < collector.args.InputStep && iterator.HasNext(); i++ {
input, err := iterator.Fetch()
if err != nil {
break
}
inputs = append(inputs, input)
}
collector.exec(divider, inputs)
}
}
} else {
// or we just did it once
collector.exec(divider, nil)
}
logger.Debug("wait for all async api to finished")
err = collector.args.GraphqlClient.Wait()
if err != nil {
logger.Info("end api collection error: %w", err)
} else {
logger.Info("end 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 {
panic(err)
}
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{}) error
fetchNextPage = func(query interface{}) error {
pageInfo, err := collector.args.GetPageInfo(query, collector.args)
if err != nil {
return fmt.Errorf("fetchPagesDetermined get totalPages faileds: %s", err.Error())
}
if pageInfo.HasNextPage {
collector.args.GraphqlClient.NextTick(func() 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
})
}
return nil
}
collector.fetchAsync(divider, reqData, fetchNextPage)
}
func (collector *GraphqlCollector) fetchAsync(divider *BatchSaveDivider, reqData *GraphqlRequestData, handler func(query interface{}) error) {
if reqData.Pager == nil {
reqData.Pager = &CursorPager{
SkipCursor: nil,
Size: collector.args.PageSize,
}
}
query, variables, err := collector.args.BuildQuery(reqData)
if err != nil {
panic(err)
}
logger := collector.args.Ctx.GetLogger()
err = collector.args.GraphqlClient.Query(query, variables)
if err != nil {
if collector.args.IgnoreQueryErr {
logger.Error("fetchAsync fail and got:", err)
return
} else {
panic(err)
}
}
defer logger.Debug("fetchAsync >>> done for %v %v", query, variables)
paramsBytes, err := json.Marshal(query)
if err != nil {
panic(err)
}
db := collector.args.Ctx.GetDal()
queryStr, _ := graphql.ConstructQuery(query, variables)
row := &RawData{
Params: collector.params,
Data: paramsBytes,
Url: queryStr,
Input: reqData.InputJSON,
}
err = db.Create(row, dal.From(collector.table))
if err != nil {
panic(err)
}
results, err := collector.args.ResponseParser(query, variables)
if err != nil {
panic(err)
}
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 {
panic(err)
}
// 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 {
panic(err)
}
collector.args.Ctx.IncProgress(1)
}
if err != nil {
panic(err)
}
collector.args.Ctx.IncProgress(1)
if handler != nil {
err = handler(query)
if err != nil {
panic(err)
}
}
}
var _ core.SubTask = (*ApiCollector)(nil)