Cypress Dashboard (Cloud) service - Deep Dive

Overview - Cypress Dashboard (Cloud) service

What is it?

The Cypress Dashboard is a cloud service that collects, stores, and displays detailed information about your Cypress test runs. It helps you see test results, videos, screenshots, and logs in one place. This service works alongside your local Cypress tests to give you a clear picture of how your tests perform over time.

Why it matters

Without the Cypress Dashboard, you would only see test results on your local machine, making it hard to track issues across teams or over time. The Dashboard solves this by centralizing test data, helping teams quickly find failures and understand test behavior. This saves time and reduces frustration when fixing bugs or improving tests.

Where it fits

Before using the Cypress Dashboard, you should know how to write and run Cypress tests locally. After learning the Dashboard, you can explore advanced test analytics, continuous integration setups, and team collaboration features that improve testing workflows.

Mental Model

Core Idea

The Cypress Dashboard is like a control center that collects and shows detailed test run information from many machines in one easy-to-understand place.

Think of it like...

Imagine running a race where each runner reports their time and challenges to a central scoreboard. The Cypress Dashboard is that scoreboard for your tests, showing who ran well and where problems happened.

┌─────────────────────────────┐
│      Cypress Dashboard      │
│  (Cloud Service Interface)  │
├─────────────┬───────────────┤
│ Test Runs   │ Test Details  │
│ (Summary)   │ (Videos, Logs)│
├─────────────┴───────────────┤
│      Aggregated Test Data    │
└─────────────┬───────────────┘
              │
      ┌───────┴────────┐
      │ Local Test Runs │
      │ (Cypress CLI)   │
      └────────────────┘

Build-Up - 6 Steps

1

Foundation

What is Cypress Dashboard Service

Concept: Introducing the Cypress Dashboard as a cloud tool that stores and shows test results.

The Cypress Dashboard is a web service where your Cypress test results are sent after running tests. It stores videos, screenshots, and logs from your tests so you can review them anytime. This helps you see test history and details beyond your local machine.

Result

You understand the Dashboard is a cloud place to see test results and details.

Knowing the Dashboard is a separate cloud service helps you see why it adds value beyond local test runs.

2

Foundation

How Cypress Sends Data to Dashboard

Concept: Explaining how Cypress connects to the Dashboard during test runs.

When you run Cypress tests with the Dashboard enabled, Cypress sends test data to the cloud service automatically. This includes test results, screenshots on failure, and videos if enabled. You need to link your project with the Dashboard using a project ID and authentication token.

Result

You know the Dashboard receives data live from your test runs.

Understanding this connection clarifies how the Dashboard stays updated with your latest test results.

3

Intermediate

Using Dashboard to Debug Failures

🤔Before reading on: Do you think the Dashboard only shows pass/fail or also detailed failure info? Commit to your answer.

Concept: Learning how the Dashboard helps find and understand test failures with rich details.

The Dashboard shows failed tests with screenshots and video clips of the failure moment. It also displays logs and error messages. This helps you quickly see what went wrong without rerunning tests locally. You can compare runs to find flaky or new failures.

Result

You can use the Dashboard to diagnose test problems faster and more clearly.

Knowing the Dashboard provides rich failure details saves time and reduces guesswork in debugging.

4

Intermediate

Dashboard Features for Team Collaboration

🤔Before reading on: Do you think the Dashboard supports sharing test results with teammates? Commit to your answer.

Concept: Exploring how the Dashboard helps teams work together on testing.

The Dashboard allows multiple team members to view test results in one place. It tracks test history, so everyone sees trends and flaky tests. You can add comments and assign tests to team members. This central view improves communication and speeds up fixing issues.

Result

You understand the Dashboard as a collaboration tool, not just a report viewer.

Recognizing the Dashboard's team features helps you leverage it for better group testing workflows.

5

Advanced

Integrating Dashboard with CI/CD Pipelines

🤔Before reading on: Do you think the Dashboard can work automatically with continuous integration? Commit to your answer.

Concept: Showing how to connect the Dashboard with automated build and test systems.

You can configure your CI/CD system to run Cypress tests and send results to the Dashboard automatically. This means every code change triggers tests and uploads results without manual steps. The Dashboard then shows test status for each build, helping catch issues early.

Result

You can automate test reporting and monitor quality continuously.

Knowing this integration makes testing part of your development flow, improving software reliability.

6

Expert

Advanced Dashboard Insights and Flaky Test Detection

🤔Before reading on: Do you think the Dashboard can identify flaky tests automatically? Commit to your answer.

Concept: Understanding how the Dashboard analyzes test runs to find unstable tests and trends.

The Dashboard tracks test results over time and flags tests that sometimes pass and sometimes fail, called flaky tests. It provides analytics on test duration, failure rates, and trends. This helps teams focus on stabilizing tests and improving test suite health.

Result

You gain tools to improve test reliability and reduce false alarms.

Knowing the Dashboard's analytics helps maintain a trustworthy test suite and avoid wasting time on flaky tests.

Under the Hood

