@rivetkit/workflow-engine 0.0.0-main.6151ab0 → 0.0.0-main.79e97f1

package/dist/schemas/v1.ts

@@ -446,6 +446,23 @@ export function writeRemovedEntry(bc: bare.ByteCursor, x: RemovedEntry): void {
     write1(bc, x.originalName)
 }
 
+export type VersionCheckEntry = {
+    readonly resolved: u32,
+    readonly latest: u32,
+}
+
+export function readVersionCheckEntry(bc: bare.ByteCursor): VersionCheckEntry {
+    return {
+        resolved: bare.readU32(bc),
+        latest: bare.readU32(bc),
+    }
+}
+
+export function writeVersionCheckEntry(bc: bare.ByteCursor, x: VersionCheckEntry): void {
+    bare.writeU32(bc, x.resolved)
+    bare.writeU32(bc, x.latest)
+}
+
 export type EntryKind =
     | { readonly tag: "StepEntry", readonly val: StepEntry }
     | { readonly tag: "LoopEntry", readonly val: LoopEntry }
@@ -455,6 +472,7 @@ export type EntryKind =
     | { readonly tag: "JoinEntry", readonly val: JoinEntry }
     | { readonly tag: "RaceEntry", readonly val: RaceEntry }
     | { readonly tag: "RemovedEntry", readonly val: RemovedEntry }
+    | { readonly tag: "VersionCheckEntry", readonly val: VersionCheckEntry }
 
 export function readEntryKind(bc: bare.ByteCursor): EntryKind {
     const offset = bc.offset
@@ -476,6 +494,8 @@ export function readEntryKind(bc: bare.ByteCursor): EntryKind {
             return { tag: "RaceEntry", val: readRaceEntry(bc) }
         case 7:
             return { tag: "RemovedEntry", val: readRemovedEntry(bc) }
+        case 8:
+            return { tag: "VersionCheckEntry", val: readVersionCheckEntry(bc) }
         default: {
             bc.offset = offset
             throw new bare.BareError(offset, "invalid tag")
@@ -525,6 +545,11 @@ export function writeEntryKind(bc: bare.ByteCursor, x: EntryKind): void {
             writeRemovedEntry(bc, x.val)
             break
         }
+        case "VersionCheckEntry": {
+            bare.writeU8(bc, 8)
+            writeVersionCheckEntry(bc, x.val)
+            break
+        }
     }
 }
 

package/dist/tsup/{chunk-UMFB2AR3.js → chunk-DTS4S7RT.js}

@@ -670,6 +670,16 @@ function writeRemovedEntry(bc, x) {
   bare.writeString(bc, x.originalType);
   write1(bc, x.originalName);
 }
+function readVersionCheckEntry(bc) {
+  return {
+    resolved: bare.readU32(bc),
+    latest: bare.readU32(bc)
+  };
+}
+function writeVersionCheckEntry(bc, x) {
+  bare.writeU32(bc, x.resolved);
+  bare.writeU32(bc, x.latest);
+}
 function readEntryKind(bc) {
   const offset = bc.offset;
   const tag = bare.readU8(bc);
@@ -690,6 +700,8 @@ function readEntryKind(bc) {
       return { tag: "RaceEntry", val: readRaceEntry(bc) };
     case 7:
       return { tag: "RemovedEntry", val: readRemovedEntry(bc) };
+    case 8:
+      return { tag: "VersionCheckEntry", val: readVersionCheckEntry(bc) };
     default: {
       bc.offset = offset;
       throw new bare.BareError(offset, "invalid tag");
@@ -738,6 +750,11 @@ function writeEntryKind(bc, x) {
       writeRemovedEntry(bc, x.val);
       break;
     }
+    case "VersionCheckEntry": {
+      bare.writeU8(bc, 8);
+      writeVersionCheckEntry(bc, x.val);
+      break;
+    }
   }
 }
 function readEntry(bc) {
@@ -1182,6 +1199,14 @@ function entryKindToBare(kind) {
           originalName: kind.data.originalName ?? null
         }
       };
+    case "version_check":
+      return {
+        tag: "VersionCheckEntry",
+        val: {
+          resolved: kind.data.resolved,
+          latest: kind.data.latest
+        }
+      };
   }
 }
 function entryKindFromBare(kind) {
@@ -1263,6 +1288,14 @@ function entryKindFromBare(kind) {
           originalName: kind.val.originalName ?? void 0
         }
       };
