What’s New

Bugfixes

• Added a ready event to the Plugins process to ensure all plugins have successfully started before the configuration is loaded and the tests start.
• Made a change to the DNS lookup to improve test performances and reliability on MacOS machines that leverage the VMWare CBCloud SaaS solution. Before this change, random test failures were observed, as well as hanging tests and initially pending HTTP and HTTPS responses.

Dependency Updates

• Upgraded url-parse dependency from 1.5.2 to 1.5.6 to avoid authorization bypass through user-controlled key to address this NVD security vulnerability.

Read the complete changelog for v9.5.1

Features

• Enhancements were made to the error experience in both run mode and open mode to improve readability and provide meaningful stack traces.
• Updated the cy.request() log message to hide the origin when it matched the browser origin to make debugging easier. This reduces the length of the log message that could be partially hidden if a long url is requested.

Bugfixes

• Fixed an issue where files attached during .selectFile() could have the wrong File prototype.
• Updated .select() to only dispatch the change and input events when the selected option is not the currently selected option. This change aligns .select() with the browser.

Bugfixes

Fixed a regression in 9.4.0 where the line endings in the public NPM package prevented some users from running Cypress.

Features

Enhancements were made to .selectFile() after receiving feedback after its initial release in 9.3.0.

• The default behavior was updated to automatically infer the mime type of files based on their extension to correctly encode file uploads.
• Added the mimeType property so you can explicitly set the mime type on files using the mimeType property.
• Updated file contents types to allow either a TypedArray instance or a Cypress.Buffer instance, where previously file contents were expected to only be an instance of Cypress.Buffer.
• Updated .selectFile() to retain the fileName of files read from disk to work with aliases.

Bugfixes

Fixed an issue where the bin file was released with windows line breaks.

Features

Added a new Cypress command, called .selectFile(), to select a file or files in an HTML5 input element or simulate dragging a file or files into the browser. The API is similar to cypress-file-upload and we have provided a migration guide for previous users of that plugin. For more details, see our blog post. 

Bugfixes

Fixed a regression in 9.2.0 to keep Cypress open after each spec finishes when the --headed --no-exit flags are passed to cypress run.

Improve heuristic for verifying when the --openssl-legacy-provider option should be passed to the plugins' child process when the system Node version is v17+. This prevents Cypress from crashing when a user has Node 17 installed which was built with OpenSSL v1.

Features

Cypress will throw an error when a user attempts to update a configuration value at run-time using either the Test Configuration or using Cypress.config() that is a readonly option.

Additionally, a timeout option has been added to the cy.writeFile() command, with a default value of defaultCommandTimeout.

Bugfixes

Cypress now prevents unnecessary snapshotting when running default assertions that would unnecessarily increase CPU use in cypress open mode which lead to out of memory crashes on certain browsers.

We removed automatic retries for failed HTTP requests through the proxy. This fixes an issue where failed requests could be re-sent too many times in some conditions. This change could increase the number of failed requests that your app sees.

Tests that are skipped within then blocks will no longer throw errors causing the test to fail. Tests that are skipped outside of then blocks will no longer trigger the fail event. This will prevent screenshots from happening from errors thrown by the fail event.

Bugfixes

We fixed a regression in 9.1.0 where our built binary didn't contain patches to some dependencies.

Additionally, when using the default configuration of "nodeVersion": "system" with an installed system node >=17, Cypress will now work properly rather than throw an error incorrectly pointing to the user's plugin file.

Features

A CYPRESS environment variable will be set to true in child processes where Cypress runs user code in Node.js. You can now detect that you're running in Cypress by looking for process.env.CYPRESS.

Bugfixes

Specs with % in the filename will no longer fail to load and now behave as any other spec.

Additionally, when using the Selector Playground, the HTML attribute's value will be wrapped in double-quotes.

Breaking Changes

The nodeVersion configuration option now defaults to system. The behavior of the system option has changed to always use the Node.js binary/version that launched Cypress. If Cypress was not launched via the terminal, Cypress will use the bundled Node.js version. This could change the behavior of code within your pluginsFile since it may be run in your system Node.js version.

