Skip to content

Commit

Permalink
content tweaks & add troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
jaffrepaul committed Jul 17, 2023
1 parent f104829 commit 4a8d8a4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
4 changes: 4 additions & 0 deletions docs/faq/questions/cloud-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,10 @@ Yes! The test is captured in Cyress Cloud as it executed in your CI run. That me

Expect an even performance exchange with Test Replay vs. video. There is more activity in the capture and replay steps but without the overhead of recording, compressing, and storing video assets.

### <Icon name="angle-right" /> Can I use Test Replay for tests recorded in different browsers?

Test Replay currently supports Chromium-based browsers only. You can still record and capture test [artifacts](/guides/cloud/debugging/recorded-runs#Artifacts) (screenshots, videos and CI logs) in other browsers, while leveraging Test Replay for Chrome, Edge, and Electron.

### <Icon name="angle-right" /> Can I replay tests from historical Cypress Cloud runs?

Test Replay is available for tests recorded using Cypress `v13` and up. Tests recorded prior to this will not have Test Replay enabled in Cypress Cloud. You will still have any artifacts collected during the pre `v13` test runs.
Expand Down
18 changes: 14 additions & 4 deletions docs/guides/cloud/debugging/test-replay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ Test Replay complements the existing visual artifacts provided by Cypress Cloud

:::info

&#8239<Icon name="check-circle" /> Test Replay is available to **all** Cypress Cloud plans at no additional cost, subject to usage limits. Free plans allow up to 500 test results per month, while exceeding this limit requires upgrading the plan.
&#8239<Icon name="check-circle" /> Test Replay is available to **all** Cypress Cloud plans at no additional cost, subject to usage limits.

Free plans allow up to 500 test results per month, while exceeding this limit requires upgrading the plan.

:::

Expand Down Expand Up @@ -71,7 +73,7 @@ Accessing the replay of your test is as simple as reviewing any other test artif

## Debugging With Test Replay

This displays the Test Replay interface, which we'll unpack from top to bottom in more detail below.
Both options above display the Test Replay interface, which we'll unpack from top to bottom in more detail below.

<DocsImage
src="/img/guides/cloud/test-replay/replay-demo.gif"
Expand All @@ -80,7 +82,7 @@ This displays the Test Replay interface, which we'll unpack from top to bottom i

### Run header

The left side of the header displays the test run # with the Git branch name along with the spec, platform and browser information. Hovering on this exposes additional test meta data.
The left side of the header displays the test run #, with the Git branch name along with the spec, platform and browser information. Hovering on this exposes additional test meta data.

<DocsImage
src="/img/guides/cloud/test-replay/test-replay-header.jpg"
Expand Down Expand Up @@ -125,13 +127,21 @@ will be visible in the test replay.

:::

If you'd like not to capture test data for replay purposes you can simply "shut off" Test Replay in project settings.
If you'd like not to capture test data for replay and debugging purposes you can simply "shut off" Test Replay in project settings.

<DocsImage
src="/img/guides/cloud/test-replay/kill-switch.png"
alt="Test Replay opt-out controls"
/>

## Troubleshooting

If Test Replay is not present or disabled in Cypress Cloud:

1. Confirm runs have been recorded to Cypress Cloud using Cypress `v13` or later.
2. Ensure tests were recorded using a Chromium-based browser(Chrome, Edge, Electron).
3. Check that Test Replay is enabled in project settings.

## See also

- [Test Replay FAQ](/faq/questions/cloud-faq#Test-Replay)
Expand Down

0 comments on commit 4a8d8a4

Please sign in to comment.