Upload strategies

To upload all test replays no matter the result, set the upload option to true.

• cypress
• playwright

cypress.config.js
export default defineConfig({
  e2e: {
    setupNodeEvents(cyOn, config) {
      const on = wrapOn(cyOn)
      replayPlugin(on, config, {
        apiKey: process.env.REPLAY_API_KEY,
        upload: true,
      })
      return config
    },
  },
})

To upload recordings only for failed tests use statusThreshold option:

• cypress
• playwright

cypress.config.js
export default defineConfig({
  e2e: {
    setupNodeEvents(cyOn, config) {
      const on = wrapOn(cyOn)
      replayPlugin(on, config, {
        apiKey: process.env.REPLAY_API_KEY,
        upload: {
          statusThreshold: 'failed',
        },
      })
      return config
    },
  },
})

To upload recordings for failed and flaky tests use statusThreshold option:

• cypress
• playwright

cypress.config.js
export default defineConfig({
  e2e: {
    setupNodeEvents(cyOn, config) {
      const on = wrapOn(cyOn)
      replayPlugin(on, config, {
        apiKey: process.env.REPLAY_API_KEY,
        upload: {
          statusThreshold: 'failed-and-flaky',
        },
      })
      return config
    },
  },
})

Many CI providers provide an environment variable that references the current branch name.

• CircleCI: $CIRCLE_BRANCH
• GitLab: $CI_COMMIT_REF_NAME
• Semaphore: $SEMAPHORE_GIT_BRANCH
• Travis: $TRAVIS_BRANCH

GitHub stores this value in a default variable named GITHUB_BASE_REF that can be passed along as part of a Workflow and then referenced in the test config like so:

• cypress
• playwright

cypress.config.js
export default defineConfig({
  e2e: {
    setupNodeEvents(cyOn, config) {
      const on = wrapOn(cyOn)
      replayPlugin(on, config, {
        apiKey: process.env.REPLAY_API_KEY,
        upload: process.env.BRANCH_NAME === 'main',
      })
      return config
    },
  },
})

Use the advanced upload options to reduce the number of recordings that are uploaded. When this option is enabled, only one recording will be uploaded for any passing or failing test. For flaky tests, two recordings will be uploaded– the passing test and one of the failed attempts.

playwright.config.js
import { replayDevices, replayReporter } from "@replayio/playwright";

const config: PlaywrightTestConfig = {
  reporter: [
    replayReporter({
      apiKey: process.env.REPLAY_API_KEY,
      upload: {
        minimizeUploads: true,
      },
    }),
    ["line"],
  ],
  projects: [
    {
      name: "replay-chromium",
      use: { ...replayDevices["Replay Chromium"] },
    },
  ],
};

export default config;