WIP preventing concurrent waits, throw an error

Author: matt-aitken

packages/core/src/v3/runtime/index.ts

@@ -12,8 +12,16 @@ import { usage } from "../usage-api.js";
 
 const NOOP_RUNTIME_MANAGER = new NoopRuntimeManager();
 
+const concurrentWaitErrorMessage =
+  "Parallel waits are not supported, e.g. using Promise.all() around our wait functions.";
+
+/**
+ * All state must be inside the RuntimeManager, do NOT store it on this class.
+ * This is because of the "dual package hazard", this can be bundled multiple times.
+ */
 export class RuntimeAPI {
   private static _instance?: RuntimeAPI;
+  private isExecutingWait = false;
 
   private constructor() {}
 
@@ -26,23 +34,31 @@ export class RuntimeAPI {
   }
 
   public waitForDuration(ms: number): Promise<void> {
-    return usage.pauseAsync(() => this.#getRuntimeManager().waitForDuration(ms));
+    return this.#preventConcurrentWaits(() =>
+      usage.pauseAsync(() => this.#getRuntimeManager().waitForDuration(ms))
+    );
   }
 
   public waitUntil(date: Date): Promise<void> {
-    return usage.pauseAsync(() => this.#getRuntimeManager().waitUntil(date));
+    return this.#preventConcurrentWaits(() =>
+      usage.pauseAsync(() => this.#getRuntimeManager().waitUntil(date))
+    );
   }
 
   public waitForTask(params: { id: string; ctx: TaskRunContext }): Promise<TaskRunExecutionResult> {
-    return usage.pauseAsync(() => this.#getRuntimeManager().waitForTask(params));
+    return this.#preventConcurrentWaits(() =>
+      usage.pauseAsync(() => this.#getRuntimeManager().waitForTask(params))
+    );
   }
 
   public waitForBatch(params: {
     id: string;
     runs: string[];
     ctx: TaskRunContext;
   }): Promise<BatchTaskRunExecutionResult> {
-    return usage.pauseAsync(() => this.#getRuntimeManager().waitForBatch(params));
+    return this.#preventConcurrentWaits(() =>
+      usage.pauseAsync(() => this.#getRuntimeManager().waitForBatch(params))
+    );
   }
 
   public setGlobalRuntimeManager(runtimeManager: RuntimeManager): boolean {
@@ -57,4 +73,19 @@ export class RuntimeAPI {
   #getRuntimeManager(): RuntimeManager {
     return getGlobal(API_NAME) ?? NOOP_RUNTIME_MANAGER;
   }
+
+  async #preventConcurrentWaits<T>(cb: () => Promise<T>): Promise<T> {
+    if (this.isExecutingWait) {
+      console.error(concurrentWaitErrorMessage);
+      throw new Error(concurrentWaitErrorMessage);
+    }
+
+    this.isExecutingWait = true;
+
+    try {
+      return await cb();
+    } finally {
+      this.isExecutingWait = false;
+    }
+  }
 }

references/hello-world/src/trigger/parallel-waits.ts

@@ -0,0 +1,22 @@
+import { logger, task, wait } from "@trigger.dev/sdk/v3";
+import { childTask } from "./example.js";
+
+/*
+ * These aren't currently supported, and so should throw clear errors
+ */
+export const parallelWaits = task({
+  id: "parallel-waits",
+  run: async (payload: any, { ctx }) => {
+    //parallel wait for 5/10 seconds
+    await Promise.all([
+      wait.for({ seconds: 5 }),
+      wait.until({ date: new Date(Date.now() + 10_000) }),
+    ]);
+
+    //parallel task call
+    await Promise.all([
+      childTask.triggerAndWait({ message: "Hello, world!" }),
+      childTask.batchTriggerAndWait([{ payload: { message: "Hello, world!" } }]),
+    ]);
+  },
+});