/
task.go
449 lines (370 loc) · 11.6 KB
/
task.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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
package handler
import (
"fmt"
"strings"
"time"
"github.com/gin-gonic/gin"
"github.com/juju/errors"
"github.com/loopfz/gadgeto/zesty"
"github.com/ovh/utask"
"github.com/ovh/utask/engine/step"
"github.com/ovh/utask/models/resolution"
"github.com/ovh/utask/models/task"
"github.com/ovh/utask/models/tasktemplate"
"github.com/ovh/utask/pkg/auth"
"github.com/ovh/utask/pkg/constants"
"github.com/ovh/utask/pkg/metadata"
"github.com/ovh/utask/pkg/taskutils"
"github.com/ovh/utask/pkg/utils"
)
type createTaskIn struct {
TemplateName string `json:"template_name" binding:"required"`
Input map[string]interface{} `json:"input" binding:"required"`
Comment string `json:"comment"`
WatcherUsernames []string `json:"watcher_usernames"`
Delay *string `json:"delay"`
Tags map[string]string `json:"tags"`
}
// CreateTask handles the creation of a new task based on an existing template
// the template determines the expected input
// an initial comment on the task can be provided for context
// watchers will be able to follow the state of this task while having no right to act on it
// a delay can be set to offset this task's execution by a certain amount of time
// delay is expressed according to https://golang.org/pkg/time/#ParseDuration
// A duration string is a possibly signed sequence of decimal numbers,
// each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
func CreateTask(c *gin.Context, in *createTaskIn) (*task.Task, error) {
metadata.AddActionMetadata(c, metadata.TemplateName, in.TemplateName)
dbp, err := zesty.NewDBProvider(utask.DBName)
if err != nil {
return nil, err
}
tt, err := tasktemplate.LoadFromName(dbp, in.TemplateName)
if err != nil {
return nil, err
}
if err := dbp.Tx(); err != nil {
return nil, err
}
if err := utils.ValidateTags(in.Tags); err != nil {
return nil, err
}
t, err := taskutils.CreateTask(c, dbp, tt, in.WatcherUsernames, []string{}, in.Input, nil, in.Comment, in.Delay, in.Tags)
if err != nil {
dbp.Rollback()
return nil, err
}
if err := dbp.Commit(); err != nil {
dbp.Rollback()
return nil, err
}
metadata.AddActionMetadata(c, metadata.TaskID, t.PublicID)
return t, nil
}
const (
taskTypeOwn = "own"
taskTypeResolvable = "resolvable"
taskTypeAll = "all"
)
type listTasksIn struct {
Type string `query:"type,default=own"`
State *string `query:"state"`
BatchPublicID *string `query:"batch"`
Template *string `query:"template"`
PageSize uint64 `query:"page_size"`
Last *string `query:"last"`
After *time.Time `query:"after"`
Before *time.Time `query:"before"`
Tags []string `query:"tag" explode:"true"`
}
// ListTasks returns a list of tasks, which can be filtered by state, batch ID,
// and last activity time (before and/or after)
// type=own (default) returns tasks for which the user is the requester
// type=resolvable returns tasks for which the user is a potential resolver
// type=all returns every task (only available to administrator users)
func ListTasks(c *gin.Context, in *listTasksIn) (t []*task.Task, err error) {
if in.Template != nil {
metadata.AddActionMetadata(c, metadata.TemplateName, *in.Template)
}
dbp, err := zesty.NewDBProvider(utask.DBName)
if err != nil {
return nil, err
}
tags := make(map[string]string, len(in.Tags))
for _, t := range in.Tags {
parts := strings.Split(t, "=")
if len(parts) != 2 {
return nil, errors.BadRequestf("invalid tag %s", t)
}
if parts[0] == "" || parts[1] == "" {
return nil, errors.BadRequestf("invalid tag %s", t)
}
tags[parts[0]] = parts[1]
}
filter := task.ListFilter{
PageSize: normalizePageSize(in.PageSize),
Last: in.Last,
State: in.State,
After: in.After,
Before: in.Before,
Template: in.Template,
Tags: tags,
}
var b *task.Batch
if in.BatchPublicID != nil {
b, err = task.LoadBatchFromPublicID(dbp, *in.BatchPublicID)
if err != nil {
return nil, err
}
filter.Batch = b
}
reqUsername := auth.GetIdentity(c)
var user *string
if reqUsername != "" {
user = &reqUsername
}
switch in.Type {
case taskTypeOwn:
filter.RequesterUser = user
case taskTypeResolvable:
filter.PotentialResolverUser = user
case taskTypeAll:
if err2 := auth.IsAdmin(c); err2 != nil {
filter.RequesterOrPotentialResolverUser = user
}
default:
return nil, errors.BadRequestf("Unknown type for listing: '%s'. Was expecting '%s', '%s' or '%s'", in.Type, taskTypeOwn, taskTypeResolvable, taskTypeAll)
}
t, err = task.ListTasks(dbp, filter)
if err != nil {
return nil, err
}
if uint64(len(t)) == filter.PageSize {
lastT := t[len(t)-1].PublicID
c.Header(
linkHeader,
buildTaskNextLink(in.Type, in.State, in.BatchPublicID, filter.PageSize, lastT),
)
}
c.Header(pageSizeHeader, fmt.Sprintf("%v", filter.PageSize))
return t, nil
}
type getTaskIn struct {
PublicID string `path:"id,required"`
}
// GetTask returns a single task
// inputs of type password are obfuscated to every user except administrators
func GetTask(c *gin.Context, in *getTaskIn) (*task.Task, error) {
metadata.AddActionMetadata(c, metadata.TaskID, in.PublicID)
dbp, err := zesty.NewDBProvider(utask.DBName)
if err != nil {
return nil, err
}
t, err := task.LoadFromPublicID(dbp, in.PublicID)
if err != nil {
return nil, err
}
tt, err := tasktemplate.LoadFromID(dbp, t.TemplateID)
if err != nil {
return nil, err
}
metadata.AddActionMetadata(c, metadata.TemplateName, tt.Name)
var res *resolution.Resolution
if t.Resolution != nil {
res, err = resolution.LoadFromPublicID(dbp, *t.Resolution)
if err != nil {
return nil, err
}
}
admin := auth.IsAdmin(c) == nil
requester := auth.IsRequester(c, t) == nil
watcher := auth.IsWatcher(c, t) == nil
resolutionManager := auth.IsResolutionManager(c, tt, t, res) == nil
if !admin && !requester && !watcher && !resolutionManager {
return nil, errors.Forbiddenf("Can't display task details")
}
if !admin {
t.Input = obfuscateInput(tt.Inputs, t.Input)
}
if t.State == task.StateBlocked && res != nil {
for _, s := range res.Steps {
if s.State == step.StateClientError {
t.Errors = append(t.Errors, task.StepError{
Step: s.Description,
Error: s.Error,
})
}
}
}
return t, nil
}
type updateTaskIn struct {
PublicID string `path:"id,required"`
Input map[string]interface{} `json:"input"`
WatcherUsernames []string `json:"watcher_usernames"`
Tags map[string]string `json:"tags"`
}
// UpdateTask modifies a task, allowing it's requester or an administrator
// to fix a broken input, or to add/remove watchers
func UpdateTask(c *gin.Context, in *updateTaskIn) (*task.Task, error) {
metadata.AddActionMetadata(c, metadata.TaskID, in.PublicID)
dbp, err := zesty.NewDBProvider(utask.DBName)
if err != nil {
return nil, err
}
if err := dbp.Tx(); err != nil {
return nil, err
}
t, err := task.LoadFromPublicID(dbp, in.PublicID)
if err != nil {
dbp.Rollback()
return nil, err
}
tt, err := tasktemplate.LoadFromID(dbp, t.TemplateID)
if err != nil {
dbp.Rollback()
return nil, err
}
metadata.AddActionMetadata(c, metadata.TemplateName, tt.Name)
admin := auth.IsAdmin(c) == nil
requester := (auth.IsRequester(c, t) == nil && t.Resolution == nil)
templateOwner := auth.IsTemplateOwner(c, tt) == nil
if !admin && !requester && !templateOwner {
dbp.Rollback()
return nil, errors.Forbiddenf("Can't update task")
} else if !requester && !templateOwner {
metadata.SetSUDO(c)
}
var res *resolution.Resolution
if t.Resolution != nil {
res, err = resolution.LoadFromPublicID(dbp, *t.Resolution)
if err != nil {
dbp.Rollback()
return nil, err
}
if res.State != resolution.StatePaused {
dbp.Rollback()
return nil, errors.BadRequestf("Cannot update a task which resolution is not in state '%s'", resolution.StatePaused)
}
}
// avoid secrets being squashed by their obfuscated placeholder
clearInput := deobfuscateNewInput(t.Input, in.Input)
t.SetInput(clearInput)
t.SetWatcherUsernames(in.WatcherUsernames)
// validate read-only tags
v, readOnlyTagUpdated := in.Tags[constants.SubtaskTagParentTaskID]
oldValue, readOnlyTagInTask := t.Tags[constants.SubtaskTagParentTaskID]
if (readOnlyTagUpdated && (!readOnlyTagInTask || oldValue != v)) || (!readOnlyTagUpdated && readOnlyTagInTask) {
dbp.Rollback()
return nil, errors.BadRequestf("tag %s is read-only and cannot be modified", constants.SubtaskTagParentTaskID)
}
if err := t.SetTags(in.Tags, nil); err != nil {
return nil, errors.BadRequestf("failed to set tags: %s", err)
}
if err := t.Update(dbp,
false, // do validate task contents
true, // change last activity value, bring task bask to top of the list
); err != nil {
dbp.Rollback()
return nil, err
}
reqUsername := auth.GetIdentity(c)
_, err = task.CreateComment(dbp, t, reqUsername, "manually edited task")
if err != nil {
dbp.Rollback()
return nil, err
}
if err := dbp.Commit(); err != nil {
dbp.Rollback()
return nil, err
}
return t, nil
}
type deleteTaskIn struct {
PublicID string `path:"id,required"`
}
// DeleteTask removes a task from the data backend
func DeleteTask(c *gin.Context, in *deleteTaskIn) error {
metadata.AddActionMetadata(c, metadata.TaskID, in.PublicID)
dbp, err := zesty.NewDBProvider(utask.DBName)
if err != nil {
return err
}
t, err := task.LoadFromPublicID(dbp, in.PublicID)
if err != nil {
return err
}
tt, err := tasktemplate.LoadFromID(dbp, t.TemplateID)
if err != nil {
return err
}
metadata.AddActionMetadata(c, metadata.TemplateName, tt.Name)
if err := auth.IsAdmin(c); err != nil {
return err
}
metadata.SetSUDO(c)
switch t.State {
case task.StateRunning, task.StateBlocked:
return errors.BadRequestf("Task can't be deleted while in state %q", t.State)
}
return t.Delete(dbp)
}
type wontfixTaskIn struct {
PublicID string `path:"id,required"`
}
// WontfixTask changes a task's state to prevent it from ever being resolved
func WontfixTask(c *gin.Context, in *wontfixTaskIn) error {
metadata.AddActionMetadata(c, metadata.TaskID, in.PublicID)
dbp, err := zesty.NewDBProvider(utask.DBName)
if err != nil {
return err
}
if err := dbp.Tx(); err != nil {
return err
}
t, err := task.LoadFromPublicID(dbp, in.PublicID)
if err != nil {
dbp.Rollback()
return err
}
if t.State != task.StateTODO {
dbp.Rollback()
return errors.BadRequestf("Can't set task's state to %s: task is in state %s", task.StateWontfix, t.State)
}
tt, err := tasktemplate.LoadFromID(dbp, t.TemplateID)
if err != nil {
dbp.Rollback()
return err
}
metadata.AddActionMetadata(c, metadata.TemplateName, tt.Name)
admin := auth.IsAdmin(c) == nil
requester := auth.IsRequester(c, t) == nil
resolutionManager := auth.IsResolutionManager(c, tt, t, nil) == nil
if !admin && !requester && !resolutionManager {
dbp.Rollback()
return errors.Forbiddenf("Can't set task's state to %s", task.StateWontfix)
} else if !requester && !resolutionManager {
metadata.SetSUDO(c)
}
t.SetState(task.StateWontfix)
err = t.Update(dbp,
false, // skip validation of task contents, task is dead anyway
true, // do record mark change with last activity timestamp
)
if err != nil {
dbp.Rollback()
return err
}
reqUsername := auth.GetIdentity(c)
_, err = task.CreateComment(dbp, t, reqUsername, "changed task state to WONTFIX")
if err != nil {
dbp.Rollback()
return err
}
if err := dbp.Commit(); err != nil {
dbp.Rollback()
return err
}
return nil
}