timgit / pg-boss / 19686010876

100%

push

github

Add AbortSignal support to worker job handlers (#622)

Closes https://github.com/timgit/pg-boss/issues/555

Workers now receive an AbortSignal on each job that gets aborted when
the job times out (exceeds expireInSeconds). This allows handlers to:
- Pass the signal to APIs like fetch() for automatic cancellation
- Listen for abort events to cleanup resources
- Check signal.aborted to exit long-running operations early

Implementation:
- Created one AbortController per job batch in manager.ts
- Reused the controller in the existing timeout mechanism via delay()
- Added signal property to Job interface in types.d.ts
- Updated worker documentation with signal property and example
- Added tests to verify signal is provided and aborted on timeout

The signal is automatically aborted by Node's setTimeout when the job
exceeds its expireInSeconds limit, providing a standard way for handlers
to detect and respond to timeouts.

425 of 466 branches covered (91.2%)

7 of 7 new or added lines in 2 files covered. (100.0%)

1000 of 1001 relevant lines covered (99.9%)

132.63 hits per line