Additionally, Windows 32-bit is no longer supported in Cypress.

An error will now be thrown if an invalid value is passed to Cypress.config. Previously invalid values were ignored and could cause unexpected behavior.

cy.contains() no longer yields the <body> element when it matches the content of <script> or <style> tags.

Deprecations

The nodeVersion configuration option has been deprecated and will be removed in a future release.

Features

When null is passed as the encoding to cy.readFile() or cy.fixture(), the file is treated as binary and read as a Buffer. Similarly, null passed as the encoding to cy.writeFile() allows direct writing of buffers. If the encoding is unspecified, the default remains utf8, matching the current behavior.

Bugfixes

Sticky elements within a fixed container will now be able to be properly scrolled to during action commands.

Features

There are now changes to how "slow" tests are determined and displayed in Cypress.

Users can also now pass an overwrite: true option to Cypress.Screenshot.defaults to change default behavior to overwrite existing screenshots without having to set overwrite for each cy.screenshot() command.

Bugfixes

We fixed a regression introduced in 8.6.0 where videos recorded in Electron to the Dashboard were not playable in the Firefox or Safari browser and were not compatible with QuickTime player in MacOS.

We also fixed a regression introduced in 8.6.0 so that the warning about the projectRoot directory not being writeable will now display correctly.

Features

cy.screenshot() now accepts overwrite: true as an option to overwrite existing screenshots with the same file name.

 cy.select([]) can now be used to clear any selected options in a multi-value select.

Bugfixes

We fixed a regression introduced in 8.2.0 where certain XMLHttpRequests would not display their response bodies in the DevTools Console when clicked. 

We also fixed a regression in 8.3.0 where capturing videos in Chrome versions earlier than 89 would result in choppy videos and skipped frames.

Misc.

We updated the cy.request() error message when conflicting failOnStatusCode and retryOnStatusCodeFailure options are passed to be clearer.

Dependency Updates

We upgraded the Chromium browser version used during cypress run and when selecting Electron browser in cypress open from 91.0.4472.164 to 93.0.4577.58

Features

You can now select an option by index within the .select() command.

Bugfixes

The download of Cypress now respects the NO_PROXY environment variable when one is set.

Misc.

Windows 32-bit has been deprecated and support will be removed in a later release. A deprecation warning will now display when using Cypress in a Windows 32-bit OS.

Bugfixes

Cypress will no longer crash when setting up a project to record to the Dashboard or viewing the runs or record key for a previously set up project.

Read the complete changelog for v8.4.1.

Features

When a URL contains non-ASCII characters, you can use the new decode option of cy.url() to decode it.

Bugfixes

Cypress now better handles situations where the extension was installed in a read-only location.

A clearer error message is now thrown for .check() or .uncheck() when there are no matching value attributes found.

Read the complete changelog for v8.4.0.

Performance Updates

Projects will now open much faster on MacOS Big Sur with improved browser detection performance.

Bugfixes

We fixed a regression in 8.3.0 where the correct exit code would not be issued during cypress run-ct while running in the Electron browser.

Fixed a regression in 8.3.0 where Cypress would cause a SIGSEGV error on Mac when closing the Cypress app opened via cypress open.

Read the complete changelog for v8.3.1.

What’s New

We've included new instructions for recording a run for some users.

Performance Updates

We addressed an issue that increased CPU usage during video recording in Chrome 89+/Electron 12+.

Bugfixes

We fixed an issue that could cause intermittent OpenSSL errors when the local CA cert cache becomes corrupted.

We also fixed a regression in 7.2.0 causing the menu bar of Cypress to not be clickable in Windows.

Read the complete changelog for v8.3.0.

What’s New

You can now cache and restore cookies, localStorage, and sessionStorage in order to reduce test setup times by using the experimental cy.session().

Bugfixes

A "removing cookie failed" error will no longer throw when cookies are cleared in Firefox.

We also fixed a regression in 8.0.0 where an error would longer throw when there is no /etc/passwd entry for the current user, such as in some Docker and GitHub Action setups.

