feat: add unref option for heartbeat timers#588
Merged
Merged
Conversation
When unref: true is passed in RunnerOptions (or TaskOptions), the heartbeat setTimeout and jitter setTimeout are unref'd so the Node.js process can exit when only these timers remain. Useful for CLI tools and short-lived scripts.
Add unref field to RunnerOptions and TaskOptions. When true, the heartbeat setTimeout and jitter setTimeout handles are unref'd after each arm so the Node.js process can exit naturally when only cron timers remain. InlineScheduledTask passes the option through to RunnerOptions.
Allow changing ref/unref at runtime on a running task. Runner.setUnref() applies immediately to the current heartbeat and jitter timeouts. Background tasks delegate to child.unref/ref.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
unref?: booleantoTaskOptionsandRunnerOptions.unref()on the heartbeat and jittersetTimeouthandles so the Node.js process can exit naturally when only unref'd timers remainChanges
src/scheduler/runner.ts: storesunrefflag, calls.unref()onheartBeatTimeoutinarmHeartBeat()and onjitterTimeoutsrc/tasks/scheduled-task.ts: addsunref?: booleantoTaskOptionssrc/tasks/inline-scheduled-task.ts: passesunrefthrough toRunnerOptionssrc/scheduler/runner-unref.test.ts: 4 tests (default ref, unref true, stop/start persistence, jitter unref)Test plan
hasRef() === true)unref: true: heartbeat is unref'd (hasRef() === false)