How do I sign up for the Replay Test Suites beta?
Contact us at firstname.lastname@example.org or in our Discord. There is a preference for teams with the following qualifications:
- Using Cypress or Playwright Test
- Runs tests in CI with GitHub Actions
- Wants to record with Replay in CI
- Flexibility with browser and OS requirements
Is a Test Team required?
A Replay Test Team is required to properly view test runs, results, and replays in the Test Suites Dashboard.
While you can record tests with Replay and upload them using any team API key, you will not have access to test-specific views without a Test Team.
How do I include matrix strategy variables to my test run?
You can compose a string that details your matrix strategy, and pass it as an environment variable using
RECORD_REPLAY_METADATA_TEST_RUN_TITLE. That will let you differentiate different test runs in the library.
Here is an example.
What test runners are supported?
Cypress and Playwright Test are the primary test runners supported in Replay Test Suites beta.
We have experimental support for Puppeteer, Jest, and Node-based Playwright with additional configuration.
What browsers are supported?
- Replay Firefox (macOS, Linux)
- Replay Chromium Beta (Linux only)
Is there performance overhead when recording?
The performance overhead of recording with Replay will vary depending on the browser, the test runner, your test suite, the application under test, the recording environment, and other factors. We aim to Replay overhead as low as possible so your CI runs are not impacted.
Please let us know if you experience significant recording overhead when using Replay so we can troubleshoot.
Are only failed test replays uploaded?
- When using
action-playwright, only replays of failed tests are uploaded by default. To upload all replays, set the
truein the GitHub Action.
- When using
action-uploadto upload tests, all replays generated (passing and failing) will be uploaded unless a filter is passed to the
- When using
upload-allto upload all recordings. Uploading only failed replays with
@replayio/replaywill require a custom script to identify failed tests and pass IDs to
Is using GitHub Actions required?
Using GitHub Actions is recommended because you get access to easy configuration and additional functionality through our Replay GitHub Actions.
However, you can use a different CI provider by configuring your run command manually and using
@replayio/replayto upload recordings. See Manual CI configuration for more.
How do I update the Replay Browser?
When running in CI, the latest version of the Replay Browser will be installed on each run.
To update your browser locally, use
npx @replayio/replay update-browsers. Please note that the desktop version of the Replay Browser used to record manually is not the same as the browsers installed for testing.
The desktop Replay Browser and testing Replay Browsers must be updated separately.