@stonyx/cron 0.2.1-alpha.12 → 0.2.1-alpha.13

package/README.md

@@ -35,6 +35,8 @@ When a job is executed, its next trigger time is updated, and it is re-inserted
 |  `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. |
 | `unregister` |                               `key: string`                              | Remove a previously registered job.                                                                                      |
 
+> Callbacks are invoked fire-and-forget: `Cron` never waits for one to settle. Two *different* jobs that fall due on the same tick may therefore overlap, and a job that is still running when it next falls due is skipped for that tick (a warning is logged). Both synchronous throws and asynchronous rejections are caught and logged; neither can stop the scheduler.
+
 > `MinHeap` is also exported as a public subpath (`@stonyx/cron/min-heap`) and can be imported directly for advanced usage.
 
 ## Configuration

package/dist/main.d.ts

@@ -9,10 +9,21 @@ export default class Cron {
     jobs: Record<string, CronJob>;
     heap: MinHeap<CronJob>;
     timer: ReturnType<typeof setTimeout> | null;
+    /** Keys whose previous invocation has not settled yet. */
+    inFlight: Set<string>;
     constructor();
     init(): Promise<void>;
     scheduleNextRun(): void;
     runDueJobs(): Promise<void>;
+    /**
+     * The one safe way this class invokes a consumer callback.
+     *
+     * Never blocks the caller, catches synchronous throws and asynchronous
+     * rejections alike, and skips the invocation entirely when the job's previous
+     * invocation has not settled yet (fire-and-forget would otherwise let a slow
+     * job stack invocations on itself).
+     */
+    safeInvoke(job: CronJob, runOnInit?: boolean): void;
     register(key: string, callback: () => void | Promise<void>, interval: string, runOnInit?: boolean): void;
     unregister(key: string): void;
     setNextTrigger(job: CronJob): void;

package/dist/main.js

@@ -22,6 +22,8 @@ export default class Cron {
     jobs = {};
     heap = new MinHeap();
     timer = null;
+    /** Keys whose previous invocation has not settled yet. */
+    inFlight = new Set();
     constructor() {
         if (Cron.instance)
             return Cron.instance;
@@ -55,17 +57,47 @@ export default class Cron {
             const job = heap.pop();
             if (config.debug)
                 this.log('job has been triggered', job.key);
-            try {
-                await job.callback();
-            }
-            catch (err) {
-                log.error(`Cron job "${job.key}" failed:`, err);
-            }
+            // Reschedule *before* invoking. The callback's result is not used by this
+            // class (`runDueJobs` returns void), so awaiting it bought nothing and
+            // cost the scheduler: a callback that never settled left the job absent
+            // from the heap and stopped the timer from ever re-arming.
             this.setNextTrigger(job);
             heap.push(job);
+            this.safeInvoke(job);
         }
         this.scheduleNextRun();
     }
+    /**
+     * The one safe way this class invokes a consumer callback.
+     *
+     * Never blocks the caller, catches synchronous throws and asynchronous
+     * rejections alike, and skips the invocation entirely when the job's previous
+     * invocation has not settled yet (fire-and-forget would otherwise let a slow
+     * job stack invocations on itself).
+     */
+    safeInvoke(job, runOnInit = false) {
+        const { key } = job;
+        const context = runOnInit ? 'failed on init:' : 'failed:';
+        if (this.inFlight.has(key)) {
+            log.warn(`Cron job "${key}" is still running; skipping this tick`);
+            return;
+        }
+        this.inFlight.add(key);
+        try {
+            const result = job.callback();
+            if (result && typeof result.then === 'function') {
+                Promise.resolve(result)
+                    .catch(err => log.error(`Cron job "${key}" ${context}`, err))
+                    .finally(() => this.inFlight.delete(key));
+                return;
+            }
+            this.inFlight.delete(key);
+        }
+        catch (err) {
+            this.inFlight.delete(key);
+            log.error(`Cron job "${key}" ${context}`, err);
+        }
+    }
     register(key, callback, interval, runOnInit = false) {
         const job = { callback, interval, key, nextTrigger: 0 };
         this.jobs[key] = job;
@@ -74,14 +106,8 @@ export default class Cron {
         if (config.debug) {
             this.log(`job has been registered with interval: ${interval}`, key);
         }
-        if (runOnInit) {
-            try {
-                callback();
-            }
-            catch (err) {
-                log.error(`Cron job "${key}" failed on init:`, err);
-            }
-        }
+        if (runOnInit)
+            this.safeInvoke(job, true);
         this.scheduleNextRun();
     }
     unregister(key) {
@@ -91,6 +117,7 @@ export default class Cron {
             return;
         delete jobs[key];
         heap.remove(job);
+        this.inFlight.delete(key);
         if (config.debug)
             this.log('job has been unregistered', key);
         this.scheduleNextRun();

package/dist/service.d.ts

@@ -78,35 +78,7 @@ export default class CronService {
     armTimer(): void;
     onTimer(): Promise<void>;
     findDueJobs(nowMs: number): Job[];
-    /**
-     * Execute a job in three phases:
-     *
-     *   1. claim  (locked)   - take ownership of the job, detach it from the heap
-     *   2. invoke (UNLOCKED) - await the consumer callback
-     *   3. settle (locked)   - apply the result, log it, re-insert into the heap
-     *
-     * The critical section deliberately excludes phase 2. `onJobDue` is
-     * arbitrary, unbounded consumer code; awaiting it under the module-global
-     * lock is what wedged every subsequent `locked()` call (add/update/remove)
-     * when a callback never settled.
-     *
-     * `alreadyClaimed` is passed by `onTimer`, which performs the batch claim
-     * (findDueJobs + markRunning) for all due jobs under a single lock.
-     */
-    executeJob(job: Job, alreadyClaimed?: boolean): Promise<ExecuteResult>;
-    /**
-     * Phase 1 - claim. Must be called while holding the lock.
-     *
-     * Returns false if the job is already running, so a second `run()` reports
-     * "already running" instead of launching a concurrent invocation. Detaching
-     * from the heap here (rather than relying on phase 3 to push a fresh entry)
-     * is what keeps manual runs from permanently duplicating heap entries.
-     */
-    claimJob(job: Job): boolean;
-    /**
-     * Phase 3 - settle. Must be called while holding the lock.
-     */
-    settleJob(job: Job, status: string, error: string | undefined, summary: string | undefined, startMs: number, durationMs: number): ExecuteResult;
+    executeJob(job: Job): Promise<ExecuteResult>;
     removeFromHeap(id: string): void;
     log(message: string): void;
 }

package/dist/service.js

@@ -144,10 +144,6 @@ export default class CronService {
         if (mode === 'due' && !isDue(job, Date.now())) {
             return { status: 'skipped', reason: 'not due' };
         }
-        // Deliberately NOT wrapped in locked(): executeJob takes the lock itself
-        // for its claim and settle phases only. Wrapping here would re-create the
-        // wedge through a second door, since the callback would again be awaited
-        // while a lock is held.
         return this.executeJob(job);
     }
     /**
@@ -176,23 +172,16 @@ export default class CronService {
         }
         this.running = true;
         try {
-            // Phase 1 - claim (locked). Collecting due jobs pops them off the heap
-            // and marking them running makes them un-collectable by anyone else, so
-            // both must happen under the same lock.
-            const dueJobs = await locked(() => {
+            await locked(async () => {
                 const nowMs = Date.now();
-                const due = this.findDueJobs(nowMs);
-                for (const job of due) {
+                const dueJobs = this.findDueJobs(nowMs);
+                for (const job of dueJobs) {
                     markRunning(job);
                 }
-                return due;
+                for (const job of dueJobs) {
+                    await this.executeJob(job);
+                }
             });
-            // Phases 2 and 3 run outside the claim lock. The consumer callback is
-            // awaited here holding no lock at all, so a callback that never settles
-            // cannot poison the lock chain.
-            for (const job of dueJobs) {
-                await this.executeJob(job, true);
-            }
         }
         finally {
             this.running = false;
@@ -213,29 +202,7 @@ export default class CronService {
         }
         return due;
     }
-    /**
-     * Execute a job in three phases:
-     *
-     *   1. claim  (locked)   - take ownership of the job, detach it from the heap
-     *   2. invoke (UNLOCKED) - await the consumer callback
-     *   3. settle (locked)   - apply the result, log it, re-insert into the heap
-     *
-     * The critical section deliberately excludes phase 2. `onJobDue` is
-     * arbitrary, unbounded consumer code; awaiting it under the module-global
-     * lock is what wedged every subsequent `locked()` call (add/update/remove)
-     * when a callback never settled.
-     *
-     * `alreadyClaimed` is passed by `onTimer`, which performs the batch claim
-     * (findDueJobs + markRunning) for all due jobs under a single lock.
-     */
-    async executeJob(job, alreadyClaimed = false) {
-        // -- Phase 1: claim (locked) --
-        if (!alreadyClaimed) {
-            const claimed = await locked(() => this.claimJob(job));
-            if (!claimed)
-                return { status: 'skipped', reason: 'already running' };
-        }
-        // -- Phase 2: invoke (NOT locked) --
+    async executeJob(job) {
         const startMs = Date.now();
         let status = 'ok';
         let error;
@@ -256,37 +223,8 @@ export default class CronService {
             this.log(`Job "${job.name}" (${job.id}) failed: ${error}`);
         }
         const durationMs = Date.now() - startMs;
-        // -- Phase 3: settle (locked) --
-        return locked(() => this.settleJob(job, status, error, summary, startMs, durationMs));
-    }
-    /**
-     * Phase 1 - claim. Must be called while holding the lock.
-     *
-     * Returns false if the job is already running, so a second `run()` reports
-     * "already running" instead of launching a concurrent invocation. Detaching
-     * from the heap here (rather than relying on phase 3 to push a fresh entry)
-     * is what keeps manual runs from permanently duplicating heap entries.
-     */
-    claimJob(job) {
-        if (job.state.runningAtMs)
-            return false;
-        markRunning(job);
-        this.removeFromHeap(job.id);
-        return true;
-    }
-    /**
-     * Phase 3 - settle. Must be called while holding the lock.
-     */
-    settleJob(job, status, error, summary, startMs, durationMs) {
         const validStatus = (status === 'ok' || status === 'error' || status === 'skipped') ? status : 'error';
         applyResult(job, validStatus, error, durationMs);
-        // The callback ran unlocked, so it may have removed this job while it was
-        // in flight. Do not resurrect a removed job's heap entry or run log.
-        if (this.jobs.get(job.id) !== job) {
-            this.removeFromHeap(job.id);
-            this.armTimer();
-            return { status, error, summary, durationMs };
-        }
         // Log the run
         this.runLog.record({
             jobId: job.id,
@@ -300,22 +238,13 @@ export default class CronService {
         // Handle one-shot auto-delete
         if (job.deleteAfterRun && status === 'ok' && !job.enabled) {
             this.jobs.delete(job.id);
-            this.removeFromHeap(job.id);
             this.runLog.removeJob(job.id);
-            this.armTimer();
             return { status, summary, deleted: true };
         }
-        // Re-insert into heap if still active. The callback ran unlocked, so it
-        // may itself have added a heap entry for this job (via add/update); drop
-        // any such entry first to preserve one-entry-per-key.
-        this.removeFromHeap(job.id);
+        // Re-insert into heap if still active
         if (job.enabled && job.state.nextRunAtMs) {
             this.heap.push({ key: job.id, nextTrigger: job.state.nextRunAtMs });
         }
-        // The claim phase detached this job from the heap, so a timer that fired
-        // during the unlocked invoke would have seen it missing. Re-arm here so a
-        // manual run() can never leave the scheduler without a pending wake.
-        this.armTimer();
         return { status, error, summary, durationMs };
     }
     // -- Helpers ---------------------------------------------------------

package/package.json

@@ -3,7 +3,7 @@
   "keywords": [
     "stonyx-module"
   ],
-  "version": "0.2.1-alpha.12",
+  "version": "0.2.1-alpha.13",
   "description": "Cron/job scheduler for Stonyx framework",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",