Add ability to opt-out of maxDuration with timeout.None

Author: ericallam

apps/webapp/app/presenters/v3/SpanPresenter.server.ts

@@ -9,6 +9,7 @@ import { eventRepository } from "~/v3/eventRepository.server";
 import { machinePresetFromName } from "~/v3/machinePresets.server";
 import { FINAL_ATTEMPT_STATUSES, isFinalRunStatus } from "~/v3/taskStatus";
 import { BasePresenter } from "./basePresenter.server";
+import { getMaxDuration } from "~/v3/utils/maxDuration";
 
 type Result = Awaited<ReturnType<SpanPresenter["call"]>>;
 export type Span = NonNullable<NonNullable<Result>["span"]>;
@@ -309,7 +310,7 @@ export class SpanPresenter extends BasePresenter {
       },
       context: JSON.stringify(context, null, 2),
       metadata,
-      maxDurationInSeconds: run.maxDurationInSeconds,
+      maxDurationInSeconds: getMaxDuration(run.maxDurationInSeconds),
     };
   }
 

apps/webapp/app/v3/marqs/devQueueConsumer.server.ts

@@ -24,6 +24,7 @@ import {
   tracer,
 } from "../tracer.server";
 import { DevSubscriber, devPubSub } from "./devPubSub.server";
