-
Notifications
You must be signed in to change notification settings - Fork 124
/
task_stats.go
363 lines (319 loc) · 10.9 KB
/
task_stats.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
package route
// This file defines the handlers for the endpoint to query the task execution
// statistics.
import (
"context"
"fmt"
"net/http"
"net/url"
"strconv"
"strings"
"time"
"github.com/evergreen-ci/evergreen"
dbModel "github.com/evergreen-ci/evergreen/model"
"github.com/evergreen-ci/evergreen/model/taskstats"
"github.com/evergreen-ci/evergreen/rest/data"
"github.com/evergreen-ci/gimlet"
"github.com/pkg/errors"
)
const (
// Requester API values
statsAPIRequesterMainline = "mainline"
statsAPIRequesterPatch = "patch"
statsAPIRequesterTrigger = "trigger"
statsAPIRequesterGitTag = "git_tag"
statsAPIRequesterAdhoc = "adhoc"
// Sort API values
statsAPISortEarliest = "earliest"
statsAPISortLatest = "latest"
// GroupBy API values for tasks
StatsAPITaskGroupByDistro = "task_variant_distro"
StatsAPITaskGroupByVariant = "task_variant"
StatsAPITaskGroupByTask = "task"
// API Limits
statsAPIMaxGroupNumDays = 26 * 7 // 26 weeks which is the maximum amount of data available
statsAPIMaxNumTasks = 50
statsAPIMaxLimit = 1000
// Format used to encode dates in the API
statsAPIDateFormat = "2006-01-02"
)
///////////////////////////////////////////////////////////////////////
// Base handler with functionality common to test and stats handlers //
///////////////////////////////////////////////////////////////////////
type StatsHandler struct {
filter taskstats.StatsFilter
}
// ParseCommonFilter parses the query parameter values and fills the struct filter field.
func (sh *StatsHandler) ParseCommonFilter(vals url.Values) error {
var err error
sh.filter.Requesters, err = sh.readRequesters(sh.readStringList(vals["requesters"]))
if err != nil {
return errors.Wrap(err, "invalid requesters")
}
sh.filter.BuildVariants = sh.readStringList(vals["variants"])
sh.filter.Distros = sh.readStringList(vals["distros"])
sh.filter.GroupNumDays, err = sh.readInt(vals.Get("group_num_days"), 1, statsAPIMaxGroupNumDays, 1)
if err != nil {
return errors.Wrap(err, "invalid grouping by number of days")
}
sh.filter.StartAt, err = sh.readStartAt(vals.Get("start_at"))
return err
}
// parseStatsFilter parses the query parameter values and fills the struct filter field.
func (sh *StatsHandler) parseStatsFilter(vals url.Values) error {
var err error
err = sh.ParseCommonFilter(vals)
if err != nil {
return err
}
sh.filter.GroupBy, err = sh.readGroupBy(vals.Get("group_by"))
if err != nil {
return err
}
sh.filter.Limit, err = sh.readInt(vals.Get("limit"), 1, statsAPIMaxLimit, statsAPIMaxLimit)
if err != nil {
return gimlet.ErrorResponse{
Message: errors.Wrap(err, "invalid limit").Error(),
StatusCode: http.StatusBadRequest,
}
}
// Add 1 for pagination
sh.filter.Limit++
sh.filter.Tasks = sh.readStringList(vals["tasks"])
if len(sh.filter.Tasks) > statsAPIMaxNumTasks {
return gimlet.ErrorResponse{
Message: fmt.Sprintf("number of tasks given must not exceed %d", statsAPIMaxNumTasks),
StatusCode: http.StatusBadRequest,
}
}
beforeDate := vals.Get("before_date")
if beforeDate == "" {
return gimlet.ErrorResponse{
Message: "missing 'before' date",
StatusCode: http.StatusBadRequest,
}
}
sh.filter.BeforeDate, err = time.ParseInLocation(statsAPIDateFormat, beforeDate, time.UTC)
if err != nil {
return gimlet.ErrorResponse{
Message: errors.Wrapf(err, "parsing 'before' date in expected format (%s)", statsAPIDateFormat).Error(),
StatusCode: http.StatusBadRequest,
}
}
afterDate := vals.Get("after_date")
if afterDate == "" {
return gimlet.ErrorResponse{
Message: "missing 'after' date",
StatusCode: http.StatusBadRequest,
}
}
sh.filter.AfterDate, err = time.ParseInLocation(statsAPIDateFormat, afterDate, time.UTC)
if err != nil {
return gimlet.ErrorResponse{
Message: errors.Wrapf(err, "parsing 'after' date in expected format (%s)", statsAPIDateFormat).Error(),
StatusCode: http.StatusBadRequest,
}
}
sh.filter.Sort, err = sh.readSort(vals.Get("sort"))
if err != nil {
return gimlet.ErrorResponse{
Message: errors.Wrap(err, "invalid sort").Error(),
StatusCode: http.StatusBadRequest,
}
}
return err
}
// readRequesters parses requesters parameter values and translates them into a list of internal Evergreen requester names.
func (sh *StatsHandler) readRequesters(requesters []string) ([]string, error) {
if len(requesters) == 0 {
requesters = []string{statsAPIRequesterMainline}
}
requesterValues := []string{}
for _, requester := range requesters {
switch requester {
case statsAPIRequesterMainline:
requesterValues = append(requesterValues, evergreen.RepotrackerVersionRequester)
case statsAPIRequesterPatch:
requesterValues = append(requesterValues, evergreen.PatchRequesters...)
case statsAPIRequesterTrigger:
requesterValues = append(requesterValues, evergreen.TriggerRequester)
case statsAPIRequesterGitTag:
requesterValues = append(requesterValues, evergreen.GitTagRequester)
case statsAPIRequesterAdhoc:
requesterValues = append(requesterValues, evergreen.AdHocRequester)
default:
return nil, errors.Errorf("invalid requester '%s'", requester)
}
}
return requesterValues, nil
}
// readStringList parses a string list parameter value, the values can be comma separated or specified multiple times.
func (sh *StatsHandler) readStringList(values []string) []string {
var parsedValues []string
for _, val := range values {
elements := strings.Split(val, ",")
parsedValues = append(parsedValues, elements...)
}
return parsedValues
}
// readInt parses an integer parameter value, given minimum, maximum, and default values.
func (sh *StatsHandler) readInt(intString string, min, max, defaultValue int) (int, error) {
if intString == "" {
return defaultValue, nil
}
value, err := strconv.Atoi(intString)
if err != nil {
return 0, err
}
if value < min || value > max {
return 0, gimlet.ErrorResponse{
Message: fmt.Sprintf("integer value %d must be between %d and %d", value, min, max),
StatusCode: http.StatusBadRequest,
}
}
return value, nil
}
// readTestGroupBy parses a sort parameter value and returns the corresponding Sort struct.
func (sh *StatsHandler) readSort(sortValue string) (taskstats.Sort, error) {
switch sortValue {
case statsAPISortEarliest:
return taskstats.SortEarliestFirst, nil
case statsAPISortLatest:
return taskstats.SortLatestFirst, nil
case "":
return taskstats.SortEarliestFirst, nil
default:
return taskstats.Sort(""), gimlet.ErrorResponse{
Message: fmt.Sprintf("invalid sort '%s'", sortValue),
StatusCode: http.StatusBadRequest,
}
}
}
// readGroupBy parses a group_by parameter value and returns the corresponding GroupBy struct.
func (sh *StatsHandler) readGroupBy(groupByValue string) (taskstats.GroupBy, error) {
switch groupByValue {
case StatsAPITaskGroupByDistro:
return taskstats.GroupByDistro, nil
case StatsAPITaskGroupByVariant:
return taskstats.GroupByVariant, nil
case StatsAPITaskGroupByTask:
return taskstats.GroupByTask, nil
// Default value.
case "":
return taskstats.GroupByDistro, nil
default:
return taskstats.GroupBy(""), gimlet.ErrorResponse{
Message: fmt.Sprintf("invalid grouping '%s'", groupByValue),
StatusCode: http.StatusBadRequest,
}
}
}
// readStartAt parses a start_at key value and returns the corresponding StartAt struct.
func (sh *StatsHandler) readStartAt(startAtValue string) (*taskstats.StartAt, error) {
if startAtValue == "" {
return nil, nil
}
elements := strings.Split(startAtValue, "|")
if len(elements) != 4 {
return nil, gimlet.ErrorResponse{
Message: "invalid 'start at' value",
StatusCode: http.StatusBadRequest,
}
}
date, err := time.ParseInLocation(statsAPIDateFormat, elements[0], time.UTC)
if err != nil {
return nil, gimlet.ErrorResponse{
Message: errors.Wrapf(err, "parsing date in expected format (%s)", statsAPIDateFormat).Error(),
StatusCode: http.StatusBadRequest,
}
}
return &taskstats.StartAt{
Date: date,
BuildVariant: elements[1],
Task: elements[2],
Distro: elements[3],
}, nil
}
///////////////////////////////////////////////
// /projects/<project_id>/task_stats handler //
///////////////////////////////////////////////
type taskStatsHandler struct {
StatsHandler
url string
}
func (tsh *taskStatsHandler) Factory() gimlet.RouteHandler {
return &taskStatsHandler{url: tsh.url}
}
func makeGetProjectTaskStats(url string) gimlet.RouteHandler {
return &taskStatsHandler{url: url}
}
func (tsh *taskStatsHandler) Parse(ctx context.Context, r *http.Request) error {
project := gimlet.GetVars(r)["project_id"]
projectId, err := dbModel.GetIdForProject(project)
if err != nil {
return errors.Wrapf(err, "project ID not found for project '%s'", project)
}
tsh.filter = taskstats.StatsFilter{Project: projectId}
if err = tsh.StatsHandler.parseStatsFilter(r.URL.Query()); err != nil {
return errors.Wrap(err, "invalid query parameters")
}
if err = tsh.filter.ValidateForTasks(); err != nil {
return errors.Wrap(err, "invalid filter")
}
return nil
}
func (tsh *taskStatsHandler) Run(ctx context.Context) gimlet.Responder {
flags, err := evergreen.GetServiceFlags(ctx)
if err != nil {
return gimlet.MakeJSONInternalErrorResponder(errors.Wrap(err, "getting service flags"))
}
if flags.CacheStatsEndpointDisabled {
return gimlet.MakeJSONErrorResponder(gimlet.ErrorResponse{
Message: "endpoint is disabled",
StatusCode: http.StatusServiceUnavailable,
})
}
taskStatsResult, err := data.GetTaskStats(tsh.filter)
if err != nil {
return gimlet.MakeJSONInternalErrorResponder(errors.Wrap(err, "getting task stats"))
}
if len(taskStatsResult) == 0 {
statsStatus, err := taskstats.GetStatsStatus(tsh.filter.Project)
if err != nil {
return gimlet.MakeJSONInternalErrorResponder(errors.Wrapf(err, "getting stats status for project '%s'", tsh.filter.Project))
}
if statsStatus.ProcessedTasksUntil.Before(tsh.filter.AfterDate) {
return gimlet.MakeJSONErrorResponder(gimlet.ErrorResponse{
Message: "stats for this time range have not been generated yet",
StatusCode: http.StatusServiceUnavailable,
})
}
}
resp := gimlet.NewResponseBuilder()
requestLimit := tsh.filter.Limit - 1
lastIndex := len(taskStatsResult)
if len(taskStatsResult) > requestLimit {
lastIndex = requestLimit
err = resp.SetPages(&gimlet.ResponsePages{
Next: &gimlet.Page{
Relation: "next",
LimitQueryParam: "limit",
KeyQueryParam: "start_at",
BaseURL: tsh.url,
Key: taskStatsResult[requestLimit].StartAtKey(),
Limit: requestLimit,
},
})
if err != nil {
return gimlet.MakeJSONInternalErrorResponder(errors.Wrap(err,
"paginating response"))
}
}
taskStatsResult = taskStatsResult[:lastIndex]
for i, apiTaskStats := range taskStatsResult {
if err = resp.AddData(apiTaskStats); err != nil {
return gimlet.MakeJSONInternalErrorResponder(errors.Wrapf(err, "adding task stats at index %d", i))
}
}
return resp
}