Package Exports

@replayio/cypress
@replayio/cypress/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@replayio/cypress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`@replayio/cypress`

Plugin to record your Cypress tests with Replay

Installation

npm i @replayio/cypress

Usage

// 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);
    }
  }
});

Runtime Configuration

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) \
CYPRESS_NO_COMMAND_LOG=1 \
npx cypress run --browser "Replay Firefox"

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.