cypress
16.3.0 · 10 Nov 2026MIT7.6M / weekRepositoryHomepagenpmAtom feed
12.17.4 is the newest release of 12.x.
In short
1 breaking5 new4 fixed17 changed
- Breaking
Cypress dropped support for Node.js 12, 15, and 17. Those versions have reached end-of-life. Installing Cypress on your system now requires Node.js 14, 16 or 18+. Addressed in #24885.
Release note
12.0.0
Released Dec 06, 2022
Summary:
The Session and Origin Experiment is now generally available for end-to-end testing. This means Cypress now fully supports:
Testing multiple origins in a single test with the new cy.origin() command.
Caching and restoring cookies, localStorage, and sessionStoragebetween tests.
Configuring testIsolationin suites to define whether or not the browser context is cleaned or persisted between tests.
Additionally in this release, enhancements were made to how Cypress manages DOM element resolution to reduce the likelihood of hitting detached DOM errors due to maintaining stale DOM references. We've updated our Retry-ability Guide with all the details if you'd like to learn more.
Read more about 12.0 in our blog post.
Breaking Changes:
- Breaking
Cypress dropped support for Node.js 12, 15, and 17. Those versions have reached end-of-life. Installing Cypress on your system now requires Node.js 14, 16 or 18+. Addressed in #24885.
Cypress has always recommended writing tests in a clean context. In Cypress 12, we enforce running tests in a clean browser context through test isolation. This option is configurable, but is enabled by default. Whether enabled or disabled, this changes how Cypress cleans up the browser context before each test and you may experience test errors with this upgrade. To better understand the full impact of this change, review the migration guide.
In Cypress v12, the
testIsolationconfiguration values have changed fromonorofftotrueorfalse. Addressed in #24935.
The
experimentalSessionAndOriginconfiguration option has been removed and all functionality associated with this experiment is now enabled by default, with the exception of usingrequireandimportwith callback supplied to the cy.origin() command. To use external dependencies incy.origin()callbacks, set the new e2e.experimentalOriginDependenciesconfiguration option totrue. Addresses #21471.The
Cookies.defaultsandCookies.preserveOnceAPIs have been removed. Use the new cy.session() command to preserve cookies between tests. Addresses #21472.The
cy.server()andcy.route()commands have been removed. Additionally, the correspondingCypress.Server.defaultsAPI has also been removed. Use the [cy.intercept()(/api/commands/intercept) command to stub network responses and requests. Addresses #22126.The Cookie commands now uses the
hostnameas the domain by default instead of thesuperdomain. This change aligns Cypress' cookie rules with the browser cookie rules. This may affect what cookies are returned by cy.getCookie(), what cookies are set with cy.setCookie(), and the cookies cleared with cy.clearCookies(). Addresses #363, #5723 and #24526.The .within() command now requires a single subject and throws an error if given more than one subject. This change adds consistency around how
.within()behaves across commands. Previously some commands inside a.within()callback would silently select the first element, while others would use all of the previously yielded subjects, and others would throw an error. Addressed in #24975.Cypress now throws an error if any Cypress commands are invoked from inside a .should() callback. This previously resulted in unusual and undefined behavior. Addresses #5963, #14656 and #22587.
The .invoke() command now throws an error if the invoked function returns a promise. If you wish to call a method that returns a promise and wait for it to resolve, use .then()instead of
.invoke(). Addressed in #24417.The cy.request() command now uses querystringify to stringify & parse the
qsoptions. This change aligns with how the cy.visit() command generates urls with query parameters. Addressed in #20302.
Features:
Added a new configuration option called
testIsolation, which defaults totrue. This option can be set at thee2eor suite-level to determine whether or not test isolationis enabled to ensure a clean browser context between tests. Addressed in #22230.The previously experimental Cypress command, cy.origin(), is now generally available in end-to-end testing. This command allows testing multiple origins in a single test. Addresses #17336.
The previously experimental Cypress command, cy.session(), is now generally available. This command caches and restores
cookies, localStorage, and sessionStorageto recreate a consistent browser context between tests. Addresses #20977.Added a new Cypress command, cy.getAllLocalStorage(), to get localStoragedata for all origins with which the test has interacted. Addresses #24276.
Added a new Cypress command, cy.clearAllLocalStorage(), to clear localStoragedata for all origins with which the test has interacted. Addresses #24276.
Added a new Cypress command, cy.getAllSessionStorage(), to get sessionStoragedata for all origins with which the test has interacted. Addresses #24276.
Added a new Cypress command, cy.clearAllSessionStorage(), to clear sessionStoragedata for all origins with which the test has interacted. Addresses #24276.
Added a new configuration option called experimentalOriginDependencies, which defaults to
false. This option enables support forrequireandimportwithin the callback supplied to the cy.origin() command in end-to-end testing. Previously this feature was enabled through theexperimentalSessionAndOriginconfiguration option.experimentalOriginDependencieswas added as a configuration option in Cypress 12, instead of being enabled by default, due to increased Node.js memory usage associated with this option that needs to be addressed before making this behavior generally available. See issue #24976 for more information. Addressed in #24931.Added a new
Cypress.ensureAPI which provides several methods that can be helpful when writing customs commands. Addressed in #24697.Added a new "Run All" button to the experimentalRunAllSpecsexperiment which enables running all spec files returned from the
specPatternglob or an array of globs, regardless of the specs sharing a root folder. Addresses #24759.Further improved bundling in the binary to reduce startup and unzip time. Addressed in #24909.
Bugfixes:
Fixed a regression in 10.11.0 where the Launchpad no longer showed a loading spinner on startup to indicate that it had successfully started and was in a loading state. Fixed #24950.
Fixed the "Create Spec from Component" capability to correctly scaffold the component spec from a component which contains special characters in its name. Before this change, a spec was scaffolded with either the wrong spec name or the incorrect component import which led to invalid JS errors. Fixes #23492.
Corrected Cypress environment variable resolution to correctly resolve environment variables set with
npm config set. Fixes #24556.When experimentalRunAllSpecs=true, the "Run N specs" directory-level buttons in the Inline Specs List now function correctly when activated by the keyboard. Fixes #24762.
Fixed unexpected behaviors when verifying a cookie was not returned from cy.getCookie(). Now it's possible to explicitly assert the cookie did not exist with
cy.getCookie('foo1').should('not.exist'). Previously users had to verify cookies properties did not exist with.its('value').should('equal', null). Addressed in #24203.Fixed the console output returned from clicking on an aliased intercept in the Command Log. It now logs the yielded request/response object associated to the intercepted call when clicked, where previously it did not log these details. Fixed in #24623.
A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.