Read the complete changelog for v8.2.0.

What’s New

When using experimentalStudio, you can now generate assertions in Cypress Studio by right clicking on an element.

Additionally, when searching specs in the Test Runner during end-to-end testing, characters that are not letters will be ignored and don't have to be typed.

Bugfixes

When running Cypress in global mode, an error will no longer be thrown when trying to add a new project to the Dashboard.

Read the complete changelog for v8.1.0.

What’s New

We've made some updates to ensure a consistent run experience across browsers. Now all browsers run via cypress run run headlessly, with a device pixel ratio of 1, and a screen size of 1280x720 by default.

Bugfixes

console.log and console.error called within the plugins file will now be captured in the stdout sent to the Cypress Dashboard, making it visible in Output logs in the Dashboard.

There are also several fixes for cy.intercept().

Read the complete changelog for v8.0.0.

What’s New

When using experimentalStudio, Cypress Studio can now copy all commands generated to your clipboard.

Bugfixes

Cypress now respects preventScroll options passed to element.focus() calls within the application under test.

Read the complete changelog for v7.7.0.

What’s New

You can now override the default delay between typing characters for .type() with Cypress.Keyboard.defaults() or via test configuration.

The experience when opening a new project via cypress open has also been improved.

Bugfixes

Cypress no longer hangs intermittently when using webpack 5.

It is no longer necessary to return the config from the plugins function when using the dev-server:start event for component testing.

Many fixes have also been made to cy.intercept().

Read the complete changelog for v7.6.0.

What’s New

The Test Runner has a new 'Docs' menu with links and prompts specific to helping you get started writing tests, set up in CI, and running tests in the Dashboard.

Bugfixes

Cypress will not longer crash with a hasBinary infinite recursive call.

cy.location(<key>) will now retry if the remote location returns an empty string, which is possible during otherwise harmless redirects.

Read the complete changelog for v7.5.0.

What’s New

Cypress now detects and supports testing in the Chrome Beta browser.

There are also new keyboard shortcuts to continue (c) and to go to the next test (n) when the Test Runner is paused via .pause() and to toggle auto-scrolling of the Test Runner (a).

Bugfixes

We fixed an issue where cy.wait() could yield the incorrect result when used with cy.intercept() and several simultaneous requests.

We also improved the way that cy.intercept() matchers are displayed in the Command Log when using RouteMatcher properties besides url and method.

Read the complete changelog for v7.4.0.

What’s New

Component tests can now be launched via the Module API by passing testingType: 'component' via the new testingType property. The testingType will default to e2e.

Additionally, cy.intercept() now accepts a times option in the RouteMatcher. times will specify the number of times that a particular cy.intercept() should be applied.

Bugfixes

Cypress will no longer incorrectly redirect the AUT window to /__/ when location.href is set to a relative path within the call stack of an XHR event handler.

Cypress now properly handles when a form submit or anchor tag target is set to _top or _parent so that it no longer redirects the parent frame.

Read the complete changelog for v7.3.0.

What’s New

You can now navigate through folders in the Test Runner using the Tab keyboard input and open or close the folder's content with the Enter & Space keyboard inputs.

Bugfixes

We fixed a regression in 7.0.0 that caused the Test Runner to crash with an ERR_INVALID_ARG_TYPE type error. We now correctly detect a utf8 request body with multi-byte Unicode characters.

Reusing cy.intercept() aliases will now work as expected.

We fixed an issue in 7.0 where users could get a misleading "must pass a handler as the 3rd argument" error when using cy.intercept.

Read the complete changelog for v7.2.0.

What’s New

Introducing the Cypress Component Test Runner - now in alpha. Today’s release includes a brand new test runner designed to replace your Node-based component tests. Our Component Test Runner tests your components in the browser, just like a user would. And, since it runs in the browser, you get to debug your components using your favorite developer tools. Learn more about the alpha release of our Component Test Runner in the docs.