+import { getMaxDuration } from "../utils/maxDuration";
 
 const MessageBody = z.discriminatedUnion("type", [
   z.object({
@@ -378,8 +379,10 @@ export class DevQueueConsumer {
         status: "EXECUTING",
         lockedToVersionId: backgroundWorker.id,
         startedAt: existingTaskRun.startedAt ?? new Date(),
-        maxDurationInSeconds:
-          existingTaskRun.maxDurationInSeconds ?? backgroundTask.maxDurationInSeconds,
+        maxDurationInSeconds: getMaxDuration(
+          existingTaskRun.maxDurationInSeconds,
+          backgroundTask.maxDurationInSeconds
+        ),
       },
       include: {
         attempts: {

apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts

@@ -44,6 +44,7 @@ import { EnvironmentVariable } from "../environmentVariables/repository";
 import { machinePresetFromConfig } from "../machinePresets.server";
 import { env } from "~/env.server";
 import { isFinalAttemptStatus, isFinalRunStatus } from "../taskStatus";
+import { getMaxDuration } from "../utils/maxDuration";
 
 const WithTraceContext = z.object({
   traceparent: z.string().optional(),
@@ -403,8 +404,10 @@ export class SharedQueueConsumer {
             startedAt: existingTaskRun.startedAt ?? new Date(),
             baseCostInCents: env.CENTS_PER_RUN,
             machinePreset: machinePresetFromConfig(backgroundTask.machineConfig ?? {}).name,
-            maxDurationInSeconds:
-              existingTaskRun.maxDurationInSeconds ?? backgroundTask.maxDurationInSeconds,
+            maxDurationInSeconds: getMaxDuration(
+              existingTaskRun.maxDurationInSeconds,
+              backgroundTask.maxDurationInSeconds
+            ),
           },
           include: {
             runtimeEnvironment: true,

apps/webapp/app/v3/services/createBackgroundWorker.server.ts

@@ -15,6 +15,7 @@ import { projectPubSub } from "./projectPubSub.server";
 import { RegisterNextTaskScheduleInstanceService } from "./registerNextTaskScheduleInstance.server";
 import cronstrue from "cronstrue";
 import { CheckScheduleService } from "./checkSchedule.server";
+import { clampMaxDuration } from "../utils/maxDuration";
 
 export class CreateBackgroundWorkerService extends BaseService {
   public async call(
@@ -156,7 +157,7 @@ export async function createBackgroundTasks(
           machineConfig: task.machine,
           triggerSource: task.triggerSource === "schedule" ? "SCHEDULED" : "STANDARD",
           fileId: tasksToBackgroundFiles?.get(task.id) ?? null,
-          maxDurationInSeconds: task.maxDuration ? Math.max(task.maxDuration, 5) : null,
+          maxDurationInSeconds: task.maxDuration ? clampMaxDuration(task.maxDuration) : null,
         },
       });
 

apps/webapp/app/v3/services/triggerTask.server.ts

@@ -23,6 +23,7 @@ import { findCurrentWorkerFromEnvironment } from "../models/workerDeployment.ser
 import { handleMetadataPacket } from "~/utils/packets";
 import { ExpireEnqueuedRunService } from "./expireEnqueuedRun.server";
 import { guardQueueSizeLimitsForEnv } from "../queueSizeLimits.server";
+import { clampMaxDuration } from "../utils/maxDuration";
 
 export type TriggerTaskServiceOptions = {
   idempotencyKey?: string;
@@ -374,7 +375,7 @@ export class TriggerTaskService extends BaseService {
                   seedMetadata: metadataPacket?.data,
                   seedMetadataType: metadataPacket?.dataType,
                   maxDurationInSeconds: body.options?.maxDuration
-                    ? Math.max(body.options.maxDuration, 5)
+                    ? clampMaxDuration(body.options.maxDuration)
                     : undefined,
                 },
               });

apps/webapp/app/v3/utils/maxDuration.ts

@@ -0,0 +1,22 @@
+const MINIMUM_MAX_DURATION = 5;
+const MAXIMUM_MAX_DURATION = 2_147_483_647; // largest 32-bit signed integer
+
+export function clampMaxDuration(maxDuration: number): number {
+  return Math.min(Math.max(maxDuration, MINIMUM_MAX_DURATION), MAXIMUM_MAX_DURATION);
+}
+
+export function getMaxDuration(
+  maxDuration?: number | null,
+  defaultMaxDuration?: number | null
+): number | undefined {
+  if (!maxDuration) {
+    return defaultMaxDuration ?? undefined;
+  }
+
+  // Setting the maxDuration to MAXIMUM_MAX_DURATION means we don't want to use the default maxDuration
+  if (maxDuration === MAXIMUM_MAX_DURATION) {
+    return;
+  }
+
+  return maxDuration;
+}

packages/trigger-sdk/src/v3/index.ts

@@ -8,6 +8,7 @@ export * from "./usage.js";
 export * from "./idempotencyKeys.js";
 export * from "./tags.js";
 export * from "./metadata.js";
+export * from "./timeout.js";
 export type { Context };
 
 import type { Context } from "./shared.js";

packages/trigger-sdk/src/v3/timeout.ts

@@ -0,0 +1,8 @@
+import { timeout as timeoutApi } from "@trigger.dev/core/v3";
+
+const MAXIMUM_MAX_DURATION = 2_147_483_647;
+
+export const timeout = {
+  None: MAXIMUM_MAX_DURATION,
+  signal: timeoutApi.signal,
+};

references/hello-world/src/trigger/example.ts

@@ -1,4 +1,4 @@
-import { logger, task, usage, wait } from "@trigger.dev/sdk/v3";
+import { logger, task, timeout, usage, wait } from "@trigger.dev/sdk/v3";
 import { setTimeout } from "timers/promises";
 
 export const helloWorldTask = task({
@@ -51,12 +51,9 @@ export const maxDurationTask = task({
     maxTimeoutInMs: 2_000,
     factor: 1.4,
   },
+  maxDuration: 5,
   run: async (payload: { sleepFor: number }, { signal, ctx }) => {
     await setTimeout(payload.sleepFor * 1000, { signal });
-
-    if (ctx.attempt.number < 5) {
-      throw new Error("Example error");
-    }
   },
 });
 
@@ -65,7 +62,7 @@ export const maxDurationParentTask = task({
   run: async (payload: { sleepFor?: number; maxDuration?: number }, { ctx, signal }) => {
     const result = await maxDurationTask.triggerAndWait(
       { sleepFor: payload.sleepFor ?? 10 },
-      { maxDuration: payload.maxDuration ?? 600 }
+      { maxDuration: timeout.None }
     );
 
     return result;