rivetkit 2.3.3 → 2.3.5-rc.1

package/dist/tsup/agent-os/index.js

@@ -18,6 +18,7 @@ var BUILTIN_INSPECTOR_TAB_IDS = [
   "database",
   "state",
   "queue",
+  "schedules",
   "connections",
   "console"
 ];
@@ -81,6 +82,8 @@ var GlobalActorOptionsBaseSchema = z.object({
   name: z.string().optional(),
   /** Icon for the actor in the Inspector UI. Can be an emoji or FontAwesome icon name. */
   icon: z.string().optional(),
+  /** Enables the experimental Actor Runtime Socket for this actor. */
+  enableActorRuntimeSocket: z.boolean().default(false),
   /**
    * Can hibernate WebSockets for onWebSocket.
    *
@@ -112,10 +115,12 @@ var InstanceActorOptionsBaseSchema = z.object({
   noSleep: z.boolean().default(false),
   sleepTimeout: z.number().positive().default(3e4),
   maxQueueSize: z.number().positive().default(1e3),
+  /** Maximum pending one-shot and recurring schedules. */
+  maxSchedules: z.number().int().nonnegative().default(1e3),
   maxQueueMessageSize: z.number().positive().default(64 * 1024),
-  /** Override RivetKit's workflow preload budget for this actor. Set to 0 to disable workflow preloading. */
+  /** @deprecated Internal storage moved to SQLite and no longer uses KV preloading, so this option is ignored. Will be removed in 2.2.0. */
   preloadMaxWorkflowBytes: z.number().nonnegative().optional(),
-  /** Override RivetKit's connections preload budget for this actor. Set to 0 to disable connections preloading. */
+  /** @deprecated Internal storage moved to SQLite and no longer uses KV preloading, so this option is ignored. Will be removed in 2.2.0. */
   preloadMaxConnectionsBytes: z.number().nonnegative().optional()
 }).strict();
 var InstanceActorOptionsSchema = InstanceActorOptionsBaseSchema.prefault(() => ({}));
