Repository navigation
Expand file tree
/
Copy pathexecutor_test.go
More file actions
1328 lines (1171 loc) · 49.1 KB
/
Copy pathexecutor_test.go
File metadata and controls
1328 lines (1171 loc) · 49.1 KB
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 workflow
import (
"context"
"encoding/json"
"errors"
"fmt"
"log/slog"
"slices"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/Masterminds/squirrel"
"github.com/google/uuid"
"github.com/jackc/pgx/v5"
"github.com/stretchr/testify/require"
"github.com/goware/workflow/store"
)
type firstOut struct {
Token string `json:"token"`
}
type secondOut struct {
Result string `json:"result"`
}
func makeDue(t *testing.T, db *store.Store, ctx context.Context, runID uuid.UUID) {
t.Helper()
q := db.DB.SQL.Update(store.TableRuns).
Set("next_retry_at", squirrel.Expr("now() - interval '1 second'")).
Where(squirrel.Eq{"id": runID})
_, err := db.DB.Query.Exec(ctx, q)
require.NoError(t, err)
}
func ageClaim(t *testing.T, db *store.Store, ctx context.Context, runID, claimID uuid.UUID, age time.Duration) {
t.Helper()
q := db.DB.SQL.Update(store.TableRuns).
Set("claimed_at", squirrel.Expr("now() - make_interval(secs => ?)", age.Seconds())).
Where(squirrel.Eq{"id": runID, "claim_id": claimID})
res, err := db.DB.Query.Exec(ctx, q)
require.NoError(t, err)
require.EqualValues(t, 1, res.RowsAffected())
}
// backOffRun stands in for PersistTaskFailure's backoff so a release visibly
// preserves it.
func backOffRun(t *testing.T, db *store.Store, ctx context.Context, runID uuid.UUID) {
t.Helper()
q := db.DB.SQL.Update(store.TableRuns).
Set("next_retry_at", squirrel.Expr("now() + interval '1 minute'")).
Where(squirrel.Eq{"id": runID})
res, err := db.DB.Query.Exec(ctx, q)
require.NoError(t, err)
require.EqualValues(t, 1, res.RowsAffected())
}
// failHeartbeats uses a trigger on UPDATE OF claimed_at that skips claims and
// releases, so only Heartbeat trips it and the release that follows still lands.
func failHeartbeats(t *testing.T, db *store.Store, ctx context.Context, runName string) func() {
t.Helper()
drop := func() {
_, err := db.DB.Conn.Exec(ctx, `DROP TRIGGER IF EXISTS test_fail_heartbeat ON workflow_runs`)
require.NoError(t, err)
_, err = db.DB.Conn.Exec(ctx, `DROP FUNCTION IF EXISTS test_fail_heartbeat()`)
require.NoError(t, err)
}
_, err := db.DB.Conn.Exec(ctx, `
CREATE OR REPLACE FUNCTION test_fail_heartbeat() RETURNS trigger
LANGUAGE plpgsql AS $$
BEGIN
IF NEW.name = TG_ARGV[0] AND NEW.claimed_at IS NOT NULL
AND OLD.claim_id IS NOT NULL AND NEW.claim_id = OLD.claim_id THEN
RAISE EXCEPTION 'injected heartbeat failure';
END IF;
RETURN NEW;
END;
$$`)
require.NoError(t, err)
_, err = db.DB.Conn.Exec(ctx, fmt.Sprintf(`CREATE TRIGGER test_fail_heartbeat
BEFORE UPDATE OF claimed_at ON workflow_runs
FOR EACH ROW EXECUTE FUNCTION test_fail_heartbeat('%s')`, runName))
require.NoError(t, err)
t.Cleanup(drop)
return drop
}
// failTaskTransition uses a trigger so the pool stays healthy and later writes
// land. pending to running trips MarkTaskRunning; running to stuck trips a park.
func failTaskTransition(t *testing.T, db *store.Store, ctx context.Context, runName string, from, to store.TaskStatus) func() {
t.Helper()
drop := func() {
_, err := db.DB.Conn.Exec(ctx, `DROP TRIGGER IF EXISTS test_fail_task_transition ON workflow_tasks`)
require.NoError(t, err)
_, err = db.DB.Conn.Exec(ctx, `DROP FUNCTION IF EXISTS test_fail_task_transition()`)
require.NoError(t, err)
}
_, err := db.DB.Conn.Exec(ctx, `
CREATE OR REPLACE FUNCTION test_fail_task_transition() RETURNS trigger
LANGUAGE plpgsql AS $$
BEGIN
IF OLD.status = TG_ARGV[1]::smallint AND NEW.status = TG_ARGV[2]::smallint
AND (SELECT name FROM workflow_runs WHERE id = NEW.run_id) = TG_ARGV[0] THEN
RAISE EXCEPTION 'injected task transition failure';
END IF;
RETURN NEW;
END;
$$`)
require.NoError(t, err)
_, err = db.DB.Conn.Exec(ctx, fmt.Sprintf(`CREATE TRIGGER test_fail_task_transition
BEFORE UPDATE OF status ON workflow_tasks
FOR EACH ROW EXECUTE FUNCTION test_fail_task_transition('%s', '%d', '%d')`, runName, from, to))
require.NoError(t, err)
t.Cleanup(drop)
return drop
}
// requireAttemptLedger asserts attempt_count equals the ledger length: the two
// must never drift.
func requireAttemptLedger(t *testing.T, task *store.TaskRun, want int) {
t.Helper()
var attempts []struct {
N int `json:"n"`
}
require.NoError(t, json.Unmarshal(task.Attempts, &attempts))
require.Equal(t, want, task.AttemptCount)
require.Len(t, attempts, want, "attempt_count must equal jsonb_array_length(attempts)")
for i, attempt := range attempts {
require.Equal(t, i+1, attempt.N, "ledger entries must be numbered 1..attempt_count")
}
}
// seedPlan backdates next_retry_at so an immediate claim in the same test sees it.
func seedPlan(t *testing.T, db *store.Store, ctx context.Context, mgr *Manager, workflowName string, input any) *store.WorkflowRun {
t.Helper()
plan, stages, err := mgr.buildRun(ctx, workflowName, input, "")
require.NoError(t, err)
require.NoError(t, db.InsertRun(ctx, plan, stages))
makeDue(t, db, ctx, plan.ID)
return plan
}
func claim(t *testing.T, db *store.Store, ctx context.Context, runID uuid.UUID) *store.ClaimedRun {
t.Helper()
claimed, ok, err := db.ClaimRunByID(ctx, runID)
require.NoError(t, err)
require.True(t, ok)
return claimed
}
// recordingHandler tells failure branches apart when they leave identical rows.
type recordingHandler struct {
mu sync.Mutex
msgs []string
}
func (h *recordingHandler) Enabled(context.Context, slog.Level) bool { return true }
func (h *recordingHandler) Handle(_ context.Context, r slog.Record) error {
h.mu.Lock()
defer h.mu.Unlock()
h.msgs = append(h.msgs, r.Message)
return nil
}
func (h *recordingHandler) WithAttrs([]slog.Attr) slog.Handler { return h }
func (h *recordingHandler) WithGroup(string) slog.Handler { return h }
func (h *recordingHandler) messages() []string {
h.mu.Lock()
defer h.mu.Unlock()
return slices.Clone(h.msgs)
}
func countMessage(h *recordingHandler, msg string) int {
n := 0
for _, m := range h.messages() {
if m == msg {
n++
}
}
return n
}
func TestNextBackoff(t *testing.T) {
cfg := Config{BackoffBase: time.Second, BackoffMax: time.Minute}
schedule := []time.Duration{time.Second, 5 * time.Second, 30 * time.Second}
t.Run("an explicit schedule is indexed by the failed attempt", func(t *testing.T) {
sc := taskConfig{backoffSchedule: schedule}
require.Equal(t, time.Second, nextBackoff(sc, cfg, 1))
require.Equal(t, 5*time.Second, nextBackoff(sc, cfg, 2))
require.Equal(t, 30*time.Second, nextBackoff(sc, cfg, 3))
})
t.Run("attempts past the end clamp to the last entry", func(t *testing.T) {
sc := taskConfig{backoffSchedule: schedule}
require.Equal(t, 30*time.Second, nextBackoff(sc, cfg, 4))
require.Equal(t, 30*time.Second, nextBackoff(sc, cfg, 99))
})
t.Run("an attempt below one reads the first entry", func(t *testing.T) {
sc := taskConfig{backoffSchedule: schedule}
require.Equal(t, time.Second, nextBackoff(sc, cfg, 0))
require.Equal(t, time.Second, nextBackoff(sc, cfg, -1))
})
t.Run("no schedule falls through to exponential backoff", func(t *testing.T) {
require.Equal(t, time.Second, nextBackoff(taskConfig{}, cfg, 1))
require.Equal(t, 4*time.Second, nextBackoff(taskConfig{}, cfg, 3))
require.Equal(t, time.Minute, nextBackoff(taskConfig{}, cfg, 20))
})
t.Run("a task's own exponential bounds win over the config's", func(t *testing.T) {
sc := taskConfig{backoffBase: 10 * time.Millisecond, backoffMax: 20 * time.Millisecond}
require.Equal(t, 10*time.Millisecond, nextBackoff(sc, cfg, 1))
require.Equal(t, 20*time.Millisecond, nextBackoff(sc, cfg, 2))
})
}
func TestExecutor(t *testing.T) {
db := testDB(t)
ctx := t.Context()
t.Run("runs a two-stage plan to succeeded and stage two reads stage one's output", func(t *testing.T) {
reg := NewRegistry()
firstTask := NewTask[firstOut]("test.first")
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.io"),
Handle(firstTask, func(_ context.Context, run *TaskRun[testInput]) (firstOut, error) {
return firstOut{Token: run.Input.Seed + "-1"}, nil
}),
Handle(NewTask[secondOut]("test.second"), func(_ context.Context, run *TaskRun[testInput]) (secondOut, error) {
prev, err := Output(run, firstTask)
if err != nil {
return secondOut{}, err
}
return secondOut{Result: prev.Token + "-2"}, nil
}),
)))
mgr := newManager(t, db, reg)
p, err := mgr.start(ctx, "test.io", testInput{Seed: "abc"})
require.NoError(t, err)
awaitCtx, cancel := context.WithTimeout(ctx, 10*time.Second)
defer cancel()
status, err := p.Await(awaitCtx)
require.NoError(t, err)
require.Equal(t, StatusSucceeded, status)
stages, err := db.GetTasks(ctx, p.ID())
require.NoError(t, err)
require.Equal(t, store.TaskStatusSucceeded, stages[0].Status)
require.Equal(t, store.TaskStatusSucceeded, stages[1].Status)
var got secondOut
require.NoError(t, json.Unmarshal(stages[1].Output, &got))
require.Equal(t, "abc-1-2", got.Result)
})
t.Run("crash-resume from every stage boundary completes exactly once", func(t *testing.T) {
const stageCount = 3
for b := range stageCount {
t.Run(fmt.Sprintf("boundary %d", b), func(t *testing.T) {
reg := NewRegistry()
counters := make([]*atomic.Int64, stageCount)
specs := make([]TaskSpec[testInput], stageCount)
for i := range stageCount {
counters[i] = new(atomic.Int64)
ctr := counters[i]
idx := i
specs[i] = Handle(NewTask[map[string]int](fmt.Sprintf("test.s%d", i)),
func(context.Context, *TaskRun[testInput]) (map[string]int, error) {
ctr.Add(1)
return map[string]int{"stage": idx}, nil
})
}
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.multi"), specs...)))
mgr := newManager(t, db, reg)
var p *WorkflowRun
require.NoError(t, pgx.BeginFunc(ctx, db.DB.Conn, func(tx pgx.Tx) error {
var e error
p, e = mgr.startTx(ctx, tx, "test.multi", testInput{Seed: "x"})
return e
}))
makeDue(t, db, ctx, p.ID())
first := claim(t, db, ctx, p.ID())
for s := range b {
ok, err := db.MarkTaskRunning(ctx, p.ID(), int16(s), first.ClaimID)
require.NoError(t, err)
require.True(t, ok)
ok, err = db.PersistTaskSuccess(ctx, p.ID(), int16(s), json.RawMessage(`{}`), first.ClaimID)
require.NoError(t, err)
require.True(t, ok)
}
ageClaim(t, db, ctx, p.ID(), first.ClaimID, time.Hour)
_, err := db.SweepStuck(ctx, time.Minute)
require.NoError(t, err)
released, err := db.GetRun(ctx, p.ID())
require.NoError(t, err)
require.Nil(t, released.ClaimedAt)
makeDue(t, db, ctx, p.ID())
resume := claim(t, db, ctx, p.ID())
require.Equal(t, StatusSucceeded, mgr.executePlan(ctx, resume))
got, err := db.GetRun(ctx, p.ID())
require.NoError(t, err)
require.Equal(t, StatusSucceeded, got.Status)
for s := range b {
require.EqualValues(t, 0, counters[s].Load(), "driven stage %d must not run on resume", s)
}
for s := b; s < stageCount; s++ {
require.EqualValues(t, 1, counters[s].Load(), "resumed stage %d must run exactly once", s)
}
})
}
})
t.Run("crash after final success before CompleteRun still completes", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.one"),
Handle(NewTask[any]("test.only"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return map[string]string{"v": "ok"}, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.one", testInput{Seed: "x"})
first := claim(t, db, ctx, plan.ID)
ok, err := db.MarkTaskRunning(ctx, plan.ID, 0, first.ClaimID)
require.NoError(t, err)
require.True(t, ok)
ok, err = db.PersistTaskSuccess(ctx, plan.ID, 0, json.RawMessage(`{"v":"ok"}`), first.ClaimID)
require.NoError(t, err)
require.True(t, ok)
ageClaim(t, db, ctx, plan.ID, first.ClaimID, time.Hour)
_, err = db.SweepStuck(ctx, time.Minute)
require.NoError(t, err)
makeDue(t, db, ctx, plan.ID)
resume := claim(t, db, ctx, plan.ID)
require.Equal(t, int16(1), resume.Run.CurrentTask)
require.Equal(t, StatusSucceeded, mgr.executePlan(ctx, resume))
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, StatusSucceeded, got.Status)
require.NotNil(t, got.CompletedAt)
require.EqualValues(t, 0, ran.Load())
})
t.Run("sweep preserves a skipped current stage", func(t *testing.T) {
reg := NewRegistry()
var skippedRan, secondRan atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.skipfirst"),
Handle(NewTask[any]("test.skipme"), func(context.Context, *TaskRun[testInput]) (any, error) {
skippedRan.Add(1)
return nil, nil
}).SkipIf(func(in testInput) bool { return in.Seed == "skip" }),
Handle(NewTask[any]("test.run"), func(context.Context, *TaskRun[testInput]) (any, error) {
secondRan.Add(1)
return map[string]string{"v": "ok"}, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.skipfirst", testInput{Seed: "skip"})
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSkipped, stages[0].Status)
first := claim(t, db, ctx, plan.ID)
ageClaim(t, db, ctx, plan.ID, first.ClaimID, time.Hour)
_, err = db.SweepStuck(ctx, time.Minute)
require.NoError(t, err)
swept, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSkipped, swept[0].Status)
require.Equal(t, 0, swept[0].AttemptCount)
makeDue(t, db, ctx, plan.ID)
resume := claim(t, db, ctx, plan.ID)
require.Equal(t, StatusSucceeded, mgr.executePlan(ctx, resume))
final, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSkipped, final[0].Status)
require.Equal(t, store.TaskStatusSucceeded, final[1].Status)
require.EqualValues(t, 0, skippedRan.Load())
require.EqualValues(t, 1, secondRan.Load())
})
t.Run("sweep preserves a pending current stage", func(t *testing.T) {
reg := NewRegistry()
var firstRan, secondRan atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.twopending"),
Handle(NewTask[any]("test.p0"), func(context.Context, *TaskRun[testInput]) (any, error) {
firstRan.Add(1)
return map[string]string{"v": "0"}, nil
}),
Handle(NewTask[any]("test.p1"), func(context.Context, *TaskRun[testInput]) (any, error) {
secondRan.Add(1)
return map[string]string{"v": "1"}, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.twopending", testInput{Seed: "x"})
// Crash at the boundary: claimed but never MarkTaskRunning'd.
first := claim(t, db, ctx, plan.ID)
ageClaim(t, db, ctx, plan.ID, first.ClaimID, time.Hour)
_, err := db.SweepStuck(ctx, time.Minute)
require.NoError(t, err)
swept, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, swept[0].Status)
require.Equal(t, 0, swept[0].AttemptCount)
makeDue(t, db, ctx, plan.ID)
resume := claim(t, db, ctx, plan.ID)
require.Equal(t, StatusSucceeded, mgr.executePlan(ctx, resume))
require.EqualValues(t, 1, firstRan.Load())
require.EqualValues(t, 1, secondRan.Load())
})
t.Run("shutdown mid-stage does not burn an attempt and drains fast", func(t *testing.T) {
newBlockingMgr := func(ret func() (any, error), started, proceed chan struct{}, counter *atomic.Int64) (*Manager, *store.WorkflowRun) {
reg := NewRegistry()
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.block"),
Handle(NewTask[any]("test.block"), func(context.Context, *TaskRun[testInput]) (any, error) {
if counter != nil {
counter.Add(1)
}
close(started)
<-proceed
return ret()
}),
Handle(NewTask[any]("test.after"), func(context.Context, *TaskRun[testInput]) (any, error) {
return map[string]string{"v": "after"}, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.block", testInput{Seed: "x"})
return mgr, plan
}
t.Run("interrupted handler is not attempted", func(t *testing.T) {
started, proceed := make(chan struct{}), make(chan struct{})
mgr, plan := newBlockingMgr(func() (any, error) { return nil, errors.New("interrupted") }, started, proceed, nil)
claimed := claim(t, db, ctx, plan.ID)
done := make(chan Status, 1)
go func() { done <- mgr.executePlan(ctx, claimed) }()
<-started
mgr.draining.Store(true)
close(proceed)
require.Equal(t, StatusRunning, <-done)
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.Equal(t, int16(0), got.CurrentTask)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
require.Equal(t, 0, stages[0].AttemptCount)
makeDue(t, db, ctx, plan.ID)
_, ok, err := db.ClaimRunByID(ctx, plan.ID)
require.NoError(t, err)
require.True(t, ok)
})
t.Run("a just-succeeded handler persists then releases for immediate re-claim", func(t *testing.T) {
started, proceed := make(chan struct{}), make(chan struct{})
mgr, plan := newBlockingMgr(func() (any, error) { return map[string]string{"v": "done"}, nil }, started, proceed, nil)
claimed := claim(t, db, ctx, plan.ID)
done := make(chan Status, 1)
go func() { done <- mgr.executePlan(ctx, claimed) }()
<-started
mgr.draining.Store(true)
close(proceed)
require.Equal(t, StatusRunning, <-done)
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, int16(1), got.CurrentTask)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.WithinDuration(t, time.Now(), got.NextRetryAt, 10*time.Second)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSucceeded, stages[0].Status)
require.NotNil(t, stages[0].Output)
})
t.Run("drain observed at a boundary starts no further unit", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.boundary"),
Handle(NewTask[any]("test.boundary"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return nil, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.boundary", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
mgr.draining.Store(true)
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claimed))
require.EqualValues(t, 0, ran.Load())
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
})
})
t.Run("a cancelled poller context still lands the drain-path writes", func(t *testing.T) {
t.Run("a handler that finished as the poller stopped is persisted and released", func(t *testing.T) {
reg := NewRegistry()
started := make(chan struct{})
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.polldrain"),
Handle(NewTask[any]("test.polldrain.first"), func(taskCtx context.Context, _ *TaskRun[testInput]) (any, error) {
close(started)
// Respects cancellation and returns work it already finished.
<-taskCtx.Done()
return map[string]string{"v": "done"}, nil
}),
Handle(NewTask[any]("test.polldrain.second"), func(context.Context, *TaskRun[testInput]) (any, error) {
return map[string]string{"v": "after"}, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.polldrain", testInput{Seed: "x"})
runnerCtx, cancel := context.WithCancel(ctx)
defer cancel()
stopped := make(chan error, 1)
go func() {
stopped <- mgr.NewRunnable(RunnerConfig{PollInterval: 10 * time.Millisecond}).Run(runnerCtx)
}()
<-started
cancel()
require.NoError(t, <-stopped)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSucceeded, stages[0].Status)
require.NotNil(t, stages[0].Output)
require.Equal(t, 0, stages[0].AttemptCount)
require.Equal(t, store.TaskStatusPending, stages[1].Status)
require.Nil(t, stages[1].Output)
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.Equal(t, int16(1), got.CurrentTask)
})
t.Run("a drain observed at a task boundary releases the claim", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.cancelboundary"),
Handle(NewTask[any]("test.cancelboundary"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return nil, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.cancelboundary", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
runCtx, cancel := context.WithCancel(ctx)
cancel()
require.Equal(t, StatusRunning, mgr.executePlan(runCtx, claimed))
require.EqualValues(t, 0, ran.Load())
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
})
t.Run("a heartbeat that cannot land releases the claim", func(t *testing.T) {
mgr := newManager(t, db, twoStageRegistry(t))
plan := seedPlan(t, db, ctx, mgr, "test.twostage", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
running, err := db.MarkTaskRunning(ctx, plan.ID, 0, claimed.ClaimID)
require.NoError(t, err)
require.True(t, running)
runCtx, cancel := context.WithCancel(ctx)
cancel()
require.False(t, mgr.heartbeat(runCtx, plan.ID, 0, claimed.ClaimID))
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
})
t.Run("a cancellation after the last task still completes the run", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.cancelcomplete"),
Handle(NewTask[any]("test.cancelcomplete"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return nil, nil
}),
)))
mgr := newManager(t, db, reg)
plan := seedPlan(t, db, ctx, mgr, "test.cancelcomplete", testInput{Seed: "x"})
// Stands in for an executor that persisted the last task and advanced
// past it, so only the completion write is owed.
claimed := claim(t, db, ctx, plan.ID)
advanced, err := db.PersistTaskSuccess(ctx, plan.ID, 0, json.RawMessage(`{"v":"done"}`), claimed.ClaimID)
require.NoError(t, err)
require.True(t, advanced)
require.NoError(t, db.ReleaseClaim(ctx, plan.ID, 0, claimed.ClaimID))
makeDue(t, db, ctx, plan.ID)
resumed := claim(t, db, ctx, plan.ID)
require.Equal(t, int16(1), resumed.Run.CurrentTask)
runCtx, cancel := context.WithCancel(ctx)
cancel()
require.Equal(t, StatusSucceeded, mgr.executePlan(runCtx, resumed))
require.EqualValues(t, 0, ran.Load())
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, StatusSucceeded, got.Status)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSucceeded, stages[0].Status)
})
})
t.Run("retries with backoff then succeeds", func(t *testing.T) {
reg := NewRegistry()
var calls atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.retry"),
Handle(NewTask[any]("test.retry"), func(context.Context, *TaskRun[testInput]) (any, error) {
if calls.Add(1) <= 2 {
return nil, errors.New("transient")
}
return map[string]string{"v": "ok"}, nil
}, Backoff(10*time.Millisecond, 50*time.Millisecond), MaxAttempts(5)),
)))
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{MaxInProcessBackoff: time.Second}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.retry", testInput{Seed: "x"})
require.Equal(t, StatusSucceeded, mgr.executePlan(ctx, claim(t, db, ctx, plan.ID)))
require.EqualValues(t, 3, calls.Load())
require.Equal(t, 2, countMessage(rec, "workflow: task attempt failed"))
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, StatusSucceeded, got.Status)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusSucceeded, stages[0].Status)
require.Equal(t, 2, stages[0].AttemptCount)
})
t.Run("a long backoff releases the claim with a DB-computed next_retry_at", func(t *testing.T) {
reg := NewRegistry()
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.longbackoff"),
Handle(NewTask[any]("test.longbackoff"), func(context.Context, *TaskRun[testInput]) (any, error) {
return nil, errors.New("transient")
}, Backoff(20*time.Second, time.Minute), MaxAttempts(5)),
)))
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.longbackoff", testInput{Seed: "x"})
before := time.Now()
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claim(t, db, ctx, plan.ID)))
require.Equal(t, 1, countMessage(rec, "workflow: task attempt failed"))
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, StatusRunning, got.Status)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.WithinDuration(t, before.Add(20*time.Second), got.NextRetryAt, 5*time.Second)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
require.Equal(t, 1, stages[0].AttemptCount)
})
t.Run("a shutdown during an in-process backoff keeps the recorded delay", func(t *testing.T) {
reg := NewRegistry()
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.backoffdrain"),
Handle(NewTask[any]("test.backoffdrain"), func(context.Context, *TaskRun[testInput]) (any, error) {
return nil, errors.New("transient")
}, Backoff(30*time.Second, time.Minute), MaxAttempts(3)),
)))
mgr := newManager(t, db, reg, func(c *Config) { c.MaxInProcessBackoff = time.Minute })
plan := seedPlan(t, db, ctx, mgr, "test.backoffdrain", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
runCtx, cancel := context.WithCancel(ctx)
defer cancel()
done := make(chan Status, 1)
go func() { done <- mgr.executePlan(runCtx, claimed) }()
// Cancel once the failure is recorded so shutdown lands inside the sleep.
require.Eventually(t, func() bool {
stages, err := db.GetTasks(ctx, plan.ID)
return err == nil && stages[0].AttemptCount == 1
}, 5*time.Second, 10*time.Millisecond)
cancel()
require.Equal(t, StatusRunning, <-done)
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.WithinDuration(t, time.Now().Add(30*time.Second), got.NextRetryAt, 5*time.Second)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
require.Equal(t, 1, stages[0].AttemptCount)
})
t.Run("a BackoffSchedule delay above MaxInProcessBackoff releases the claim", func(t *testing.T) {
reg := NewRegistry()
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.schedrelease"),
Handle(NewTask[any]("test.schedrelease"), func(context.Context, *TaskRun[testInput]) (any, error) {
return nil, errors.New("transient")
}, BackoffSchedule([]time.Duration{30 * time.Second, time.Minute}), MaxAttempts(5)),
)))
mgr := newManager(t, db, reg, func(c *Config) { c.MaxInProcessBackoff = time.Second })
plan := seedPlan(t, db, ctx, mgr, "test.schedrelease", testInput{Seed: "x"})
before := time.Now()
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claim(t, db, ctx, plan.ID)))
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.WithinDuration(t, before.Add(30*time.Second), got.NextRetryAt, 5*time.Second)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
require.Equal(t, 1, stages[0].AttemptCount)
})
t.Run("MaxAttempts caps a task whose BackoffSchedule is shorter than its budget", func(t *testing.T) {
reg := NewRegistry()
var calls atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.schedclamp"),
Handle(NewTask[any]("test.schedclamp"), func(context.Context, *TaskRun[testInput]) (any, error) {
calls.Add(1)
return nil, errors.New("always fails")
}, BackoffSchedule([]time.Duration{5 * time.Millisecond}), MaxAttempts(4)),
)))
mgr := newManager(t, db, reg, func(c *Config) { c.MaxInProcessBackoff = time.Second })
plan := seedPlan(t, db, ctx, mgr, "test.schedclamp", testInput{Seed: "x"})
require.Equal(t, StatusStuck, mgr.executePlan(ctx, claim(t, db, ctx, plan.ID)))
require.EqualValues(t, 4, calls.Load(), "the schedule's length must not cap attempts")
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusStuck, stages[0].Status)
requireAttemptLedger(t, stages[0], 4)
})
t.Run("heartbeat", func(t *testing.T) {
reg := NewRegistry()
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.heartbeat"),
Handle(NewTask[any]("test.heartbeat"), func(context.Context, *TaskRun[testInput]) (any, error) {
return nil, nil
}),
)))
t.Run("a lost claim takes the release path, not the error path", func(t *testing.T) {
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.heartbeat", testInput{Seed: "x"})
claim(t, db, ctx, plan.ID)
require.False(t, mgr.heartbeat(ctx, plan.ID, 0, uuid.New()))
require.Empty(t, rec.messages(), "a stolen claim is not a DB failure")
})
t.Run("a DB error releases the claim and keeps the persisted retry time", func(t *testing.T) {
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.heartbeat", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
ok, err := db.MarkTaskRunning(ctx, plan.ID, 0, claimed.ClaimID)
require.NoError(t, err)
require.True(t, ok)
backOffRun(t, db, ctx, plan.ID)
drop := failHeartbeats(t, db, ctx, "test.heartbeat")
require.False(t, mgr.heartbeat(ctx, plan.ID, 0, claimed.ClaimID))
drop()
require.Contains(t, rec.messages(), "workflow: heartbeat failed")
require.NotContains(t, rec.messages(), "workflow: release claim failed")
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
require.WithinDuration(t, time.Now().Add(time.Minute), got.NextRetryAt, 5*time.Second)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
})
})
t.Run("a MarkTaskRunning DB error releases the claim", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.markfail"),
Handle(NewTask[any]("test.markfail"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return nil, nil
}),
)))
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.markfail", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
drop := failTaskTransition(t, db, ctx, "test.markfail", store.TaskStatusPending, store.TaskStatusRunning)
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claimed))
drop()
require.EqualValues(t, 0, ran.Load())
require.Contains(t, rec.messages(), "workflow: mark task running failed")
require.NotContains(t, rec.messages(), "workflow: release claim failed")
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.Nil(t, got.ClaimedAt)
require.Nil(t, got.ClaimID)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusPending, stages[0].Status)
require.Equal(t, 0, stages[0].AttemptCount)
// Claimable now, not after SweepMaxAge.
_, ok, err := db.ClaimRunByID(ctx, plan.ID)
require.NoError(t, err)
require.True(t, ok)
})
t.Run("a PersistTaskSuccess DB error keeps the claim so the sweep charges the attempt", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.persistfail"),
Handle(NewTask[any]("test.persistfail"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return map[string]string{"v": "done"}, nil
}, MaxAttempts(1)),
)))
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.persistfail", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
drop := failTaskTransition(t, db, ctx, "test.persistfail", store.TaskStatusRunning, store.TaskStatusSucceeded)
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claimed))
drop()
require.EqualValues(t, 1, ran.Load())
require.Contains(t, rec.messages(), "workflow: persist task success failed")
got, err := db.GetRun(ctx, plan.ID)
require.NoError(t, err)
require.NotNil(t, got.ClaimID)
require.Equal(t, claimed.ClaimID, *got.ClaimID)
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusRunning, stages[0].Status)
require.Equal(t, 0, stages[0].AttemptCount)
// Not claimable until the sweeper has counted the attempt that ran.
_, ok, err := db.ClaimRunByID(ctx, plan.ID)
require.NoError(t, err)
require.False(t, ok)
ageClaim(t, db, ctx, plan.ID, claimed.ClaimID, time.Hour)
_, err = db.SweepStuck(ctx, time.Minute)
require.NoError(t, err)
stages, err = db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, 1, stages[0].AttemptCount)
// The budget, not the failing write, decides whether the handler runs again.
require.Equal(t, StatusStuck, mgr.executePlan(ctx, claim(t, db, ctx, plan.ID)))
require.EqualValues(t, 1, ran.Load())
})
t.Run("a ParkRunAfterAttempt DB error keeps the claim so the sweep charges the attempt", func(t *testing.T) {
reg := NewRegistry()
var ran atomic.Int64
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.parkfail"),
Handle(NewTask[any]("test.parkfail"), func(context.Context, *TaskRun[testInput]) (any, error) {
ran.Add(1)
return nil, Permanent(errors.New("rejected"))
}, MaxAttempts(1)),
)))
rec := new(recordingHandler)
mgr, err := NewManager(t.Context(), db.DB, reg, Config{}, slog.New(rec))
require.NoError(t, err)
plan := seedPlan(t, db, ctx, mgr, "test.parkfail", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
drop := failTaskTransition(t, db, ctx, "test.parkfail", store.TaskStatusRunning, store.TaskStatusStuck)
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claimed))
drop()
require.EqualValues(t, 1, ran.Load())
require.Contains(t, rec.messages(), "workflow: park run failed")
stages, err := db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusRunning, stages[0].Status)
require.Equal(t, 0, stages[0].AttemptCount)
_, ok, err := db.ClaimRunByID(ctx, plan.ID)
require.NoError(t, err)
require.False(t, ok)
ageClaim(t, db, ctx, plan.ID, claimed.ClaimID, time.Hour)
_, err = db.SweepStuck(ctx, time.Minute)
require.NoError(t, err)
require.Equal(t, StatusStuck, mgr.executePlan(ctx, claim(t, db, ctx, plan.ID)))
require.EqualValues(t, 1, ran.Load())
stages, err = db.GetTasks(ctx, plan.ID)
require.NoError(t, err)
require.Equal(t, store.TaskStatusStuck, stages[0].Status)
require.Equal(t, 1, stages[0].AttemptCount)
})
t.Run("a heartbeat DB error at the failure boundary", func(t *testing.T) {
reg := NewRegistry()
require.NoError(t, reg.Register(Define(NewWorkflow[testInput]("test.hbfailure"),
Handle(NewTask[any]("test.hbfailure"), func(context.Context, *TaskRun[testInput]) (any, error) {
return nil, errors.New("transient")
}, Backoff(10*time.Millisecond, 50*time.Millisecond), MaxAttempts(5)),
)))
failOnce := func(t *testing.T) (*store.WorkflowRun, uuid.UUID) {
t.Helper()
mgr := newManager(t, db, reg, func(c *Config) { c.MaxInProcessBackoff = time.Second })
plan := seedPlan(t, db, ctx, mgr, "test.hbfailure", testInput{Seed: "x"})
claimed := claim(t, db, ctx, plan.ID)
drop := failHeartbeats(t, db, ctx, "test.hbfailure")
require.Equal(t, StatusRunning, mgr.executePlan(ctx, claimed))
drop()
return plan, claimed.ClaimID
}
t.Run("releases the claim instead of stalling until the sweep", func(t *testing.T) {