Breaking Changes - 7.0.0 introduces several breaking changes. Read the Migration Guide to get an in-depth explanation of how to change your code to migrate to Cypress 7.0.

Among the breaking changes in this release are several updates to cy.intercept(). Namely that users are now able to override request handlers by calling cy.intercept() again. This matches the previous behavior that was default in cy.route2(). Speaking of cy.route2(), cy.route2() is now completely removed. So if you were still using that, those calls won't work anymore.

• Increasing the default size of videos for test runs to make it easier to see all the details of a test run for debugging. High res video playback for all!
• Creating a new spec file from the test runner GUI.
• New keyboard shortcut (ctrl/cmd + f) to search spec files in the Test Runner based on your OS.

Read the complete changelog for v7.0.0.

What's New

The biggest news for this release is that experimentalRunEvents have proven themselves and are no longer experimental. Now, you can listen to before:run, after:run, before:spec, and after:spec events in the plugins file without needing the experimentalRunEvents configuration option.

There are a couple of other cool features of this release:

• Now all recorded runs will cancel if you have in fact canceled them from the Dashboard. Previously only parallelized runs would cancel correctly, so you can see how this is now better.
• Cypress will now send test details to the Dashboard at the beginning of a recorded run (so punctual!), so that historical test code and other data can be provided to the Dashboard upfront.
• You will now see the full stack trace from errors thrown in the preprocessor.

Bug Fixes

FFmpeg was sometimes erroring during video recording (and, weirdly, always erroring in Chrome 89). When this happened it stopped tests from running which is not ideal. We've fixed this issue and FFmpeg will no longer error.

There are a few additional bug fixes in this release, including some fixes for experimentalStudio (aka Cypress Studio).

One particularly interesting miscellaneous update is that we've changed the term "test recordings" (which refers to the recorded test data from a test that ran) to "test results" in order to make it more clear and help reduce confusion around a "test recording" being the actual video recording of the test.

View the full list of all changes in the 6.7 changelog.

What's New

This release focuses primarily on performance and bug fixes.

• Improved the startup time of cypress open and cypress run.
• Fixed an issue that could cause failure when installing two Cypress instances at the same time.
• Expanded the search bar in the desktop GUI to fill the entire width.
• Fixed a regression introduced in 6.4.0 that caused Electron to crash when opening outside links in the Command Log.
• Fixed selector TypeError when an assertion failed in afterEach.
• Fixed Microsoft Edge browser detection when passing a path on Windows.
• Fixed issue where browser paths with double backslashes would not work as expected on Windows.

View the full list of all changes in the 6.6.0 changelog.

Manage your merge requests with confidence.

Today we’re excited to introduce two new integrations designed to help your Cypress test runs fit seamlessly into your day-to-day development workflow.

Our GitLab and Bitbucket integrations ensure you don't merge a PR (or MR) until all your Cypress tests pass, so your teams can collaborate with confidence.

What's New:

• See new commit statuses in your GitLab pipeline view when a run completes.
• See new build statuses in the side panel of your PR view in Bitbucket when a run completes.
• Review detailed test run information in your merge or pull request comments.
• See test run statistics, specific test failures, and deep links to the Cypress Dashboard so you can resolve issues quickly.

Read more about our GitLab integration and Bitbucket integration (currently in beta) in the docs.

What's New

Command Log entry for file downloads We've improved the UI for users testing file downloads. Now, you'll see an entry in the command log when a file has been downloaded.

Bug Fixes

A change to how the Chrome DevTools Protocol is established was reverted. Cypress now only uses TCP to try to connect to Chrome DevTools Protocol, instead of using stdio and then falling back to TCP.

Several additional bug fixes were made including an issue where using delayMs with cy.intercept did not wait for the expected amount of time when used in a StaticResponse, as well as an issue where aliases set via req.alias containing a period character would not work as expected.

View the full list of all changes in the 6.4.0 changelog.

Call for feedback

As part of the Cypress Dashboard, we've discussed allowing users to run their Cypress tests in a hosted cloud environment that we provide. We'd love to hear if this is interesting to you and, if yes, what kind of functionality would make it more appealing and helpful than using your existing CI provider? If you have thoughts or ideas to share, we'd love to hear from you in our Productboard Portal.