@@ -174,6 +179,9 @@ var DocActorOptionsSchema = z.object({
   icon: z.string().optional().describe(
     "Icon for the actor in the Inspector UI. Can be an emoji (e.g., '\u{1F680}') or FontAwesome icon name (e.g., 'rocket')."
   ),
+  enableActorRuntimeSocket: z.boolean().optional().describe(
+    "Enables the experimental Actor Runtime Socket for this actor. Default: false"
+  ),
   createVarsTimeout: z.number().optional().describe("Timeout in ms for createVars handler. Default: 5000"),
   createConnStateTimeout: z.number().optional().describe(
     "Timeout in ms for createConnState handler. Default: 5000"
@@ -211,17 +219,14 @@ var DocActorOptionsSchema = z.object({
   maxQueueSize: z.number().optional().describe(
     "Maximum number of queue messages before rejecting new messages. Default: 1000"
   ),
+  maxSchedules: z.number().int().nonnegative().optional().describe(
+    "Maximum pending one-shot and recurring schedules before rejecting new schedules. Default: 1000"
+  ),
   maxQueueMessageSize: z.number().optional().describe(
     "Maximum size of each queue message in bytes. Default: 65536"
   ),
   canHibernateWebSocket: z.boolean().optional().describe(
     "Whether WebSockets using onWebSocket can be hibernated. WebSockets using actions/events are hibernatable by default. Default: false"
-  ),
-  preloadMaxWorkflowBytes: z.number().optional().describe(
-    "Override RivetKit's workflow preload budget for this actor. Set to 0 to disable workflow preloading."
-  ),
-  preloadMaxConnectionsBytes: z.number().optional().describe(
-    "Override RivetKit's connections preload budget for this actor. Set to 0 to disable connections preloading."
   )
 }).describe("Actor options for timeouts and behavior configuration.");
 var DocActorConfigSchema = z.object({
@@ -314,7 +319,7 @@ function isRivetErrorCode(error, group, code) {
 // package.json
 var package_default = {
   name: "rivetkit",
-  version: "2.3.3",
+  version: "2.3.5-rc.1",
   description: "Lightweight libraries for building stateful actors on edge platforms",
   license: "Apache-2.0",
   keywords: [
@@ -731,15 +736,21 @@ function loggerWithoutContext() {
 }
 
 // src/actor/definition.ts
-var warnedDeprecatedTimeoutKeys = /* @__PURE__ */ new Set();
-function warnDeprecatedShutdownTimeoutKeys(options) {
+var warnedDeprecatedOptionKeys = /* @__PURE__ */ new Set();
+var DEPRECATED_OPTION_MESSAGES = {
+  onDestroyTimeout: "Configure `sleepGracePeriod` instead, which bounds the entire graceful shutdown window for both sleep and destroy.",
+  waitUntilTimeout: "Configure `sleepGracePeriod` instead, which bounds the entire graceful shutdown window for both sleep and destroy.",
+  preloadMaxWorkflowBytes: "Internal storage moved to SQLite and no longer uses KV preloading.",
+  preloadMaxConnectionsBytes: "Internal storage moved to SQLite and no longer uses KV preloading."
+};
+function warnDeprecatedOptionKeys(options) {
   if (!options || typeof options !== "object") return;
   const opts = options;
-  for (const key of ["onDestroyTimeout", "waitUntilTimeout"]) {
-    if (opts[key] !== void 0 && !warnedDeprecatedTimeoutKeys.has(key)) {
-      warnedDeprecatedTimeoutKeys.add(key);
+  for (const [key, detail] of Object.entries(DEPRECATED_OPTION_MESSAGES)) {
+    if (opts[key] !== void 0 && !warnedDeprecatedOptionKeys.has(key)) {
+      warnedDeprecatedOptionKeys.add(key);
       loggerWithoutContext().warn({
-        msg: `actor option \`${key}\` is deprecated and is now ignored. Configure \`sleepGracePeriod\` instead, which bounds the entire graceful shutdown window for both sleep and destroy. Will be removed in 2.2.0.`
+        msg: `actor option \`${key}\` is deprecated and is now ignored. ${detail} Will be removed in 2.2.0.`
       });
     }
   }
@@ -754,7 +765,7 @@ var ActorDefinition = class {
   }
 };
 function actor(input) {
-  warnDeprecatedShutdownTimeoutKeys(
+  warnDeprecatedOptionKeys(
     input == null ? void 0 : input.options
   );
   const config = ActorConfigSchema.parse(input);
@@ -767,6 +778,17 @@ function event(options) {
 }
 
 // src/common/database/shared.ts
+var MIGRATION_TRANSACTION_TIMEOUT_MS = 5 * 6e4;
+function isManualTransactionControl(query) {
+  return /^\s*(?:BEGIN|SAVEPOINT|COMMIT|END|ROLLBACK)\b/i.test(query);
+}
+function validateTransactionTimeout(timeout) {
+  if (timeout !== void 0 && (!Number.isFinite(timeout) || timeout <= 0)) {
+    throw new Error(
+      "db.transaction() timeout must be a positive finite number of milliseconds"
+    );
+  }
+}
 function isSqliteBindingValue(value) {
   if (value === null || typeof value === "number" || typeof value === "string" || typeof value === "bigint" || value instanceof Uint8Array) {
     return true;
@@ -811,7 +833,8 @@ function hasMultipleStatements(query) {
   return trimmed.includes(";");
 }
 function db({
-  onMigrate
+  onMigrate,
+  warnOnManualTransactions = true
 } = {}) {
   return {
     createClient: async (ctx) => {
@@ -823,6 +846,7 @@ function db({
       }
       const db2 = await nativeDatabaseProvider.open(ctx.actorId);
       let closed = false;
+      let manualTransactionWarned = false;
       const ensureOpen = () => {
         if (closed) {
           throw new Error(
@@ -830,17 +854,24 @@ function db({
           );
         }
       };
-      const client = {
+      const createClient = (target, transactionScoped = false) => ({
         execute: async (query, ...args) => {
           var _a, _b, _c, _d;
           ensureOpen();
+          if (!transactionScoped && warnOnManualTransactions && !manualTransactionWarned && !hasMultipleStatements(query) && isManualTransactionControl(query)) {
+            manualTransactionWarned = true;
+            getLogger("database").warn(
+              { actorId: ctx.actorId },
+              "Manual cross-call SQLite transactions can interleave with other actor work. Use db.transaction() for coordinated transactions. Set warnOnManualTransactions: false in your db(...) configuration to disable this warning."
+            );
+          }
           const kvReadsBefore = ((_a = ctx.metrics) == null ? void 0 : _a.totalKvReads) ?? 0;
           const kvWritesBefore = ((_b = ctx.metrics) == null ? void 0 : _b.totalKvWrites) ?? 0;
           const start = performance.now();
           try {
             if (args.length > 0) {
               const bindings = args.length === 1 && isSqliteBindingObject(args[0]) ? toSqliteBindings(args[0]) : toSqliteBindings(args);
-              const { rows, columns } = await db2.execute(
+              const { rows, columns } = await target.execute(
                 query,
                 bindings
               );
@@ -849,12 +880,15 @@ function db({
               );
             }
             if (!hasMultipleStatements(query)) {
-              const { rows, columns } = await db2.execute(query);
+              const { rows, columns } = await target.execute(
+                query,
+                void 0
+              );
               return rows.map(
                 (row) => rowToObject(row, columns)
               );
             }
-            return await execMultiStatement(db2, query);
+            return await execMultiStatement(target, query);
           } finally {
             const durationMs = performance.now() - start;
             (_c = ctx.metrics) == null ? void 0 : _c.trackSql(query, durationMs);
@@ -871,6 +905,24 @@ function db({
             }
           }
         },
+        transaction: async (callback, options) => {
+          validateTransactionTimeout(options == null ? void 0 : options.timeout);
+          const transaction = await db2.beginTransaction(
+            options == null ? void 0 : options.timeout
+          );
+          const tx = createClient(transaction, true);
+          try {
+            const result = await callback(tx);
+            await transaction.commit();
+            return result;
+          } catch (error) {
+            try {
+              await transaction.rollback();
+            } catch {
+            }
+            throw error;
+          }
+        },
         close: async () => {
           if (!closed) {
             closed = true;
@@ -881,12 +933,16 @@ function db({
           var _a;
           return ((_a = db2.nativeMetrics) == null ? void 0 : _a.call(db2)) ?? null;
         }
-      };
+      });
+      const client = createClient(db2);
       return client;
     },
     onMigrate: async (client) => {
       if (onMigrate) {
-        await withMigrationSavepoint(client, () => onMigrate(client));
+        await withMigrationSavepoint(
+          client,
+          (leased) => onMigrate(leased)
+        );
       }
     }
   };
@@ -910,19 +966,30 @@ async function execMultiStatement(db2, query) {
   return results;
 }
 async function withMigrationSavepoint(client, callback) {
-  await client.execute("SAVEPOINT __rivet_on_migrate");
-  try {
-    const result = await callback();
-    await client.execute("RELEASE SAVEPOINT __rivet_on_migrate");
-    return result;
-  } catch (error) {
-    try {
-      await client.execute("ROLLBACK TO SAVEPOINT __rivet_on_migrate");
-    } finally {
-      await client.execute("RELEASE SAVEPOINT __rivet_on_migrate");
-    }
-    throw error;
-  }
+  return await client.transaction(
+    async (transaction) => {
+      await transaction.execute("SAVEPOINT __rivet_on_migrate");
+      try {
+        const result = await callback(transaction);
+        await transaction.execute(
+          "RELEASE SAVEPOINT __rivet_on_migrate"
+        );
+        return result;
+      } catch (error) {
+        try {
+          await transaction.execute(
+            "ROLLBACK TO SAVEPOINT __rivet_on_migrate"
+          );
+        } finally {
+          await transaction.execute(
+            "RELEASE SAVEPOINT __rivet_on_migrate"
+          );
+        }
+        throw error;
+      }
+    },
+    { timeout: MIGRATION_TRANSACTION_TIMEOUT_MS }
+  );
 }
 
 // src/agent-os/config.ts