@stonyx/cron 0.2.1-alpha.49 → 0.2.1-alpha.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -35,34 +35,20 @@ When a job is executed, its next trigger time is updated, and it is re-inserted
35
35
  | `register` | `key: string, callback: Function, interval: number, runOnInit?: boolean` | Register a new job with a given interval in seconds. If `runOnInit` is true, the job runs immediately upon registration. |
36
36
  | `unregister` | `key: string` | Remove a previously registered job. |
37
37
 
38
- > **Callback semantics.** Callbacks are invoked fire-and-forget: `Cron` never waits for one to settle, and reschedules a job *before* invoking it. Two *different* jobs that fall due on the same tick may therefore overlap.
39
- >
40
- > A job that is still running when it next falls due is skipped — and **keeps** being skipped until that invocation settles. `Cron` provides no timeout by design, so **bounding your own callback is your responsibility**: a promise that never settles means that job never runs again for the lifetime of the process, even though the scheduler stays healthy and the job stays visible in `jobs` and in the heap. Other jobs are unaffected.
41
- >
42
- > One warning is emitted per stuck run (not per tick), including how long the invocation has been running. That warning goes to `log.warn` and is **not** gated by `config.cron.log` — a dropped execution reported on a channel a config flag can silence would be indistinguishable from a healthy scheduler.
43
- >
44
- > The same-job guarantee holds for the lifetime of a **registration**, not of a key: `unregister` followed by `register` on a key whose invocation is still in flight builds a fresh job object with a fresh guard, so the replacement can run alongside the abandoned invocation. That is also the only way to recover a permanently stuck job.
45
- >
46
- > Synchronous throws and asynchronous rejections are both caught and reported through `log.error`, with the error's stack interpolated into the message. Neither can stop the scheduler. Note that a rejection which previously escaped `register()` as an unhandled rejection — process-fatal under Node's default — is now swallowed into `log.error`.
47
-
48
38
  > `MinHeap` is also exported as a public subpath (`@stonyx/cron/min-heap`) and can be imported directly for advanced usage.
49
39
 
50
40
  ## Configuration
51
41
 
52
- Optionally, informational logging and debugging can be controlled through `config.cron`:
42
+ Optionally, logging and debugging can be enabled through `config.cron`:
53
43
 
54
44
  ```js
55
45
  config.cron = {
56
- log: true // informational cron job logs; defaults to true
46
+ log: true // enable cron job logs
57
47
  };
58
48
 
59
49
  config.debug = true; // optional: debug logs for job registration and execution
60
50
  ```
61
51
 
62
- `config.cron.log` gates **informational** messages only. Error reports and the
63
- stuck-job warning described above are never gated by it, so setting it to `false`
64
- cannot make a dropped execution silent.
65
-
66
52
  ## License
67
53
 
68
54
  Apache — do what you want, just keep attribution.
package/dist/main.d.ts CHANGED
@@ -3,24 +3,6 @@ interface CronJob extends HeapItem {
3
3
  callback: () => void | Promise<void>;
4
4
  interval: string;
5
5
  key: string;
6
- /**
7
- * Timestamp (ms) at which the current invocation started; `undefined` when the
8
- * job is idle. Optional so the emitted `CronJob` stays assignable from a job
9
- * object built by a consumer — `jobs`, `heap` and `setNextTrigger` all expose
10
- * this interface structurally, so a required field is a breaking type change.
11
- *
12
- * A timestamp rather than a boolean, mirroring `job.state.runningAtMs` in the
13
- * service tier (`markRunning` / `applyResult` / `isDue` in `src/job.ts`), and
14
- * carrying the one fact a stuck-job warning needs: how long it has been stuck.
15
- * `CronService.running` is a class-level re-entrancy flag and a different
16
- * concept; reusing that word here would collide.
17
- */
18
- runningAtMs?: number;
19
- /**
20
- * True once a skip has been reported for the *current* invocation. Bounds the
21
- * still-running warning to one line per stuck run instead of one per tick.
22
- */
23
- skipReported?: boolean;
24
6
  }
