@dbos-inc/dbos-sdk 4.9.6-preview → 4.9.9-preview

package/dist/src/scheduler/scheduler.js

@@ -1,172 +1,231 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScheduledReceiver = exports.SchedulerMode = void 0;
+exports.backfillSchedule = exports.triggerSchedule = exports.DynamicSchedulerLoop = exports.createScheduleId = exports.toWorkflowSchedule = void 0;
+const serialization_1 = require("../serialization");
+const crypto_1 = require("crypto");
 const __1 = require("..");
+const decorators_1 = require("../decorators");
 const utils_1 = require("../utils");
 const crontab_1 = require("./crontab");
-////
-// Configuration
-////
-/**
- * Choices for scheduler mode for `@DBOS.scheduled` workflows
- */
-var SchedulerMode;
-(function (SchedulerMode) {
-    /**
-     * Using `ExactlyOncePerInterval` causes the scheduler to add "make-up work" for any
-     *  schedule slots that occurred when the app was not running
-     */
-    SchedulerMode["ExactlyOncePerInterval"] = "ExactlyOncePerInterval";
-    /**
-     * Using `ExactlyOncePerIntervalWhenActive` causes the scheduler to run the workflow once
-     *  per interval when the application is active.  If the app is not running at a time
-     *  otherwise indicated by the schedule, no workflow will be run.
-     */
-    SchedulerMode["ExactlyOncePerIntervalWhenActive"] = "ExactlyOncePerIntervalWhenActive";
-})(SchedulerMode || (exports.SchedulerMode = SchedulerMode = {}));
-///////////////////////////
-// Scheduler Management
-///////////////////////////
-const SCHEDULER_EVENT_SERVICE_NAME = 'dbos.scheduler';
-class ScheduledReceiver {
-    #controller = new AbortController();
-    #disposables = new Array();
-    constructor() {
+const dbos_executor_1 = require("../dbos-executor");
+const error_1 = require("../error");
+const workflow_1 = require("../workflow");
+function toWorkflowSchedule(internal, serializer) {
+    const context = serializer.parse(internal.context);
+    return {
+        scheduleId: internal.scheduleId,
+        scheduleName: internal.scheduleName,
+        workflowName: internal.workflowName,
+        workflowClassName: internal.workflowClassName,
+        schedule: internal.schedule,
+        status: internal.status,
+        context,
+    };
+}
+exports.toWorkflowSchedule = toWorkflowSchedule;
+function createScheduleId() {
+    return (0, crypto_1.randomUUID)();
+}
+exports.createScheduleId = createScheduleId;
+class DynamicSchedulerLoop {
+    #mainController = new AbortController();
+    #pollingPromise;
+    #scheduleLoops = new Map();
+    #pollingIntervalMs;
+    constructor(pollingIntervalMs) {
+        this.#pollingIntervalMs = pollingIntervalMs ?? 30000;
         __1.DBOS.registerLifecycleCallback(this);
     }
-    // eslint-disable-next-line @typescript-eslint/require-await
     async initialize() {
-        for (const regOp of __1.DBOS.getAssociatedInfo(SCHEDULER_EVENT_SERVICE_NAME)) {
-            if (regOp.methodReg.registeredFunction === undefined) {
-                __1.DBOS.logger.warn(`Scheduled workflow ${regOp.methodReg.className}.${regOp.methodReg.name} is missing registered function; skipping`);
-                continue;
-            }
-            const { crontab, mode, queueName } = regOp.methodConfig;
-            if (!crontab) {
-                __1.DBOS.logger.warn(`Scheduled workflow ${regOp.methodReg.className}.${regOp.methodReg.name} is missing crontab; skipping`);
-                continue;
-            }
-            const timeMatcher = new crontab_1.TimeMatcher(crontab);
-            const promise = ScheduledReceiver.#schedulerLoop(regOp.methodReg, timeMatcher, mode ?? SchedulerMode.ExactlyOncePerIntervalWhenActive, queueName, this.#controller.signal);
-            this.#disposables.push(promise);
-        }
+        this.#pollingPromise = this.#pollingLoop(this.#mainController.signal);
+        await Promise.resolve();
     }
     async destroy() {
-        this.#controller.abort();
-        const promises = this.#disposables.splice(0);
-        await Promise.allSettled(promises);
+        this.#mainController.abort();
+        // Abort all per-schedule loops
+        for (const entry of this.#scheduleLoops.values()) {
+            entry.controller.abort();
+        }
+        const allPromises = [];
+        if (this.#pollingPromise) {
+            allPromises.push(this.#pollingPromise);
+        }
+        for (const entry of this.#scheduleLoops.values()) {
+            allPromises.push(entry.promise);
+        }
+        await Promise.allSettled(allPromises);
+        this.#scheduleLoops.clear();
     }
-    logRegisteredEndpoints() {
-        __1.DBOS.logger.info('Scheduled endpoints:');
-        for (const regOp of __1.DBOS.getAssociatedInfo(SCHEDULER_EVENT_SERVICE_NAME)) {
-            const name = `${regOp.methodReg.className}.${regOp.methodReg.name}`;
-            const { crontab, mode } = regOp.methodConfig;
-            if (crontab) {
-                __1.DBOS.logger.info(`    ${name} @ ${crontab}; ${mode ?? SchedulerMode.ExactlyOncePerIntervalWhenActive}`);
+    async #pollingLoop(signal) {
+        while (!signal.aborted) {
+            let schedules;
+            try {
+                const executor = dbos_executor_1.DBOSExecutor.globalInstance;
+                schedules = await executor.systemDatabase.listSchedules();
+            }
+            catch (e) {
+                __1.DBOS.logger.warn(`Dynamic scheduler: error listing schedules: ${e.message}`);
+                await DynamicSchedulerLoop.#cancellableSleep(this.#pollingIntervalMs, signal);
+                continue;
+            }
+            // Build set of current schedule names
+            const currentNames = new Set(schedules.map((s) => s.scheduleName));
+            // Stop loops for deleted schedules
+            for (const [name, entry] of this.#scheduleLoops) {
+                if (!currentNames.has(name)) {
+                    entry.controller.abort();
+                    this.#scheduleLoops.delete(name);
+                }
             }
-            else {
-                __1.DBOS.logger.info(`    ${name} is missing crontab; skipping`);
+            // Process each schedule
+            for (const sched of schedules) {
+                const existing = this.#scheduleLoops.get(sched.scheduleName);
+                if (sched.status === 'PAUSED' && existing) {
+                    // Paused but has a running loop — stop it
+                    existing.controller.abort();
+                    this.#scheduleLoops.delete(sched.scheduleName);
+                }
+                else if (sched.status === 'ACTIVE') {
+                    // If schedule was replaced (different scheduleId), restart the loop
+                    if (existing && existing.scheduleId !== sched.scheduleId) {
+                        existing.controller.abort();
+                        this.#scheduleLoops.delete(sched.scheduleName);
+                    }
+                    if (!this.#scheduleLoops.has(sched.scheduleName)) {
+                        // Active and no running loop — start one
+                        const controller = new AbortController();
+                        const executor = dbos_executor_1.DBOSExecutor.globalInstance;
+                        const promise = DynamicSchedulerLoop.#scheduleLoop(sched.scheduleName, sched.workflowName, sched.workflowClassName, sched.schedule, sched.context, executor.serializer, controller.signal);
+                        this.#scheduleLoops.set(sched.scheduleName, { controller, promise, scheduleId: sched.scheduleId });
+                    }
+                }
             }
+            await DynamicSchedulerLoop.#cancellableSleep(this.#pollingIntervalMs, signal);
         }
     }
-    static async #schedulerLoop(methodReg, timeMatcher, mode, queueName, signal) {
-        const name = `${methodReg.className}.${methodReg.name}`;
-        let lastExec = new Date().setMilliseconds(0);
-        if (mode === SchedulerMode.ExactlyOncePerInterval) {
-            const lastState = await __1.DBOS.getEventDispatchState(SCHEDULER_EVENT_SERVICE_NAME, name, 'lastState');
-            if (lastState?.value) {
-                lastExec = parseFloat(lastState.value);
-            }
+    static async #scheduleLoop(scheduleName, workflowName, workflowClassName, cronExpression, serializedContext, serializer, signal) {
+        // Look up the registered workflow function
+        const methReg = (0, decorators_1.getFunctionRegistrationByName)(workflowClassName, workflowName);
+        if (!methReg || !methReg.registeredFunction) {
+            __1.DBOS.logger.warn(`Dynamic scheduler: workflow ${workflowClassName}.${workflowName} for schedule "${scheduleName}" is not registered; skipping`);
+            return;
         }
+        const timeMatcher = new crontab_1.TimeMatcher(cronExpression);
+        let lastExec = new Date().setMilliseconds(0);
         while (!signal.aborted) {
             const nextExec = timeMatcher.nextWakeupTime(lastExec).getTime();
             let sleepTime = nextExec - Date.now();
-            // To prevent a "thundering herd" problem in a distributed setting,
-            // apply jitter of up to 10% the sleep time, capped at 10 seconds
+            // Apply jitter to prevent thundering herd
             if (sleepTime > 0) {
                 const maxJitter = Math.min(sleepTime / 10, 10000);
-                const jitter = Math.random() * maxJitter;
-                sleepTime += jitter;
+                sleepTime += Math.random() * maxJitter;
             }
             if (sleepTime > 0) {
-                await new Promise((resolve, reject) => {
-                    // eslint-disable-next-line prefer-const
-                    let timeoutID;
-                    const onAbort = () => {
-                        clearTimeout(timeoutID);
-                        reject(new Error('Abort signal received'));
-                    };
-                    signal.addEventListener('abort', onAbort, { once: true });
-                    if (signal.aborted) {
-                        signal.removeEventListener('abort', onAbort);
-                        reject(new Error('Abort signal received'));
-                    }
-                    timeoutID = setTimeout(() => {
-                        signal.removeEventListener('abort', onAbort);
-                        resolve();
-                    }, sleepTime);
-                });
+                await DynamicSchedulerLoop.#cancellableSleep(sleepTime, signal);
             }
             if (signal.aborted) {
                 break;
             }
-            if (!timeMatcher.match(nextExec)) {
-                lastExec = nextExec;
-                continue;
-            }
             const date = new Date(nextExec);
-            if (methodReg.workflowConfig && methodReg.registeredFunction) {
-                const workflowID = `sched-${name}-${date.toISOString()}`;
-                const wfParams = { workflowID, queueName: queueName ?? utils_1.INTERNAL_QUEUE_NAME };
-                __1.DBOS.logger.debug(`Executing scheduled workflow ${workflowID}`);
-                await __1.DBOS.startWorkflow(methodReg.registeredFunction, wfParams)(date, new Date());
+            const workflowID = `sched-${scheduleName}-${date.toISOString()}`;
+            try {
+                // Idempotency check -- for performance only, not needed for correctness
+                const existing = await __1.DBOS.getWorkflowStatus(workflowID);
+                if (existing) {
+                    lastExec = nextExec;
+                    continue;
+                }
+                const wfParams = { workflowID, queueName: utils_1.INTERNAL_QUEUE_NAME };
+                const context = serializer.parse(serializedContext);
+                await __1.DBOS.startWorkflow(methReg.registeredFunction, wfParams)(date, context);
             }
-            else {
-                __1.DBOS.logger.error(`${name} is @scheduled but not a workflow`);
+            catch (e) {
+                __1.DBOS.logger.warn(`Dynamic scheduler: error firing workflow for schedule "${scheduleName}": ${e.message}`);
             }
-            lastExec = await ScheduledReceiver.#setLastExecTime(name, nextExec);
+            lastExec = nextExec;
         }
     }
-    static async #setLastExecTime(name, time) {
-        // Record the time of the wf kicked off
-        try {
-            const state = {
-                service: SCHEDULER_EVENT_SERVICE_NAME,
-                workflowFnName: name,
-                key: 'lastState',
-                value: `${time}`,
-                updateTime: time,
+    static async #cancellableSleep(ms, signal) {
+        if (signal.aborted)
+            return;
+        await new Promise((resolve) => {
+            // eslint-disable-next-line prefer-const
+            let timeoutID;
+            const onAbort = () => {
+                clearTimeout(timeoutID);
+                resolve();
             };
-            const newState = await __1.DBOS.upsertEventDispatchState(state);
-            const dbTime = parseFloat(newState.value);
-            if (dbTime && dbTime > time) {
-                return dbTime;
+            signal.addEventListener('abort', onAbort, { once: true });
+            if (signal.aborted) {
+                signal.removeEventListener('abort', onAbort);
+                resolve();
+                return;
             }
-        }
-        catch (e) {
-            // This write is not strictly essential and the scheduler is often the "canary in the coal mine"
-            //  We will simply continue after giving full details.
-            const err = e;
-            __1.DBOS.logger.warn(`Scheduler caught an error writing to system DB: ${err.message}`);
-            __1.DBOS.logger.error(e);
-        }
-        return time;
-    }
-    // registerScheduled is static so it can be called before an instance is created during DBOS.launch.
-    // This means we can't use the instance as the external info key for associateFunctionWithInfo below
-    // or in getAssociatedInfo above...which means we can only have one scheduled receiver instance.
-    // However, since this is an internal receiver, it's safe to assume there is ever only one instnace.
-    static registerScheduled(func, config) {
-        const { regInfo } = __1.DBOS.associateFunctionWithInfo(SCHEDULER_EVENT_SERVICE_NAME, func, {
-            ctorOrProto: config.ctorOrProto,
-            className: config.className,
-            name: config.name ?? func.name,
+            timeoutID = setTimeout(() => {
+                signal.removeEventListener('abort', onAbort);
+                resolve();
+            }, ms);
         });
-        const schedRegInfo = regInfo;
-        schedRegInfo.crontab = config.crontab;
-        schedRegInfo.mode = config.mode;
-        schedRegInfo.queueName = config.queueName;
     }
 }
-exports.ScheduledReceiver = ScheduledReceiver;
+exports.DynamicSchedulerLoop = DynamicSchedulerLoop;
+function enqueueScheduledWorkflow(systemDatabase, serializer, sched, workflowID, scheduledDate, context) {
+    const serparam = (0, serialization_1.serializeArgs)([scheduledDate, context], undefined, serializer, undefined);
+    const internalStatus = {
+        workflowUUID: workflowID,
+        status: workflow_1.StatusString.ENQUEUED,
+        workflowName: sched.workflowName,
+        workflowClassName: sched.workflowClassName,
+        workflowConfigName: '',
+        queueName: utils_1.INTERNAL_QUEUE_NAME,
+        authenticatedUser: '',
+        output: null,
+        error: null,
+        assumedRole: '',
+        authenticatedRoles: [],
+        request: {},
+        executorId: '',
+        applicationID: '',
+        createdAt: Date.now(),
+        input: serparam.serializedValue,
+        deduplicationID: undefined,
+        priority: 0,
+        queuePartitionKey: undefined,
+        serialization: serparam.serialization,
+    };
+    return systemDatabase.initWorkflowStatus(internalStatus, null).then(() => { });
+}
+async function triggerSchedule(systemDatabase, serializer, name) {
+    const sched = await systemDatabase.getSchedule(name);
+    if (!sched) {
+        throw new error_1.DBOSError(`Schedule "${name}" not found`);
+    }
+    const context = serializer.parse(sched.context);
+    const now = new Date();
+    const workflowID = `sched-${name}-trigger-${now.toISOString()}`;
+    await enqueueScheduledWorkflow(systemDatabase, serializer, sched, workflowID, now, context);
+    return workflowID;
+}
+exports.triggerSchedule = triggerSchedule;
+async function backfillSchedule(systemDatabase, serializer, name, start, end) {
+    const sched = await systemDatabase.getSchedule(name);
+    if (!sched) {
+        throw new error_1.DBOSError(`Schedule "${name}" not found`);
+    }
+    const context = serializer.parse(sched.context);
+    const timeMatcher = new crontab_1.TimeMatcher(sched.schedule);
+    const workflowIDs = [];
+    let current = start.getTime();
+    while (current < end.getTime()) {
+        const next = timeMatcher.nextWakeupTime(current);
+        if (next.getTime() >= end.getTime())
+            break;
+        const workflowID = `sched-${name}-${next.toISOString()}`;
+        await enqueueScheduledWorkflow(systemDatabase, serializer, sched, workflowID, next, context);
+        workflowIDs.push(workflowID);
+        current = next.getTime();
+    }
+    return workflowIDs;
+}
+exports.backfillSchedule = backfillSchedule;
 //# sourceMappingURL=scheduler.js.map

package/dist/src/scheduler/scheduler.js.map

@@ -1 +1 @@
-{"version":3,"file":"scheduler.js","sourceRoot":"","sources":["../../../src/scheduler/scheduler.ts"],"names":[],"mappings":";;;AAAA,0BAA6C;AAE7C,oCAA+C;AAC/C,uCAAwC;AAExC,IAAI;AACJ,gBAAgB;AAChB,IAAI;AAEJ;;GAEG;AACH,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB;;;OAGG;IACH,kEAAiD,CAAA;IACjD;;;;OAIG;IACH,sFAAqE,CAAA;AACvE,CAAC,EAZW,aAAa,6BAAb,aAAa,QAYxB;AAyBD,2BAA2B;AAC3B,uBAAuB;AACvB,2BAA2B;AAE3B,MAAM,4BAA4B,GAAG,gBAAgB,CAAC;AAEtD,MAAa,iBAAiB;IACnB,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;IACpC,YAAY,GAAG,IAAI,KAAK,EAAiB,CAAC;IAEnD;QACE,QAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,UAAU;QACd,KAAK,MAAM,KAAK,IAAI,QAAI,CAAC,iBAAiB,CAAC,4BAA4B,CAAC,EAAE,CAAC;YACzE,IAAI,KAAK,CAAC,SAAS,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBACrD,QAAI,CAAC,MAAM,CAAC,IAAI,CACd,sBAAsB,KAAK,CAAC,SAAS,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,2CAA2C,CACnH,CAAC;gBACF,SAAS;YACX,CAAC;YAED,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,YAAwC,CAAC;YACpF,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,QAAI,CAAC,MAAM,CAAC,IAAI,CACd,sBAAsB,KAAK,CAAC,SAAS,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,+BAA+B,CACvG,CAAC;gBACF,SAAS;YACX,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,qBAAW,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,OAAO,GAAG,iBAAiB,CAAC,cAAc,CAC9C,KAAK,CAAC,SAAS,EACf,WAAW,EACX,IAAI,IAAI,aAAa,CAAC,gCAAgC,EACtD,SAAS,EACT,IAAI,CAAC,WAAW,CAAC,MAAM,CACxB,CAAC;YACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,sBAAsB;QACpB,QAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACzC,KAAK,MAAM,KAAK,IAAI,QAAI,CAAC,iBAAiB,CAAC,4BAA4B,CAAC,EAAE,CAAC;YACzE,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YACpE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,YAAwC,CAAC;YACzE,IAAI,OAAO,EAAE,CAAC;gBACZ,QAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,OAAO,KAAK,IAAI,IAAI,aAAa,CAAC,gCAAgC,EAAE,CAAC,CAAC;YAC1G,CAAC;iBAAM,CAAC;gBACN,QAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,+BAA+B,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,cAAc,CACzB,SAAiC,EACjC,WAAwB,EACxB,IAAmB,EACnB,SAA6B,EAC7B,MAAmB;QAEnB,MAAM,IAAI,GAAG,GAAG,SAAS,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;QAExD,IAAI,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,IAAI,KAAK,aAAa,CAAC,sBAAsB,EAAE,CAAC;YAClD,MAAM,SAAS,GAAG,MAAM,QAAI,CAAC,qBAAqB,CAAC,4BAA4B,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;YACpG,IAAI,SAAS,EAAE,KAAK,EAAE,CAAC;gBACrB,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,IAAI,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEtC,mEAAmE;YACnE,iEAAiE;YACjE,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;gBACzC,SAAS,IAAI,MAAM,CAAC;YACtB,CAAC;YAED,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC1C,wCAAwC;oBACxC,IAAI,SAAyB,CAAC;oBAE9B,MAAM,OAAO,GAAG,GAAG,EAAE;wBACnB,YAAY,CAAC,SAAS,CAAC,CAAC;wBACxB,MAAM,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;oBAC7C,CAAC,CAAC;oBAEF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;oBAE1D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;wBACnB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;wBAC7C,MAAM,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;oBAC7C,CAAC;oBAED,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;wBAC1B,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;wBAC7C,OAAO,EAAE,CAAC;oBACZ,CAAC,EAAE,SAAS,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;YACL,CAAC;YAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,QAAQ,GAAG,QAAQ,CAAC;gBACpB,SAAS;YACX,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,SAAS,CAAC,cAAc,IAAI,SAAS,CAAC,kBAAkB,EAAE,CAAC;gBAC7D,MAAM,UAAU,GAAG,SAAS,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACzD,MAAM,QAAQ,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,IAAI,2BAAmB,EAAE,CAAC;gBAC7E,QAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,UAAU,EAAE,CAAC,CAAC;gBAChE,MAAM,QAAI,CAAC,aAAa,CAAC,SAAS,CAAC,kBAA+C,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;YAClH,CAAC;iBAAM,CAAC;gBACN,QAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,mCAAmC,CAAC,CAAC;YAChE,CAAC;YAED,QAAQ,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,IAAY;QACtD,uCAAuC;QACvC,IAAI,CAAC;YACH,MAAM,KAAK,GAAsB;gBAC/B,OAAO,EAAE,4BAA4B;gBACrC,cAAc,EAAE,IAAI;gBACpB,GAAG,EAAE,WAAW;gBAChB,KAAK,EAAE,GAAG,IAAI,EAAE;gBAChB,UAAU,EAAE,IAAI;aACjB,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,QAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC;YAC3C,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,EAAE,CAAC;gBAC5B,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,gGAAgG;YAChG,sDAAsD;YACtD,MAAM,GAAG,GAAG,CAAU,CAAC;YACvB,QAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mDAAmD,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YACnF,QAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oGAAoG;IACpG,oGAAoG;IACpG,gGAAgG;IAChG,oGAAoG;IAEpG,MAAM,CAAC,iBAAiB,CACtB,IAA6D,EAC7D,MAAsC;QAEtC,MAAM,EAAE,OAAO,EAAE,GAAG,QAAI,CAAC,yBAAyB,CAAC,4BAA4B,EAAE,IAAI,EAAE;YACrF,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;SAC/B,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,OAA0B,CAAC;QAChD,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QACtC,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QAChC,YAAY,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IAC5C,CAAC;CACF;AAlLD,8CAkLC"}
+{"version":3,"file":"scheduler.js","sourceRoot":"","sources":["../../../src/scheduler/scheduler.ts"],"names":[],"mappings":";;;AACA,oDAAiE;AACjE,mCAAoC;AACpC,0BAA0B;AAC1B,8CAAqF;AACrF,oCAA+C;AAC/C,uCAAwC;AACxC,oDAAgD;AAChD,oCAAqC;AACrC,0CAA2C;AAc3C,SAAgB,kBAAkB,CAAC,QAAkC,EAAE,UAA0B;IAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEnD,OAAO;QACL,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;QAC7C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO;KACR,CAAC;AACJ,CAAC;AAZD,gDAYC;AAED,SAAgB,gBAAgB;IAC9B,OAAO,IAAA,mBAAU,GAAE,CAAC;AACtB,CAAC;AAFD,4CAEC;AAQD,MAAa,oBAAoB;IACtB,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IACjD,eAAe,CAA4B;IAClC,cAAc,GAAG,IAAI,GAAG,EAA6B,CAAC;IACtD,kBAAkB,CAAS;IAEpC,YAAY,iBAA0B;QACpC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,IAAI,KAAK,CAAC;QACrD,QAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACtE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,+BAA+B;QAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC;YACjD,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;QACD,MAAM,WAAW,GAAoB,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACzC,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC;YACjD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAmB;QACpC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,IAAI,SAAqC,CAAC;YAC1C,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,4BAAY,CAAC,cAAe,CAAC;gBAC9C,SAAS,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;YAC5D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,QAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+CAAgD,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;gBACxF,MAAM,oBAAoB,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;gBAC9E,SAAS;YACX,CAAC;YAED,sCAAsC;YACtC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;YAEnE,mCAAmC;YACnC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAChD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBACzB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAED,wBAAwB;YACxB,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;gBAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAE7D,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,QAAQ,EAAE,CAAC;oBAC1C,0CAA0C;oBAC1C,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBAC5B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBACjD,CAAC;qBAAM,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACrC,oEAAoE;oBACpE,IAAI,QAAQ,IAAI,QAAQ,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;wBACzD,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;wBAC5B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;oBACjD,CAAC;oBAED,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;wBACjD,yCAAyC;wBACzC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;wBACzC,MAAM,QAAQ,GAAG,4BAAY,CAAC,cAAe,CAAC;wBAC9C,MAAM,OAAO,GAAG,oBAAoB,CAAC,aAAa,CAChD,KAAK,CAAC,YAAY,EAClB,KAAK,CAAC,YAAY,EAClB,KAAK,CAAC,iBAAiB,EACvB,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,OAAO,EACb,QAAQ,CAAC,UAAU,EACnB,UAAU,CAAC,MAAM,CAClB,CAAC;wBACF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;oBACrG,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,oBAAoB,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CACxB,YAAoB,EACpB,YAAoB,EACpB,iBAAyB,EACzB,cAAsB,EACtB,iBAAyB,EACzB,UAA0B,EAC1B,MAAmB;QAEnB,2CAA2C;QAC3C,MAAM,OAAO,GAAG,IAAA,0CAA6B,EAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAC/E,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC5C,QAAI,CAAC,MAAM,CAAC,IAAI,CACd,+BAA+B,iBAAiB,IAAI,YAAY,kBAAkB,YAAY,+BAA+B,CAC9H,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,qBAAW,CAAC,cAAc,CAAC,CAAC;QAEpD,IAAI,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAE7C,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,IAAI,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEtC,0CAA0C;YAC1C,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,SAAS,IAAI,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;YACzC,CAAC;YAED,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,oBAAoB,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAClE,CAAC;YAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,MAAM,UAAU,GAAG,SAAS,YAAY,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAEjE,IAAI,CAAC;gBACH,wEAAwE;gBACxE,MAAM,QAAQ,GAAG,MAAM,QAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;gBAC1D,IAAI,QAAQ,EAAE,CAAC;oBACb,QAAQ,GAAG,QAAQ,CAAC;oBACpB,SAAS;gBACX,CAAC;gBACD,MAAM,QAAQ,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,2BAAmB,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;gBACpD,MAAM,QAAI,CAAC,aAAa,CAAC,OAAO,CAAC,kBAAyC,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACvG,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,QAAI,CAAC,MAAM,CAAC,IAAI,CACd,0DAA0D,YAAY,MAAO,CAAW,CAAC,OAAO,EAAE,CACnG,CAAC;YACJ,CAAC;YAED,QAAQ,GAAG,QAAQ,CAAC;QACtB,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAU,EAAE,MAAmB;QAC5D,IAAI,MAAM,CAAC,OAAO;YAAE,OAAO;QAC3B,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,wCAAwC;YACxC,IAAI,SAAyB,CAAC;YAE9B,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YAEF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAE1D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,OAAO,EAAE,CAAC;gBACV,OAAO;YACT,CAAC;YAED,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1B,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,OAAO,EAAE,CAAC;YACZ,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AArLD,oDAqLC;AAED,SAAS,wBAAwB,CAC/B,cAA8B,EAC9B,UAA0B,EAC1B,KAA+B,EAC/B,UAAkB,EAClB,aAAmB,EACnB,OAAgB;IAEhB,MAAM,QAAQ,GAAG,IAAA,6BAAa,EAAC,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC3F,MAAM,cAAc,GAA2B;QAC7C,YAAY,EAAE,UAAU;QACxB,MAAM,EAAE,uBAAY,CAAC,QAAQ;QAC7B,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;QAC1C,kBAAkB,EAAE,EAAE;QACtB,SAAS,EAAE,2BAAmB;QAC9B,iBAAiB,EAAE,EAAE;QACrB,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,EAAE;QACf,kBAAkB,EAAE,EAAE;QACtB,OAAO,EAAE,EAAE;QACX,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,EAAE;QACjB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,KAAK,EAAE,QAAQ,CAAC,eAAe;QAC/B,eAAe,EAAE,SAAS;QAC1B,QAAQ,EAAE,CAAC;QACX,iBAAiB,EAAE,SAAS;QAC5B,aAAa,EAAE,QAAQ,CAAC,aAAa;KACtC,CAAC;IACF,OAAO,cAAc,CAAC,kBAAkB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;AAChF,CAAC;AAEM,KAAK,UAAU,eAAe,CACnC,cAA8B,EAC9B,UAA0B,EAC1B,IAAY;IAEZ,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,iBAAS,CAAC,aAAa,IAAI,aAAa,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,UAAU,GAAG,SAAS,IAAI,YAAY,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;IAChE,MAAM,wBAAwB,CAAC,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC5F,OAAO,UAAU,CAAC;AACpB,CAAC;AAdD,0CAcC;AAEM,KAAK,UAAU,gBAAgB,CACpC,cAA8B,EAC9B,UAA0B,EAC1B,IAAY,EACZ,KAAW,EACX,GAAS;IAET,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,iBAAS,CAAC,aAAa,IAAI,aAAa,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,IAAI,qBAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpD,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,IAAI,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAE9B,OAAO,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE;YAAE,MAAM;QAE3C,MAAM,UAAU,GAAG,SAAS,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACzD,MAAM,wBAAwB,CAAC,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7F,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AA3BD,4CA2BC"}

package/dist/src/scheduler/scheduler_decorator.d.ts

@@ -0,0 +1,41 @@
+import { DBOSLifecycleCallback, FunctionName } from '../decorators';
+/**
+ * Choices for scheduler mode for `@DBOS.scheduled` workflows
+ */
+export declare enum SchedulerMode {
+    /**
+     * Using `ExactlyOncePerInterval` causes the scheduler to add "make-up work" for any
+     *  schedule slots that occurred when the app was not running
+     */
+    ExactlyOncePerInterval = "ExactlyOncePerInterval",
+    /**
+     * Using `ExactlyOncePerIntervalWhenActive` causes the scheduler to run the workflow once
+     *  per interval when the application is active.  If the app is not running at a time
+     *  otherwise indicated by the schedule, no workflow will be run.
+     */
+    ExactlyOncePerIntervalWhenActive = "ExactlyOncePerIntervalWhenActive"
+}
+/**
+ * Configuration for a `@DBOS.scheduled` workflow
+ */
+export interface SchedulerConfig {
+    /** Schedule, in 5- or 6-spot crontab format */
+    crontab: string;
+    /**
+     * Indicates whether or not to retroactively start workflows that were scheduled during
+     *  times when the app was not running.  @see `SchedulerMode`.
+     */
+    mode?: SchedulerMode;
+    /** If set, workflows will be enqueued on the named queue, rather than being started immediately */
+    queueName?: string;
+}
+export type ScheduledArgs = [Date, Date];
+export declare class ScheduledReceiver implements DBOSLifecycleCallback {
+    #private;
+    constructor();
+    initialize(): Promise<void>;
+    destroy(): Promise<void>;
+    logRegisteredEndpoints(): void;
+    static registerScheduled<This, Return>(func: (this: This, ...args: ScheduledArgs) => Promise<Return>, config: SchedulerConfig & FunctionName): void;
+}
+//# sourceMappingURL=scheduler_decorator.d.ts.map

package/dist/src/scheduler/scheduler_decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler_decorator.d.ts","sourceRoot":"","sources":["../../../src/scheduler/scheduler_decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAA0B,MAAM,eAAe,CAAC;AAQ5F;;GAEG;AACH,oBAAY,aAAa;IACvB;;;OAGG;IACH,sBAAsB,2BAA2B;IACjD;;;;OAIG;IACH,gCAAgC,qCAAqC;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,mGAAmG;IACnG,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAOD,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AASzC,qBAAa,iBAAkB,YAAW,qBAAqB;;;IASvD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA6B3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAM9B,sBAAsB,IAAI,IAAI;IAuH9B,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EACnC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,EAC7D,MAAM,EAAE,eAAe,GAAG,YAAY;CAazC"}

package/dist/src/scheduler/scheduler_decorator.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduledReceiver = exports.SchedulerMode = void 0;
+const __1 = require("..");
+const utils_1 = require("../utils");
+const crontab_1 = require("./crontab");
+////
+// Configuration
+////
+/**
+ * Choices for scheduler mode for `@DBOS.scheduled` workflows
+ */
+var SchedulerMode;
+(function (SchedulerMode) {
+    /**
+     * Using `ExactlyOncePerInterval` causes the scheduler to add "make-up work" for any
+     *  schedule slots that occurred when the app was not running
+     */
+    SchedulerMode["ExactlyOncePerInterval"] = "ExactlyOncePerInterval";
+    /**
+     * Using `ExactlyOncePerIntervalWhenActive` causes the scheduler to run the workflow once
+     *  per interval when the application is active.  If the app is not running at a time
+     *  otherwise indicated by the schedule, no workflow will be run.
+     */
+    SchedulerMode["ExactlyOncePerIntervalWhenActive"] = "ExactlyOncePerIntervalWhenActive";
+})(SchedulerMode || (exports.SchedulerMode = SchedulerMode = {}));
+///////////////////////////
+// Scheduler Management
+///////////////////////////
+const SCHEDULER_EVENT_SERVICE_NAME = 'dbos.scheduler';
+class ScheduledReceiver {
+    #controller = new AbortController();
+    #disposables = new Array();
+    constructor() {
+        __1.DBOS.registerLifecycleCallback(this);
+    }
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async initialize() {
+        for (const regOp of __1.DBOS.getAssociatedInfo(SCHEDULER_EVENT_SERVICE_NAME)) {
+            if (regOp.methodReg.registeredFunction === undefined) {
+                __1.DBOS.logger.warn(`Scheduled workflow ${regOp.methodReg.className}.${regOp.methodReg.name} is missing registered function; skipping`);
+                continue;
+            }
+            const { crontab, mode, queueName } = regOp.methodConfig;
+            if (!crontab) {
+                __1.DBOS.logger.warn(`Scheduled workflow ${regOp.methodReg.className}.${regOp.methodReg.name} is missing crontab; skipping`);
+                continue;
+            }
+            const timeMatcher = new crontab_1.TimeMatcher(crontab);
+            const promise = ScheduledReceiver.#schedulerLoop(regOp.methodReg, timeMatcher, mode ?? SchedulerMode.ExactlyOncePerIntervalWhenActive, queueName, this.#controller.signal);
+            this.#disposables.push(promise);
+        }
+    }
+    async destroy() {
+        this.#controller.abort();
+        const promises = this.#disposables.splice(0);
+        await Promise.allSettled(promises);
+    }
+    logRegisteredEndpoints() {
+        __1.DBOS.logger.info('Scheduled endpoints:');
+        for (const regOp of __1.DBOS.getAssociatedInfo(SCHEDULER_EVENT_SERVICE_NAME)) {
+            const name = `${regOp.methodReg.className}.${regOp.methodReg.name}`;
+            const { crontab, mode } = regOp.methodConfig;
+            if (crontab) {
+                __1.DBOS.logger.info(`    ${name} @ ${crontab}; ${mode ?? SchedulerMode.ExactlyOncePerIntervalWhenActive}`);
+            }
+            else {
+                __1.DBOS.logger.info(`    ${name} is missing crontab; skipping`);
+            }
+        }
+    }
+    static async #schedulerLoop(methodReg, timeMatcher, mode, queueName, signal) {
+        const name = `${methodReg.className}.${methodReg.name}`;
+        let lastExec = new Date().setMilliseconds(0);
+        if (mode === SchedulerMode.ExactlyOncePerInterval) {
+            const lastState = await __1.DBOS.getEventDispatchState(SCHEDULER_EVENT_SERVICE_NAME, name, 'lastState');
+            if (lastState?.value) {
+                lastExec = parseFloat(lastState.value);
+            }
+        }
+        while (!signal.aborted) {
+            const nextExec = timeMatcher.nextWakeupTime(lastExec).getTime();
+            let sleepTime = nextExec - Date.now();
+            // To prevent a "thundering herd" problem in a distributed setting,
+            // apply jitter of up to 10% the sleep time, capped at 10 seconds
+            if (sleepTime > 0) {
+                const maxJitter = Math.min(sleepTime / 10, 10000);
+                const jitter = Math.random() * maxJitter;
+                sleepTime += jitter;
+            }
+            if (sleepTime > 0) {
+                await new Promise((resolve, reject) => {
+                    // eslint-disable-next-line prefer-const
+                    let timeoutID;
+                    const onAbort = () => {
+                        clearTimeout(timeoutID);
+                        reject(new Error('Abort signal received'));
+                    };
+                    signal.addEventListener('abort', onAbort, { once: true });
+                    if (signal.aborted) {
+                        signal.removeEventListener('abort', onAbort);
+                        reject(new Error('Abort signal received'));
+                    }
+                    timeoutID = setTimeout(() => {
+                        signal.removeEventListener('abort', onAbort);
+                        resolve();
+                    }, sleepTime);
+                });
+            }
+            if (signal.aborted) {
+                break;
+            }
+            if (!timeMatcher.match(nextExec)) {
+                lastExec = nextExec;
+                continue;
+            }
+            const date = new Date(nextExec);
+            if (methodReg.workflowConfig && methodReg.registeredFunction) {
+                const workflowID = `sched-${name}-${date.toISOString()}`;
+                const wfParams = { workflowID, queueName: queueName ?? utils_1.INTERNAL_QUEUE_NAME };
+                __1.DBOS.logger.debug(`Executing scheduled workflow ${workflowID}`);
+                await __1.DBOS.startWorkflow(methodReg.registeredFunction, wfParams)(date, new Date());
+            }
+            else {
+                __1.DBOS.logger.error(`${name} is @scheduled but not a workflow`);
+            }
+            lastExec = await ScheduledReceiver.#setLastExecTime(name, nextExec);
+        }
+    }
+    static async #setLastExecTime(name, time) {
+        // Record the time of the wf kicked off
+        try {
+            const state = {
+                service: SCHEDULER_EVENT_SERVICE_NAME,
+                workflowFnName: name,
+                key: 'lastState',
+                value: `${time}`,
+                updateTime: time,
+            };
+            const newState = await __1.DBOS.upsertEventDispatchState(state);
+            const dbTime = parseFloat(newState.value);
+            if (dbTime && dbTime > time) {
+                return dbTime;
+            }
+        }
+        catch (e) {
+            // This write is not strictly essential and the scheduler is often the "canary in the coal mine"
+            //  We will simply continue after giving full details.
+            const err = e;
+            __1.DBOS.logger.warn(`Scheduler caught an error writing to system DB: ${err.message}`);
+            __1.DBOS.logger.error(e);
+        }
+        return time;
+    }
+    // registerScheduled is static so it can be called before an instance is created during DBOS.launch.
+    // This means we can't use the instance as the external info key for associateFunctionWithInfo below
+    // or in getAssociatedInfo above...which means we can only have one scheduled receiver instance.
+    // However, since this is an internal receiver, it's safe to assume there is ever only one instnace.
+    static registerScheduled(func, config) {
+        const { regInfo } = __1.DBOS.associateFunctionWithInfo(SCHEDULER_EVENT_SERVICE_NAME, func, {
+            ctorOrProto: config.ctorOrProto,
+            className: config.className,
+            name: config.name ?? func.name,
+        });
+        const schedRegInfo = regInfo;
+        schedRegInfo.crontab = config.crontab;
+        schedRegInfo.mode = config.mode;
+        schedRegInfo.queueName = config.queueName;
+    }
+}
+exports.ScheduledReceiver = ScheduledReceiver;
+//# sourceMappingURL=scheduler_decorator.js.map