Max duration

Set a maximum duration for a task to run.

By default tasks can execute indefinitely, which can be great! But you also might want to set a maxDuration to prevent a task from running too long. You can set the maxDuration for a run in the following ways:

• Across all your tasks in the config
• On a specific task
• On a specific run when you trigger a task

How it works

The maxDuration is set in seconds, and is compared to the CPU time elapsed since the start of a single execution (which we call attempts) of the task. The CPU time is the time that the task has been actively running on the CPU, and does not include time spent waiting during the following:

• wait.for calls
• triggerAndWait calls
• batchTriggerAndWait calls

You can inspect the CPU time of a task inside the run function with our usage utility:

/trigger/max-duration.ts

import { task, usage } from "@trigger.dev/sdk/v3";

export const maxDurationTask = task({
  id: "max-duration-task",
  maxDuration: 300, // 300 seconds or 5 minutes
  run: async (payload: any, { ctx }) => {
    let currentUsage = usage.getCurrent();

    currentUsage.attempt.durationMs; // The CPU time in milliseconds since the start of the run
  },
});

The above value will be compared to the maxDuration you set. If the task exceeds the maxDuration, it will be stopped with the following error:

The minimum maxDuration is 5 seconds. The maximum is ~68 years.

Configuring a default max duration

You can set a default maxDuration for all tasks in your config file. This will apply to all tasks unless you override it on a specific task or run.

/config/default-max-duration.ts

import { defineConfig } from "@trigger.dev/sdk/v3";

export default defineConfig({
  //Your project ref (you can see it on the Project settings page in the dashboard)
  project: "proj_gtcwttqhhtlasxgfuhxs",
  maxDuration: 60, // 60 seconds or 1 minute
});

Configuring for a task

You can set a maxDuration on a specific task:

/trigger/max-duration-task.ts

import { task } from "@trigger.dev/sdk/v3";

export const maxDurationTask = task({
  id: "max-duration-task",
  maxDuration: 300, // 300 seconds or 5 minutes
  run: async (payload: any, { ctx }) => {
    //...
  },
});

This will override the default maxDuration set in the config file. If you have a config file with a default maxDuration of 60 seconds, and you set a maxDuration of 300 seconds on a task, the task will run for 300 seconds.

You can “turn off” the Max duration set in your config file for a specific task like so:

/trigger/max-duration-task.ts

import { task, timeout } from "@trigger.dev/sdk/v3";

export const maxDurationTask = task({
  id: "max-duration-task",
  maxDuration: timeout.None, // No max duration
  run: async (payload: any, { ctx }) => {
    //...
  },
});

Configuring for a run

You can set a maxDuration on a specific run when you trigger a task:

/trigger/max-duration.ts

import { maxDurationTask } from "./trigger/max-duration-task";

// Trigger the task with a maxDuration of 300 seconds
const run = await maxDurationTask.trigger(
  { foo: "bar" },
  {
    maxDuration: 300, // 300 seconds or 5 minutes
  }
);

You can also set the maxDuration to timeout.None to turn off the max duration for a specific run:

/trigger/max-duration.ts

import { maxDurationTask } from "./trigger/max-duration-task";
import { timeout } from "@trigger.dev/sdk/v3";

// Trigger the task with no maxDuration
const run = await maxDurationTask.trigger(
  { foo: "bar" },
  {
    maxDuration: timeout.None, // No max duration
  }
);

maxDuration in run context

You can access the maxDuration set for a run in the run context:

/trigger/max-duration-task.ts

import { task } from "@trigger.dev/sdk/v3";

export const maxDurationTask = task({
  id: "max-duration-task",
  maxDuration: 300, // 300 seconds or 5 minutes
  run: async (payload: any, { ctx }) => {
    console.log(ctx.run.maxDuration); // 300
  },
});

maxDuration and lifecycle functions

When a task run exceeds the maxDuration, the lifecycle functions cleanup, onSuccess, and onFailure will not be called.