What's New

Introducing the new, experimental feature, Cypress Studio. Cypress Studio offers a visual way to generate tests within the Test Runner by recording interactions against the application under test instead of writing test code. Cypress Studio can be enabled by adding the experimentalStudio attribute to your configuration, cypress.json by default.

Test file downloads in Cypress without the download prompt displaying. Any files downloaded while testing file downloads will be stored in the downloadsFolder which is set to cypress/downloads by default. The downloadsFolder will be deleted before each run unless trashAssetsBeforeRuns is set to false.

What's New

Get more control of scrollBehavior.

This release introduces a new scrollBehavior configuration option that allows you to control the viewport position when an element is scrolled prior to action commands including disabling scrolling altogether.

As always, several bug fixes were made including a few bugs with the new cy.intercept API for network stubbing. View the full list including deprecations and dependency updates in the 6.1.0 changelog.

What's New

Introducing Next Gen Network Stubbing with cy.intercept

Cypress now offers next generation network stubbing support with the introduction of the cy.intercept API (previously cy.route2()). With cy.intercept you'll have out-of-the-box support for intercepting fetch calls, page loads, and resource loads in addition to the pre-existing support for XMLHttpRequests (XHR).

Cypress 6.0.0 introduces breaking changes. We put together a detailed Cypress 6.0.0 Migration Guide for a full run down on how to update your code to support Cypress 6.0.0.

See the full changelog for Cypress 6.0.0.

What's New

You can now run all integration specs or all component specs separately (or a filtered list of specs) by clicking the appropriate button in the Test Runner in the Tests tab. .

You can now dynamically add aliases for requests intercepted via cy.route2(). Check out an example.

As always bug fixes were made including fixing an issue causing failed subresource integrity checks for external scripts. View the full list of all changes, in the 5.6.0 changelog.

What's New

Turn off the Command Log in the Test Runner when debugging performance issues. The Command Log can be hidden by passing the CYPRESS_NO_COMMAND_LOG=1 environmental variable during cypress open or cypress run to be used as a tool to debug performance issues.

As always, bug fixes and improvements were made. View the full list in the 5.4.0 changelog.

What’s New

Firefox support is out of beta! Firefox 80 and newer are officially stable when used with Cypress. The firefoxGcInterval workaround is no longer needed unless testing versions of Firefox older than 80.

As always, bug fixes and improvements were made, including a few fixes to experimental network stubbing. View the full list in the 5.3.0 changelog.

New Features:

