Replaying

A replay is a copy of a run with the same payload but against the latest version in that environment. This is useful if something went wrong and you want to try again with the latest version of your code.

Replaying from the UI

From a run

1. Click the Replay button in the top right

   
2. Confirm replay settings

   You can edit the payload (if available) and choose the environment to replay the run in.

   

Runs list

1. Click the action button on a run

   
2. Click replay

   

Detecting replays in your task

You can check if a run is a replay using the context object:

export const myTask = task({
  id: "my-task",
  run: async (payload, { ctx }) => {
    if (ctx.run.isReplay) {
      // This run is a replay of a previous run
    }
  },
});

Replaying using the SDK

You can replay a run using the SDK:

const replayedRun = await runs.replay(run.id);

When you call trigger() or batchTrigger() on a task you receive back a run handle which has an id property. You can use that id to replay the run.

You can also access the run id from inside a run. You could write this to your database and then replay it later.

export const simpleChildTask = task({
  id: "simple-child-task",
  run: async (payload, { ctx }) => {
    // the run ID (and other useful info) is in ctx
    const runId = ctx.run.id;
  },
});

Bulk replaying

See Bulk actions for more information.