When Cypress runs tests with Dashboard enabled, it collects test events and artifacts like screenshots and videos. It streams this data securely to the Dashboard cloud service using an API key. The Dashboard stores this data in a database and processes it to generate reports, timelines, and analytics. It also links test runs to commits and CI builds for traceability.

Why designed this way?

The Dashboard was designed to centralize test data from many machines and runs, solving the problem of scattered test results. Cloud storage allows teams to access history and rich media without local storage limits. The API-based design supports integration with CI/CD and multiple projects. Alternatives like local-only reports lack collaboration and history features.

┌───────────────┐       ┌─────────────────────┐
│ Cypress Test  │──────▶│ Data Collection API  │
│ Runner (CLI)  │       │ (Sends results, logs)│
└───────────────┘       └──────────┬──────────┘
                                      │
                             ┌────────▼─────────┐
                             │ Cypress Dashboard │
                             │   Cloud Service   │
                             │ (Stores & Analyzes│
                             │  test data)       │
                             └────────┬─────────┘
                                      │
                        ┌─────────────▼─────────────┐
                        │ Web UI & API for Teams     │
                        │ (View results, analytics) │
                        └───────────────────────────┘

Myth Busters - 4 Common Misconceptions

Quick: Does the Dashboard run your tests for you? Commit to yes or no before reading on.

Common Belief: The Dashboard runs tests remotely in the cloud for you.

Reality: The Dashboard only collects and displays results; tests run on your machines or CI servers.

Why it matters: Thinking the Dashboard runs tests can cause confusion about test execution and lead to misconfigured setups.

Quick: Do you think the Dashboard stores your test code? Commit to yes or no before reading on.

Common Belief: The Dashboard stores your actual test code and source files.

Reality: The Dashboard stores only test results, videos, screenshots, and logs, not your source code.

Why it matters: Expecting code storage might lead to security concerns or misunderstandings about version control.

Quick: Does the Dashboard guarantee tests will never fail? Commit to yes or no before reading on.

Common Belief: Using the Dashboard makes tests more reliable automatically.

Reality: The Dashboard helps identify failures but does not fix or prevent them.

Why it matters:

Quick: Can the Dashboard detect flaky tests without any configuration? Commit to yes or no before reading on.

Common Belief: The Dashboard instantly knows which tests are flaky without setup.

Reality: Flaky test detection requires multiple runs and some configuration to identify patterns.

Why it matters: Assuming instant flaky detection may cause false confidence in test stability.

Expert Zone

1

The Dashboard's ability to link test runs to specific Git commits enables precise tracking of when failures were introduced.

2

Video recordings are stored only for failed tests by default to save space, but this can be customized for full run recordings.

3

The Dashboard supports parallelization insights, showing how tests split across machines to optimize run time.

When NOT to use

If your project requires full offline test reporting or strict data privacy without cloud storage, local reporting tools or self-hosted solutions are better. Also, for very small projects or quick prototypes, the overhead of Dashboard setup might not be worth it.

Production Patterns

Teams integrate the Dashboard with CI pipelines like GitHub Actions or Jenkins to automatically upload results on every pull request. They use Dashboard analytics to monitor flaky tests and assign failures to developers. Large projects use Dashboard's parallelization features to speed up test suites across multiple machines.

Connections

Continuous Integration (CI)

Builds-on

Understanding the Dashboard enhances CI by providing real-time test feedback and historical data for every code change.

Observability in Software Systems

Similar pattern

The Dashboard acts like an observability tool for tests, collecting logs, metrics, and traces to understand system health.

Project Management Tools

Complementary

Linking Dashboard test results with project management helps teams prioritize bug fixes and track quality alongside feature development.

Common Pitfalls

#1 Not linking the Cypress project to the Dashboard before running tests.

Wrong approach:

cypress run --record
// No project ID or authentication set

Correct approach:

cypress run --record --key your-dashboard-key --projectId your-project-id

Root cause:

Missing configuration causes Cypress not to send data to the Dashboard, so no results appear.

#2 Expecting all test runs to upload instantly without internet connection.

Wrong approach:

Running tests offline and expecting Dashboard updates immediately.

Correct approach:

Run tests with internet or upload results later when connected.

Root cause:

Dashboard requires network access to receive test data; offline runs do not sync automatically.

#3 Enabling video recording for all tests without storage consideration.

Wrong approach:

cypress.json with "video": true for all runs without limits.

Correct approach:

Configure video recording only for failed tests or limit retention to save space.

Root cause:

Uncontrolled video storage leads to high costs and slow Dashboard performance.

Key Takeaways

The Cypress Dashboard is a cloud service that collects and shows detailed test run data to help teams understand test results better.

It connects to your local or CI test runs by sending videos, screenshots, and logs for centralized viewing and analysis.

The Dashboard improves debugging by providing rich failure details and supports team collaboration with shared views and comments.

Integrating the Dashboard with CI/CD pipelines automates test reporting and helps catch issues early in development.

Advanced features like flaky test detection and parallelization insights help maintain test reliability and speed in production.