25
7
  export default class Cron {
26
8
  static instance: Cron | null;
@@ -33,33 +15,6 @@ export default class Cron {
33
15
  runDueJobs(): Promise<void>;
34
16
  register(key: string, callback: () => void | Promise<void>, interval: string, runOnInit?: boolean): void;
35
17
  unregister(key: string): void;
36
- /**
37
- * The one place this class invokes a consumer callback.
38
- *
39
- * Never blocks the caller, catches synchronous throws and asynchronous
40
- * rejections identically, and skips the invocation entirely while the job's
41
- * previous invocation has not settled (fire-and-forget would otherwise let a
42
- * slow job stack invocations on itself).
43
- *
44
- * Everything that touches the callback — including the thenable probe and the
45
- * handler attachment — is inside the `try`. A callback may return an object
46
- * whose `then` is a throwing getter, and reading it outside the guard would
47
- * abort the drain loop before `scheduleNextRun()`, which is defect #36 again.
48
- */
49
- invokeJob(job: CronJob, runOnInit?: boolean): void;
50
- /**
51
- * Report a scheduler-level message without ever letting the logger's own
52
- * failure reach the caller.
53
- *
54
- * `@stonyx/logs` convenience methods return a promise and write to disk
55
- * through an unguarded `mkdirSync` + `fsp.appendFile`. On a read-only or full
56
- * log volume that promise rejects; an unobserved rejection raised from inside
57
- * the handler that exists to prevent unhandled rejections would re-create
58
- * exactly the defect this class was fixed for.
59
- */
60
- report(level: 'error' | 'warn', message: string): void;
61
- /** Release a job's in-flight guard. Only ever called for the job it belongs to. */
62
- release(job: CronJob): void;
63
18
  setNextTrigger(job: CronJob): void;
64
19
  log(text: string, key?: string | null): void;
65
20
  }
package/dist/main.js CHANGED
@@ -17,30 +17,6 @@ import config from 'stonyx/config';
17
17
  import log from 'stonyx/log';
18
18
  import { getTimestamp } from '@stonyx/utils/date';
19
19
  import MinHeap from './min-heap.js';
20
- /**
21
- * Render an unknown thrown value as log text.
22
- *
23
- * `@stonyx/logs` reads a second argument as `logToFile`, not as a format
24
- * argument, so `log.error(message, err)` discards the error entirely *and*
25
- * forces a disk write on every failure. The error has to be interpolated into
26
- * the message instead — the shape `CronService.executeJob` already uses.
27
- */
28
- function describeError(err) {
29
- if (err instanceof Error)
30
- return err.stack ?? `${err.name}: ${err.message}`;
31
- return String(err);
32
- }
33
- /**
34
- * Render a consumer-supplied job key safely for log output.
35
- *
36
- * Keys reach the log verbatim, so a key containing a newline can forge a
37
- * complete, well-formed log line (`'a:\n[FORGED] Cron::admin - all jobs
38
- * healthy'`). `JSON.stringify` quotes the value and escapes the control
39
- * characters, which is also how the key is rendered one tier up.
40
- */
41
- function describeKey(key) {
42
- return JSON.stringify(key);
43
- }
44
20
  export default class Cron {
45
21
  static instance;
46
22
  jobs = {};
@@ -67,41 +43,28 @@ export default class Cron {
67
43
  if (!nextJob)
68
44
  return;
69
45
  const delay = Math.max(0, nextJob.nextTrigger - getTimestamp()) * 1000;
70
- // Terminal catch: `runDueJobs` is async, so anything that escapes it would
71
- // otherwise become an unhandled rejection raised from a bare timer callback
72
- // — the very failure mode this class was fixed for.
73
- this.timer = setTimeout(() => {
74
- this.runDueJobs().catch((err) => {
75
- this.report('error', `Cron scheduler tick failed: ${describeError(err)}`);
76
- });
77
- }, delay);
46
+ this.timer = setTimeout(() => this.runDueJobs(), delay);
78
47
  }
79
48
  async runDueJobs() {
80
49
  const now = getTimestamp();
81
50
  const { heap } = this;
82
- // `finally`, not a trailing statement: `scheduleNextRun()` running on every
83
- // exit from the drain loop is the invariant this whole fix is about. If
84
- // anything in the loop body ever throws, the scheduler must still re-arm
85
- // rather than stopping silently while `timer` still holds a fired handle.
86
- try {
87
- while (!heap.isEmpty()) {
88
- const next = heap.peek();
89
- if (!next || next.nextTrigger > now)
90
- break;
91
- const job = heap.pop();
92
- if (config.debug)
93
- this.log('job has been triggered', job.key);
94
- // Reschedule before invoking: a consumer callback is never awaited here,
95
- // so a callback that hangs or rejects can no longer starve the drain loop
96
- // or leave the job orphaned outside the heap.
97
- this.setNextTrigger(job);
98
- heap.push(job);
99
- this.invokeJob(job);
51
+ while (!heap.isEmpty()) {
52
+ const next = heap.peek();
53
+ if (!next || next.nextTrigger > now)
54
+ break;
55
+ const job = heap.pop();
56
+ if (config.debug)
57
+ this.log('job has been triggered', job.key);
58
+ try {
59
+ await job.callback();
100
60
  }
61
+ catch (err) {
62
+ log.error(`Cron job "${job.key}" failed:`, err);
63
+ }
64
+ this.setNextTrigger(job);
65
+ heap.push(job);
101
66
  }
102
- finally {
103
- this.scheduleNextRun();
104
- }
67
+ this.scheduleNextRun();
105
68
  }
106
69
  register(key, callback, interval, runOnInit = false) {
107
70
  const job = { callback, interval, key, nextTrigger: 0 };
@@ -111,8 +74,14 @@ export default class Cron {
111
74
  if (config.debug) {
112
75
  this.log(`job has been registered with interval: ${interval}`, key);
113
76
  }
114
- if (runOnInit)
115
- this.invokeJob(job, true);
77
+ if (runOnInit) {
78
+ try {
79
+ callback();
80
+ }
81
+ catch (err) {
82
+ log.error(`Cron job "${key}" failed on init:`, err);
83
+ }
84
+ }
116
85
  this.scheduleNextRun();
117
86
  }
118
87
  unregister(key) {
@@ -126,104 +95,13 @@ export default class Cron {
126
95
  this.log('job has been unregistered', key);
127
96
  this.scheduleNextRun();
128
97
  }
129
- /**
130
- * The one place this class invokes a consumer callback.
131
- *
132
- * Never blocks the caller, catches synchronous throws and asynchronous
133
- * rejections identically, and skips the invocation entirely while the job's
134
- * previous invocation has not settled (fire-and-forget would otherwise let a
135
- * slow job stack invocations on itself).
136
- *
137
- * Everything that touches the callback — including the thenable probe and the
138
- * handler attachment — is inside the `try`. A callback may return an object
139
- * whose `then` is a throwing getter, and reading it outside the guard would
140
- * abort the drain loop before `scheduleNextRun()`, which is defect #36 again.
141
- */
142
- invokeJob(job, runOnInit = false) {
143
- const { key } = job;
144
- const context = runOnInit ? 'failed on init:' : 'failed:';
145
- // The in-flight guard lives on the job object, not in a module-level set
146
- // keyed by string. Object identity is invocation identity: the only thing
147
- // that clears the guard is the settle handler of the invocation that set it,
148
- // and that handler closes over this exact job object, so a stale handler can
149
- // never release a later invocation's guard.
150
- if (job.runningAtMs !== undefined) {
151
- // Bounded to one line per stuck run, not one per tick. A permanently hung
152
- // job is re-pushed and re-skipped every interval forever; at the 1s
153
- // interval this class's own tests use that measures 43,200 lines/day per
154
- // job — a disk-fill and ingest-cost vector whose natural operator response
155
- // is to silence the only signal that the job is dead.
156
- if (!job.skipReported) {
157
- job.skipReported = true;
158
- const runningForSeconds = Math.max(0, Math.round((Date.now() - job.runningAtMs) / 1000));
159
- // Ungated, deliberately, matching the sibling `CronService` handler. A
160
- // skipped run is a *lost* execution, and `runDueJobs`/`register` both
161
- // return `void`, so this is the legacy class's only wedged-job channel.
162
- // Routing it through `this.log` would put it behind `config.cron.log`,
163
- // where a permanently dead job is indistinguishable from a healthy one.
164
- this.report('warn', `Cron job ${describeKey(key)} is still running after ${runningForSeconds}s; skipping this `
165
- + 'tick and any further ticks until it settles (this warning is not repeated for this run)');
166
- }
167
- return;
168
- }
169
- job.runningAtMs = Date.now();
170
- job.skipReported = false;
171
- try {
172
- const result = job.callback();
173
- if (result && typeof result.then === 'function') {
174
- Promise.resolve(result)
175
- .catch((err) => {
176
- // Braces matter: returning `report`'s value would put it back into
177
- // the chain, and `.finally` passes a rejection straight through.
178
- this.report('error', `Cron job ${describeKey(key)} ${context} ${describeError(err)}`);
179
- })
180
- .finally(() => { this.release(job); })
181
- // Backstop: a throw inside the error handler or the release must not
182
- // re-create the unhandled rejection this helper exists to prevent.
183
- .catch(() => { });
184
- return;
185
- }
186
- this.release(job);
187
- }
188
- catch (err) {
189
- this.release(job);
190
- this.report('error', `Cron job ${describeKey(key)} ${context} ${describeError(err)}`);
191
- }
192
- }
193
- /**
194
- * Report a scheduler-level message without ever letting the logger's own
195
- * failure reach the caller.
196
- *
197
- * `@stonyx/logs` convenience methods return a promise and write to disk
198
- * through an unguarded `mkdirSync` + `fsp.appendFile`. On a read-only or full
199
- * log volume that promise rejects; an unobserved rejection raised from inside
200
- * the handler that exists to prevent unhandled rejections would re-create
201
- * exactly the defect this class was fixed for.
202
- */
203
- report(level, message) {
204
- try {
205
- const result = level === 'error' ? log.error(message) : log.warn(message);
206
- void Promise.resolve(result).catch(() => { });
207
- }
208
- catch {
209
- // Nowhere left to report to; the logger must never stop the scheduler.
210
- }
211
- }
212
- /** Release a job's in-flight guard. Only ever called for the job it belongs to. */
213
- release(job) {
214
- job.runningAtMs = undefined;
215
- job.skipReported = false;
216
- }
217
98
  setNextTrigger(job) {
218
99
  job.nextTrigger = getTimestamp() + parseInt(job.interval, 10);
219
100
  }
220
101
  log(text, key = null) {
221
102
  if (!config.cron?.log)
222
103
  return;
223
- // The key is consumer-controlled and reaches the log verbatim. Strip the
224
- // line terminators so a key cannot forge a second, well-formed log line;
225
- // the surrounding format is unchanged.
226
- const tag = key ? `Cron::${key.replace(/[\r\n]+/g, ' ')}` : `Cron`;
104
+ const tag = key ? `Cron::${key}` : `Cron`;
227
105
  log.cron(`${tag} - ${text}:`);
228
106
  }
229
107
  }
package/dist/service.d.ts CHANGED
@@ -4,29 +4,37 @@ import RunLog from './run-log.js';
4
4
  interface HeapEntry extends HeapItem {
5
5
  key: string;
6
6
  }
7
- interface JobDueResult {
7
+ /**
8
+ * Why a `run()` did not invoke the callback. Exported so a consumer can write a
9
+ * total handler over it: the union is closed and narrowed (it was `string`
10
+ * before #34), so an exhaustive `switch` is now both possible and expected.
11
+ */
12
+ export type SkipReason = 'not due' | 'already running' | 'removed';
13
+ export interface JobDueResult {
8
14
  status?: string;
9
15
  error?: string;
10
16
  summary?: string;
11
17
  }
12
- interface ExecuteResult {
18
+ export interface ExecuteResult {
13
19
  status: string;
14
20
  error?: string;
15
21
  summary?: string;
16
22
  durationMs?: number;
17
23
  deleted?: boolean;
18
- reason?: string;
24
+ /** Only set when `status` is `'skipped'`. */
25
+ reason?: SkipReason;
19
26
  }
20
- interface ServiceStatus {
27
+ export interface ServiceStatus {
21
28
  started: boolean;
22
29
  jobCount: number;
23
30
  nextWakeAtMs: number | undefined;
24
31
  }
25
- interface ListOptions {
32
+ export interface ListOptions {
26
33
  includeDisabled?: boolean;
27
34
  }
28
- type OnJobDueCallback = (job: Job) => Promise<JobDueResult | void> | JobDueResult | void;
35
+ export type OnJobDueCallback = (job: Job) => Promise<JobDueResult | void> | JobDueResult | void;
29
36
  export default class CronService {
37
+ #private;
30
38
  jobs: Map<string, Job>;
31
39
  heap: MinHeap<HeapEntry>;
32
40
  timer: ReturnType<typeof setTimeout> | null;
@@ -69,6 +77,21 @@ export default class CronService {
69
77
  remove(id: string): Promise<void>;
70
78
  /**
71
79
  * Manually trigger a job.
80
+ *
81
+ * Returns `{ status: 'skipped', reason }` without invoking the callback when
82
+ * the job is not due (`mode: 'due'`), is already in flight
83
+ * (`'already running'`), or was removed before the claim landed
84
+ * (`'removed'`). Before the phase split, a forced run against an in-flight
85
+ * job launched a second concurrent invocation.
86
+ *
87
+ * CONCURRENCY: the same job is bounded to one in-flight invocation on every
88
+ * path, and the timer path invokes due jobs one at a time. `run()` fan-out
89
+ * across DIFFERENT jobs is deliberately unbounded — N concurrent `run()`
90
+ * calls produce N concurrent consumer callbacks. Before the phase split
91
+ * these serialized behind the module-global lock; that serialization was the
92
+ * bug rather than the feature (one hung callback wedged every other caller),
93
+ * so it is not restored here. The fan-out is caller-driven and the scheduler
94
+ * never produces it on its own.
72
95
  */
73
96
  run(id: string, mode?: 'due' | 'force'): Promise<ExecuteResult>;
74
97
  /**
@@ -78,6 +101,25 @@ export default class CronService {
78
101
  armTimer(): void;
79
102
  onTimer(): Promise<void>;
80
103
  findDueJobs(nowMs: number): Job[];
104
+ /**
105
+ * Execute a job in three phases:
106
+ *
107
+ * 1. claim (locked) — take ownership of the job, detach it from the heap
108
+ * 2. invoke (UNLOCKED) — await the consumer callback
109
+ * 3. settle (locked) — apply the result, log it, re-insert into the heap
110
+ *
111
+ * The critical section deliberately excludes phase 2. `onJobDue` is
112
+ * arbitrary, unbounded consumer code; awaiting it under the module-global
113
+ * lock is what wedged every subsequent `locked()` call (add/update/remove)
114
+ * when a callback never settled.
115
+ *
116
+ * `onTimer` performs the batch claim (`findDueJobs` + `markRunning`) for all
117
+ * due jobs under a single lock and then enters at phase 2 via
118
+ * `#executeClaimed`. That entry point is `#private` rather than a parameter
119
+ * on this method: as a published `alreadyClaimed` flag it would be a
120
+ * supported way to skip phase 1 entirely, defeating the claim guard and
121
+ * allowing concurrent `onJobDue` invocations for the same job.
122
+ */
81
123
  executeJob(job: Job): Promise<ExecuteResult>;
82
124
  removeFromHeap(id: string): void;
83
125
  log(message: string): void;
package/dist/service.js CHANGED
@@ -2,7 +2,21 @@
2
2
  * CronService - the main API for advanced job scheduling.
3
3
  *
4
4
  * Manages jobs in memory with a min-heap for efficient next-job lookup.
5
- * All state mutations are serialized via async locking.
5
+ *
6
+ * Async locking, but never around the consumer callback. Execution is split
7
+ * into three phases: claim (locked), invoke (UNLOCKED), settle (locked). Only
8
+ * phases 1 and 3 are serialized; the critical section deliberately excludes
9
+ * phase 2, so a consumer callback that never settles cannot wedge the lock
10
+ * chain and block add/update/remove. See `run()` and `#executeClaimed`.
11
+ *
12
+ * CONSUMER NOTE — this class is NOMINALLY typed. It carries ECMAScript hard-
13
+ * private members, so `dist/service.d.ts` emits `#private;` on the class and a
14
+ * structurally-built test double will not assign to `CronService`
15
+ * (`TS2741: Property '#private' is missing`). The break is one-directional and
16
+ * has a zero-cost workaround: `extends CronService` still compiles, and
17
+ * assigning a real `CronService` to your own hand-written interface still
18
+ * compiles. Declare your own interface and depend on that rather than
19
+ * hand-building a `CronService`-typed mock. See README's `CronService` section.
6
20
  */
7
21
  import config from 'stonyx/config';
8
22
  import log from 'stonyx/log';
@@ -12,6 +26,54 @@ import { locked } from './locked.js';
12
26
  import { normalizeJobInput, recoverFlatParams } from './normalize.js';
13
27
  import RunLog from './run-log.js';
14
28
  const MAX_TIMER_DELAY_MS = 60_000;
29
+ /** Longest error text that may reach a log line. Anything past this is truncated. */
30
+ const MAX_LOGGED_ERROR_LENGTH = 512;
31
+ /** Longest job name that may reach a log line. Anything past this is truncated. */
32
+ const MAX_LOGGED_NAME_LENGTH = 120;
33
+ /**
34
+ * Flatten a value for interpolation into a single log line.
35
+ *
36
+ * Chronicle writes `${timestamp} ${content}\n` to a newline-delimited file, so
37
+ * any `\r` or `\n` inside `content` ends the record early and everything after
38
+ * it is read back as a separate, attacker-shaped entry — including a forged
39
+ * `[timestamp] Cron — ...` prefix that is indistinguishable from a real one.
40
+ * Both values that reach these lines are untrusted: `job.name` is passed
41
+ * through `createJob` unvalidated and `normalize.ts` exists specifically to
42
+ * accept AI-shaped input, and an error message is arbitrary consumer-callback
43
+ * text. Newlines become the literal two characters so the content survives for
44
+ * a reader, and the length cap keeps one pathological value from swamping the
45
+ * file.
46
+ */
47
+ function forLog(value, maxLength) {
48
+ const flattened = value.replace(/\r\n|[\r\n\u2028\u2029]/g, '\\n');
49
+ return flattened.length > maxLength ? `${flattened.slice(0, maxLength)}...` : flattened;
50
+ }
51
+ /**
52
+ * Describe a thrown value without ever throwing.
53
+ *
54
+ * `String(err)` is not total: a null-prototype object, or any object whose
55
+ * `toString`/`Symbol.toPrimitive` throws, raises "Cannot convert object to
56
+ * primitive value". Consumer callbacks throw arbitrary values, so the error
57
+ * handler must not become a second failure source of its own.
58
+ *
59
+ * The `instanceof Error` branch needs the same guard as the other one. `Error`
60
+ * is subclassable and `message` is a plain writable property, so a consumer can
61
+ * hand back an `Error` whose `message` is a getter that throws, or one that is
62
+ * an object whose `toString` throws — `Error.prototype.message` is typed
63
+ * `string`, so TypeScript sees nothing wrong and the coercion is deferred to
64
+ * the caller's template literal, outside every guard here. That made `run()`
65
+ * reject instead of returning an `ExecuteResult`: a contract violation in the
66
+ * function written to prevent exactly that. Reading and coercing `message`
67
+ * inside the `try` is what closes it.
68
+ */
69
+ function describeError(err) {
70
+ try {
71
+ return err instanceof Error ? String(err.message) : String(err);
72
+ }
73
+ catch {
74
+ return 'unknown error';
75
+ }
76
+ }
15
77
  export default class CronService {
16
78
  jobs;
17
79
  heap;
@@ -40,6 +102,23 @@ export default class CronService {
40
102
  this.started = true;
41
103
  if (initialJobs) {
42
104
  for (const job of initialJobs) {
105
+ // A `runningAtMs` on a rehydrated job is always stale. The claim it
106
+ // records was taken by a process that is gone, so nothing will ever
107
+ // settle it, and nothing reaps it — there is no lease on the field
108
+ // (tracked on #35). Left in place it is a permanently dead job that
109
+ // still reports healthy: `isDue` returns false forever because of the
110
+ // flag, `run()` answers `'already running'` forever, `update()` never
111
+ // touches `state.runningAtMs`, and `status()` counts it like any other.
112
+ // The consumer's only recovery would be remove() + add(), losing the
113
+ // job id and its run history.
114
+ //
115
+ // Same hazard, same treatment as the hand-release on the `'removed'`
116
+ // path in `#executeClaimed`: a claim with no reachable settle must be
117
+ // released. Assigned directly rather than via `applyResult` for the same
118
+ // reason — this releases the claim and nothing else. The job did not
119
+ // run, so it gets no run-log row, no `lastStatus`, and no recomputed
120
+ // `nextRunAtMs`; it is rescheduled from the store's own value below.
121
+ job.state.runningAtMs = undefined;
43
122
  this.jobs.set(job.id, job);
44
123
  if (job.enabled && job.state.nextRunAtMs) {
45
124
  this.heap.push({ key: job.id, nextTrigger: job.state.nextRunAtMs });
@@ -136,6 +215,21 @@ export default class CronService {
136
215
  }
137
216
  /**
138
217
  * Manually trigger a job.
218
+ *
219
+ * Returns `{ status: 'skipped', reason }` without invoking the callback when
220
+ * the job is not due (`mode: 'due'`), is already in flight
221
+ * (`'already running'`), or was removed before the claim landed
222
+ * (`'removed'`). Before the phase split, a forced run against an in-flight
223
+ * job launched a second concurrent invocation.
224
+ *
225
+ * CONCURRENCY: the same job is bounded to one in-flight invocation on every
226
+ * path, and the timer path invokes due jobs one at a time. `run()` fan-out
227
+ * across DIFFERENT jobs is deliberately unbounded — N concurrent `run()`
228
+ * calls produce N concurrent consumer callbacks. Before the phase split
229
+ * these serialized behind the module-global lock; that serialization was the
230
+ * bug rather than the feature (one hung callback wedged every other caller),
231
+ * so it is not restored here. The fan-out is caller-driven and the scheduler
232
+ * never produces it on its own.
139
233
  */
140
234
  async run(id, mode = 'force') {
141
235
  const job = this.jobs.get(id);
@@ -144,6 +238,10 @@ export default class CronService {
144
238
  if (mode === 'due' && !isDue(job, Date.now())) {
145
239
  return { status: 'skipped', reason: 'not due' };
146
240
  }
241
+ // Deliberately NOT wrapped in locked(): executeJob takes the lock itself,
242
+ // for its claim and settle phases only. Wrapping here would re-create the
243
+ // wedge through a second door, because the consumer callback would once
244
+ // again be awaited while a lock is held.
147
245
  return this.executeJob(job);
148
246
  }
149
247
  /**
@@ -172,16 +270,77 @@ export default class CronService {
172
270
  }
173
271
  this.running = true;
174
272
  try {
175
- await locked(async () => {
273
+ // -- Phase 1: claim (locked), batched --
274
+ // Collecting due jobs pops them off the heap, and marking them running
275
+ // makes them un-claimable by anyone else. Both must happen under the
276
+ // same lock turn, or a concurrent run() could claim a job this batch has
277
+ // already detached.
278
+ //
279
+ // This is the SECOND claim implementation — `#claimJob` is the other, and
280
+ // the two reach the same state by different routes. `#claimJob` guards
281
+ // with an explicit `job.state.runningAtMs` check; this path has no such
282
+ // check and relies entirely on `isDue`'s `!job.state.runningAtMs` clause
283
+ // (`job.ts`) to keep `findDueJobs` from re-claiming a job that `run()`
284
+ // already holds. THAT CLAUSE IS LOAD-BEARING HERE, not an optimisation:
285
+ // drop it and the timer path silently double-invokes a job that `run()`
286
+ // is mid-flight on, while `run()` keeps refusing correctly and looks
287
+ // healthy. The one-in-flight-invocation-per-job invariant this class
288
+ // advertises holds by two independent guards in two files; a change to
289
+ // either has to be checked against the other.
290
+ const dueJobs = await locked(() => {
176
291
  const nowMs = Date.now();
177
- const dueJobs = this.findDueJobs(nowMs);
178
- for (const job of dueJobs) {
292
+ const due = this.findDueJobs(nowMs);
293
+ for (const job of due) {
179
294
  markRunning(job);
180
295
  }
181
- for (const job of dueJobs) {
182
- await this.executeJob(job);
183
- }
296
+ return due;
184
297
  });
298
+ // Phases 2 and 3 run OUTSIDE the claim lock. The consumer callback is
299
+ // awaited here holding no lock at all, so a callback that never settles
300
+ // cannot poison the lock chain and wedge add/update/remove.
301
+ for (const job of dueJobs) {
302
+ try {
303
+ await this.#executeClaimed(job);
304
+ }
305
+ catch (err) {
306
+ // One job's unexpected throw must not abort the batch. Every job in
307
+ // `dueJobs` is already claimed — marked running and detached from
308
+ // the heap — and only its own settle releases it, so aborting here
309
+ // would strand every sibling permanently un-due.
310
+ //
311
+ // Reported on an UNGATED channel. `this.log()` returns early when
312
+ // `config.cron.log` is false, which is a supported production
313
+ // setting, and a failure here permanently unschedules a job while
314
+ // `status()` keeps reporting the service healthy. Silent-and-healthy
315
+ // is exactly the failure class this split exists to remove.
316
+ //
317
+ // This is the outermost handler on the timer path, so it is the one
318
+ // that must not be able to throw: `log` is a shared singleton whose
319
+ // transports can reach the filesystem, so its own failure is
320
+ // swallowed rather than allowed to take the batch down.
321
+ //
322
+ // BOTH halves of that failure have to be caught, and they are caught
323
+ // by different constructs. `log.error` is a chronicle convenience
324
+ // method that returns `logAction(...)` -> `async log(...)`, so its
325
+ // console write, colour lookup, `mkdirSync` and `appendFile` all
326
+ // surface as REJECTIONS, never as synchronous throws. A bare call
327
+ // here escapes this `catch` entirely and terminates the process under
328
+ // Node's default `--unhandled-rejections=throw` — the handler written
329
+ // so it "must not be able to throw" would be the one taking the
330
+ // daemon down. The `try` covers the synchronous half (evaluating the
331
+ // template literal); `Promise.resolve(...).catch()` covers the async
332
+ // half. Deliberately not awaited: the batch must not block on a log
333
+ // transport, and `void` marks the floated promise as intentional.
334
+ try {
335
+ void Promise.resolve(log.error(`Cron — Job "${forLog(job.name, MAX_LOGGED_NAME_LENGTH)}" (${job.id}) execution failed unexpectedly: ${forLog(describeError(err), MAX_LOGGED_ERROR_LENGTH)}`)).catch(() => {
336
+ // Nothing left to report to.
337
+ });
338
+ }
339
+ catch {
340
+ // Nothing left to report to.
341
+ }
342
+ }
343
+ }
185
344
  }
186
345
  finally {
187
346
  this.running = false;
@@ -202,50 +361,190 @@ export default class CronService {
202
361
  }
203
362
  return due;
204
363
  }
364
+ /**
365
+ * Execute a job in three phases:
366
+ *
367
+ * 1. claim (locked) — take ownership of the job, detach it from the heap
368
+ * 2. invoke (UNLOCKED) — await the consumer callback
369
+ * 3. settle (locked) — apply the result, log it, re-insert into the heap
370
+ *
371
+ * The critical section deliberately excludes phase 2. `onJobDue` is
372
+ * arbitrary, unbounded consumer code; awaiting it under the module-global
373
+ * lock is what wedged every subsequent `locked()` call (add/update/remove)
374
+ * when a callback never settled.
375
+ *
376
+ * `onTimer` performs the batch claim (`findDueJobs` + `markRunning`) for all
377
+ * due jobs under a single lock and then enters at phase 2 via
378
+ * `#executeClaimed`. That entry point is `#private` rather than a parameter
379
+ * on this method: as a published `alreadyClaimed` flag it would be a
380
+ * supported way to skip phase 1 entirely, defeating the claim guard and
381
+ * allowing concurrent `onJobDue` invocations for the same job.
382
+ */
205
383
  async executeJob(job) {
384
+ // -- Phase 1: claim (locked) --
385
+ const refusal = await locked(() => this.#claimJob(job));
386
+ if (refusal)
387
+ return { status: 'skipped', reason: refusal };
388
+ return this.#executeClaimed(job);
389
+ }
390
+ /**
391
+ * Phases 2 and 3 for a job that has already been claimed — either by
392
+ * `executeJob` above or by `onTimer`'s batch claim.
393
+ *
394
+ * Private: reaching this without a claim would run the consumer callback for
395
+ * a job nobody owns, and would leave nothing to release the claim.
396
+ */
397
+ async #executeClaimed(job) {
398
+ // Membership re-check. The claim and the invoke are no longer in the same
399
+ // critical section, and sibling callbacks run unlocked, so a `remove()` can
400
+ // now land in between AND RESOLVE — it used to deadlock. A resolved
401
+ // `remove()` must keep meaning "this callback will not fire"; the identity
402
+ // guard in `#settleJob` only cleans up afterwards, by which point the side
403
+ // effect has already happened. Identity, not id, so a removed-then-replaced
404
+ // key is caught too. Deliberately synchronous with the `onJobDue` call
405
+ // below — nothing can interleave between this check and the invocation.
406
+ //
407
+ // This is the one early return after a claim, so it is the one that has to
408
+ // release the claim by hand. Skipping settle is right — re-inserting or
409
+ // run-logging a removed job is the resurrection `#settleJob` refuses, and
410
+ // the heap entry is already gone. But the claim must still come off,
411
+ // because the detached object is NOT unreachable: it is the object `add()`
412
+ // returned and `get()`/`list()` hand out, and `start(initialJobs)`
413
+ // re-registers those objects verbatim, `state` included. A leftover
414
+ // `runningAtMs` rehydrates a permanently dead job — `isDue` false forever,
415
+ // `run()` refused forever, `status()` reporting it healthy.
416
+ //
417
+ // Assigned directly rather than via `applyResult`: this releases the claim
418
+ // and nothing else. No run-log row, no heap entry, no `lastStatus`, no
419
+ // recomputed `nextRunAtMs` — the job did not run.
420
+ if (this.jobs.get(job.id) !== job) {
421
+ job.state.runningAtMs = undefined;
422
+ return { status: 'skipped', reason: 'removed' };
423
+ }
206
424
  const startMs = Date.now();
207
425
  let status = 'ok';
208
426
  let error;
209
427
  let summary;
428
+ let settled;
429
+ // The claim marked the job running and detached it from the heap. Phase 3
430
+ // is the ONLY thing that undoes either, so it must survive every non-local
431
+ // exit from phase 2 — including a throw from the catch handler itself
432
+ // (`this.log` is public and overridable and reaches a transport). A claim
433
+ // with no matching settle is not a degraded state, it is a permanently
434
+ // dead job.
210
435
  try {
211
- if (this.onJobDue) {
212
- const result = await this.onJobDue(job);
213
- if (result) {
214
- status = result.status || 'ok';
215
- error = result.error;
216
- summary = result.summary;
436
+ // -- Phase 2: invoke (NOT locked) --
437
+ try {
438
+ if (this.onJobDue) {
439
+ const result = await this.onJobDue(job);
440
+ if (result) {
441
+ status = result.status || 'ok';
442
+ error = result.error;
443
+ summary = result.summary;
444
+ }
217
445
  }
218
446
  }
447
+ catch (err) {
448
+ status = 'error';
449
+ error = describeError(err);
450
+ this.log(`Job "${forLog(job.name, MAX_LOGGED_NAME_LENGTH)}" (${job.id}) failed: ${forLog(error, MAX_LOGGED_ERROR_LENGTH)}`);
451
+ }
219
452
  }
220
- catch (err) {
221
- status = 'error';
222
- error = err instanceof Error ? err.message : String(err);
223
- this.log(`Job "${job.name}" (${job.id}) failed: ${error}`);
453
+ finally {
454
+ // -- Phase 3: settle (locked) --
455
+ settled = await locked(() => this.#settleJob(job, status, error, summary, startMs, Date.now() - startMs));
224
456
  }
225
- const durationMs = Date.now() - startMs;
226
- const validStatus = (status === 'ok' || status === 'error' || status === 'skipped') ? status : 'error';
227
- applyResult(job, validStatus, error, durationMs);
228
- // Log the run
229
- this.runLog.record({
230
- jobId: job.id,
231
- status,
232
- error,
233
- summary,
234
- runAtMs: startMs,
235
- durationMs,
236
- nextRunAtMs: job.state.nextRunAtMs,
237
- });
238
- // Handle one-shot auto-delete
239
- if (job.deleteAfterRun && status === 'ok' && !job.enabled) {
240
- this.jobs.delete(job.id);
241
- this.runLog.removeJob(job.id);
242
- return { status, summary, deleted: true };
457
+ return settled;
458
+ }
459
+ /**
460
+ * Phase 1 — claim. Must be called while holding the lock (`locked()`, whose
461
+ * chain is module-global and therefore shared across CronService instances).
462
+ *
463
+ * Returns `null` on a successful claim, or the reason the claim was refused.
464
+ * `'already running'` is what makes a second `run()` report a skip instead of
465
+ * launching a concurrent invocation. `'removed'` covers the job being deleted
466
+ * between `run()`'s unlocked lookup and this lock turn — claiming then would
467
+ * `markRunning` an orphan and, worse, `removeFromHeap` an id that may now
468
+ * belong to a replacement.
469
+ *
470
+ * Detaching from the heap here — rather than relying on phase 3 to push a
471
+ * fresh entry — is what stops manual runs permanently duplicating entries.
472
+ *
473
+ * `#private`: published, this would be a supported call performing
474
+ * `markRunning` + `removeFromHeap` with no guaranteed settle and no lease on
475
+ * `runningAtMs`, so a single such call would strand the job forever. The
476
+ * lock-held precondition cannot be expressed in the type system, so the
477
+ * method must not be reachable from outside the class body.
478
+ */
479
+ #claimJob(job) {
480
+ if (this.jobs.get(job.id) !== job)
481
+ return 'removed';
482
+ if (job.state.runningAtMs)
483
+ return 'already running';
484
+ markRunning(job);
485
+ this.removeFromHeap(job.id);
486
+ return null;
487
+ }
488
+ /**
489
+ * Phase 3 — settle. Must be called while holding the lock.
490
+ *
491
+ * `#private` for the same reason as `#claimJob`: unlocked it would run
492
+ * `applyResult`, a `runLog.record`, a full `removeFromHeap` rebuild, a
493
+ * `heap.push` and an `armTimer` with no mutual exclusion — exactly the
494
+ * corruption `locked()` exists to prevent.
495
+ */
496
+ #settleJob(job, status, error, summary, startMs, durationMs) {
497
+ try {
498
+ const validStatus = (status === 'ok' || status === 'error' || status === 'skipped') ? status : 'error';
499
+ applyResult(job, validStatus, error, durationMs);
500
+ // The callback ran unlocked, so this job may have been removed — or
501
+ // removed and re-registered under the same id, the shape
502
+ // `start(initialJobs)` uses — while it was in flight. Identity, not id.
503
+ //
504
+ // Deliberately touch NOTHING here. The claim already detached this job's
505
+ // heap entry and nothing re-added it, so there is nothing to clean up;
506
+ // any entry now filed under this id belongs to the replacement, and
507
+ // removing it by id would silently unschedule a live job. Do not
508
+ // resurrect a removed job's heap entry or run log either.
509
+ if (this.jobs.get(job.id) !== job) {
510
+ return { status, error, summary, durationMs };
511
+ }
512
+ // Log the run
513
+ this.runLog.record({
514
+ jobId: job.id,
515
+ status,
516
+ error,
517
+ summary,
518
+ runAtMs: startMs,
519
+ durationMs,
520
+ nextRunAtMs: job.state.nextRunAtMs,
521
+ });
522
+ // Handle one-shot auto-delete. The callback ran unlocked and may have
523
+ // pushed a heap entry for this job via add()/update(), so drop it — the
524
+ // job is about to stop existing.
525
+ if (job.deleteAfterRun && status === 'ok' && !job.enabled) {
526
+ this.jobs.delete(job.id);
527
+ this.removeFromHeap(job.id);
528
+ this.runLog.removeJob(job.id);
529
+ return { status, summary, deleted: true };
530
+ }
531
+ // Re-insert into the heap if still active. Same reason as above: drop any
532
+ // entry the unlocked callback added for this job first, to preserve
533
+ // one-entry-per-key.
534
+ this.removeFromHeap(job.id);
535
+ if (job.enabled && job.state.nextRunAtMs) {
536
+ this.heap.push({ key: job.id, nextTrigger: job.state.nextRunAtMs });
537
+ }
538
+ return { status, error, summary, durationMs };
243
539
  }
244
- // Re-insert into heap if still active
245
- if (job.enabled && job.state.nextRunAtMs) {
246
- this.heap.push({ key: job.id, nextTrigger: job.state.nextRunAtMs });
540
+ finally {
541
+ // One re-arm covering every exit, rather than one per branch. The claim
542
+ // detached this job from the heap, so a timer that fired during the
543
+ // unlocked invoke would have found nothing to arm — and `run()` has no
544
+ // `finally { armTimer() }` of its own the way `onTimer` does. Without
545
+ // this, a manual run() can leave the scheduler with no pending wake.
546
+ this.armTimer();
247
547
  }
248
- return { status, error, summary, durationMs };
249
548
  }
250
549
  // -- Helpers ---------------------------------------------------------
251
550
  removeFromHeap(id) {
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "keywords": [
4
4
  "stonyx-module"
5
5
  ],
6
- "version": "0.2.1-alpha.49",
6
+ "version": "0.2.1-alpha.50",
7
7
  "description": "Cron/job scheduler for Stonyx framework",
8
8
  "main": "dist/main.js",
9
9
  "types": "dist/main.d.ts",
@@ -79,7 +79,7 @@
79
79
  "typescript": "^5.8.3"
80
80
  },
81
81
  "dependencies": {
82
- "stonyx": "0.2.3-beta.83"
82
+ "stonyx": "0.2.3-beta.81"
83
83
  },
84
84
  "scripts": {
85
85
  "build": "tsc",