openworkflow 0.3.0 → 0.4.1

package/dist/worker/worker.js

@@ -0,0 +1,208 @@
+import { executeWorkflow } from "../execution/execution.js";
+import { getWorkflowKey } from "../sdk/sdk.js";
+import { randomUUID } from "node:crypto";
+const DEFAULT_LEASE_DURATION_MS = 30 * 1000; // 30s
+const DEFAULT_POLL_INTERVAL_MS = 100; // 100ms
+const DEFAULT_CONCURRENCY = 1;
+/**
+ * Runs workflows by polling the backend, dispatching runs across a concurrency
+ * pool, and heartbeating/extending leases.
+ */
+export class Worker {
+    backend;
+    workerIds;
+    registeredWorkflows = new Map();
+    activeExecutions = new Set();
+    running = false;
+    loopPromise = null;
+    constructor(options) {
+        this.backend = options.backend;
+        const concurrency = Math.max(DEFAULT_CONCURRENCY, options.concurrency ?? DEFAULT_CONCURRENCY);
+        // generate worker IDs for every concurrency slot
+        this.workerIds = Array.from({ length: concurrency }, () => randomUUID());
+        // register workflows
+        for (const [name, workflow] of options.workflows) {
+            this.registeredWorkflows.set(name, workflow);
+        }
+    }
+    /**
+     * Start the worker. It will begin polling for and executing workflows.
+     */
+    async start() {
+        if (this.running)
+            return;
+        this.running = true;
+        this.loopPromise = this.runLoop();
+        await Promise.resolve();
+    }
+    /**
+     * Stop the worker gracefully. Waits for all active workflow runs to complete
+     * before returning.
+     */
+    async stop() {
+        this.running = false;
+        // wait for the poll loop to stop
+        if (this.loopPromise)
+            await this.loopPromise;
+        // wait for all active executions to finish
+        while (this.activeExecutions.size > 0)
+            await sleep(100);
+    }
+    /**
+     * Processes one round of work claims and execution. Exposed for testing.
+     * Returns the number of workflow runs claimed.
+     */
+    async tick() {
+        const availableSlots = this.concurrency - this.activeExecutions.size;
+        if (availableSlots <= 0)
+            return 0;
+        // claim work for each available slot
+        const claims = Array.from({ length: availableSlots }, (_, i) => {
+            const availableWorkerId = this.workerIds[i % this.workerIds.length];
+            return availableWorkerId
+                ? this.claimAndProcessWorkflowRunInBackground(availableWorkerId)
+                : Promise.resolve(null);
+        });
+        const claimed = await Promise.all(claims);
+        return claimed.filter((run) => run !== null).length;
+    }
+    /**
+     * Get the configured concurrency limit.
+     */
+    get concurrency() {
+        return this.workerIds.length;
+    }
+    /*
+     * Main run loop that continuously ticks while the worker is running.
+     * Only sleeps when no work was claimed to avoid busy-waiting.
+     */
+    async runLoop() {
+        while (this.running) {
+            try {
+                const claimedCount = await this.tick();
+                // only sleep if we didn't claim any work
+                if (claimedCount === 0) {
+                    await sleep(DEFAULT_POLL_INTERVAL_MS);
+                }
+            }
+            catch (error) {
+                console.error("Worker tick failed:", error);
+                await sleep(DEFAULT_POLL_INTERVAL_MS);
+            }
+        }
+    }
+    /*
+     * Cclaim and process a workflow run for the given worker ID. Do not await the
+     * processing here to avoid blocking the caller.
+     * Returns the claimed workflow run, or null if none was available.
+     */
+    async claimAndProcessWorkflowRunInBackground(workerId) {
+        // claim workflow run
+        const workflowRun = await this.backend.claimWorkflowRun({
+            workerId,
+            leaseDurationMs: DEFAULT_LEASE_DURATION_MS,
+        });
+        if (!workflowRun)
+            return null;
+        const key = getWorkflowKey(workflowRun.workflowName, workflowRun.version);
+        const workflow = this.registeredWorkflows.get(key);
+        if (!workflow) {
+            const versionStr = workflowRun.version
+                ? ` (version: ${workflowRun.version})`
+                : "";
+            await this.backend.failWorkflowRun({
+                workflowRunId: workflowRun.id,
+                workerId,
+                error: {
+                    message: `Workflow "${workflowRun.workflowName}"${versionStr} is not registered`,
+                },
+            });
+            return null;
+        }
+        // create execution and start processing *async* w/o blocking
+        const execution = new WorkflowExecution({
+            backend: this.backend,
+            workflowRun,
+            workerId,
+        });
+        this.activeExecutions.add(execution);
+        this.processExecutionInBackground(execution, workflow)
+            .catch(() => {
+            // errors are already handled in processExecution
+        })
+            .finally(() => {
+            execution.stopHeartbeat();
+            this.activeExecutions.delete(execution);
+        });
+        return workflowRun;
+    }
+    /**
+     * Process a workflow execution, handling heartbeats, step execution, and
+     * marking success or failure.
+     */
+    async processExecutionInBackground(execution, workflow) {
+        // start heartbeating
+        execution.startHeartbeat();
+        try {
+            await executeWorkflow({
+                backend: this.backend,
+                workflowRun: execution.workflowRun,
+                workflowFn: workflow.fn,
+                workflowVersion: execution.workflowRun.version,
+                workerId: execution.workerId,
+            });
+        }
+        catch (error) {
+            // specifically for unexpected errors in the execution wrapper itself, not
+            // for business logic errors (those are handled inside executeWorkflow)
+            console.error(`Critical error during workflow execution for run ${execution.workflowRun.id}:`, error);
+        }
+    }
+}
+/**
+ * Tracks a claimed workflow run and maintains its heartbeat lease for the
+ * worker.
+ */
+class WorkflowExecution {
+    backend;
+    workflowRun;
+    workerId;
+    heartbeatTimer = null;
+    constructor(options) {
+        this.backend = options.backend;
+        this.workflowRun = options.workflowRun;
+        this.workerId = options.workerId;
+    }
+    /**
+     * Start the heartbeat loop for this execution, heartbeating at half the lease
+     * duration.
+     */
+    startHeartbeat() {
+        const leaseDurationMs = DEFAULT_LEASE_DURATION_MS;
+        const heartbeatIntervalMs = leaseDurationMs / 2;
+        this.heartbeatTimer = setInterval(() => {
+            this.backend
+                .extendWorkflowRunLease({
+                workflowRunId: this.workflowRun.id,
+                workerId: this.workerId,
+                leaseDurationMs,
+            })
+                .catch((error) => {
+                console.error("Heartbeat failed:", error);
+            });
+        }, heartbeatIntervalMs);
+    }
+    /**
+     * Stop the heartbeat loop.
+     */
+    stopHeartbeat() {
+        if (this.heartbeatTimer) {
+            clearInterval(this.heartbeatTimer);
+            this.heartbeatTimer = null;
+        }
+    }
+}
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+//# sourceMappingURL=worker.js.map

