@rivetkit/engine-runner 2.1.5 → 2.1.6-rc.1

package/dist/mod.d.cts

@@ -127,7 +127,6 @@ interface RunnerConfig {
     namespace: string;
     totalSlots: number;
     runnerName: string;
-    runnerKey: string;
     prepopulateActorNames: Record<string, {
         metadata: Record<string, any>;
     }>;
@@ -233,6 +232,14 @@ interface RunnerConfig {
     onActorStart: (actorId: string, generation: number, config: ActorConfig) => Promise<void>;
     onActorStop: (actorId: string, generation: number) => Promise<void>;
     noAutoShutdown?: boolean;
+    /**
+     * Debug option to inject artificial latency (in ms) into WebSocket
+     * communication. Messages are queued and delivered in order after the
+     * configured delay.
+     *
+     * @experimental For testing only.
+     */
+    debugLatencyMs?: number;
 }
 interface KvListOptions {
     reverse?: boolean;
@@ -261,6 +268,7 @@ declare class Runner {
     kvListPrefix(actorId: string, prefix: Uint8Array, options?: KvListOptions): Promise<[Uint8Array, Uint8Array][]>;
     kvPut(actorId: string, entries: [Uint8Array, Uint8Array][]): Promise<void>;
     kvDelete(actorId: string, keys: Uint8Array[]): Promise<void>;
+    kvDeleteRange(actorId: string, start: Uint8Array, end: Uint8Array): Promise<void>;
     kvDrop(actorId: string): Promise<void>;
     setAlarm(actorId: string, alarmTs: number | null, generation?: number): void;
     clearAlarm(actorId: string, generation?: number): void;

package/dist/mod.d.ts

@@ -127,7 +127,6 @@ interface RunnerConfig {
     namespace: string;
     totalSlots: number;
     runnerName: string;
-    runnerKey: string;
     prepopulateActorNames: Record<string, {
         metadata: Record<string, any>;
     }>;
@@ -233,6 +232,14 @@ interface RunnerConfig {
     onActorStart: (actorId: string, generation: number, config: ActorConfig) => Promise<void>;
     onActorStop: (actorId: string, generation: number) => Promise<void>;
     noAutoShutdown?: boolean;
+    /**
+     * Debug option to inject artificial latency (in ms) into WebSocket
+     * communication. Messages are queued and delivered in order after the
+     * configured delay.
+     *
+     * @experimental For testing only.
+     */
+    debugLatencyMs?: number;
 }
 interface KvListOptions {
     reverse?: boolean;
@@ -261,6 +268,7 @@ declare class Runner {
     kvListPrefix(actorId: string, prefix: Uint8Array, options?: KvListOptions): Promise<[Uint8Array, Uint8Array][]>;
     kvPut(actorId: string, entries: [Uint8Array, Uint8Array][]): Promise<void>;
     kvDelete(actorId: string, keys: Uint8Array[]): Promise<void>;
+    kvDeleteRange(actorId: string, start: Uint8Array, end: Uint8Array): Promise<void>;
     kvDrop(actorId: string): Promise<void>;
     setAlarm(actorId: string, alarmTs: number | null, generation?: number): void;
     clearAlarm(actorId: string, generation?: number): void;

package/dist/mod.js

@@ -461,6 +461,10 @@ function stringifyKvRequestData(data) {
       const { keys } = data.val;
       return `KvDeleteRequest{keys: ${keys.length}}`;
     }
+    case "KvDeleteRangeRequest": {
+      const { start, end } = data.val;
+      return `KvDeleteRangeRequest{start: ${stringifyArrayBuffer(start)}, end: ${stringifyArrayBuffer(end)}}`;
+    }
     case "KvDropRequest":
       return "KvDropRequest";
   }
@@ -1506,8 +1510,11 @@ async function importWebSocket() {
 }
 
 // src/mod.ts
+import {
+  v4 as uuidv4
+} from "uuid";
 var KV_EXPIRE = 3e4;
-var PROTOCOL_VERSION = 6;
+var PROTOCOL_VERSION = 7;
 var EVENT_BACKLOG_WARN_THRESHOLD = 1e4;
 var SIGNAL_HANDLERS = [];
 var RunnerShutdownError = class extends Error {
@@ -1517,6 +1524,7 @@ var RunnerShutdownError = class extends Error {
 };
 var Runner = class {
   #config;
+  #runnerKey = uuidv4();
   get config() {
     return this.#config;
   }
@@ -1830,6 +1838,9 @@ var Runner = class {
    * - All actors are stopped
    * - The WebSocket connection is closed
    * - The shutdown timeout is reached (120 seconds)
+   *
+   * When changing this timeout, update
+   * website/src/content/docs/actors/versions.mdx (SIGTERM Handling section).
    */
   async #waitForActorsToStop(ws) {
     const shutdownTimeout = 12e4;
@@ -1910,7 +1921,7 @@ var Runner = class {
   get pegboardUrl() {
     const wsEndpoint = this.pegboardEndpoint.replace("http://", "ws://").replace("https://", "wss://");
     const baseUrl = wsEndpoint.endsWith("/") ? wsEndpoint.slice(0, -1) : wsEndpoint;
-    return `${baseUrl}/runners/connect?protocol_version=${PROTOCOL_VERSION}&namespace=${encodeURIComponent(this.#config.namespace)}&runner_key=${encodeURIComponent(this.#config.runnerKey)}`;
+    return `${baseUrl}/runners/connect?protocol_version=${PROTOCOL_VERSION}&namespace=${encodeURIComponent(this.#config.namespace)}&runner_key=${encodeURIComponent(this.#runnerKey)}`;
   }
   // MARK: Runner protocol
   async #openPegboardWebSocket() {
@@ -1931,7 +1942,7 @@ var Runner = class {
       msg: "connecting",
       endpoint: this.pegboardEndpoint,
       namespace: this.#config.namespace,
-      runnerKey: this.#config.runnerKey,
+      runnerKey: this.#runnerKey,
       hasToken: !!this.config.token
     });
     ws.addEventListener("open", () => {
@@ -2008,6 +2019,7 @@ var Runner = class {
       } else {
         throw new Error(`expected binary data, got ${typeof ev.data}`);
       }
+      await this.#injectLatency();
       const message = protocol.decodeToClient(buf);
       (_a2 = this.log) == null ? void 0 : _a2.debug({
         msg: "received runner message",
@@ -2567,6 +2579,24 @@ var Runner = class {
     };
     await this.#sendKvRequest(actorId, requestData);
   }
+  async kvDeleteRange(actorId, start, end) {
+    const startKey = start.buffer.slice(
+      start.byteOffset,
+      start.byteOffset + start.byteLength
+    );
+    const endKey = end.buffer.slice(
+      end.byteOffset,
+      end.byteOffset + end.byteLength
+    );
+    const requestData = {
+      tag: "KvDeleteRangeRequest",
+      val: {
+        start: startKey,
+        end: endKey
+      }
+    };
+    await this.#sendKvRequest(actorId, requestData);
+  }
   async kvDrop(actorId) {
     const requestData = {
       tag: "KvDropRequest",
@@ -2652,6 +2682,12 @@ var Runner = class {
     if (processedCount > 0) {
     }
   }
+  /** Resolves after the configured debug latency, or immediately if none. */
+  #injectLatency() {
+    const ms = this.#config.debugLatencyMs;
+    if (!ms) return Promise.resolve();
+    return new Promise((resolve) => setTimeout(resolve, ms));
+  }
   /** Asserts WebSocket exists and is ready. */
   getPegboardWebSocketIfReady() {
     if (!!this.#pegboardWebSocket && this.#pegboardWebSocket.readyState === 1) {
@@ -2661,20 +2697,23 @@ var Runner = class {
     }
   }
   __sendToServer(message) {
-    var _a, _b;
+    var _a;
     (_a = this.log) == null ? void 0 : _a.debug({
       msg: "sending runner message",
       data: stringifyToServer(message)
     });
     const encoded = protocol.encodeToServer(message);
-    const pegboardWebSocket = this.getPegboardWebSocketIfReady();
-    if (pegboardWebSocket) {
-      pegboardWebSocket.send(encoded);
-    } else {
-      (_b = this.log) == null ? void 0 : _b.error({
-        msg: "WebSocket not available or not open for sending data"
-      });
-    }
+    this.#injectLatency().then(() => {
+      var _a2;
+      const pegboardWebSocket = this.getPegboardWebSocketIfReady();
+      if (pegboardWebSocket) {
+        pegboardWebSocket.send(encoded);
+      } else {
+        (_a2 = this.log) == null ? void 0 : _a2.error({
+          msg: "WebSocket not available or not open for sending data"
+        });
+      }
+    });
   }
   sendHibernatableWebSocketMessageAck(gatewayId, requestId, index) {
     if (!this.#tunnel)