@dbos-inc/dbos-sdk 4.25.14 → 4.26.3-preview

package/dist/src/system_database.js

@@ -699,7 +699,7 @@ class SystemDatabase {
     async recordWorkflowOutput(workflowID, status) {
         const client = await this.pool.connect();
         try {
-            await this.#recordWorkflowOutcome(client, workflowID, workflow_1.StatusString.SUCCESS, { output: status.output });
+            return await this.#recordWorkflowOutcome(client, workflowID, workflow_1.StatusString.SUCCESS, { output: status.output });
         }
         finally {
             client.release();
@@ -708,36 +708,30 @@ class SystemDatabase {
     async recordWorkflowError(workflowID, status) {
         const client = await this.pool.connect();
         try {
-            await this.#recordWorkflowOutcome(client, workflowID, workflow_1.StatusString.ERROR, { error: status.error });
+            return 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.
+    // Record a workflow's terminal outcome (SUCCESS or ERROR), reporting whether
+    // the write landed. The write applies only to a PENDING row: a run owns its
+    // workflow's outcome exactly as long as the row says that run is what the
+    // workflow is doing. (Note: this does not prevent a write when another
+    // concurrent execution is already running and the status is PENDING. However,
+    // both executions should be deterministic and idempotent.)
+    //
+    // Returning false means the row was CANCELLED, dead-lettered, already
+    // terminal, handed to another execution (ENQUEUED/DELAYED, e.g. by a
+    // concurrent resume), or deleted; the caller resolves which by awaiting the
+    // recorded outcome.
     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);
-        }
+        const rowCount = await this.updateWorkflowStatus(client, workflowID, status, {
+            update: { ...outcome, resetDeduplicationID: true, setCompletedAt: true },
+            where: { status: workflow_1.StatusString.PENDING },
+            throwOnFailure: false,
+        });
+        return rowCount > 0;
     }
     async getPendingWorkflows(executorID, appVersion) {
         const getWorkflows = await this.pool.query(`SELECT workflow_uuid
@@ -1487,7 +1481,12 @@ class SystemDatabase {
     async #checkIfCanceledLimited(workflowID) {
         await this.#pollWithLimiter(() => this.#checkIfCanceled(this.pool, workflowID));
     }
-    async awaitWorkflowResult(workflowID, timeoutSeconds, callerID, timerFuncID, pollingIntervalMs) {
+    // A missing row normally means the workflow has not been inserted yet, so
+    // polling for it is correct. Callers that know the row must already exist
+    // (e.g. a run parking on an outcome it just failed to write) pass
+    // `failIfMissing` to fail fast with DBOSNonExistentWorkflowError instead of
+    // polling forever.
+    async awaitWorkflowResult(workflowID, timeoutSeconds, callerID, timerFuncID, pollingIntervalMs, failIfMissing) {
         const timeoutms = timeoutSeconds !== undefined ? timeoutSeconds * 1000 : undefined;
         let finishTime = timeoutms !== undefined ? Date.now() + timeoutms : undefined;
         const pollIntervalMs = pollingIntervalMs ?? this.dbPollingIntervalResultMs;
@@ -1499,33 +1498,37 @@ class SystemDatabase {
         while (true) {
             if (callerID)
                 await this.#checkIfCanceledLimited(callerID);
+            let rows;
             try {
-                const { rows } = await this.#pollWithLimiter(() => this.pool.query(`SELECT status, output, error, serialization FROM "${this.schemaName}".workflow_status
-             WHERE workflow_uuid=$1`, [workflowID]));
-                if (rows.length > 0) {
-                    const status = rows[0].status;
-                    if (status === workflow_1.StatusString.SUCCESS) {
-                        return { output: rows[0].output, serialization: rows[0].serialization };
-                    }
-                    else if (status === workflow_1.StatusString.ERROR) {
-                        return { error: rows[0].error, serialization: rows[0].serialization };
-                    }
-                    else if (status === workflow_1.StatusString.CANCELLED) {
-                        return { cancelled: true };
-                    }
-                    else if (status === workflow_1.StatusString.MAX_RECOVERY_ATTEMPTS_EXCEEDED) {
-                        return { maxRecoveryAttemptsExceeded: true };
-                    }
-                    else {
-                        // Status is not actionable
-                    }
-                }
+                ({ rows } = await this.#pollWithLimiter(() => this.pool.query(`SELECT status, output, error, serialization FROM "${this.schemaName}".workflow_status
+             WHERE workflow_uuid=$1`, [workflowID])));
             }
             catch (e) {
                 const err = e;
                 this.logger.error(`Exception from system database: ${err}`, err);
                 throw err;
             }
+            if (rows.length > 0) {
+                const status = rows[0].status;
+                if (status === workflow_1.StatusString.SUCCESS) {
+                    return { output: rows[0].output, serialization: rows[0].serialization };
+                }
+                else if (status === workflow_1.StatusString.ERROR) {
+                    return { error: rows[0].error, serialization: rows[0].serialization };
+                }
+                else if (status === workflow_1.StatusString.CANCELLED) {
+                    return { cancelled: true };
+                }
+                else if (status === workflow_1.StatusString.MAX_RECOVERY_ATTEMPTS_EXCEEDED) {
+                    return { maxRecoveryAttemptsExceeded: true };
+                }
+                else {
+                    // Status is not actionable
+                }
+            }
+            else if (failIfMissing) {
+                throw new error_1.DBOSNonExistentWorkflowError(`Workflow ${workflowID} does not exist`);
+            }
             const ct = Date.now();
             if (finishTime && ct > finishTime)
                 return undefined; // Time's up
@@ -3334,6 +3337,7 @@ class SystemDatabase {
         if (throwOnFailure && result.rowCount !== 1) {
             throw new error_1.DBOSWorkflowConflictError(`Attempt to record transition of nonexistent workflow ${workflowID}`);
         }
+        return result.rowCount ?? 0;
     }
     async recordOperationResultInternal(client, workflowID, functionID, functionName, checkConflict, startTimeEpochMs, endTimeEpochMs, options = {}) {
         try {
@@ -3589,9 +3593,15 @@ __decorate([
     __metadata("design:returntype", Promise)
 ], SystemDatabase.prototype, "debounceDelayedWorkflowStandalone", null);
 __decorate([
-    dbRetry(),
+    dbRetry()
+    // A missing row normally means the workflow has not been inserted yet, so
+    // polling for it is correct. Callers that know the row must already exist
+    // (e.g. a run parking on an outcome it just failed to write) pass
+    // `failIfMissing` to fail fast with DBOSNonExistentWorkflowError instead of
+    // polling forever.
+    ,
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Number, String, Number, Number]),
+    __metadata("design:paramtypes", [String, Number, String, Number, Number, Boolean]),
     __metadata("design:returntype", Promise)
 ], SystemDatabase.prototype, "awaitWorkflowResult", null);
 __decorate([