-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpgqueue_test.go
More file actions
817 lines (662 loc) · 25.7 KB
/
pgqueue_test.go
File metadata and controls
817 lines (662 loc) · 25.7 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
package pgqueue_test
import (
"context"
"fmt"
"os"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/goware/pgkit/v2"
"github.com/goware/pgqueue"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
var db *pgkit.DB
func TestMain(m *testing.M) {
host := envOr("PGQUEUE_TEST_HOST", "localhost")
user := envOr("PGQUEUE_TEST_USER", "postgres")
pass := envOr("PGQUEUE_TEST_PASS", "postgres")
name := envOr("PGQUEUE_TEST_DB", "pgqueue_test")
var err error
db, err = pgkit.Connect("pgqueue_test", pgkit.Config{
Database: name,
Host: host,
Username: user,
Password: pass,
})
if err != nil {
fmt.Fprintf(os.Stderr, "pgqueue_test: connect: %v (set PGQUEUE_TEST_* env to configure)\n", err)
os.Exit(1)
}
if err := db.Conn.Ping(context.Background()); err != nil {
fmt.Fprintf(os.Stderr, "pgqueue_test: ping: %v\n", err)
os.Exit(1)
}
os.Exit(m.Run())
}
func envOr(key, fallback string) string {
if v := os.Getenv(key); v != "" {
return v
}
return fallback
}
func setupQueue(t *testing.T) *pgqueue.Queue {
t.Helper()
ctx := t.Context()
q := pgqueue.New(db)
require.NoError(t, pgqueue.Migrate(ctx, q))
_, err := db.Conn.Exec(ctx, "TRUNCATE pgqueue_tasks")
require.NoError(t, err)
return q
}
// startWorker launches a worker in a goroutine and returns a function to
// collect the Start error. Replaces bare `go func() { _ = w.Start(...) }()`.
func startWorker(t *testing.T, w *pgqueue.Worker, ctx context.Context) (startErr func() error) {
t.Helper()
ch := make(chan error, 1)
go func() { ch <- w.Start(ctx) }()
// Wait for worker to reach running state.
require.Eventually(t, w.IsRunning, 5*time.Second, 10*time.Millisecond, "worker did not start in time")
return func() error { return <-ch }
}
// --- Test payloads ---
type EmailPayload struct {
To string `json:"to"`
Subject string `json:"subject"`
}
var emailSpec = pgqueue.JobSpec[EmailPayload]{
Queue: "send-email",
HashFn: func(p EmailPayload) *string {
h := p.To + ":" + p.Subject
return &h
},
MaxRetries: 2,
RetryDelay: 100 * time.Millisecond,
}
type CounterPayload struct {
Count int `json:"count"`
}
var counterTickerSpec = pgqueue.TickerSpec[CounterPayload]{
Queue: "counter",
Key: "counter-singleton",
InitialPayload: CounterPayload{Count: 0},
Every: 100 * time.Millisecond,
MaxRetries: 2,
RetryDelay: 50 * time.Millisecond,
LeaseDuration: 10 * time.Second,
FinalizeBuffer: 1 * time.Second,
}
// --- Enqueue tests ---
func TestEnqueue(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
t.Run("enqueue and get", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "a@b.com", Subject: "hi"})
require.NoError(t, err)
require.NotZero(t, id)
task, err := q.Get(ctx, id)
require.NoError(t, err)
assert.Equal(t, "send-email", task.Queue)
assert.Equal(t, pgqueue.TaskStatusPending, task.Status)
var p EmailPayload
require.NoError(t, task.DecodePayload(&p))
assert.Equal(t, "a@b.com", p.To)
})
t.Run("dedup with ignore duplicates", func(t *testing.T) {
_, err := db.Conn.Exec(ctx, "TRUNCATE pgqueue_tasks")
require.NoError(t, err)
id1, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "x@y.com", Subject: "dup"}, pgqueue.WithIgnoreDuplicates())
require.NoError(t, err)
id2, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "x@y.com", Subject: "dup"}, pgqueue.WithIgnoreDuplicates())
require.NoError(t, err)
assert.Equal(t, id1, id2, "should return same ID for duplicate")
})
t.Run("ignore duplicates requires hash", func(t *testing.T) {
noHashSpec := pgqueue.JobSpec[EmailPayload]{Queue: "no-hash"}
_, err := pgqueue.Enqueue(ctx, q, noHashSpec, EmailPayload{To: "a@b.com", Subject: "hi"}, pgqueue.WithIgnoreDuplicates())
require.Error(t, err)
assert.Contains(t, err.Error(), "WithIgnoreDuplicates requires")
})
t.Run("find by queue and hash", func(t *testing.T) {
_, err := db.Conn.Exec(ctx, "TRUNCATE pgqueue_tasks")
require.NoError(t, err)
_, err = pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "find@me.com", Subject: "test"})
require.NoError(t, err)
task, err := q.Find(ctx, "send-email", "find@me.com:test")
require.NoError(t, err)
assert.Equal(t, "send-email", task.Queue)
})
}
// --- Cancel tests ---
func TestCancel(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
t.Run("cancel pending task", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "c@d.com", Subject: "cancel"})
require.NoError(t, err)
require.NoError(t, q.Cancel(ctx, id))
_, err = q.Get(ctx, id)
require.ErrorIs(t, err, pgqueue.ErrTaskNotFound, "cancelled task should be deleted")
})
t.Run("cancel non-pending fails", func(t *testing.T) {
err := q.Cancel(ctx, 99999999)
require.ErrorIs(t, err, pgqueue.ErrTaskNotFound)
})
}
// --- Recovery tests ---
func TestRecovery(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
t.Run("enable failed task", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "r@r.com", Subject: "fail"})
require.NoError(t, err)
_, err = db.Conn.Exec(ctx, "UPDATE pgqueue_tasks SET status = $1, try = 3 WHERE id = $2", pgqueue.TaskStatusFailed, id)
require.NoError(t, err)
require.NoError(t, q.Enable(ctx, id))
task, err := q.Get(ctx, id)
require.NoError(t, err)
assert.Equal(t, pgqueue.TaskStatusPending, task.Status)
assert.Equal(t, int16(0), task.Try)
})
t.Run("enable running task fails", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "r@r.com", Subject: "run"})
require.NoError(t, err)
now := time.Now().UTC()
token := "test-token"
_, err = db.Conn.Exec(ctx,
"UPDATE pgqueue_tasks SET status = $1, claimed_at = $2, lease_until = $3, claim_token = $4 WHERE id = $5",
pgqueue.TaskStatusRunning, now, now.Add(5*time.Minute), token, id,
)
require.NoError(t, err)
err = q.Enable(ctx, id)
require.ErrorIs(t, err, pgqueue.ErrTaskNotRecoverable)
})
t.Run("enable pending task fails", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "r@r.com", Subject: "pend"})
require.NoError(t, err)
err = q.Enable(ctx, id)
require.ErrorIs(t, err, pgqueue.ErrTaskNotRecoverable)
})
t.Run("replace payload on disabled task", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "old@old.com", Subject: "old"})
require.NoError(t, err)
_, err = db.Conn.Exec(ctx, "UPDATE pgqueue_tasks SET status = $1 WHERE id = $2", pgqueue.TaskStatusDisabled, id)
require.NoError(t, err)
require.NoError(t, pgqueue.ReplacePayloadJSON(ctx, q, id, EmailPayload{To: "new@new.com", Subject: "fixed"}))
task, err := q.Get(ctx, id)
require.NoError(t, err)
var p EmailPayload
require.NoError(t, task.DecodePayload(&p))
assert.Equal(t, "new@new.com", p.To)
})
t.Run("replace payload rejects invalid json", func(t *testing.T) {
id, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "x@x.com", Subject: "x"})
require.NoError(t, err)
_, err = db.Conn.Exec(ctx, "UPDATE pgqueue_tasks SET status = $1 WHERE id = $2", pgqueue.TaskStatusFailed, id)
require.NoError(t, err)
err = q.ReplacePayload(ctx, id, []byte(`{invalid`))
require.Error(t, err)
assert.Contains(t, err.Error(), "not valid JSON")
})
}
// --- Worker: job handler ---
type countingHandler struct {
count atomic.Int32
started chan struct{} // closed on first RunTask call
once sync.Once
}
func newCountingHandler() *countingHandler {
return &countingHandler{started: make(chan struct{})}
}
func (h *countingHandler) RunTask(_ context.Context, _ *pgqueue.Job[EmailPayload]) pgqueue.Result {
h.once.Do(func() { close(h.started) })
h.count.Add(1)
return pgqueue.Done()
}
func TestWorkerJobHappyPath(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
handler := newCountingHandler()
w := pgqueue.NewWorker(q)
spec := emailSpec
spec.PollInterval = 50 * time.Millisecond
spec.LeaseDuration = 10 * time.Second
spec.FinalizeBuffer = 1 * time.Second
require.NoError(t, pgqueue.Register(w, spec, handler))
_, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "w@w.com", Subject: "work"})
require.NoError(t, err)
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
require.Eventually(t, func() bool { return handler.count.Load() >= 1 }, 5*time.Second, 50*time.Millisecond)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx))
workerCancel()
require.NoError(t, collectErr())
tasks, _, err := q.List(ctx, nil, nil, nil)
require.NoError(t, err)
require.Len(t, tasks, 1)
assert.Equal(t, pgqueue.TaskStatusCompleted, tasks[0].Status)
}
// --- Worker: no double-processing ---
func TestWorkerNoDoubleProcess(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
var processed sync.Map
var dupes atomic.Int32
spec := emailSpec
spec.PollInterval = 50 * time.Millisecond
spec.LeaseDuration = 10 * time.Second
spec.FinalizeBuffer = 1 * time.Second
for i := range 20 {
noHashSpec := pgqueue.JobSpec[EmailPayload]{Queue: "send-email"}
_, err := pgqueue.Enqueue(ctx, q, noHashSpec, EmailPayload{To: fmt.Sprintf("u%d@test.com", i), Subject: "test"})
require.NoError(t, err)
}
workers := make([]*pgqueue.Worker, 3)
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
var collectErrs []func() error
for i := range workers {
h := pgqueue.JobHandlerFunc[EmailPayload](func(_ context.Context, job *pgqueue.Job[EmailPayload]) pgqueue.Result {
if _, loaded := processed.LoadOrStore(job.Task.ID, true); loaded {
dupes.Add(1)
}
time.Sleep(10 * time.Millisecond)
return pgqueue.Done()
})
workers[i] = pgqueue.NewWorker(q)
require.NoError(t, pgqueue.Register(workers[i], spec, h))
collectErrs = append(collectErrs, startWorker(t, workers[i], workerCtx))
}
require.Eventually(t, func() bool {
count := 0
processed.Range(func(_, _ any) bool { count++; return true })
return count >= 20
}, 10*time.Second, 100*time.Millisecond)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
for _, w := range workers {
require.NoError(t, w.Stop(drainCtx))
}
workerCancel()
for _, f := range collectErrs {
require.NoError(t, f())
}
assert.Zero(t, dupes.Load(), "no task should be processed twice")
}
// --- Worker: retry and max retries ---
type failingHandler struct {
attempts atomic.Int32
}
func (h *failingHandler) RunTask(_ context.Context, _ *pgqueue.Job[EmailPayload]) pgqueue.Result {
h.attempts.Add(1)
return pgqueue.Retry(fmt.Errorf("transient error"))
}
func TestWorkerRetry(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
handler := &failingHandler{}
spec := emailSpec
spec.PollInterval = 50 * time.Millisecond
spec.MaxRetries = 2
spec.RetryDelay = 50 * time.Millisecond
spec.LeaseDuration = 10 * time.Second
spec.FinalizeBuffer = 1 * time.Second
w := pgqueue.NewWorker(q)
require.NoError(t, pgqueue.Register(w, spec, handler))
_, err := pgqueue.Enqueue(ctx, q, emailSpec, EmailPayload{To: "retry@test.com", Subject: "retry"})
require.NoError(t, err)
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
require.Eventually(t, func() bool {
tasks, _, _ := q.List(ctx, nil, nil, nil)
return len(tasks) == 1 && tasks[0].Status == pgqueue.TaskStatusFailed
}, 5*time.Second, 100*time.Millisecond)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx))
workerCancel()
require.NoError(t, collectErr())
assert.GreaterOrEqual(t, handler.attempts.Load(), int32(2))
}
// --- Worker: ticker ---
type counterTickerHandler struct {
runs atomic.Int32
}
func (h *counterTickerHandler) RunTick(_ context.Context, job *pgqueue.Job[CounterPayload]) pgqueue.Result {
job.Payload.Count++
h.runs.Add(1)
return pgqueue.Done()
}
func TestWorkerTicker(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
handler := &counterTickerHandler{}
w := pgqueue.NewWorker(q)
require.NoError(t, pgqueue.RegisterTicker(w, counterTickerSpec, handler))
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
require.Eventually(t, func() bool { return handler.runs.Load() >= 3 }, 5*time.Second, 50*time.Millisecond)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx))
workerCancel()
require.NoError(t, collectErr())
task, err := q.Find(ctx, "counter", "counter-singleton")
require.NoError(t, err)
var p CounterPayload
require.NoError(t, task.DecodePayload(&p))
assert.GreaterOrEqual(t, p.Count, 3, "ticker payload should persist across runs")
}
// --- Worker: stale finalize after reap ---
func TestWorkerStaleFinalize(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
// Handler that blocks on its own signal — ignores context deadline so the
// poll goroutine stays stuck past lease expiry.
handlerStarted := make(chan struct{})
releaseHandler := make(chan struct{})
blocking := pgqueue.JobHandlerFunc[EmailPayload](func(_ context.Context, _ *pgqueue.Job[EmailPayload]) pgqueue.Result {
close(handlerStarted)
<-releaseHandler // block until test releases
return pgqueue.Done()
})
// Worker A: very short lease so we can manually reap.
wA := pgqueue.NewWorker(q)
specA := pgqueue.JobSpec[EmailPayload]{
Queue: "stale-test",
PollInterval: 50 * time.Millisecond,
LeaseDuration: 500 * time.Millisecond,
FinalizeBuffer: 100 * time.Millisecond,
}
require.NoError(t, pgqueue.Register(wA, specA, blocking))
// Worker B: completes tasks normally.
completedByB := make(chan int64, 1)
handlerB := pgqueue.JobHandlerFunc[EmailPayload](func(_ context.Context, job *pgqueue.Job[EmailPayload]) pgqueue.Result {
completedByB <- job.Task.ID
return pgqueue.Done()
})
wB := pgqueue.NewWorker(q)
specB := pgqueue.JobSpec[EmailPayload]{
Queue: "stale-test",
PollInterval: 50 * time.Millisecond,
LeaseDuration: 10 * time.Second,
FinalizeBuffer: 1 * time.Second,
}
require.NoError(t, pgqueue.Register(wB, specB, handlerB))
// Enqueue one task.
id, err := pgqueue.Enqueue(ctx, q, pgqueue.JobSpec[EmailPayload]{Queue: "stale-test"}, EmailPayload{To: "stale@test.com", Subject: "stale"})
require.NoError(t, err)
// Start worker A — it will claim the task and block in the handler.
ctxA, cancelA := context.WithCancel(ctx)
defer cancelA()
collectA := startWorker(t, wA, ctxA)
// Wait for handler A to start executing.
select {
case <-handlerStarted:
case <-time.After(5 * time.Second):
t.Fatal("handler A did not start")
}
// Wait for lease to actually expire in the DB.
require.Eventually(t, func() bool {
task, err := q.Get(ctx, id)
return err == nil && task.LeaseUntil != nil && task.LeaseUntil.Before(time.Now().UTC())
}, 3*time.Second, 50*time.Millisecond, "lease should expire in the DB")
// Manually reap: reset the expired task to pending (simulates reaper).
// Enforces lease_until < NOW() — same condition as the real reaper.
tag, err := db.Conn.Exec(ctx,
"UPDATE pgqueue_tasks SET status = $1, run_at = NOW(), claimed_at = NULL, lease_until = NULL, claim_token = NULL WHERE id = $2 AND status = $3 AND lease_until < NOW()",
pgqueue.TaskStatusPending, id, pgqueue.TaskStatusRunning,
)
require.NoError(t, err)
require.Equal(t, int64(1), tag.RowsAffected(), "reap should affect 1 row (lease expired)")
// Start worker B — it will reclaim the reaped task with a new claim_token.
ctxB, cancelB := context.WithCancel(ctx)
defer cancelB()
collectB := startWorker(t, wB, ctxB)
// Wait for B to complete the task.
select {
case completedID := <-completedByB:
assert.Equal(t, id, completedID)
case <-time.After(5 * time.Second):
t.Fatal("worker B did not pick up reaped task")
}
// Verify task is completed (by worker B).
require.Eventually(t, func() bool {
task, err := q.Get(ctx, id)
return err == nil && task.Status == pgqueue.TaskStatusCompleted
}, 3*time.Second, 50*time.Millisecond)
// Snapshot task state after B completed it, before releasing A.
// B's claim incremented Try to 2 (A had it at 1). If A's stale finalize
// overwrites the row, Try would revert to 1.
taskBeforeRelease, err := q.Get(ctx, id)
require.NoError(t, err)
require.Equal(t, pgqueue.TaskStatusCompleted, taskBeforeRelease.Status)
require.Equal(t, int16(2), taskBeforeRelease.Try, "B's claim should have incremented Try to 2")
// Release worker A's handler. It will return Done(), then poll() will
// attempt to finalize with the OLD claim_token → 0 rows (fenced out).
close(releaseHandler)
// Cancel worker A and wait for Start to return — this guarantees the
// poll goroutine (including the stale finalize attempt) has completed.
cancelA()
require.NoError(t, collectA()) // Start returns nil after context cancel + clean exit
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, wB.Stop(drainCtx))
cancelB()
require.NoError(t, collectB())
// Final verification: compare full row against snapshot.
// If A's stale finalize clobbered B, Try would be 1 (not 2) and
// other fields could differ.
taskAfterRelease, err := q.Get(ctx, id)
require.NoError(t, err)
assert.Equal(t, pgqueue.TaskStatusCompleted, taskAfterRelease.Status, "status must still be completed")
assert.Equal(t, taskBeforeRelease.Try, taskAfterRelease.Try, "Try must not change (stale finalize fenced)")
assert.Equal(t, taskBeforeRelease.LastRanAt, taskAfterRelease.LastRanAt, "LastRanAt must not change")
}
// --- Worker: handler context deadline ---
func TestWorkerHandlerDeadline(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
var gotDeadline atomic.Bool
var deadlineWithin atomic.Bool
handler := pgqueue.JobHandlerFunc[EmailPayload](func(ctx context.Context, _ *pgqueue.Job[EmailPayload]) pgqueue.Result {
deadline, ok := ctx.Deadline()
gotDeadline.Store(ok)
if ok {
// Deadline should be roughly leaseUntil - finalizeBuffer from now.
remaining := time.Until(deadline)
// LeaseDuration=2s, FinalizeBuffer=500ms → ~1.5s remaining.
deadlineWithin.Store(remaining > 500*time.Millisecond && remaining < 3*time.Second)
}
return pgqueue.Done()
})
w := pgqueue.NewWorker(q)
spec := pgqueue.JobSpec[EmailPayload]{
Queue: "deadline-test",
PollInterval: 50 * time.Millisecond,
LeaseDuration: 2 * time.Second,
FinalizeBuffer: 500 * time.Millisecond,
}
require.NoError(t, pgqueue.Register(w, spec, handler))
_, err := pgqueue.Enqueue(ctx, q, pgqueue.JobSpec[EmailPayload]{Queue: "deadline-test"}, EmailPayload{To: "dl@test.com", Subject: "dl"})
require.NoError(t, err)
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
require.Eventually(t, func() bool { return gotDeadline.Load() }, 5*time.Second, 50*time.Millisecond)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx))
workerCancel()
require.NoError(t, collectErr())
assert.True(t, gotDeadline.Load(), "handler context should have a deadline")
assert.True(t, deadlineWithin.Load(), "deadline should be ~leaseUntil-finalizeBuffer")
}
// --- Worker: shutdown ---
func TestWorkerShutdown(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
t.Run("clean drain", func(t *testing.T) {
w := pgqueue.NewWorker(q)
spec := pgqueue.JobSpec[EmailPayload]{Queue: "drain-test", PollInterval: 50 * time.Millisecond}
require.NoError(t, pgqueue.Register(w, spec, newCountingHandler()))
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx), "should drain cleanly")
workerCancel()
require.NoError(t, collectErr())
})
t.Run("timeout drain", func(t *testing.T) {
handlerStarted := make(chan struct{})
blocking := pgqueue.JobHandlerFunc[EmailPayload](func(ctx context.Context, _ *pgqueue.Job[EmailPayload]) pgqueue.Result {
close(handlerStarted)
<-ctx.Done()
return pgqueue.Done()
})
w := pgqueue.NewWorker(q)
spec := pgqueue.JobSpec[EmailPayload]{Queue: "block-test", PollInterval: 50 * time.Millisecond, LeaseDuration: 30 * time.Second, FinalizeBuffer: 1 * time.Second}
require.NoError(t, pgqueue.Register(w, spec, blocking))
_, err := pgqueue.Enqueue(ctx, q, pgqueue.JobSpec[EmailPayload]{Queue: "block-test"}, EmailPayload{To: "block@test.com", Subject: "block"})
require.NoError(t, err)
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
// Wait for the handler to be actively blocking.
select {
case <-handlerStarted:
case <-time.After(5 * time.Second):
t.Fatal("handler did not start")
}
drainCtx, drainCancel := context.WithTimeout(ctx, 200*time.Millisecond)
defer drainCancel()
err = w.Stop(drainCtx)
assert.ErrorIs(t, err, context.DeadlineExceeded, "should timeout")
workerCancel()
// Start returns nil after workerCancel — goroutines exit once workerCtx is cancelled.
require.NoError(t, collectErr())
})
t.Run("start after stop fails", func(t *testing.T) {
w := pgqueue.NewWorker(q)
spec := pgqueue.JobSpec[EmailPayload]{Queue: "once-test", PollInterval: 50 * time.Millisecond}
require.NoError(t, pgqueue.Register(w, spec, newCountingHandler()))
workerCtx, workerCancel := context.WithCancel(ctx)
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx))
workerCancel()
require.NoError(t, collectErr())
err := w.Start(ctx)
require.ErrorIs(t, err, pgqueue.ErrWorkerStopped)
})
}
// --- Worker: state machine ---
func TestWorkerStateMachine(t *testing.T) {
q := setupQueue(t)
t.Run("register after start fails", func(t *testing.T) {
w := pgqueue.NewWorker(q)
spec := pgqueue.JobSpec[EmailPayload]{Queue: "sm-test", PollInterval: 50 * time.Millisecond}
require.NoError(t, pgqueue.Register(w, spec, newCountingHandler()))
workerCtx, workerCancel := context.WithCancel(t.Context())
defer workerCancel()
collectErr := startWorker(t, w, workerCtx)
err := pgqueue.Register(w, pgqueue.JobSpec[EmailPayload]{Queue: "late"}, newCountingHandler())
require.Error(t, err)
assert.Contains(t, err.Error(), "cannot register")
drainCtx, drainCancel := context.WithTimeout(t.Context(), 5*time.Second)
defer drainCancel()
require.NoError(t, w.Stop(drainCtx))
workerCancel()
require.NoError(t, collectErr())
})
t.Run("duplicate queue fails", func(t *testing.T) {
w := pgqueue.NewWorker(q)
spec := pgqueue.JobSpec[EmailPayload]{Queue: "dup-queue", PollInterval: 50 * time.Millisecond}
require.NoError(t, pgqueue.Register(w, spec, newCountingHandler()))
err := pgqueue.Register(w, spec, newCountingHandler())
require.Error(t, err)
assert.Contains(t, err.Error(), "already registered")
})
}
// --- Worker: real reaper reclaims expired lease ---
func TestWorkerReaper(t *testing.T) {
q := setupQueue(t)
ctx := t.Context()
// Worker A: handler blocks on signal, short lease, fast reaper.
handlerStarted := make(chan struct{})
releaseHandler := make(chan struct{})
blockingHandler := pgqueue.JobHandlerFunc[EmailPayload](func(_ context.Context, _ *pgqueue.Job[EmailPayload]) pgqueue.Result {
close(handlerStarted)
<-releaseHandler
return pgqueue.Done()
})
wA := pgqueue.NewWorker(q, pgqueue.WithReapInterval(200*time.Millisecond))
specA := pgqueue.JobSpec[EmailPayload]{
Queue: "reaper-test",
PollInterval: 50 * time.Millisecond,
LeaseDuration: 500 * time.Millisecond,
FinalizeBuffer: 100 * time.Millisecond,
}
require.NoError(t, pgqueue.Register(wA, specA, blockingHandler))
// Worker B: same queue, completes normally.
completedByB := make(chan int64, 1)
handlerB := pgqueue.JobHandlerFunc[EmailPayload](func(_ context.Context, job *pgqueue.Job[EmailPayload]) pgqueue.Result {
completedByB <- job.Task.ID
return pgqueue.Done()
})
wB := pgqueue.NewWorker(q, pgqueue.WithReapInterval(200*time.Millisecond))
specB := pgqueue.JobSpec[EmailPayload]{
Queue: "reaper-test",
PollInterval: 50 * time.Millisecond,
LeaseDuration: 10 * time.Second,
FinalizeBuffer: 1 * time.Second,
}
require.NoError(t, pgqueue.Register(wB, specB, handlerB))
// Enqueue one task.
id, err := pgqueue.Enqueue(ctx, q, pgqueue.JobSpec[EmailPayload]{Queue: "reaper-test"}, EmailPayload{To: "reap@test.com", Subject: "reap"})
require.NoError(t, err)
// Start worker A — it claims the task and blocks.
ctxA, cancelA := context.WithCancel(ctx)
defer cancelA()
collectA := startWorker(t, wA, ctxA)
select {
case <-handlerStarted:
case <-time.After(5 * time.Second):
t.Fatal("handler A did not start")
}
// Start worker B — its reaper will reclaim the expired task.
ctxB, cancelB := context.WithCancel(ctx)
defer cancelB()
collectB := startWorker(t, wB, ctxB)
// Wait for B to complete the reaped task. The reaper runs every 200ms,
// lease is 500ms, so within ~1s the task should be reaped and reclaimed.
select {
case completedID := <-completedByB:
assert.Equal(t, id, completedID, "B should process the same task")
case <-time.After(5 * time.Second):
t.Fatal("worker B did not pick up reaped task")
}
// Release A and shut down both workers.
close(releaseHandler)
cancelA()
require.NoError(t, collectA())
drainCtx, drainCancel := context.WithTimeout(ctx, 5*time.Second)
defer drainCancel()
require.NoError(t, wB.Stop(drainCtx))
cancelB()
require.NoError(t, collectB())
// Verify task completed.
task, err := q.Get(ctx, id)
require.NoError(t, err)
assert.Equal(t, pgqueue.TaskStatusCompleted, task.Status)
}