package/dist/worker/worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../../worker/worker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,yBAAyB,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM;AACnD,MAAM,wBAAwB,GAAG,GAAG,CAAC,CAAC,QAAQ;AAC9C,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAY9B;;;GAGG;AACH,MAAM,OAAO,MAAM;IACA,OAAO,CAAU;IACjB,SAAS,CAAW;IACpB,mBAAmB,GAAG,IAAI,GAAG,EAG3C,CAAC;IACa,gBAAgB,GAAG,IAAI,GAAG,EAAqB,CAAC;IACzD,OAAO,GAAG,KAAK,CAAC;IAChB,WAAW,GAAyB,IAAI,CAAC;IAEjD,YAAY,OAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAE/B,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAC1B,mBAAmB,EACnB,OAAO,CAAC,WAAW,IAAI,mBAAmB,CAC3C,CAAC;QAEF,iDAAiD;QACjD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;QAEzE,qBAAqB;QACrB,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACjD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,iCAAiC;QACjC,IAAI,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,CAAC,WAAW,CAAC;QAE7C,2CAA2C;QAC3C,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC;YAAE,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;QACrE,IAAI,cAAc,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC;QAElC,qCAAqC;QACrC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC7D,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACpE,OAAO,iBAAiB;gBACtB,CAAC,CAAC,IAAI,CAAC,sCAAsC,CAAC,iBAAiB,CAAC;gBAChE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,IAAY,WAAW;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,OAAO;QACnB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvC,yCAAyC;gBACzC,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;oBACvB,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;gBACxC,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;gBAC5C,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,sCAAsC,CAClD,QAAgB;QAEhB,qBAAqB;QACrB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC;YACtD,QAAQ;YACR,eAAe,EAAE,yBAAyB;SAC3C,CAAC,CAAC;QACH,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC;QAE9B,MAAM,GAAG,GAAG,cAAc,CAAC,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO;gBACpC,CAAC,CAAC,cAAc,WAAW,CAAC,OAAO,GAAG;gBACtC,CAAC,CAAC,EAAE,CAAC;YACP,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;gBACjC,aAAa,EAAE,WAAW,CAAC,EAAE;gBAC7B,QAAQ;gBACR,KAAK,EAAE;oBACL,OAAO,EAAE,aAAa,WAAW,CAAC,YAAY,IAAI,UAAU,oBAAoB;iBACjF;aACF,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;QAED,6DAA6D;QAC7D,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC;YACtC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW;YACX,QAAQ;SACT,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAErC,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,QAAQ,CAAC;aACnD,KAAK,CAAC,GAAG,EAAE;YACV,iDAAiD;QACnD,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEL,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,4BAA4B,CACxC,SAA4B,EAC5B,QAAuD;QAEvD,qBAAqB;QACrB,SAAS,CAAC,cAAc,EAAE,CAAC;QAE3B,IAAI,CAAC;YACH,MAAM,eAAe,CAAC;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,UAAU,EAAE,QAAQ,CAAC,EAAE;gBACvB,eAAe,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO;gBAC9C,QAAQ,EAAE,SAAS,CAAC,QAAQ;aAC7B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,0EAA0E;YAC1E,uEAAuE;YACvE,OAAO,CAAC,KAAK,CACX,oDAAoD,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,EAC/E,KAAK,CACN,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAWD;;;GAGG;AACH,MAAM,iBAAiB;IACb,OAAO,CAAU;IACzB,WAAW,CAAc;IACzB,QAAQ,CAAS;IACT,cAAc,GAA0B,IAAI,CAAC;IAErD,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,MAAM,eAAe,GAAG,yBAAyB,CAAC;QAClD,MAAM,mBAAmB,GAAG,eAAe,GAAG,CAAC,CAAC;QAEhD,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE;YACrC,IAAI,CAAC,OAAO;iBACT,sBAAsB,CAAC;gBACtB,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE;gBAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,eAAe;aAChB,CAAC;iBACD,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;gBACxB,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACP,CAAC,EAAE,mBAAmB,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC;IACH,CAAC;CACF;AAED,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC"}

package/dist/worker/worker.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker.test.d.ts.map

package/dist/worker/worker.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.test.d.ts","sourceRoot":"","sources":["../../worker/worker.test.ts"],"names":[],"mappings":""}