@dbos-inc/dbos-sdk 4.19.8 → 4.20.5-preview

package/dist/src/system_database.js

@@ -517,9 +517,7 @@ class SystemDatabase {
     async recordWorkflowOutput(workflowID, status) {
         const client = await this.pool.connect();
         try {
-            await this.updateWorkflowStatus(client, workflowID, workflow_1.StatusString.SUCCESS, {
-                update: { output: status.output, resetDeduplicationID: true, setCompletedAt: true },
-            });
+            await this.#recordWorkflowOutcome(client, workflowID, workflow_1.StatusString.SUCCESS, { output: status.output });
         }
         finally {
             client.release();
@@ -528,14 +526,37 @@ class SystemDatabase {
     async recordWorkflowError(workflowID, status) {
         const client = await this.pool.connect();
         try {
-            await this.updateWorkflowStatus(client, workflowID, workflow_1.StatusString.ERROR, {
-                update: { error: status.error, resetDeduplicationID: true, setCompletedAt: true },
-            });
+            await this.#recordWorkflowOutcome(client, workflowID, workflow_1.StatusString.ERROR, { error: status.error });
         }
         finally {
             client.release();
         }
     }
+    // Record a workflow's terminal outcome (SUCCESS or ERROR), but never overwrite
+    // the terminal CANCELLED status: a workflow can be cancelled during its final
+    // step, and if so it must not be able to subsequently complete. If the
+    // workflow is cancelled, abort the function so it does not complete. This
+    // mirrors the cancellation check done before each step.
+    async #recordWorkflowOutcome(client, workflowID, status, outcome) {
+        let cancelled = false;
+        try {
+            await client.query('BEGIN');
+            await this.updateWorkflowStatus(client, workflowID, status, {
+                update: { ...outcome, resetDeduplicationID: true, setCompletedAt: true },
+                where: { notStatus: workflow_1.StatusString.CANCELLED },
+                throwOnFailure: false,
+            });
+            cancelled = (await this.getWorkflowStatusValue(client, workflowID)) === workflow_1.StatusString.CANCELLED;
+            await client.query('COMMIT');
+        }
+        catch (e) {
+            await client.query('ROLLBACK');
+            throw e;
+        }
+        if (cancelled) {
+            throw new error_1.DBOSWorkflowCancelledError(workflowID);
+        }
+    }
     async getPendingWorkflows(executorID, appVersion) {
         const getWorkflows = await this.pool.query(`SELECT workflow_uuid, queue_name 
        FROM "${this.schemaName}".workflow_status 
@@ -673,7 +694,24 @@ class SystemDatabase {
         return { isPatched: true, hasEntry: true };
     }
     // ==================== Workflow Management ====================
-    async cancelWorkflows(workflowIDs) {
+    async cancelWorkflows(workflowIDs, cancelChildren = false) {
+        if (!cancelChildren) {
+            await this.#cancelWorkflows(workflowIDs);
+            return;
+        }
+        // Cascade cancellation to child workflows level by level.
+        const visited = new Set(workflowIDs);
+        let frontier = workflowIDs;
+        while (frontier.length > 0) {
+            await this.#cancelWorkflows(frontier);
+            const children = await this.#getDirectChildren(frontier);
+            frontier = children.filter((id) => !visited.has(id));
+            for (const id of frontier) {
+                visited.add(id);
+            }
+        }
+    }
+    async #cancelWorkflows(workflowIDs) {
         await this.pool.query(`UPDATE "${this.schemaName}".workflow_status
        SET status = $1, queue_name = NULL, deduplication_id = NULL, started_at_epoch_ms = NULL,
            updated_at = (EXTRACT(EPOCH FROM now()) * 1000)::bigint,
@@ -718,32 +756,28 @@ class SystemDatabase {
        WHERE workflow_uuid = $3
          AND status = $4`, [delayUntilEpochMS, Date.now(), workflowID, workflow_1.StatusString.DELAYED]);
     }
+    // Get the immediate (one-level) child workflow IDs for a set of workflows.
+    async #getDirectChildren(workflowIDs) {
+        if (workflowIDs.length === 0) {
+            return [];
+        }
+        const result = await this.pool.query(`SELECT workflow_uuid
+       FROM "${this.schemaName}".workflow_status
+       WHERE parent_workflow_id = ANY($1)`, [workflowIDs]);
+        return result.rows.map((row) => row.workflow_uuid);
+    }
     async getWorkflowChildren(workflowID) {
         // BFS to find all descendant workflows
-        const visited = new Set([workflowID]);
-        const queue = [workflowID];
-        const children = [];
-        const client = await this.pool.connect();
-        try {
-            while (queue.length > 0) {
-                const batch = queue.splice(0, queue.length);
-                const result = await client.query(`SELECT DISTINCT child_workflow_id
-           FROM "${this.schemaName}".operation_outputs
-           WHERE workflow_uuid = ANY($1)
-             AND child_workflow_id IS NOT NULL`, [batch]);
-                for (const row of result.rows) {
-                    if (!visited.has(row.child_workflow_id)) {
-                        visited.add(row.child_workflow_id);
-                        queue.push(row.child_workflow_id);
-                        children.push(row.child_workflow_id);
-                    }
-                }
+        const descendants = new Set();
+        let frontier = [workflowID];
+        while (frontier.length > 0) {
+            const children = await this.#getDirectChildren(frontier);
+            frontier = children.filter((id) => !descendants.has(id));
+            for (const id of frontier) {
+                descendants.add(id);
             }
         }
-        finally {
-            client.release();
-        }
-        return children;
+        return [...descendants];
     }
     async deleteWorkflows(workflowIDs, deleteChildren = false) {
         const allIds = [...workflowIDs];
@@ -1151,9 +1185,10 @@ class SystemDatabase {
             //throw new Error('Message notification map is not empty - shutdown is not clean.');
         }
     }
-    async awaitWorkflowResult(workflowID, timeoutSeconds, callerID, timerFuncID) {
+    async awaitWorkflowResult(workflowID, timeoutSeconds, callerID, timerFuncID, pollingIntervalMs) {
         const timeoutms = timeoutSeconds !== undefined ? timeoutSeconds * 1000 : undefined;
         let finishTime = timeoutms !== undefined ? Date.now() + timeoutms : undefined;
+        const pollIntervalMs = pollingIntervalMs ?? this.dbPollingIntervalResultMs;
         while (true) {
             let resolveNotification;
             const statusPromise = new Promise((resolve) => {
@@ -1203,14 +1238,14 @@ class SystemDatabase {
                 let timeoutPromise = Promise.resolve();
                 let timeoutCancel = () => { };
                 if (timerFuncID !== undefined && callerID !== undefined && timeoutms !== undefined) {
-                    const { promise, cancel, endTime } = await this.#durableSleep(callerID, timerFuncID, timeoutms, this.dbPollingIntervalResultMs);
+                    const { promise, cancel, endTime } = await this.#durableSleep(callerID, timerFuncID, timeoutms, pollIntervalMs);
                     finishTime = endTime;
                     timeoutPromise = promise;
                     timeoutCancel = cancel;
                 }
                 else {
-                    let poll = finishTime ? finishTime - ct : this.dbPollingIntervalResultMs;
-                    poll = Math.min(this.dbPollingIntervalResultMs, poll);
+                    let poll = finishTime ? finishTime - ct : pollIntervalMs;
+                    poll = Math.min(pollIntervalMs, poll);
                     const { promise, cancel } = (0, utils_1.cancellableSleep)(poll);
                     timeoutPromise = promise;
                     timeoutCancel = cancel;
@@ -1229,8 +1264,9 @@ class SystemDatabase {
             }
         }
     }
-    async awaitFirstWorkflowId(workflowIds, callerID) {
+    async awaitFirstWorkflowId(workflowIds, callerID, pollingIntervalMs) {
         const placeholders = workflowIds.map((_, i) => `$${i + 1}`).join(', ');
+        const pollIntervalMs = pollingIntervalMs ?? this.dbPollingIntervalResultMs;
         while (true) {
             let resolveNotification;
             const wakeupPromise = new Promise((resolve) => {
@@ -1251,7 +1287,7 @@ class SystemDatabase {
                 if (rows.length > 0) {
                     return rows[0].workflow_uuid;
                 }
-                const { promise: sleepPromise, cancel: sleepCancel } = (0, utils_1.cancellableSleep)(this.dbPollingIntervalResultMs);
+                const { promise: sleepPromise, cancel: sleepCancel } = (0, utils_1.cancellableSleep)(pollIntervalMs);
                 try {
                     await Promise.race([wakeupPromise, sleepPromise]);
                 }
@@ -1344,7 +1380,7 @@ class SystemDatabase {
             throw err;
         }
     }
-    async recv(workflowID, functionID, timeoutFunctionID, topic, timeoutSeconds = dbos_executor_1.DBOSExecutor.defaultNotificationTimeoutSec) {
+    async recv(workflowID, functionID, timeoutFunctionID, topic, timeoutSeconds = dbos_executor_1.DBOSExecutor.defaultNotificationTimeoutSec, pollingIntervalMs) {
         topic = topic ?? this.nullTopic;
         const startTime = Date.now();
         // First, check for previous executions.
@@ -1357,6 +1393,7 @@ class SystemDatabase {
         }
         const timeoutms = timeoutSeconds !== undefined ? timeoutSeconds * 1000 : undefined;
         let finishTime = timeoutms !== undefined ? Date.now() + timeoutms : undefined;
+        const pollIntervalMs = pollingIntervalMs ?? this.dbPollingIntervalEventMs;
         while (true) {
             // register the key with the global notifications listener.
             let resolveNotification;
@@ -1380,14 +1417,14 @@ class SystemDatabase {
                 let timeoutPromise = Promise.resolve();
                 let timeoutCancel = () => { };
                 if (timeoutms) {
-                    const { promise, cancel, endTime } = await this.#durableSleep(workflowID, timeoutFunctionID, timeoutms, this.dbPollingIntervalEventMs);
+                    const { promise, cancel, endTime } = await this.#durableSleep(workflowID, timeoutFunctionID, timeoutms, pollIntervalMs);
                     timeoutPromise = promise;
                     timeoutCancel = cancel;
                     finishTime = endTime;
                 }
                 else {
-                    let poll = finishTime ? finishTime - ct : this.dbPollingIntervalEventMs;
-                    poll = Math.min(this.dbPollingIntervalEventMs, poll);
+                    let poll = finishTime ? finishTime - ct : pollIntervalMs;
+                    poll = Math.min(pollIntervalMs, poll);
                     const { promise, cancel } = (0, utils_1.cancellableSleep)(poll);
                     timeoutPromise = promise;
                     timeoutCancel = cancel;
@@ -1475,7 +1512,7 @@ class SystemDatabase {
             client.release();
         }
     }
-    async getEvent(workflowID, key, timeoutSeconds, callerWorkflow) {
+    async getEvent(workflowID, key, timeoutSeconds, callerWorkflow, pollingIntervalMs) {
         const startTime = Date.now();
         // Check if the operation has been done before for OAOO (only do this inside a workflow).
         if (callerWorkflow) {
@@ -1493,6 +1530,7 @@ class SystemDatabase {
         const payloadKey = `${workflowID}::${key}`;
         const timeoutms = timeoutSeconds !== undefined ? timeoutSeconds * 1000 : undefined;
         let finishTime = timeoutms !== undefined ? Date.now() + timeoutms : undefined;
+        const pollIntervalMs = pollingIntervalMs ?? this.dbPollingIntervalEventMs;
         // Register the key with the global notifications listener first... we do not want to look in the DB first
         //  or that would cause a timing hole.
         while (true) {
@@ -1525,14 +1563,14 @@ class SystemDatabase {
                 let timeoutPromise = Promise.resolve();
                 let timeoutCancel = () => { };
                 if (callerWorkflow && timeoutms) {
-                    const { promise, cancel, endTime } = await this.#durableSleep(callerWorkflow.workflowID, callerWorkflow.timeoutFunctionID ?? -1, timeoutms, this.dbPollingIntervalEventMs);
+                    const { promise, cancel, endTime } = await this.#durableSleep(callerWorkflow.workflowID, callerWorkflow.timeoutFunctionID ?? -1, timeoutms, pollIntervalMs);
                     timeoutPromise = promise;
                     timeoutCancel = cancel;
                     finishTime = endTime;
                 }
                 else {
-                    let poll = finishTime ? finishTime - ct : this.dbPollingIntervalEventMs;
-                    poll = Math.min(this.dbPollingIntervalEventMs, poll);
+                    let poll = finishTime ? finishTime - ct : pollIntervalMs;
+                    poll = Math.min(pollIntervalMs, poll);
                     const { promise, cancel } = (0, utils_1.cancellableSleep)(poll);
                     timeoutPromise = promise;
                     timeoutCancel = cancel;
@@ -2745,6 +2783,10 @@ class SystemDatabase {
             const param = args.push(where.status);
             whereClause += ` AND status=$${param}`;
         }
+        if (where.notStatus) {
+            const param = args.push(where.notStatus);
+            whereClause += ` AND status!=$${param}`;
+        }
         const result = await client.query(`UPDATE "${this.schemaName}".workflow_status ${setClause} ${whereClause}`, args);
         const throwOnFailure = options.throwOnFailure ?? true;
         if (throwOnFailure && result.rowCount !== 1) {
@@ -3000,13 +3042,13 @@ __decorate([
 __decorate([
     dbRetry(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Number, String, Number]),
+    __metadata("design:paramtypes", [String, Number, String, Number, Number]),
     __metadata("design:returntype", Promise)
 ], SystemDatabase.prototype, "awaitWorkflowResult", null);
 __decorate([
     dbRetry(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Array, String]),
+    __metadata("design:paramtypes", [Array, String, Number]),
     __metadata("design:returntype", Promise)
 ], SystemDatabase.prototype, "awaitFirstWorkflowId", null);
 __decorate([
@@ -3030,7 +3072,7 @@ __decorate([
 __decorate([
     dbRetry(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Number, Number, String, Number]),
+    __metadata("design:paramtypes", [String, Number, Number, String, Number, Number]),
     __metadata("design:returntype", Promise)
 ], SystemDatabase.prototype, "recv", null);
 __decorate([
@@ -3042,7 +3084,7 @@ __decorate([
 __decorate([
     dbRetry(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, String, Number, Object]),
+    __metadata("design:paramtypes", [String, String, Number, Object, Number]),
     __metadata("design:returntype", Promise)
 ], SystemDatabase.prototype, "getEvent", null);
 __decorate([