@solidactions/sdk 0.1.1 → 0.2.0

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

@@ -1,41 +0,0 @@
-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.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["../../../src/scheduler/scheduler.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;IA+G9B,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.js

@@ -1,165 +0,0 @@
-"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();
-            const sleepTime = nextExec - Date.now();
-            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.js.map

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

@@ -1 +0,0 @@
-{"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,MAAM,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAExC,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;AA1KD,8CA0KC"}

package/dist/src/wfqueue.d.ts

@@ -1,64 +0,0 @@
-import { DBOSExecutor } from './dbos-executor';
-/**
- * Limit the maximum number of functions started from a `WorkflowQueue`
- *   per given time period.
- * If the limit is 5 and the period is 10, no more than 5 functions can be
- *   started per 10 seconds.
- */
-interface QueueRateLimit {
-    /** Number of queue dispateches per `periodSec` */
-    limitPerPeriod: number;
-    /** Period of time during which `limitPerPeriod` queued workflows may be dispatched */
-    periodSec: number;
-}
-/**
- * Limit the number of concurrent workflows running for a queue.
- * This limit may be per worker or global
- */
-export interface QueueParameters {
-    /** If defined, this limits the number of running workflows for a single DBOS process */
-    workerConcurrency?: number;
-    /** If defined, this limits the number of running workflows globally in the app */
-    concurrency?: number;
-    /** If set, this limits the rate at which queued workflows are started */
-    rateLimit?: QueueRateLimit;
-    /** If set, this queue supports priority */
-    priorityEnabled?: boolean;
-    /** If set, this queue supports partitioning */
-    partitionQueue?: boolean;
-}
-/**
- * Settings structure for a named workflow queue.
- * Workflow queues limit the rate and concurrency at which DBOS executes workflows.
- * Queue policies apply to workflows started by `DBOS.startWorkflow`,
- *   `DBOS.withWorkflowQueue`, etc.
- */
-export declare class WorkflowQueue {
-    readonly name: string;
-    readonly concurrency?: number;
-    readonly rateLimit?: QueueRateLimit;
-    readonly workerConcurrency?: number;
-    readonly priorityEnabled: boolean;
-    readonly partitionQueue: boolean;
-    constructor(name: string);
-    /**
-     *
-     * @param name - Name to give the `WorkflowQueue`, accepted by `DBOS.startWorkflow`
-     * @param queueParameters - Policy for limiting workflow initiation rate and execution concurrency
-     */
-    constructor(name: string, queueParameters: QueueParameters);
-}
-declare class WFQueueRunner {
-    readonly wfQueuesByName: Map<string, WorkflowQueue>;
-    private isRunning;
-    private interruptResolve?;
-    private pollingIntervalMs;
-    private readonly minPollingIntervalMs;
-    private readonly maxPollingIntervalMs;
-    stop(): void;
-    dispatchLoop(exec: DBOSExecutor, listenQueuesArg: WorkflowQueue[] | null): Promise<void>;
-    logRegisteredEndpoints(exec: DBOSExecutor): void;
-}
-export declare const wfQueueRunner: WFQueueRunner;
-export {};
-//# sourceMappingURL=wfqueue.d.ts.map

package/dist/src/wfqueue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wfqueue.d.ts","sourceRoot":"","sources":["../../src/wfqueue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAK/C;;;;;GAKG;AACH,UAAU,cAAc;IACtB,kDAAkD;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,sFAAsF;IACtF,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,wFAAwF;IACxF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kFAAkF;IAClF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yEAAyE;IACzE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,2CAA2C;IAC3C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,+CAA+C;IAC/C,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;GAKG;AACH,qBAAa,aAAa;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;IACpC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAS;IAC1C,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAS;gBAE7B,IAAI,EAAE,MAAM;IAExB;;;;OAIG;gBACS,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe;CA6B3D;AAED,cAAM,aAAa;IACjB,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAa;IAEhE,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,gBAAgB,CAAC,CAAa;IACtC,OAAO,CAAC,iBAAiB,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAgB;IACrD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkB;IAEvD,IAAI;IAQE,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0F9F,sBAAsB,CAAC,IAAI,EAAE,YAAY;CAc1C;AAED,eAAO,MAAM,aAAa,eAAsB,CAAC"}

package/dist/src/wfqueue.js

@@ -1,147 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.wfQueueRunner = exports.WorkflowQueue = void 0;
-const dbos_1 = require("./dbos");
-const debugpoint_1 = require("./debugpoint");
-const utils_1 = require("./utils");
-/**
- * Settings structure for a named workflow queue.
- * Workflow queues limit the rate and concurrency at which DBOS executes workflows.
- * Queue policies apply to workflows started by `DBOS.startWorkflow`,
- *   `DBOS.withWorkflowQueue`, etc.
- */
-class WorkflowQueue {
-    name;
-    concurrency;
-    rateLimit;
-    workerConcurrency;
-    priorityEnabled = false;
-    partitionQueue = false;
-    constructor(name, arg2, rateLimit) {
-        this.name = name;
-        if (dbos_1.DBOS.isInitialized()) {
-            dbos_1.DBOS.logger.warn(`Workflow queue '${name}' is being created after DBOS initialization and will not be considered for dequeue.`);
-        }
-        if (typeof arg2 === 'object' && arg2 !== null) {
-            // Handle the case where the second argument is QueueParameters
-            this.concurrency = arg2.concurrency;
-            this.rateLimit = arg2.rateLimit;
-            this.workerConcurrency = arg2.workerConcurrency;
-            this.priorityEnabled = arg2.priorityEnabled ?? false;
-            this.partitionQueue = arg2.partitionQueue ?? false;
-        }
-        else {
-            // Handle the case where the second argument is a number
-            this.concurrency = arg2;
-            this.rateLimit = rateLimit;
-        }
-        if (exports.wfQueueRunner.wfQueuesByName.has(name)) {
-            throw Error(`Workflow Queue '${name}' defined multiple times`);
-        }
-        exports.wfQueueRunner.wfQueuesByName.set(name, this);
-    }
-}
-exports.WorkflowQueue = WorkflowQueue;
-class WFQueueRunner {
-    wfQueuesByName = new Map();
-    isRunning = false;
-    interruptResolve;
-    pollingIntervalMs = 1000;
-    minPollingIntervalMs = 1000;
-    maxPollingIntervalMs = 120000;
-    stop() {
-        if (!this.isRunning)
-            return;
-        this.isRunning = false;
-        if (this.interruptResolve) {
-            this.interruptResolve();
-        }
-    }
-    async dispatchLoop(exec, listenQueuesArg) {
-        this.isRunning = true;
-        while (this.isRunning) {
-            // Wait for either the timeout or an interruption
-            let timer;
-            const timeoutPromise = new Promise((resolve) => {
-                timer = setTimeout(() => {
-                    resolve();
-                }, this.pollingIntervalMs);
-            });
-            await Promise.race([timeoutPromise, new Promise((_, reject) => (this.interruptResolve = reject))]).catch(() => {
-                exec.logger.debug('Workflow queue loop interrupted!');
-            }); // Interrupt sleep throws
-            clearTimeout(timer);
-            if (!this.isRunning) {
-                break;
-            }
-            let listenQueues;
-            if (listenQueuesArg !== null) {
-                // If explicitly listening for queues, use only those queues plus the internal queue
-                listenQueues = [...listenQueuesArg, this.wfQueuesByName.get(utils_1.INTERNAL_QUEUE_NAME)];
-            }
-            else {
-                // Else, listen to all declared queues
-                listenQueues = Array.from(this.wfQueuesByName.values());
-            }
-            // Check queues
-            for (const q of listenQueues) {
-                let wfids = [];
-                try {
-                    if (q.partitionQueue) {
-                        // For partitioned queues, get all partition keys and dequeue from each partition separately
-                        const partitionKeys = await exec.systemDatabase.getQueuePartitions(q.name);
-                        for (const partitionKey of partitionKeys) {
-                            const partitionWfids = await exec.systemDatabase.findAndMarkStartableWorkflows(q, exec.executorID, utils_1.globalParams.appVersion, partitionKey);
-                            wfids.push(...partitionWfids);
-                        }
-                    }
-                    else {
-                        // For non-partitioned queues, pass null to match workflows with queue_partition_key IS NULL
-                        wfids = await exec.systemDatabase.findAndMarkStartableWorkflows(q, exec.executorID, utils_1.globalParams.appVersion, undefined);
-                    }
-                }
-                catch (e) {
-                    const err = e;
-                    // Handle serialization errors and lock contention with backoff
-                    if ('code' in err && (err.code === '40001' || err.code === '55P03')) {
-                        // 40001: serialization_failure, 55P03: lock_not_available
-                        // Increase the polling interval on contention
-                        this.pollingIntervalMs = Math.min(this.maxPollingIntervalMs, this.pollingIntervalMs * 2.0);
-                        exec.logger.warn(`Contention detected in queue thread for ${q.name}. Increasing polling interval to ${(this.pollingIntervalMs / 1000).toFixed(2)}s.`);
-                    }
-                    else {
-                        exec.logger.warn(`Error getting startable workflows: ${err.message}`);
-                    }
-                    wfids = [];
-                }
-                if (wfids.length > 0) {
-                    await (0, debugpoint_1.debugTriggerPoint)(debugpoint_1.DEBUG_TRIGGER_WORKFLOW_QUEUE_START);
-                }
-                for (const wfid of wfids) {
-                    try {
-                        const _wfh = await exec.executeWorkflowId(wfid, { isQueueDispatch: true });
-                    }
-                    catch (e) {
-                        exec.logger.warn(`Could not execute workflow with id ${wfid}: ${e.message}`);
-                    }
-                }
-            }
-            // Gradually decrease the polling interval when there's no contention
-            this.pollingIntervalMs = Math.max(this.minPollingIntervalMs, this.pollingIntervalMs * 0.9);
-        }
-    }
-    logRegisteredEndpoints(exec) {
-        const logger = exec.logger;
-        logger.info('Workflow queues:');
-        for (const [qn, q] of this.wfQueuesByName) {
-            const conc = q.concurrency !== undefined ? `global concurrency limit: ${q.concurrency}` : 'No concurrency limit set';
-            logger.info(`    ${qn}: ${conc}`);
-            const workerconc = q.workerConcurrency !== undefined
-                ? `worker concurrency limit: ${q.workerConcurrency}`
-                : 'No worker concurrency limit set';
-            logger.info(`    ${qn}: ${workerconc}`);
-        }
-    }
-}
-exports.wfQueueRunner = new WFQueueRunner();
-//# sourceMappingURL=wfqueue.js.map

package/dist/src/wfqueue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wfqueue.js","sourceRoot":"","sources":["../../src/wfqueue.ts"],"names":[],"mappings":";;;AACA,iCAA8B;AAC9B,6CAAqF;AACrF,mCAA4D;AAgC5D;;;;;GAKG;AACH,MAAa,aAAa;IACf,IAAI,CAAS;IACb,WAAW,CAAU;IACrB,SAAS,CAAkB;IAC3B,iBAAiB,CAAU;IAC3B,eAAe,GAAY,KAAK,CAAC;IACjC,cAAc,GAAY,KAAK,CAAC;IAWzC,YAAY,IAAY,EAAE,IAA+B,EAAE,SAA0B;QACnF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,WAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzB,WAAI,CAAC,MAAM,CAAC,IAAI,CACd,mBAAmB,IAAI,sFAAsF,CAC9G,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC9C,+DAA+D;YAC/D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;YACpC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YAChC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YAChD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC;YACrD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,wDAAwD;YACxD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC7B,CAAC;QAED,IAAI,qBAAa,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,KAAK,CAAC,mBAAmB,IAAI,0BAA0B,CAAC,CAAC;QACjE,CAAC;QACD,qBAAa,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;CACF;AA5CD,sCA4CC;AAED,MAAM,aAAa;IACR,cAAc,GAA+B,IAAI,GAAG,EAAE,CAAC;IAExD,SAAS,GAAY,KAAK,CAAC;IAC3B,gBAAgB,CAAc;IAC9B,iBAAiB,GAAW,IAAI,CAAC;IACxB,oBAAoB,GAAW,IAAI,CAAC;IACpC,oBAAoB,GAAW,MAAM,CAAC;IAEvD,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAkB,EAAE,eAAuC;QAC5E,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;YACtB,iDAAiD;YACjD,IAAI,KAAqB,CAAC;YAC1B,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACnD,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBACtB,OAAO,EAAE,CAAC;gBACZ,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAC5G,GAAG,EAAE;gBACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;YACxD,CAAC,CACF,CAAC,CAAC,yBAAyB;YAC5B,YAAY,CAAC,KAAM,CAAC,CAAC;YAErB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACpB,MAAM;YACR,CAAC;YAED,IAAI,YAAY,CAAC;YACjB,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;gBAC7B,oFAAoF;gBACpF,YAAY,GAAG,CAAC,GAAG,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,2BAAmB,CAAE,CAAC,CAAC;YACrF,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1D,CAAC;YAED,eAAe;YACf,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC;gBAC7B,IAAI,KAAK,GAAa,EAAE,CAAC;gBACzB,IAAI,CAAC;oBACH,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;wBACrB,4FAA4F;wBAC5F,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;wBAC3E,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;4BACzC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAC5E,CAAC,EACD,IAAI,CAAC,UAAU,EACf,oBAAY,CAAC,UAAU,EACvB,YAAY,CACb,CAAC;4BACF,KAAK,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;wBAChC,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,4FAA4F;wBAC5F,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAC7D,CAAC,EACD,IAAI,CAAC,UAAU,EACf,oBAAY,CAAC,UAAU,EACvB,SAAS,CACV,CAAC;oBACJ,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,MAAM,GAAG,GAAG,CAAU,CAAC;oBACvB,+DAA+D;oBAC/D,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;wBACpE,0DAA0D;wBAC1D,8CAA8C;wBAC9C,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC;wBAC3F,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,2CAA2C,CAAC,CAAC,IAAI,oCAAoC,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CACpI,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;oBACxE,CAAC;oBACD,KAAK,GAAG,EAAE,CAAC;gBACb,CAAC;gBAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrB,MAAM,IAAA,8BAAiB,EAAC,+CAAkC,CAAC,CAAC;gBAC9D,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,IAAI,CAAC;wBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC7E,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,KAAM,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;oBAC1F,CAAC;gBACH,CAAC;YACH,CAAC;YAED,qEAAqE;YACrE,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC;QAC7F,CAAC;IACH,CAAC;IAED,sBAAsB,CAAC,IAAkB;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChC,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,MAAM,IAAI,GACR,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC;YAC1G,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;YAClC,MAAM,UAAU,GACd,CAAC,CAAC,iBAAiB,KAAK,SAAS;gBAC/B,CAAC,CAAC,6BAA6B,CAAC,CAAC,iBAAiB,EAAE;gBACpD,CAAC,CAAC,iCAAiC,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,UAAU,EAAE,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AAEY,QAAA,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC"}