Support for shadow DOM is no longer experimental (which also means that we've removed the experimentalShadowDomSupport configuration flag). Now, by using the configuration option includeShadowDOM to enable shadow DOM, you'll be able to query globally, per-suite, per-test, or programmatically.

Ensure redirects are followed with experimental network stubbing. We recently introduced experimental network stubbing via cy.route2(). Now, we've added a followRedirect option that will ensure redirects are followed before resolving the req.reply callback. Additionally, we've added the capability to specify delayMs and throttleKbps when stubbing static responses.

As always, bug fixes and improvements were made and you can see the full list in the 5.2.0 changelog.

However, if you happened to experience the issue with test retries that caused Cypress to hang in run mode with certain assertions, that has been fixed.

And if you experienced a performance issue which led to CPU bottlenecking during Cypress runs, that too has now been fixed.

What's New

Introducing experimental full network stubbing support. When experimentalNetworkStubbing is enabled, the cy.route2 command is available. By using cy.route2(), your tests can intercept, modify, and wait on any type of HTTP request originating from your app, including XMLHttpRequests, fetch requests, beacons and subresources (like iframes and scripts).

Outgoing HTTP requests can be modified before reaching the destination server, and the HTTP response can be intercepted as well before it reaches the browser.

Get specific with your event triggers. cy.trigger() now accepts an eventConstructor option in case you want to specify the type of event that you want to trigger (e.g. MouseEvent or KeyboardEvent).

For example - cy.get('button').trigger('mouseover', { eventConstructor: 'MouseEvent' })

We also fixed several bugs and made a small handful of dependency updates. See the full changelog for 5.1.0 >

New Features

Cypress 5.0 has native support for test retries. Test retries are off by default. However, they can be configured using the new retries configuration option which allows you to set the number of times to retry a failing test.

We’ve improved clicking with modifiers. Now, .click(), .dblclick(), and .rightclick() accept options altKey, ctrlKey, metaKey, and shiftKey to hold down key combinations while clicking.

We now allow you to disable DOM snapshots for stubs and spies. You can chain .snapshot() off of cy.stub() and cy.spy() to disable snapshots during those commands. For example: cy.stub().snapshot(false).

Breaking Changes

Ready to upgrade? Cypress 5.0 contains some breaking changes. We put together a detailed Cypress 5.0 Migration Guide for a full breakdown on how to update your code to support 5.0.

We’ve renamed Cypress.Cookies.defaults() whitelist to preserve to better reflect its behavior. We also renamed the blacklistHosts configuration to blockHosts and cy.server() whitelist option to ignore for the same reason.

Because Cypress 5.0 has test retries built in natively (although they are disabled by default), we have deprecated the cypress-plugin-retries plugin. You will see an error message if you have the plugin still installed after upgrading to Cypress 5.0.

We made adding the sameSite property to objects yielded by cy.setCookie(), cy.getCookie(), and cy.getCookies() the default. As a result, the experimentalGetCookiesSameSite configuration has been removed.

If you have file paths with a question mark ? in them, Cypress no longer supports those.

Libgbm-dev is now a requirement to run Cypress on Linux.

Cypress now requires TypeScript 3.4+

Installing Cypress on your system now requires node.js 10+

Several bug fixes and improvements were made as well. See the full changelog for 5.0.0 >

New Features

• You can now control whether screenshots are automatically taken on test failure during  cypress run by setting screenshotOnRunFailure in your configuration.
• The pluginsFile now has access to a readonly version property within the config object that returns the current Cypress version being run. This will allow plugins to better target specific Cypress versions.
• During cypress open, you can now run a subset of all specs by entering a text search filter and clicking ‘Run n tests’.

New from the Cypress Team

• Read how to extend the Cypress config file. 
• Watch how Optimizely tests features and feature flags 300% faster with Cypress.

What's New

Better time traveling with improvements to cy.clock(). If you've ever used cy.clock() to control the time of the world within your app, you know that historically you needed to provide an epoch time number (and you may have tried to pass a Date object and realized that we would just ignore it). But now, you can provide either a Date object or an epoch time number AND we won't just ignore it, we’ll convert it to the Number and it’ll work just fine.

Do or don’t ensureScrollability. We also made it so that you can now pass an ensureScrollability: false option to .scrollTo() to skip checking whether the element is scrollable.

We also fixed several bugs and made several (specifically 10) dependency updates. See the full changelog for 4.11.0 >

What’s New

Edit tests more easily with the Open in IDE button. Now, when hovering over a test in the Test Runner you’ll see the 'Open in IDE' link. Clicking it will open the spec in your code editor so you can edit your tests more easily.

Get better insight into the hooks running around your tests. If you’re using the before, beforeEach, after, and afterEach hook definitions to set conditions that you want to run before or after a set of tests (or before or after each test), those will now display separately in the Test Runner’s Command Log if they are defined in separate hook definitions.

And, if you need to open or edit those specs in your IDE you’ll see that ‘Open in IDE’ link when hovering, and you can click to open that spec file directly.

We also fixed several bugs and made some minor UI improvements to the Test Runner. See the full changelog for 4.10.0 >

The Cypress Real World App (RWA) is now available as an open-sourced project on Github. The RWA is a sample payment application that we have often used for demonstrating real world usage of Cypress testing methods, patterns, best practices and workflows.

Now anyone can use the Cypress Real World App to learn, experiment, tinker, train and practice testing with Cypress. Learn more >