Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update cloud debug sidebar #5496

Merged
merged 4 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/api/commands/screenshot.mdx

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/api/cypress-api/screenshot-api.mdx

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docs/faq/questions/cloud-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ before being sent to the Cloud so those are not captured.

When [Test Replay](#Test-Replay) capturing is enabled, the additional data outlined
below will be sent to the Cloud. You can
[disable capturing](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) this data.
[disable capturing](/guides/cloud/test-replay#Opt-out-of-Test-Replay) this data.

- The rendered DOM and CSS styles for the application under test
- Cypress commands and events represented in the Command Log
Expand Down Expand Up @@ -87,7 +87,7 @@ the number of tests you record each month in your organization.

Tests are recorded when [cypress run](/guides/guides/command-line#cypress-run)
is called with the `--record` flag while supplying the record `--key`. This
means your [test run data](/guides/cloud/debugging/recorded-runs#Latest-Runs) is being
means your [test run data](/guides/cloud/recorded-runs#Latest-Runs) is being
"recorded" to Cypress Cloud.

We consider each time the `it()` function is called to be a single test. So you
Expand Down Expand Up @@ -164,7 +164,7 @@ any test results.
### <Icon name="angle-right" /> What is the projectId for?

The `projectId` is a 6-character string that helps identify your project once
you've [set up your tests to record](/guides/cloud/debugging/recorded-runs#Latest-Runs).
you've [set up your tests to record](/guides/cloud/recorded-runs#Latest-Runs).
It's generated by Cypress and typically is found in your
[Cypress configuration](/guides/references/configuration).

Expand All @@ -185,7 +185,7 @@ section of the [Cypress Cloud](/guides/cloud/introduction) docs.
### <Icon name="angle-right" /> What is a Record Key?

A _Record Key_ is a GUID that's generated automatically by Cypress once you've
[set up your tests to record](/guides/cloud/debugging/recorded-runs#Latest-Runs). It helps
[set up your tests to record](/guides/cloud/recorded-runs#Latest-Runs). It helps
identify your project and authenticate that your project is even _allowed_ to
record tests.

Expand All @@ -204,14 +204,14 @@ section of the [Cypress Cloud](/guides/cloud/introduction) docs.
### <Icon name="angle-right" /> How do I record my tests?

1. First [set up the project to record](/guides/cloud/getting-started#Setup).
2. Then [record your runs](/guides/cloud/debugging/recorded-runs#Latest-Runs).
2. Then [record your runs](/guides/cloud/recorded-runs#Latest-Runs).

After recording your tests, you will see them in
[Cypress Cloud](https://on.cypress.io/cloud) and in the Cypress App [Runs](/guides/core-concepts/cypress-app#Runs) tab.

### <Icon name="angle-right" /> Can I delete a run from Cypress Cloud?

You can [archive a run](/guides/cloud/debugging/recorded-runs#Archive-run) so that it does
You can [archive a run](/guides/cloud/recorded-runs#Archive-run) so that it does
not display in the runs list or in analytics.

**Note:** Archiving the recorded runs has no effect on the amount of tests
Expand Down Expand Up @@ -330,7 +330,7 @@ in your account will be permanently deleted.

### <Icon name="angle-right" /> What is Test Replay?

[Test Replay](/guides/cloud/debugging/test-replay) enables you and your team to troubleshoot and debug failed tests faster. After updating to Cypress `v13`, the new feature will automatically record all browser events and allow you to “replay” what your application under test looked like.
[Test Replay](/guides/cloud/test-replay) enables you and your team to troubleshoot and debug failed tests faster. After updating to Cypress `v13`, the new feature will automatically record all browser events and allow you to “replay” what your application under test looked like.

Wind back the clock to any point in an application's test execution and directly interact with tests as they happened in CI. Debug complex problems as if you were there when they first happened. You can:

Expand Down Expand Up @@ -381,15 +381,15 @@ Our aim is to create an impactful debugging experience that covers the most grou

Test Replay leverages [Chrome DevTools Protocol(CDP)](https://chromedevtools.github.io/devtools-protocol/), so currently supports Chromium-based browsers (Chrome, Edge, and Electron) only.

Test Replay would be disabled, with a message that it's only available on Chromium, for tests run in Firefox or WebKit (Safari). You can still record and capture test [artifacts](/guides/cloud/debugging/recorded-runs#Artifacts) (screenshots, videos and CI logs) via other browsers in separate [run groups](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs).
Test Replay would be disabled, with a message that it's only available on Chromium, for tests run in Firefox or WebKit (Safari). You can still record and capture test [artifacts](/guides/cloud/recorded-runs#Artifacts) (screenshots, videos and CI logs) via other browsers in separate [run groups](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs).

### <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.

### <Icon name="angle-right" /> Can I enable or disable Test Replay for specific, individual tests, or is it a global setting? Can I configure my settings so that Test Replay is only enabled for failing test retries?

At this time, users can only opt-out of Test Replay via [project-level settings](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) in Cypress Cloud. There is no local option for opting out at this time.
At this time, users can only opt-out of Test Replay via [project-level settings](/guides/cloud/test-replay#Opt-out-of-Test-Replay) in Cypress Cloud. There is no local option for opting out at this time.

### <Icon name="angle-right" /> Can I share my test replays?

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cloud/account-management/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Account Management",
"position": 80,
"position": 110,
"collapsible": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Data Storage and Controls
sidebar_position: 60
sidebar_position: 80
---

:::info
Expand Down Expand Up @@ -30,7 +30,7 @@ When you run Cypress via `cypress run` and pass the `--record` flag, the followi
- Videos
- OS environment variables related to CI and git information

When [Test Replay](/guides/cloud/debugging/test-replay) capturing is enabled, the additional data outlined below will be sent to Cypress Cloud. [See our guide on disabling Test Replay.](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay)
When [Test Replay](/guides/cloud/test-replay) capturing is enabled, the additional data outlined below will be sent to Cypress Cloud. [See our guide on disabling Test Replay.](/guides/cloud/test-replay#Opt-out-of-Test-Replay)

- The rendered DOM and CSS styles for the application under test
- Cypress commands and events represented in the Command Log
Expand All @@ -41,7 +41,7 @@ Cypress Cloud does not capture anything related to the code of your application

You, the customer, own and are responsible for your test content. We trust that customers will make decisions about the appropriateness of data to use in testing and will avoid use of PII, PHI, or other types of protected information. Cypress makes commercially reasonable efforts to protect confidentiality of information that is provided to Cypress Cloud.

## Cypress Cloud data controls
## Types of Data

We understand that controlling what data is sent to Cypress Cloud is important to our users. Cypress provides a number of ways to control what data is sent to Cypress Cloud.

Expand All @@ -57,7 +57,7 @@ Setting a project to private means that only the users explicitly invited to the

#### Disable Test Replay

You can disable capturing data in Test Replay per project by following [this guide](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay). This means Test Replay will not be available for viewing or debugging in the project. This will prevent Cypress Cloud from capturing the following data:
You can disable capturing data in Test Replay per project by following [this guide](/guides/cloud/test-replay#Opt-out-of-Test-Replay). This means Test Replay will not be available for viewing or debugging in the project. This will prevent Cypress Cloud from capturing the following data:

- The rendered DOM and CSS styles for the application under test
- Cypress commands and events represented in the Command Log
Expand Down Expand Up @@ -129,7 +129,7 @@ You can delete videos that are recorded when you are passing `video: true` by fo

You can disable showing the entirety of the Cypress Command Log as well as the Application under Test (AUT) controls in your tests to prevent all test content from being shown and recorded in any screenshot or video by passing `--no-runner-ui` via the CLI while running Cypress tests. See [Cypress Command Line options](/guides/guides/command-line#Options). This means that the AUT will be the only thing that is rendered while running tests, so the only thing that is captured in screenshots and videos.

Note that when `--no-runner-ui` is set, data from the Cypress Command Log will still be sent to Cypress Cloud to be generated and displayed in Test Replay if it is enabled. See [Disable Test Replay](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) for more information.
Note that when `--no-runner-ui` is set, data from the Cypress Command Log will still be sent to Cypress Cloud to be generated and displayed in Test Replay if it is enabled. See [Disable Test Replay](/guides/cloud/test-replay#Opt-out-of-Test-Replay) for more information.

#### Mask data in the Cypress Command Log

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cloud/analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Analytics & Insights
sidebar_position: 50
sidebar_position: 70
---

Cypress Cloud provides Analytics to offer insight into metrics like runs over
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/cloud/branch-review.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Branch Review
sidebar_position: 35
sidebar_position: 50
sidebar_class_name: new_label
---

Expand Down Expand Up @@ -98,7 +98,7 @@ The header includes the Git commit message, PR selector, PR status, and base and

If there are multiple pull requests open for the same branch, you can select the pull request you want to review from the dropdown to the right of the commit message.

Clicking the branch label will link you directly to the appropriate [run overview](/guides/cloud/debugging/recorded-runs#Overview-tab) and hovering on these elements exposes additional run meta data.
Clicking the branch label will link you directly to the appropriate [run overview](/guides/cloud/recorded-runs#Overview-tab) and hovering on these elements exposes additional run meta data.

<DocsImage
src="/img/guides/cloud/branch-review/branch-review-header.jpg"
Expand Down
6 changes: 0 additions & 6 deletions docs/guides/cloud/debugging/_category_.json

This file was deleted.

2 changes: 1 addition & 1 deletion docs/guides/cloud/flaky-test-management.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Flaky Test Management
sidebar_position: 40
sidebar_position: 60
sidebar_label: Flake Management
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cloud/integrations/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Integrations",
"position": 70,
"position": 100,
"collapsible": true,
"collapsed": true
}
14 changes: 7 additions & 7 deletions docs/guides/cloud/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@ read on for more benefits of Cypress Cloud.
### View and debug past test results

Each test run is stored in Cypress Cloud, where you can see past results and the
current state of your app on the [Latest Runs](/guides/cloud/debugging/recorded-runs) page.
current state of your app on the [Latest Runs](/guides/cloud/recorded-runs) page.

Replay the test as it executed during the recorded run with full debug capability using [<Logo src="/img/guides/cloud/test-replay/replay-icon.svg" /> Test Replay](/guides/cloud/debugging/test-replay).
Replay the test as it executed during the recorded run with full debug capability using [<Logo src="/img/guides/cloud/test-replay/replay-icon.svg" /> Test Replay](/guides/cloud/test-replay).

Or view each test's
[command logs, screenshots, video replays, stack traces, and CI logs](/guides/cloud/debugging/recorded-runs#Test-detail-sidebar).
[command logs, screenshots, video replays, stack traces, and CI logs](/guides/cloud/recorded-runs#Test-detail-sidebar).
Quickly identifying a test failure in CI is just a click away.

<DocsVideo src="https://vimeo.com/806005654" />

### Analyze and diagnose test health

View each [run's overview](/guides/cloud/debugging/recorded-runs#Overview-tab) to see and compare
View each [run's overview](/guides/cloud/recorded-runs#Overview-tab) to see and compare
past runs and analyze trends over time. You can quickly analyze changes in your
setup that might introduce problematic trends as well as identify unreliable
tests with [Flaky Test Management](/guides/cloud/flaky-test-management).
Expand All @@ -64,7 +64,7 @@ no setup required! You can prioritize recently failed specs with
surface problems earlier, and cancel whole test runs on failure with
[Auto Cancellation](/guides/cloud/smart-orchestration/run-cancellation) to save
on resource usage. You can also
[cancel in-progress runs](/guides/cloud/debugging/recorded-runs#Run-cancellation) manually
[cancel in-progress runs](/guides/cloud/recorded-runs#Run-cancellation) manually
from Cypress Cloud if you need to.

<DocsImage
Expand All @@ -77,7 +77,7 @@ Cypress Cloud's
lets you prioritize recently failed specs so they run faster on their next run.
The [Auto Cancellation](/guides/cloud/smart-orchestration/run-cancellation)
feature will cancel a whole test run on failure, saving time and resource usage.
You can also [cancel in-progress runs](/guides/cloud/debugging/recorded-runs#Run-cancellation)
You can also [cancel in-progress runs](/guides/cloud/recorded-runs#Run-cancellation)
manually from Cypress Cloud if you need to.

### Integrate with your favorite tools
Expand Down Expand Up @@ -125,7 +125,7 @@ directly from specific test failures.

### Cypress app integration

The [Cypress app](/guides/cloud/debugging/recorded-runs#Cypress-App) integrates directly with
The [Cypress app](/guides/cloud/recorded-runs#Cypress-App) integrates directly with
Cypress Cloud to provide developers with the latest test results without having
to switch tools.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Recorded Runs
sidebar_position: 10
sidebar_position: 30
---

Recorded runs capture the results from your test runs. Each specific area of
Expand Down Expand Up @@ -119,7 +119,7 @@ It orders results by:
- **Flaky** - when a test failed one or more attempts before finally passing
- **Modified** - when the test body has changed from a previously recorded tests

The panel shows these tests broken down by spec, with a badge clearly indicating the reason the result was considered notable. Access run artifacts with a mouse hover to quickly expose the [Test Replay](/guides/cloud/debugging/test-replay), [screenshots](/guides/guides/screenshots-and-videos#Screenshots),
The panel shows these tests broken down by spec, with a badge clearly indicating the reason the result was considered notable. Access run artifacts with a mouse hover to quickly expose the [Test Replay](/guides/cloud/test-replay), [screenshots](/guides/guides/screenshots-and-videos#Screenshots),
[videos](/guides/guides/screenshots-and-videos#Videos), and CI logs generated by this test.

Clicking on a specific test opens the
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cloud/smart-orchestration/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Smart Orchestration",
"position": 60,
"position": 90,
"collapsible": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/guides/cloud/smart-orchestration/run-cancellation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ failure will:
**Auto Cancellation** is a _Smart Orchestration_ feature available to users with
a [Business or Enterprise tier Cypress Cloud plan](https://cypress.io/pricing).
Wondering if upgrading your Team tier subscription is worth it? Check out the
[recommendations](/guides/cloud/debugging/recorded-runs#Recommendations) on the run
[recommendations](/guides/cloud/recorded-runs#Recommendations) on the run
overview page to see how much time we predict these features would save you.

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ time.**
with a
[Business or Enterprise tier Cypress Cloud plan](https://cypress.io/pricing).
Wondering if upgrading your Team tier subscription is worth it? Check out the
[recommendations](/guides/cloud/debugging/recorded-runs#Recommendations) on the run
[recommendations](/guides/cloud/recorded-runs#Recommendations) on the run
overview page to see how much time we predict these features would save you.

:::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Test Replay
sidebar_position: 20
sidebar_position: 40
sidebar_class_name: new_label
---

Expand Down Expand Up @@ -57,14 +57,14 @@ All you need to do after [recording test runs](/guides/cloud/getting-started) is

Accessing the replay of your test is as simple as reviewing any other test artifact in Cypress Cloud.

1. Hover on a [test for review](/guides/cloud/debugging/recorded-runs#Tests-for-Review) under the Latest Runs Overview.
1. Hover on a [test for review](/guides/cloud/recorded-runs#Tests-for-Review) under the Latest Runs Overview.

<DocsImage
src="/img/guides/cloud/test-replay/replay_row_magnified.jpg"
alt="Run overview row"
/>

2. Or navigate to the [test detail sidebar](/guides/cloud/debugging/recorded-runs#Test-detail-sidebar) header or above each attempt in the errors panel. The header option will replay the first failing test while the option above each attempt will replay the affiliated test.
2. Or navigate to the [test detail sidebar](/guides/cloud/recorded-runs#Test-detail-sidebar) header or above each attempt in the errors panel. The header option will replay the first failing test while the option above each attempt will replay the affiliated test.

<DocsImage
src="/img/guides/cloud/test-replay/replay_sidebar_magnified.jpg"
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/continuous-integration/github-actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -433,8 +433,8 @@ are leveraging three useful features of
to [Cypress Cloud](https://on.cypress.io/cloud):

- In-depth and shareable
[test reports](/guides/cloud/debugging/recorded-runs#Latest-Runs).
- Visibility into test failures via quick access to [Test Replay](/guides/cloud/debugging/test-replay), error messages, stack
[test reports](/guides/cloud/recorded-runs#Latest-Runs).
- Visibility into test failures via quick access to [Test Replay](/guides/cloud/test-replay), error messages, stack
traces, screenshots, videos, and contextual details.
- [Integrating testing with the pull-request (PR) process](/guides/cloud/integrations/source-control/github)
via
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/continuous-integration/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,7 @@ CI providers. Find the workshop at
viewport sizes.
- [cypress-example-kitchensink](https://github.com/cypress-io/cypress-example-kitchensink#ci-status)
is set up to run on multiple CI providers.
- [Test Replay](/guides/cloud/debugging/test-replay)
- [Test Replay](/guides/cloud/test-replay)
- [Cross Browser Testing Guide](/guides/guides/cross-browser-testing)
- [Blog: Setting up Bitbucket Pipelines with proper caching of npm and Cypress](https://www.cypress.io/blog/2018/08/30/setting-up-bitbucket-pipelines-with-proper-caching-of-npm-and-cypress/)
- [Blog: Record Test Artifacts from any Docker CI](https://www.cypress.io/blog/2018/08/28/record-test-artifacts-from-any-ci/)
Expand Down
Loading