Cypress.session

Experimental

The session API is currently experimental, and can be enabled by setting the experimentalSessionAndOrigin option to true in the Cypress config.

Enabling this flag does the following:

• It adds the cy.session() and cy.origin() commands, and Cypress.session API.
• It adds the following new behaviors (that will be the default in a future major update of Cypress) at the beginning of each test:
  • The testIsolation mode is enhanced from legacy mode to on mode such that
    • The page is cleared (by setting it to about:blank).
    • All active session data (cookies, localStorage and sessionStorage) across all domains are cleared.
• It overrides the Cypress.Cookies.preserveOnce() and Cypress.Cookies.defaults() methods.
• Cross-origin navigation will no longer fail immediately, but instead, time out based on pageLoadTimeout.
• Tests will no longer wait on page loads before moving on to the next test.

Because the page is cleared at the beginning of each test by default, cy.visit() must be explicitly called at the beginning of each test.