+    case "VersionCheckEntry":
+      return {
+        type: "version_check",
+        data: {
+          resolved: kind.val.resolved,
+          latest: kind.val.latest
+        }
+      };
     default:
       throw new Error(
         `Unknown entry kind: ${kind.tag}`
@@ -1402,6 +1435,8 @@ function deserializeName(bytes) {
 }
 
 // src/storage.ts
+var MAX_KV_BATCH_ENTRIES = 128;
+var MAX_KV_BATCH_PAYLOAD_BYTES = 976 * 1024;
 function createStorage() {
   return {
     nameRegistry: [],
@@ -1519,6 +1554,8 @@ async function loadMetadata(storage, driver, entryId) {
 }
 async function flush(storage, driver, onHistoryUpdated, pendingDeletions) {
   const writes = [];
+  const dirtyEntries = [];
+  const dirtyMetadata = [];
   let historyUpdated = false;
   for (let i = storage.flushedNameCount; i < storage.nameRegistry.length; i++) {
     const name = storage.nameRegistry[i];
@@ -1536,7 +1573,7 @@ async function flush(storage, driver, onHistoryUpdated, pendingDeletions) {
         key: buildHistoryKey(entry.location),
         value: serializeEntry(entry)
       });
-      entry.dirty = false;
+      dirtyEntries.push(entry);
       historyUpdated = true;
     }
   }
@@ -1546,7 +1583,7 @@ async function flush(storage, driver, onHistoryUpdated, pendingDeletions) {
         key: buildEntryMetadataKey(id),
         value: serializeEntryMetadata(metadata)
       });
-      metadata.dirty = false;
+      dirtyMetadata.push(metadata);
       historyUpdated = true;
     }
   }
@@ -1570,7 +1607,13 @@ async function flush(storage, driver, onHistoryUpdated, pendingDeletions) {
     });
   }
   if (writes.length > 0) {
-    await driver.batch(writes);
+    if (driver.atomicBatch) {
+      await driver.batch(writes);
+    } else {
+      for (const chunk of splitBatchWrites(writes)) {
+        await driver.batch(chunk);
+      }
+    }
   }
   if (pendingDeletions) {
     const deleteOps = [];
@@ -1588,6 +1631,12 @@ async function flush(storage, driver, onHistoryUpdated, pendingDeletions) {
       historyUpdated = true;
     }
   }
+  for (const entry of dirtyEntries) {
+    entry.dirty = false;
+  }
+  for (const metadata of dirtyMetadata) {
+    metadata.dirty = false;
+  }
   storage.flushedNameCount = storage.nameRegistry.length;
   storage.flushedState = storage.state;
   storage.flushedOutput = storage.output;
@@ -1596,6 +1645,30 @@ async function flush(storage, driver, onHistoryUpdated, pendingDeletions) {
     onHistoryUpdated();
   }
 }
