-
Notifications
You must be signed in to change notification settings - Fork 110
/
controller.go
1281 lines (971 loc) · 36.1 KB
/
controller.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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package jobs
import (
"context"
"errors"
"fmt"
"sync"
"time"
"github.com/go-co-op/gocron/v2"
"github.com/goccy/go-json"
"github.com/rs/zerolog"
"golang.org/x/sync/errgroup"
"github.com/hatchet-dev/hatchet/internal/datautils"
"github.com/hatchet-dev/hatchet/internal/datautils/merge"
"github.com/hatchet-dev/hatchet/internal/logger"
"github.com/hatchet-dev/hatchet/internal/msgqueue"
"github.com/hatchet-dev/hatchet/internal/repository"
"github.com/hatchet-dev/hatchet/internal/repository/prisma/db"
"github.com/hatchet-dev/hatchet/internal/repository/prisma/dbsqlc"
"github.com/hatchet-dev/hatchet/internal/repository/prisma/sqlchelpers"
"github.com/hatchet-dev/hatchet/internal/services/shared/defaults"
"github.com/hatchet-dev/hatchet/internal/services/shared/recoveryutils"
"github.com/hatchet-dev/hatchet/internal/services/shared/tasktypes"
"github.com/hatchet-dev/hatchet/internal/telemetry"
"github.com/hatchet-dev/hatchet/internal/telemetry/servertel"
hatcheterrors "github.com/hatchet-dev/hatchet/pkg/errors"
)
type JobsController interface {
Start(ctx context.Context) error
}
type JobsControllerImpl struct {
mq msgqueue.MessageQueue
l *zerolog.Logger
repo repository.EngineRepository
dv datautils.DataDecoderValidator
s gocron.Scheduler
a *hatcheterrors.Wrapped
}
type JobsControllerOpt func(*JobsControllerOpts)
type JobsControllerOpts struct {
mq msgqueue.MessageQueue
l *zerolog.Logger
repo repository.EngineRepository
dv datautils.DataDecoderValidator
alerter hatcheterrors.Alerter
}
func defaultJobsControllerOpts() *JobsControllerOpts {
logger := logger.NewDefaultLogger("jobs-controller")
alerter := hatcheterrors.NoOpAlerter{}
return &JobsControllerOpts{
l: &logger,
dv: datautils.NewDataDecoderValidator(),
alerter: alerter,
}
}
func WithMessageQueue(mq msgqueue.MessageQueue) JobsControllerOpt {
return func(opts *JobsControllerOpts) {
opts.mq = mq
}
}
func WithLogger(l *zerolog.Logger) JobsControllerOpt {
return func(opts *JobsControllerOpts) {
opts.l = l
}
}
func WithAlerter(a hatcheterrors.Alerter) JobsControllerOpt {
return func(opts *JobsControllerOpts) {
opts.alerter = a
}
}
func WithRepository(r repository.EngineRepository) JobsControllerOpt {
return func(opts *JobsControllerOpts) {
opts.repo = r
}
}
func WithDataDecoderValidator(dv datautils.DataDecoderValidator) JobsControllerOpt {
return func(opts *JobsControllerOpts) {
opts.dv = dv
}
}
func New(fs ...JobsControllerOpt) (*JobsControllerImpl, error) {
opts := defaultJobsControllerOpts()
for _, f := range fs {
f(opts)
}
if opts.mq == nil {
return nil, fmt.Errorf("task queue is required. use WithMessageQueue")
}
if opts.repo == nil {
return nil, fmt.Errorf("repository is required. use WithRepository")
}
newLogger := opts.l.With().Str("service", "jobs-controller").Logger()
opts.l = &newLogger
s, err := gocron.NewScheduler(gocron.WithLocation(time.UTC))
if err != nil {
return nil, fmt.Errorf("could not create scheduler: %w", err)
}
a := hatcheterrors.NewWrapped(opts.alerter)
a.WithData(map[string]interface{}{"service": "jobs-controller"})
return &JobsControllerImpl{
mq: opts.mq,
l: opts.l,
repo: opts.repo,
dv: opts.dv,
s: s,
a: a,
}, nil
}
func (jc *JobsControllerImpl) Start() (func() error, error) {
ctx, cancel := context.WithCancel(context.Background())
wg := sync.WaitGroup{}
_, err := jc.s.NewJob(
gocron.DurationJob(time.Second*1),
gocron.NewTask(
jc.runStepRunRequeue(ctx),
),
)
if err != nil {
cancel()
return nil, fmt.Errorf("could not schedule step run requeue: %w", err)
}
_, err = jc.s.NewJob(
gocron.DurationJob(time.Second*1),
gocron.NewTask(
jc.runStepRunReassign(ctx),
),
)
if err != nil {
cancel()
return nil, fmt.Errorf("could not schedule step run reassign: %w", err)
}
jc.s.Start()
f := func(task *msgqueue.Message) error {
wg.Add(1)
defer wg.Done()
err := jc.handleTask(context.Background(), task)
if err != nil {
jc.l.Error().Err(err).Msg("could not handle job task")
return jc.a.WrapErr(fmt.Errorf("could not handle job task: %w", err), map[string]interface{}{"task_id": task.ID}) // nolint: errcheck
}
return nil
}
cleanupQueue, err := jc.mq.Subscribe(msgqueue.JOB_PROCESSING_QUEUE, f, msgqueue.NoOpHook)
if err != nil {
cancel()
return nil, fmt.Errorf("could not subscribe to job processing queue: %w", err)
}
cleanup := func() error {
cancel()
if err := cleanupQueue(); err != nil {
return fmt.Errorf("could not cleanup job processing queue: %w", err)
}
if err := jc.s.Shutdown(); err != nil {
return fmt.Errorf("could not shutdown scheduler: %w", err)
}
wg.Wait()
return nil
}
return cleanup, nil
}
func (ec *JobsControllerImpl) handleTask(ctx context.Context, task *msgqueue.Message) (err error) {
defer func() {
if r := recover(); r != nil {
recoverErr := recoveryutils.RecoverWithAlert(ec.l, ec.a, r)
if recoverErr != nil {
err = recoverErr
}
}
}()
switch task.ID {
case "job-run-queued":
return ec.handleJobRunQueued(ctx, task)
case "job-run-cancelled":
return ec.handleJobRunCancelled(ctx, task)
case "step-run-replay":
return ec.handleStepRunReplay(ctx, task)
case "step-run-retry":
return ec.handleStepRunRetry(ctx, task)
case "step-run-queued":
return ec.handleStepRunQueued(ctx, task)
case "step-run-started":
return ec.handleStepRunStarted(ctx, task)
case "step-run-finished":
return ec.handleStepRunFinished(ctx, task)
case "step-run-failed":
return ec.handleStepRunFailed(ctx, task)
case "step-run-cancelled":
return ec.handleStepRunCancelled(ctx, task)
case "step-run-timed-out":
return ec.handleStepRunTimedOut(ctx, task)
}
return fmt.Errorf("unknown task: %s", task.ID)
}
func (ec *JobsControllerImpl) handleJobRunQueued(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-job-run-queued")
defer span.End()
payload := tasktypes.JobRunQueuedTaskPayload{}
metadata := tasktypes.JobRunQueuedTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode job task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode job task metadata: %w", err)
}
err = ec.repo.JobRun().SetJobRunStatusRunning(ctx, metadata.TenantId, payload.JobRunId)
if err != nil {
return fmt.Errorf("could not set job run status to running: %w", err)
}
// list the step runs which are startable
startableStepRuns, err := ec.repo.StepRun().ListStartableStepRuns(ctx, metadata.TenantId, payload.JobRunId, nil)
if err != nil {
return fmt.Errorf("could not list startable step runs: %w", err)
}
g := new(errgroup.Group)
for _, stepRun := range startableStepRuns {
stepRunCp := stepRun
g.Go(func() error {
return ec.mq.AddMessage(
ctx,
msgqueue.JOB_PROCESSING_QUEUE,
tasktypes.StepRunQueuedToTask(stepRunCp),
)
})
}
err = g.Wait()
if err != nil {
ec.l.Err(err).Msg("could not run job run queued")
return err
}
return nil
}
func (ec *JobsControllerImpl) handleJobRunCancelled(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-job-run-cancelled")
defer span.End()
payload := tasktypes.JobRunCancelledTaskPayload{}
metadata := tasktypes.JobRunCancelledTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode job task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode job task metadata: %w", err)
}
stepRuns, err := ec.repo.StepRun().ListStepRuns(ctx, metadata.TenantId, &repository.ListStepRunsOpts{
JobRunId: &payload.JobRunId,
})
if err != nil {
return fmt.Errorf("could not list step runs: %w", err)
}
g := new(errgroup.Group)
for _, stepRun := range stepRuns {
stepRunCp := stepRun
reason := "JOB_RUN_CANCELLED"
if payload.Reason != nil {
reason = *payload.Reason
}
g.Go(func() error {
return ec.mq.AddMessage(
ctx,
msgqueue.JOB_PROCESSING_QUEUE,
tasktypes.StepRunCancelToTask(stepRunCp, reason),
)
})
}
err = g.Wait()
if err != nil {
ec.l.Err(err).Msg("could not run job run cancelled")
return err
}
return nil
}
func (ec *JobsControllerImpl) handleStepRunRetry(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-retry")
defer span.End()
payload := tasktypes.StepRunRetryTaskPayload{}
metadata := tasktypes.StepRunRetryTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode job task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode job task metadata: %w", err)
}
err = ec.repo.StepRun().ArchiveStepRunResult(ctx, metadata.TenantId, payload.StepRunId)
if err != nil {
return fmt.Errorf("could not archive step run result: %w", err)
}
stepRun, err := ec.repo.StepRun().GetStepRunForEngine(ctx, metadata.TenantId, payload.StepRunId)
if err != nil {
return fmt.Errorf("could not get step run: %w", err)
}
inputBytes := stepRun.StepRun.Input
retryCount := int(stepRun.StepRun.RetryCount) + 1
// update step run
_, _, err = ec.repo.StepRun().UpdateStepRun(
ctx,
metadata.TenantId,
sqlchelpers.UUIDToStr(stepRun.StepRun.ID),
&repository.UpdateStepRunOpts{
Input: inputBytes,
Status: repository.StepRunStatusPtr(db.StepRunStatusPending),
IsRerun: true,
RetryCount: &retryCount,
Event: &repository.CreateStepRunEventOpts{
EventReason: repository.StepRunEventReasonPtr(dbsqlc.StepRunEventReasonRETRYING),
EventMessage: repository.StringPtr(
fmt.Sprintf("Retrying step run. This is retry %d / %d", retryCount, stepRun.StepRetries),
)},
},
)
if err != nil {
return fmt.Errorf("could not update step run: %w", err)
}
// send a task to the taskqueue
return ec.mq.AddMessage(
ctx,
msgqueue.JOB_PROCESSING_QUEUE,
tasktypes.StepRunQueuedToTask(stepRun),
)
}
// handleStepRunReplay replays a step run from scratch - it resets the workflow run state, job run state, and
// all cancelled step runs which are children of the step run being replayed.
func (ec *JobsControllerImpl) handleStepRunReplay(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-replay")
defer span.End()
payload := tasktypes.StepRunReplayTaskPayload{}
metadata := tasktypes.StepRunReplayTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode job task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode job task metadata: %w", err)
}
err = ec.repo.StepRun().ArchiveStepRunResult(ctx, metadata.TenantId, payload.StepRunId)
if err != nil {
return fmt.Errorf("could not archive step run result: %w", err)
}
// Unlink the step run from its existing worker. This is necessary because automatic retries increment the
// worker semaphore on failure/cancellation, but in this case we don't want to increment the semaphore.
// FIXME: this is very far decoupled from the actual worker logic, and should be refactored.
err = ec.repo.StepRun().UnlinkStepRunFromWorker(ctx, metadata.TenantId, payload.StepRunId)
if err != nil {
return fmt.Errorf("could not unlink step run from worker: %w", err)
}
stepRun, err := ec.repo.StepRun().GetStepRunForEngine(ctx, metadata.TenantId, payload.StepRunId)
if err != nil {
return fmt.Errorf("could not get step run: %w", err)
}
var inputBytes []byte
retryCount := int(stepRun.StepRun.RetryCount) + 1
// update the input schema for the step run based on the new input
if payload.InputData != "" {
inputBytes = []byte(payload.InputData)
// Merge the existing input data with the new input data. We don't blindly trust the
// input data because the user could have deleted fields that are required by the step.
// A better solution would be to validate the user input ahead of time.
// NOTE: this is an expensive operation.
if currentInput := stepRun.StepRun.Input; len(currentInput) > 0 {
inputMap, err := datautils.JSONBytesToMap([]byte(payload.InputData))
if err != nil {
return fmt.Errorf("could not convert input data to map: %w", err)
}
currentInputMap, err := datautils.JSONBytesToMap(currentInput)
if err != nil {
return fmt.Errorf("could not convert current input to map: %w", err)
}
currentInputOverridesMap, ok1 := currentInputMap["overrides"].(map[string]interface{})
inputOverridesMap, ok2 := inputMap["overrides"].(map[string]interface{})
if ok1 && ok2 {
mergedInputOverrides := merge.MergeMaps(currentInputOverridesMap, inputOverridesMap)
inputMap["overrides"] = mergedInputOverrides
mergedInputBytes, err := json.Marshal(inputMap)
if err != nil {
return fmt.Errorf("could not marshal merged input: %w", err)
}
inputBytes = mergedInputBytes
}
}
// if the input data has been manually set, we reset the retry count as this is a user-triggered retry
retryCount = 0
} else {
inputBytes = stepRun.StepRun.Input
}
// update step run
_, err = ec.repo.StepRun().ReplayStepRun(
ctx,
metadata.TenantId,
sqlchelpers.UUIDToStr(stepRun.StepRun.ID),
&repository.UpdateStepRunOpts{
Input: inputBytes,
Status: repository.StepRunStatusPtr(db.StepRunStatusPending),
IsRerun: true,
RetryCount: &retryCount,
Event: &repository.CreateStepRunEventOpts{
EventReason: repository.StepRunEventReasonPtr(dbsqlc.StepRunEventReasonRETRIEDBYUSER),
EventMessage: repository.StringPtr(
"This step was manually replayed by a user",
)},
},
)
if err != nil {
return fmt.Errorf("could not update step run for replay: %w", err)
}
// send a task to the taskqueue
return ec.mq.AddMessage(
ctx,
msgqueue.JOB_PROCESSING_QUEUE,
tasktypes.StepRunQueuedToTask(stepRun),
)
}
func (ec *JobsControllerImpl) handleStepRunQueued(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-queued")
defer span.End()
payload := tasktypes.StepRunTaskPayload{}
metadata := tasktypes.StepRunTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode job task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode job task metadata: %w", err)
}
return ec.queueStepRun(ctx, metadata.TenantId, metadata.StepId, payload.StepRunId)
}
func (jc *JobsControllerImpl) runStepRunRequeue(ctx context.Context) func() {
return func() {
ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()
jc.l.Debug().Msgf("jobs controller: checking step run requeue")
// list all tenants
tenants, err := jc.repo.Tenant().ListTenants(ctx)
if err != nil {
jc.l.Err(err).Msg("could not list tenants")
return
}
g := new(errgroup.Group)
for i := range tenants {
tenantId := sqlchelpers.UUIDToStr(tenants[i].ID)
g.Go(func() error {
return jc.runStepRunRequeueTenant(ctx, tenantId)
})
}
err = g.Wait()
if err != nil {
jc.l.Err(err).Msg("could not run step run requeue")
}
}
}
// handleStepRunRequeue looks for any step runs that haven't been assigned that are past their requeue time
func (ec *JobsControllerImpl) runStepRunRequeueTenant(ctx context.Context, tenantId string) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-requeue")
defer span.End()
stepRuns, err := ec.repo.StepRun().ListStepRunsToRequeue(ctx, tenantId)
if err != nil {
return fmt.Errorf("could not list step runs to requeue: %w", err)
}
if num := len(stepRuns); num > 0 {
ec.l.Info().Msgf("requeueing %d step runs", num)
}
g := new(errgroup.Group)
for i := range stepRuns {
stepRunCp := stepRuns[i]
// wrap in func to get defer on the span to avoid leaking spans
g.Go(func() error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-requeue-step-run")
defer span.End()
now := time.Now().UTC()
stepRunId := sqlchelpers.UUIDToStr(stepRunCp.StepRun.ID)
// if the current time is after the scheduleTimeoutAt, then mark this as timed out
scheduleTimeoutAt := stepRunCp.StepRun.ScheduleTimeoutAt.Time
// timed out if there was no scheduleTimeoutAt set and the current time is after the step run created at time plus the default schedule timeout,
// or if the scheduleTimeoutAt is set and the current time is after the scheduleTimeoutAt
isTimedOut := !scheduleTimeoutAt.IsZero() && scheduleTimeoutAt.Before(now)
if isTimedOut {
return ec.cancelStepRun(ctx, tenantId, stepRunId, "SCHEDULING_TIMED_OUT")
}
return ec.scheduleStepRun(ctx, tenantId, stepRunCp)
})
}
return g.Wait()
}
func (jc *JobsControllerImpl) runStepRunReassign(ctx context.Context) func() {
return func() {
ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()
jc.l.Debug().Msgf("jobs controller: checking step run reassignment")
// list all tenants
tenants, err := jc.repo.Tenant().ListTenants(ctx)
if err != nil {
jc.l.Err(err).Msg("could not list tenants")
return
}
g := new(errgroup.Group)
for i := range tenants {
tenantId := sqlchelpers.UUIDToStr(tenants[i].ID)
g.Go(func() error {
return jc.runStepRunReassignTenant(ctx, tenantId)
})
}
err = g.Wait()
if err != nil {
jc.l.Err(err).Msg("could not run step run requeue")
}
}
}
// runStepRunReassignTenant looks for step runs that have been assigned to a worker but have not started,
// or have been running but the worker has become inactive.
func (ec *JobsControllerImpl) runStepRunReassignTenant(ctx context.Context, tenantId string) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-reassign")
defer span.End()
stepRuns, err := ec.repo.StepRun().ListStepRunsToReassign(ctx, tenantId)
if err != nil {
return fmt.Errorf("could not list step runs to reassign: %w", err)
}
if num := len(stepRuns); num > 0 {
ec.l.Info().Msgf("reassigning %d step runs", num)
}
g := new(errgroup.Group)
for i := range stepRuns {
stepRunCp := stepRuns[i]
// wrap in func to get defer on the span to avoid leaking spans
g.Go(func() error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-reassign-step-run")
defer span.End()
stepRunId := sqlchelpers.UUIDToStr(stepRunCp.StepRun.ID)
// if the current time is after the scheduleTimeoutAt, then mark this as timed out
now := time.Now().UTC().UTC()
scheduleTimeoutAt := stepRunCp.StepRun.ScheduleTimeoutAt.Time
// timed out if there was no scheduleTimeoutAt set and the current time is after the step run created at time plus the default schedule timeout,
// or if the scheduleTimeoutAt is set and the current time is after the scheduleTimeoutAt
isTimedOut := !scheduleTimeoutAt.IsZero() && scheduleTimeoutAt.Before(now)
if isTimedOut {
return ec.cancelStepRun(ctx, tenantId, stepRunId, "SCHEDULING_TIMED_OUT")
}
eventData := map[string]interface{}{
"worker_id": sqlchelpers.UUIDToStr(stepRunCp.StepRun.WorkerId),
}
err = ec.repo.StepRun().CreateStepRunEvent(ctx, tenantId, stepRunId, repository.CreateStepRunEventOpts{
EventReason: repository.StepRunEventReasonPtr(dbsqlc.StepRunEventReasonREASSIGNED),
EventSeverity: repository.StepRunEventSeverityPtr(dbsqlc.StepRunEventSeverityCRITICAL),
EventMessage: repository.StringPtr("Worker has become inactive"),
EventData: &eventData,
})
if err != nil {
return fmt.Errorf("could not create step run event: %w", err)
}
return ec.scheduleStepRun(ctx, tenantId, stepRunCp)
})
}
return g.Wait()
}
func (ec *JobsControllerImpl) queueStepRun(ctx context.Context, tenantId, stepId, stepRunId string) error {
ctx, span := telemetry.NewSpan(ctx, "queue-step-run")
defer span.End()
// add the rendered data to the step run
stepRun, err := ec.repo.StepRun().GetStepRunForEngine(ctx, tenantId, stepRunId)
errData := map[string]interface{}{
"tenant_id": tenantId,
"step_id": stepId,
"step_run_id": stepRunId,
}
if err != nil {
return ec.a.WrapErr(fmt.Errorf("could not get step run: %w", err), errData)
}
servertel.WithStepRunModel(span, stepRun)
updateStepOpts := &repository.UpdateStepRunOpts{}
// set scheduling timeout
if scheduleTimeoutAt := stepRun.StepRun.ScheduleTimeoutAt.Time; scheduleTimeoutAt.IsZero() {
scheduleTimeoutAt = getScheduleTimeout(stepRun)
updateStepOpts.ScheduleTimeoutAt = &scheduleTimeoutAt
}
// If the step run input is not set, then we should set it. This will be set upstream if we've rerun
// the step run manually with new inputs. It will not be set when the step is automatically queued.
if in := stepRun.StepRun.Input; len(in) == 0 || string(in) == "{}" {
lookupDataBytes := stepRun.JobRunLookupData
if lookupDataBytes != nil {
lookupData := &datautils.JobRunLookupData{}
err := json.Unmarshal(lookupDataBytes, lookupData)
if err != nil {
return ec.a.WrapErr(fmt.Errorf("could not get job run lookup data: %w", err), errData)
}
userData := map[string]interface{}{}
if setUserData := stepRun.StepCustomUserData; len(setUserData) > 0 {
err := json.Unmarshal(setUserData, &userData)
if err != nil {
return fmt.Errorf("could not unmarshal custom user data: %w", err)
}
}
// input data is the triggering event data and any parent step data
inputData := datautils.StepRunData{
Input: lookupData.Input,
TriggeredBy: lookupData.TriggeredBy,
Parents: lookupData.Steps,
UserData: userData,
Overrides: map[string]interface{}{},
}
inputDataBytes, err := json.Marshal(inputData)
if err != nil {
return ec.a.WrapErr(fmt.Errorf("could not convert input data to json: %w", err), errData)
}
updateStepOpts.Input = inputDataBytes
}
}
// begin transaction and make sure step run is in a pending status
// if the step run is no longer is a pending status, we should return with no error
updateStepOpts.Status = repository.StepRunStatusPtr(db.StepRunStatusPendingAssignment)
// indicate that the step run is pending assignment
stepRun, err = ec.repo.StepRun().QueueStepRun(ctx, tenantId, stepRunId, updateStepOpts)
if err != nil {
if errors.Is(err, repository.ErrStepRunIsNotPending) {
ec.l.Debug().Msgf("step run %s is not pending, skipping scheduling", stepRunId)
return nil
}
return ec.a.WrapErr(fmt.Errorf("could not update step run: %w", err), errData)
}
return ec.a.WrapErr(ec.scheduleStepRun(ctx, tenantId, stepRun), errData)
}
func (ec *JobsControllerImpl) scheduleStepRun(ctx context.Context, tenantId string, stepRun *dbsqlc.GetStepRunForEngineRow) error {
ctx, span := telemetry.NewSpan(ctx, "schedule-step-run")
defer span.End()
stepRunId := sqlchelpers.UUIDToStr(stepRun.StepRun.ID)
selectedWorkerId, dispatcherId, err := ec.repo.StepRun().AssignStepRunToWorker(ctx, stepRun)
if err != nil {
if errors.Is(err, repository.ErrNoWorkerAvailable) {
ec.l.Debug().Msgf("no worker available for step run %s, requeueing", stepRunId)
return nil
}
if errors.Is(err, repository.ErrRateLimitExceeded) {
ec.l.Debug().Msgf("rate limit exceeded for step run %s, requeueing", stepRunId)
return nil
}
return fmt.Errorf("could not assign step run to worker: %w", err)
}
// send a task to the dispatcher
err = ec.mq.AddMessage(
ctx,
msgqueue.QueueTypeFromDispatcherID(dispatcherId),
stepRunAssignedTask(tenantId, stepRunId, selectedWorkerId, dispatcherId),
)
if err != nil {
return fmt.Errorf("could not add job assigned task to task queue: %w", err)
}
return nil
}
func (ec *JobsControllerImpl) handleStepRunStarted(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-started")
defer span.End()
payload := tasktypes.StepRunStartedTaskPayload{}
metadata := tasktypes.StepRunStartedTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode step run started task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode step run started task metadata: %w", err)
}
// update the step run in the database
startedAt, err := time.Parse(time.RFC3339, payload.StartedAt)
if err != nil {
return fmt.Errorf("could not parse started at: %w", err)
}
stepRun, updateInfo, err := ec.repo.StepRun().UpdateStepRun(ctx, metadata.TenantId, payload.StepRunId, &repository.UpdateStepRunOpts{
StartedAt: &startedAt,
Status: repository.StepRunStatusPtr(db.StepRunStatusRunning),
Event: &repository.CreateStepRunEventOpts{
EventReason: repository.StepRunEventReasonPtr(dbsqlc.StepRunEventReasonSTARTED),
EventMessage: repository.StringPtr(
fmt.Sprintf("Step run started running on %s", startedAt.Format(time.RFC1123)),
),
},
})
if err != nil {
return fmt.Errorf("could not update step run: %w", err)
}
defer ec.handleStepRunUpdateInfo(stepRun, updateInfo)
return nil
}
func (ec *JobsControllerImpl) handleStepRunFinished(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-finished")
defer span.End()
payload := tasktypes.StepRunFinishedTaskPayload{}
metadata := tasktypes.StepRunFinishedTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode step run finished task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode step run finished task metadata: %w", err)
}
// update the step run in the database
finishedAt, err := time.Parse(time.RFC3339, payload.FinishedAt)
if err != nil {
return fmt.Errorf("could not parse started at: %w", err)
}
var stepOutput []byte
if payload.StepOutputData != "" {
stepOutput = []byte(payload.StepOutputData)
}
stepRun, updateInfo, err := ec.repo.StepRun().UpdateStepRun(ctx, metadata.TenantId, payload.StepRunId, &repository.UpdateStepRunOpts{
FinishedAt: &finishedAt,
Status: repository.StepRunStatusPtr(db.StepRunStatusSucceeded),
Output: stepOutput,
Event: &repository.CreateStepRunEventOpts{
EventReason: repository.StepRunEventReasonPtr(dbsqlc.StepRunEventReasonFINISHED),
EventMessage: repository.StringPtr(
fmt.Sprintf("Step run finished on %s", finishedAt.Format(time.RFC1123)),
)},
})
if err != nil {
return fmt.Errorf("could not update step run: %w", err)
}
defer ec.handleStepRunUpdateInfo(stepRun, updateInfo)
// queue the next step runs
jobRunId := sqlchelpers.UUIDToStr(stepRun.JobRunId)
stepRunId := sqlchelpers.UUIDToStr(stepRun.StepRun.ID)
nextStepRuns, err := ec.repo.StepRun().ListStartableStepRuns(ctx, metadata.TenantId, jobRunId, &stepRunId)
if err != nil {
return fmt.Errorf("could not list startable step runs: %w", err)
}
for _, nextStepRun := range nextStepRuns {
nextStepId := sqlchelpers.UUIDToStr(nextStepRun.StepId)
nextStepRunId := sqlchelpers.UUIDToStr(nextStepRun.StepRun.ID)
err = ec.queueStepRun(ctx, metadata.TenantId, nextStepId, nextStepRunId)
if err != nil {
return fmt.Errorf("could not queue next step run: %w", err)
}
}
return nil
}
func (ec *JobsControllerImpl) handleStepRunFailed(ctx context.Context, task *msgqueue.Message) error {
ctx, span := telemetry.NewSpan(ctx, "handle-step-run-failed")
defer span.End()
payload := tasktypes.StepRunFailedTaskPayload{}
metadata := tasktypes.StepRunFailedTaskMetadata{}
err := ec.dv.DecodeAndValidate(task.Payload, &payload)
if err != nil {
return fmt.Errorf("could not decode step run failed task payload: %w", err)
}
err = ec.dv.DecodeAndValidate(task.Metadata, &metadata)
if err != nil {
return fmt.Errorf("could not decode step run failed task metadata: %w", err)
}
failedAt, err := time.Parse(time.RFC3339, payload.FailedAt)
if err != nil {
return fmt.Errorf("could not parse failed at: %w", err)
}
return ec.failStepRun(ctx, metadata.TenantId, payload.StepRunId, payload.Error, failedAt)
}