short circuit

Author: ianmacartney

example/convex/_generated/api.d.ts

@@ -48,8 +48,9 @@ export declare const components: {
       load: FunctionReference<
         "query",
         "internal",
-        { workflowId: string },
+        { shortCircuit?: boolean; workflowId: string },
         {
+          blocked?: boolean;
           journalEntries: Array<{
             _creationTime: number;
             _id: string;

src/client/step.ts

@@ -18,6 +18,7 @@ import {
   valueSize,
 } from "../component/schema.js";
 import type { SchedulerOptions, WorkflowComponent } from "./types.js";
+import { MAX_JOURNAL_SIZE } from "../shared.js";
 
 export type WorkerResult =
   | { type: "handlerDone"; runResult: RunResult }
@@ -35,8 +36,6 @@ export type StepRequest = {
   reject: (error: unknown) => void;
 };
 
-const MAX_JOURNAL_SIZE = 8 << 20;
-
 export class StepExecutor {
   private journalEntrySize: number;
 
@@ -56,6 +55,7 @@ export class StepExecutor {
     );
 
     if (this.journalEntrySize > MAX_JOURNAL_SIZE) {
+      // This should never happen, but we'll throw an error just in case.
       throw new Error(journalSizeError(this.journalEntrySize, this.workflowId));
     }
   }

src/client/workflowMutation.ts

@@ -69,7 +69,7 @@ export function workflowMutation<ArgsValidator extends PropertyValidators>(
       const { workflowId, generationNumber } = args;
       const { workflow, logLevel, journalEntries, ok } = await ctx.runQuery(
         component.journal.load,
-        { workflowId },
+        { workflowId, shortCircuit: true },
       );
       const inProgress = journalEntries.filter(({ step }) => step.inProgress);
       const console = createLogger(logLevel);

src/component/_generated/api.d.ts

@@ -42,8 +42,9 @@ export type Mounts = {
     load: FunctionReference<
       "query",
       "public",
-      { workflowId: string },
+      { shortCircuit?: boolean; workflowId: string },
       {
+        blocked?: boolean;
         journalEntries: Array<{
           _creationTime: number;
           _id: string;

src/component/journal.ts

@@ -19,33 +19,53 @@ import { internal } from "./_generated/api.js";
 import { type FunctionHandle } from "convex/server";
 import { getDefaultLogger } from "./utils.js";
 import { assert } from "convex-helpers";
+import { MAX_JOURNAL_SIZE } from "../shared.js";
 
 export const load = query({
   args: {
     workflowId: v.id("workflows"),
+    shortCircuit: v.optional(v.boolean()),
   },
   returns: v.object({
     workflow: workflowDocument,
     journalEntries: v.array(journalDocument),
     ok: v.boolean(),
     logLevel,
+    blocked: v.optional(v.boolean()),
   }),
-  handler: async (ctx, { workflowId }) => {
+  handler: async (ctx, { workflowId, shortCircuit }) => {
     const workflow = await ctx.db.get(workflowId);
     assert(workflow, `Workflow not found: ${workflowId}`);
     const { logLevel } = await getDefaultLogger(ctx);
     const journalEntries: JournalEntry[] = [];
-    let sizeSoFar = 0;
+    let journalSize = 0;
+    if (shortCircuit) {
+      const inProgress = await ctx.db
+        .query("steps")
+        .withIndex("inProgress", (q) =>
+          q.eq("step.inProgress", true).eq("workflowId", workflowId),
+        )
+        .first();
+      if (inProgress) {
+        return {
+          journalEntries: [inProgress],
+          blocked: true,
+          workflow,
+          logLevel,
+          ok: false,
+        };
+      }
+    }
     for await (const entry of ctx.db
       .query("steps")
       .withIndex("workflow", (q) => q.eq("workflowId", workflowId))) {
       journalEntries.push(entry);
-      sizeSoFar += journalEntrySize(entry);
-      if (sizeSoFar > 4 * 1024 * 1024) {
-        return { journalEntries, ok: false, workflow, logLevel };
+      journalSize += journalEntrySize(entry);
+      if (journalSize > MAX_JOURNAL_SIZE) {
+        return { journalEntries, workflow, logLevel, ok: false };
       }
     }
-    return { journalEntries, ok: true, workflow, logLevel };
+    return { journalEntries, workflow, logLevel, ok: true };
   },
 });
 

src/shared.ts

@@ -1,3 +1,5 @@
+export const MAX_JOURNAL_SIZE = 8 << 20;
+
 export function formatErrorWithStack(error: unknown): string {
   if (error instanceof Error) {
     return error.toString() + (error.stack ? "\n" + error.stack : "");