+function splitBatchWrites(writes) {
+  const chunks = [];
+  let chunk = [];
+  let chunkBytes = 0;
+  for (const write of writes) {
+    const writeBytes = write.key.byteLength + write.value.byteLength;
+    if (writeBytes > MAX_KV_BATCH_PAYLOAD_BYTES) {
+      throw new Error(
+        `KV batch write is ${writeBytes} bytes, exceeding the ${MAX_KV_BATCH_PAYLOAD_BYTES} byte limit`
+      );
+    }
+    if (chunk.length >= MAX_KV_BATCH_ENTRIES || chunk.length > 0 && chunkBytes + writeBytes > MAX_KV_BATCH_PAYLOAD_BYTES) {
+      chunks.push(chunk);
+      chunk = [];
+      chunkBytes = 0;
+    }
+    chunk.push(write);
+    chunkBytes += writeBytes;
+  }
+  if (chunk.length > 0) {
+    chunks.push(chunk);
+  }
+  return chunks;
+}
 async function deleteEntriesWithPrefix(storage, driver, prefixLocation, onHistoryUpdated) {
   const deletions = collectDeletionsForPrefix(storage, prefixLocation);
   await driver.deletePrefix(deletions.prefixes[0]);
@@ -1628,30 +1701,6 @@ function setEntry(storage, location, entry) {
   storage.history.entries.set(key, entry);
 }
 
-// src/utils.ts
-function sleep(ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
-var TIMEOUT_MAX = 2147483647;
-function setLongTimeout(listener, after) {
-  let timeout;
-  function start(remaining) {
-    if (remaining <= TIMEOUT_MAX) {
-      timeout = setTimeout(listener, remaining);
-    } else {
-      timeout = setTimeout(() => {
-        start(remaining - TIMEOUT_MAX);
-      }, TIMEOUT_MAX);
-    }
-  }
-  start(after);
-  return {
-    abort: () => {
-      if (timeout !== void 0) clearTimeout(timeout);
-    }
-  };
-}
-
 // src/context.ts
 var DEFAULT_MAX_RETRIES = 3;
 var DEFAULT_RETRY_BACKOFF_BASE = 100;
@@ -1927,7 +1976,7 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
    * Throws HistoryDivergedError if duplicate detected.
    */
   checkDuplicateName(name) {
-    const fullKey = locationToKey(this.storage, this.currentLocation) + "/" + name;
+    const fullKey = `${locationToKey(this.storage, this.currentLocation)}/${name}`;
     if (this.usedNamesInExecution.has(fullKey)) {
       throw new HistoryDivergedError(
         `Duplicate entry name "${name}" at location "${locationToKey(this.storage, this.currentLocation)}". Each step/loop/sleep/queue.next/join/race must have a unique name within its scope.`
@@ -1981,7 +2030,7 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
   validateComplete() {
     const prefix = locationToKey(this.storage, this.currentLocation);
     for (const key of this.storage.history.entries.keys()) {
-      const isUnderPrefix = prefix === "" ? true : key.startsWith(prefix + "/") || key === prefix;
+      const isUnderPrefix = prefix === "" ? true : key.startsWith(`${prefix}/`) || key === prefix;
       if (isUnderPrefix) {
         if (!this.visitedKeys.has(key)) {
           throw new HistoryDivergedError(
@@ -1998,25 +2047,33 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
     this.abortController.abort(new EvictedError());
   }
   /**
-   * Wait for eviction message.
-   *
-   * The event listener uses { once: true } to auto-remove after firing,
-   * preventing memory leaks if this method is called multiple times.
+   * Wait for `ms`, rejecting early with EvictedError if the workflow is
+   * evicted. Both the timer and the abort listener are torn down on either
+   * outcome, so a completed sleep never leaves a dangling listener on the
+   * long-lived run abort signal.
    */
-  waitForEviction() {
-    return new Promise((_, reject) => {
-      if (this.abortSignal.aborted) {
-        reject(new EvictedError());
-        return;
+  async sleepOrEvict(ms) {
+    if (this.abortSignal.aborted) {
+      throw new EvictedError();
+    }
+    let timer;
+    let onAbort;
+    try {
+      await new Promise((resolve, reject) => {
+        timer = setTimeout(resolve, ms);
+        onAbort = () => reject(new EvictedError());
+        this.abortSignal.addEventListener("abort", onAbort, {
+          once: true
+        });
+      });
+    } finally {
+      if (timer !== void 0) {
+        clearTimeout(timer);
       }
-      this.abortSignal.addEventListener(
-        "abort",
-        () => {
-          reject(new EvictedError());
-        },
-        { once: true }
-      );
-    });
+      if (onAbort) {
+        this.abortSignal.removeEventListener("abort", onAbort);
+      }
+    }
   }
   // === Step ===
   async step(nameOrConfig, run) {
@@ -2165,7 +2222,7 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
       }
       const maxRetries2 = config2.maxRetries ?? DEFAULT_MAX_RETRIES;
       if (metadata2.attempts > maxRetries2) {
-        const lastError = stepData.error ?? metadata2.error;
+        const lastError = metadata2.error;
         const exhaustedError = new StepExhaustedError(
           config2.name,
           lastError
@@ -2254,37 +2311,28 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
       });
       return output;
     } catch (error) {
-      if (error instanceof StepTimeoutError) {
-        if (entry.kind.type === "step") {
-          entry.kind.data.error = String(error);
-        }
-        entry.dirty = true;
+      if (entry.kind.type === "step") {
+        entry.kind.data.error = String(error);
+      }
+      entry.dirty = true;
+      if (error instanceof StepTimeoutError && !config2.retryOnTimeout) {
         metadata.status = "exhausted";
         metadata.error = String(error);
-        await this.flushStorage();
         await this.notifyStepError(config2, metadata.attempts, error, {
           willRetry: false
         });
         throw markErrorReported(
-          attachTryStepFailure(
-            new CriticalError(error.message),
-            {
-              kind: "timeout",
-              stepName: config2.name,
-              attempts: metadata.attempts,
-              error: extractErrorInfo(error)
-            }
-          )
+          attachTryStepFailure(new CriticalError(error.message), {
+            kind: "timeout",
+            stepName: config2.name,
+            attempts: metadata.attempts,
+            error: extractErrorInfo(error)
+          })
         );
       }
       if (error instanceof CriticalError || error instanceof RollbackError) {
-        if (entry.kind.type === "step") {
-          entry.kind.data.error = String(error);
-        }
-        entry.dirty = true;
         metadata.status = "exhausted";
         metadata.error = String(error);
-        await this.flushStorage();
         await this.notifyStepError(config2, metadata.attempts, error, {
           willRetry: false
         });
@@ -2297,14 +2345,9 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
           })
         );
       }
-      if (entry.kind.type === "step") {
-        entry.kind.data.error = String(error);
-      }
-      entry.dirty = true;
       const willRetry = metadata.attempts <= maxRetries;
       metadata.status = willRetry ? "failed" : "exhausted";
       metadata.error = String(error);
-      await this.flushStorage();
       if (willRetry) {
         const retryDelay = calculateBackoff(
           metadata.attempts,
@@ -2328,7 +2371,7 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
         attachTryStepFailure(
           new StepExhaustedError(config2.name, String(error)),
           {
-            kind: "exhausted",
+            kind: error instanceof StepTimeoutError ? "timeout" : "exhausted",
             stepName: config2.name,
             attempts: metadata.attempts,
             error: extractErrorInfo(error)
@@ -2346,7 +2389,9 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
   	 *
   	 * Note: This does NOT cancel the underlying operation. JavaScript Promises
   	 * cannot be cancelled once started. When a timeout occurs:
-  	 * - The step is marked as failed with StepTimeoutError
+  	 * - The step is rejected with StepTimeoutError. By default this is treated
+  	 *   as a critical failure with no retry. Set retryOnTimeout: true on the
+  	 *   step config to retry timeouts like any other error.
   	 * - The underlying async operation continues running in the background
   	 * - Any side effects from the operation may still occur
   	 *
@@ -2481,8 +2526,8 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
       metadata.error = void 0;
       metadata.dirty = true;
     }
-    const historyPruneInterval = config2.historyPruneInterval ?? DEFAULT_LOOP_HISTORY_PRUNE_INTERVAL;
-    const historySize = config2.historySize ?? historyPruneInterval;
+    const historyPruneInterval = config2.historyPruneInterval ?? config2.commitInterval ?? config2.historyEvery ?? DEFAULT_LOOP_HISTORY_PRUNE_INTERVAL;
+    const historySize = config2.historySize ?? config2.historyKeep ?? historyPruneInterval;
     let lastPrunedUpTo = 0;
     let deferredFlush = null;
     while (true) {
@@ -2671,7 +2716,7 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
       return;
     }
     if (remaining < this.driver.workerPollInterval) {
-      await Promise.race([sleep(remaining), this.waitForEviction()]);
+      await this.sleepOrEvict(remaining);
       this.checkEvicted();
       if (entry.kind.type === "sleep") {
         entry.kind.data.state = "completed";
@@ -3480,8 +3525,91 @@ var WorkflowContextImpl = class _WorkflowContextImpl {
     setEntry(this.storage, location, entry);
     await this.flushStorage();
   }
+  // === Version ===
+  async getVersion(name, latest) {
+    this.assertNotInProgress();
+    this.checkEvicted();
+    this.entryInProgress = true;
+    try {
+      return await this.executeGetVersion(name, latest);
+    } finally {
+      this.entryInProgress = false;
+    }
+  }
+  async executeGetVersion(name, latest) {
+    if (!Number.isInteger(latest) || latest < 1) {
+      throw new Error(
+        `getVersion("${name}", ${latest}): latest must be an integer >= 1`
+      );
+    }
+    this.checkDuplicateName(name);
+    const location = appendName(this.storage, this.currentLocation, name);
+    const key = locationToKey(this.storage, location);
+    const existing = this.storage.history.entries.get(key);
+    this.markVisited(key);
+    this.stopRollbackIfMissing(existing);
+    if (existing) {
+      if (existing.kind.type !== "version_check") {
+        throw new HistoryDivergedError(
+          `Expected version_check at ${key}, found ${existing.kind.type}`
+        );
+      }
+      return existing.kind.data.resolved;
+    }
+    const resolved = this.hasUnvisitedUnderCurrentScope(key) ? 1 : latest;
+    const entry = createEntry(location, {
+      type: "version_check",
+      data: { resolved, latest }
+    });
+    setEntry(this.storage, location, entry);
+    await this.flushStorage();
+    return resolved;
+  }
+  /**
+   * Returns true if any history entry under the current location scope
+   * (other than `excludeKey`) has not yet been visited this run. Used by
+   * getVersion to detect an old in-flight instance whose scope was already
+   * executed by code that predates a version gate.
+   */
+  hasUnvisitedUnderCurrentScope(excludeKey) {
+    const prefix = locationToKey(this.storage, this.currentLocation);
+    for (const key of this.storage.history.entries.keys()) {
+      if (key === excludeKey) {
+        continue;
+      }
+      const isUnderPrefix = prefix === "" ? true : key.startsWith(`${prefix}/`) || key === prefix;
+      if (isUnderPrefix && !this.visitedKeys.has(key)) {
+        return true;
+      }
+    }
+    return false;
+  }
 };
 
+// src/utils.ts
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+var TIMEOUT_MAX = 2147483647;
+function setLongTimeout(listener, after) {
+  let timeout;
+  function start(remaining) {
+    if (remaining <= TIMEOUT_MAX) {
+      timeout = setTimeout(listener, remaining);
+    } else {
+      timeout = setTimeout(() => {
+        start(remaining - TIMEOUT_MAX);
+      }, TIMEOUT_MAX);
+    }
+  }
+  start(after);
+  return {
+    abort: () => {
+      if (timeout !== void 0) clearTimeout(timeout);
+    }
+  };
+}
+
 // src/index.ts
 var Loop = {
   continue: (state) => ({
@@ -3705,25 +3833,41 @@ async function executeLiveWorkflow(workflowId, workflowFn, input, driver, messag
     const hasMessages = result.waitingForMessages !== void 0;
     const hasDeadline = result.sleepUntil !== void 0;
     if (hasMessages && hasDeadline) {
+      const iterationAbort = new AbortController();
+      const onRunAbort = () => iterationAbort.abort();
+      if (abortController.signal.aborted) {
+        iterationAbort.abort();
+      } else {
+        abortController.signal.addEventListener("abort", onRunAbort, {
+          once: true
+        });
+      }
+      const messagePromise = awaitWithEviction(
+        driver.waitForMessages(
+          result.waitingForMessages,
+          iterationAbort.signal
+        ),
+        iterationAbort.signal
+      );
+      const sleepPromise = waitForSleep(
+        runtime,
+        result.sleepUntil,
+        iterationAbort.signal
+      );
+      messagePromise.catch(() => {
+      });
+      sleepPromise.catch(() => {
+      });
       try {
-        const messagePromise = awaitWithEviction(
-          driver.waitForMessages(
-            result.waitingForMessages,
-            abortController.signal
-          ),
-          abortController.signal
-        );
-        const sleepPromise = waitForSleep(
-          runtime,
-          result.sleepUntil,
-          abortController.signal
-        );
         await Promise.race([messagePromise, sleepPromise]);
       } catch (error) {
         if (error instanceof EvictedError) {
           return lastResult;
         }
         throw error;
+      } finally {
+        iterationAbort.abort();
+        abortController.signal.removeEventListener("abort", onRunAbort);
       }
       continue;
     }
@@ -4166,15 +4310,15 @@ export {
   deleteEntriesWithPrefix,
   getEntry,
   setEntry,
-  sleep,
   DEFAULT_MAX_RETRIES,
   DEFAULT_RETRY_BACKOFF_BASE,
   DEFAULT_RETRY_BACKOFF_MAX,
   DEFAULT_LOOP_HISTORY_PRUNE_INTERVAL,
   DEFAULT_STEP_TIMEOUT,
   WorkflowContextImpl,
+  sleep,
   Loop,
   runWorkflow,
   replayWorkflowFromStep
 };
-//# sourceMappingURL=chunk-UMFB2AR3.js.map
+//# sourceMappingURL=chunk-DTS4S7RT.js.map