@replayio/cypress

Plugin to record your Cypress tests with Replay

Check out the "Recording Automated Tests Guide" to get started.

Use with action-cypress to automatically upload replays of failed tests.

Installation

npm i @replayio/cypress

Configuration

The Replay adapter for cypress requires two updates: one to your cypress.config.js and one to your support file in cypress/e2e/support.js.

// cypress.config.js
import { defineConfig } from "cypress";
import cypressReplay from "@replayio/cypress";

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // Adds replay-firefox (macOS, linux) and replay-chromium (linux)
      // browsers and hooks into Cypress lifecycle methods to capture test
      // metadata and results
      cypressReplay(on, config);
      return config;
    },
  },
});

// cypress/e2e/support.js

import "@replayio/cypress/support";

Runtime Configuration

• Use the --browser flag to select a Replay Browser to record
• If using the Firefox version of Replay, you must set the RECORD_ALL_CONTENT environment variable to enable recording.
• To enable capturing metadata for the tests, you must set RECORD_REPLAY_METADATA_FILE to an accessible file path.
• To hide the Cypress sidebar and only show your application, set CYPRESS_NO_COMMAND_LOG.

RECORD_ALL_CONTENT=1 \
RECORD_REPLAY_METADATA_FILE=$(mktemp) \
npx cypress run --browser replay-chromium

Parallel runs on CI

If you have a large test suite, you might choose to split your test suite up and run them in parallel across multiple machines but still treat them as a single suite. By default, @replayio/cypress will generate a UUID for the suite and store it in the recording metadata under test.run.id but in this case each machine will have its own id.

In order to link these independently ran tests together, you can generate your own UUID and set it in the RECORD_REPLAY_TEST_RUN_ID environment variable and it will be used instead of generating a value.