-
Notifications
You must be signed in to change notification settings - Fork 70
/
task.go
362 lines (309 loc) · 9.76 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
package entity
import (
"fmt"
"runtime"
"time"
"github.com/shiningrush/fastflow/pkg/entity/run"
"github.com/shiningrush/fastflow/pkg/log"
"github.com/shiningrush/fastflow/pkg/utils"
)
// Task
type Task struct {
ID string `yaml:"id,omitempty" json:"id,omitempty" bson:"id,omitempty"`
Name string `yaml:"name,omitempty" json:"name,omitempty" bson:"name,omitempty"`
DependOn []string `yaml:"dependOn,omitempty" json:"dependOn,omitempty" bson:"dependOn,omitempty"`
ActionName string `yaml:"actionName,omitempty" json:"actionName,omitempty" bson:"actionName,omitempty"`
TimeoutSecs int `yaml:"timeoutSecs,omitempty" json:"timeoutSecs,omitempty" bson:"timeoutSecs,omitempty"`
Params map[string]interface{} `yaml:"params,omitempty" json:"params,omitempty" bson:"params,omitempty"`
PreChecks PreChecks `yaml:"preCheck,omitempty" json:"preCheck,omitempty" bson:"preCheck,omitempty"`
}
// GetGraphID
func (t *Task) GetGraphID() string {
return t.ID
}
// GetID
func (t *Task) GetID() string {
return t.ID
}
// GetDepend
func (t *Task) GetDepend() []string {
return t.DependOn
}
// GetStatus
func (t *Task) GetStatus() TaskInstanceStatus {
return ""
}
type PreChecks map[string]*Check
// Check
type Check struct {
Conditions []TaskCondition `yaml:"conditions,omitempty" json:"conditions,omitempty" bson:"conditions,omitempty"`
Act ActiveAction `yaml:"act,omitempty" json:"act,omitempty" bson:"act,omitempty"`
}
// IsMeet return if check is meet
func (c *Check) IsMeet(dagIns *DagInstance) bool {
for _, cd := range c.Conditions {
if !cd.IsMeet(dagIns) {
return false
}
}
return true
}
type ActiveAction string
const (
// skip action when all condition is meet, otherwise execute it
ActiveActionSkip ActiveAction = "skip"
// block action when all condition is meet, otherwise execute it
ActiveActionBlock ActiveAction = "block"
)
type Operator string
const (
OperatorIn Operator = "in"
OperatorNotIn Operator = "not-in"
)
type TaskConditionSource string
const (
TaskConditionSourceVars TaskConditionSource = "vars"
TaskConditionSourceShareData TaskConditionSource = "share-data"
)
// BuildKvGetter
func (t TaskConditionSource) BuildKvGetter(dagIns *DagInstance) utils.KeyValueGetter {
switch t {
case TaskConditionSourceVars:
return dagIns.VarsGetter()
case TaskConditionSourceShareData:
return dagIns.ShareData.Get
default:
panic(fmt.Sprintf("task condition source %s is not valid", t))
}
}
// TaskCondition
type TaskCondition struct {
Source TaskConditionSource `yaml:"source,omitempty" json:"source,omitempty" bson:"source,omitempty"`
Key string `yaml:"key,omitempty" json:"key,omitempty" bson:"key,omitempty"`
Values []string `yaml:"values,omitempty" json:"values,omitempty" bson:"values,omitempty"`
Op Operator `yaml:"op,omitempty" json:"op,omitempty" bson:"op,omitempty"`
}
// IsMeet return if check is meet
func (c *TaskCondition) IsMeet(dagIns *DagInstance) bool {
kvGetter := c.Source.BuildKvGetter(dagIns)
v, ok := kvGetter(c.Key)
if !ok {
return false
}
switch c.Op {
case OperatorIn:
return isStrInArray(v, c.Values)
case OperatorNotIn:
return !isStrInArray(v, c.Values)
}
return false
}
func isStrInArray(str string, arr []string) bool {
for _, v := range arr {
if v == str {
return true
}
}
return false
}
// TaskInstance
type TaskInstance struct {
BaseInfo `bson:"inline"`
// Task's Id it should be unique in a dag instance
TaskID string `json:"taskId,omitempty" bson:"taskId,omitempty"`
DagInsID string `json:"dagInsId,omitempty" bson:"dagInsId,omitempty"`
Name string `json:"name,omitempty" bson:"name,omitempty"`
DependOn []string `json:"dependOn,omitempty" bson:"dependOn,omitempty"`
ActionName string `json:"actionName,omitempty" bson:"actionName,omitempty"`
TimeoutSecs int `json:"timeoutSecs" bson:"timeoutSecs"`
Params map[string]interface{} `json:"params,omitempty" bson:"params,omitempty"`
Traces []TraceInfo `json:"traces,omitempty" bson:"traces,omitempty"`
Status TaskInstanceStatus `json:"status,omitempty" bson:"status,omitempty"`
Reason string `json:"reason,omitempty" bson:"reason,omitempty"`
PreChecks PreChecks `json:"preChecks,omitempty" bson:"preChecks,omitempty"`
// used to save changes
Patch func(*TaskInstance) error `json:"-" bson:"-"`
Context run.ExecuteContext `json:"-" bson:"-"`
RelatedDagInstance *DagInstance `json:"-" bson:"-"`
// it used to buffer traces, and persist when status changed
bufTraces []TraceInfo
}
// TraceInfo
type TraceInfo struct {
Time int64 `json:"time,omitempty" bson:"time,omitempty"`
Message string `json:"message,omitempty" bson:"message,omitempty"`
}
// NewTaskInstance
func NewTaskInstance(dagInsId string, t Task) *TaskInstance {
return &TaskInstance{
TaskID: t.ID,
DagInsID: dagInsId,
Name: t.Name,
DependOn: t.DependOn,
ActionName: t.ActionName,
TimeoutSecs: t.TimeoutSecs,
Params: t.Params,
Status: TaskInstanceStatusInit,
PreChecks: t.PreChecks,
}
}
// GetGraphID
func (t *TaskInstance) GetGraphID() string {
return t.TaskID
}
// GetID
func (t *TaskInstance) GetID() string {
return t.ID
}
// GetDepend
func (t *TaskInstance) GetDepend() []string {
return t.DependOn
}
// GetStatus
func (t *TaskInstance) GetStatus() TaskInstanceStatus {
return t.Status
}
// InitialDep
func (t *TaskInstance) InitialDep(ctx run.ExecuteContext, patch func(*TaskInstance) error, dagIns *DagInstance) {
t.Patch = patch
t.Context = ctx
t.RelatedDagInstance = dagIns
}
// SetStatus will persist task instance
func (t *TaskInstance) SetStatus(s TaskInstanceStatus) error {
t.Status = s
patch := &TaskInstance{BaseInfo: BaseInfo{ID: t.ID}, Status: t.Status, Reason: t.Reason}
if len(t.bufTraces) != 0 {
patch.Traces = append(t.Traces, t.bufTraces...)
}
return t.Patch(patch)
}
// Trace info
func (t *TaskInstance) Trace(msg string, ops ...run.TraceOp) {
opt := run.NewTraceOption(ops...)
if opt.Priority == run.PersistPriorityAfterAction {
t.bufTraces = append(t.bufTraces, TraceInfo{
Time: time.Now().Unix(),
Message: msg,
})
return
}
t.Traces = append(t.Traces, TraceInfo{
Time: time.Now().Unix(),
Message: msg,
})
if err := t.Patch(&TaskInstance{BaseInfo: BaseInfo{ID: t.ID}, Traces: t.Traces}); err != nil {
log.Error("save trace failed",
"err", err,
"trace", t.Traces)
}
}
// Run action
func (t *TaskInstance) Run(params interface{}, act run.Action) (err error) {
defer func() {
if rErr := recover(); rErr != nil {
var stacktrace string
for i := 2; ; i++ {
_, f, l, got := runtime.Caller(i)
if !got {
break
}
stacktrace += fmt.Sprintf("%s:%d\n", f, l)
}
err = fmt.Errorf("get panic when running action: %s, err: %s, stack: %s", act.Name(), rErr, stacktrace)
}
}()
if t.Status == TaskInstanceStatusInit || t.Status == TaskInstanceStatusContinue {
beforeAct, ok := act.(run.BeforeAction)
if ok {
if err := beforeAct.RunBefore(t.Context, params); err != nil {
return fmt.Errorf("run before failed: %w", err)
}
}
if err := t.SetStatus(TaskInstanceStatusRunning); err != nil {
return err
}
if err := act.Run(t.Context, params); err != nil {
return fmt.Errorf("run failed: %w", err)
}
if err := t.SetStatus(TaskInstanceStatusEnding); err != nil {
return err
}
}
if t.Status == TaskInstanceStatusEnding {
afterAct, ok := act.(run.AfterAction)
if ok {
if err := afterAct.RunAfter(t.Context, params); err != nil {
return fmt.Errorf("run after failed: %w", err)
}
}
if err := t.SetStatus(TaskInstanceStatusSuccess); err != nil {
return err
}
}
if t.Status == TaskInstanceStatusRetrying {
retryAct, ok := act.(run.RetryBeforeAction)
if ok {
if err := retryAct.RetryBefore(t.Context, params); err != nil {
return fmt.Errorf("run retryBefore failed: %w", err)
}
}
if err := t.SetStatus(TaskInstanceStatusInit); err != nil {
return err
}
}
return nil
}
// DoPreCheck
func (t *TaskInstance) DoPreCheck(dagIns *DagInstance) (isActive bool, err error) {
if t.PreChecks == nil || t.IsLastState() {
return
}
for k, c := range t.PreChecks {
// we should not block a continued task
if c.Act == ActiveActionBlock && !t.CanBlock() {
continue
}
if c.IsMeet(dagIns) {
switch c.Act {
case ActiveActionSkip:
t.Status = TaskInstanceStatusSkipped
case ActiveActionBlock:
t.Status = TaskInstanceStatusBlocked
default:
return false, fmt.Errorf("pre-check[%s] act is invalid: %s", k, c.Act)
}
isActive = true
return
}
}
return
}
func (t *TaskInstance) IsLastState() bool {
switch t.Status {
case TaskInstanceStatusFailed, TaskInstanceStatusCanceled, TaskInstanceStatusSuccess, TaskInstanceStatusSkipped:
return true
default:
return false
}
}
func (t *TaskInstance) CanBlock() bool {
if t.Status == TaskInstanceStatusContinue {
return false
}
return true
}
// TaskInstanceStatus
type TaskInstanceStatus string
const (
TaskInstanceStatusInit TaskInstanceStatus = "init"
TaskInstanceStatusCanceled TaskInstanceStatus = "canceled"
TaskInstanceStatusRunning TaskInstanceStatus = "running"
TaskInstanceStatusEnding TaskInstanceStatus = "ending"
TaskInstanceStatusFailed TaskInstanceStatus = "failed"
TaskInstanceStatusRetrying TaskInstanceStatus = "retrying"
TaskInstanceStatusSuccess TaskInstanceStatus = "success"
TaskInstanceStatusBlocked TaskInstanceStatus = "blocked"
TaskInstanceStatusContinue TaskInstanceStatus = "continue"
TaskInstanceStatusSkipped TaskInstanceStatus = "skipped"
)