Merge pull request #23904 from cypress-io/cache-sessions

Author: emilyrohrbough

cli/types/cypress.d.ts

@@ -661,7 +661,22 @@ declare namespace Cypress {
   }
 
   interface SessionOptions {
-    validate?: () => false | void
+    /**
+     * Whether or not to persist the session across all specs in the run.
+     * @default {false}
+     */
+    cacheAcrossSpecs?: boolean,
+    /**
+     * Function to run immediately after the session is created and `setup` function runs or
+     * after a session is restored and the page is cleared. If this returns `false`, throws an
+     * exception, returns a Promise which resolves to `false` or rejects or contains any failing
+     * Cypress command, the session is considered invalid.
+     *
+     * If validation fails immediately after `setup`, the test will fail.
+     * If validation fails after restoring a session, `setup` will re-run.
+     * @default {false}
+     */
+    validate?: () => Promise<false | void> | false | void
   }
 
   type CanReturnChainable = void | Chainable | Promise<unknown>
@@ -1080,7 +1095,7 @@ declare namespace Cypress {
       *
       * @see https://on.cypress.io/session
       */
-    session(id: string | object, setup?: SessionOptions['validate'], options?: SessionOptions): Chainable<null>
+    session(id: string | object, setup?: () => void, options?: SessionOptions): Chainable<null>
 
     /**
      * Get the window.document of the page that is currently active.

packages/app/cypress/e2e/runner/sessions.ui.cy.ts

@@ -4,6 +4,7 @@ import { snapshotReporter } from './support/snapshot-reporter'
 const validateSessionsInstrumentPanel = (sessionIds: Array<string> = []) => {
   cy.get('.sessions-container')
   .should('contain', `Sessions (${sessionIds.length})`)
+  .as('instrument_panel')
   .click()
 
   sessionIds.forEach((id) => {
@@ -142,7 +143,11 @@ describe('runner/cypress sessions.ui.spec', {
     })
 
     it('restores session as expected', () => {
-      cy.get('.test').each(($el) => cy.wrap($el).click())
+      cy.get('.test').each(($el, index) => {
+        if (index < 5) { // don't click on failed test
+          cy.wrap($el).click()
+        }
+      })
 
       cy.log('validate new session was created in first test')
       cy.get('.test').eq(0).within(() => {
@@ -153,7 +158,6 @@ describe('runner/cypress sessions.ui.spec', {
       cy.log('validate saved session was used in second test')
       cy.get('.test').eq(1).within(() => {
         validateSessionsInstrumentPanel(['user1'])
-
         cy.get('.command-name-session')
         .within(() => {
           cy.get('.command-expander').first().click()
@@ -192,7 +196,7 @@ describe('runner/cypress sessions.ui.spec', {
       cy.get('.test').eq(3).should('have.class', 'runnable-passed')
       cy.get('.test').eq(4).should('have.class', 'runnable-passed')
       cy.get('.test').eq(5).should('have.class', 'runnable-failed')
-      cy.contains('If you want to specify different options, please use a unique name').should('exist')
+      cy.contains('This session already exists.').should('exist')
     })
   })
 
@@ -323,7 +327,7 @@ describe('runner/cypress sessions.ui.spec', {
       passCount: 1,
     })
 
-    validateSessionsInstrumentPanel(['user1', 'user2'])
+    validateSessionsInstrumentPanel(['spec_session_1', 'spec_session_2', 'global_session_1'])
     // cy.percySnapshot() // TODO: restore when Percy CSS is fixed. See https://github.com/cypress-io/cypress/issues/23435
   })
 })
@@ -340,50 +344,91 @@ describe('runner/cypress sessions.open_mode.spec', () => {
       passCount: 1,
     })
 
-    cy.get('.command-name-session').should('contain', 'user1')
-    .find('.reporter-tag').should('contain', 'created')
-
-    cy.get('.command-name-session').should('contain', 'user2')
-    .find('.reporter-tag').should('contain', 'created')
+    cy.get('.reporter-tag').should('contain', 'created').should('length', 3)
   })
 
-  it('persists spec sessions when clicking "rerun all tests" button', () => {
+  it('persists global and spec sessions when clicking "rerun all tests" button', () => {
     cy.get('.restart').click()
 
     cy.waitForSpecToFinish({
       passCount: 1,
     })
 
-    cy.get('.command-name-session').should('contain', 'user1')
-    .find('.reporter-tag').should('contain', 'restored')
-
-    cy.get('.command-name-session').should('contain', 'user2')
-    .find('.reporter-tag').should('contain', 'restored')
+    cy.get('.reporter-tag').should('contain', 'restored').should('length', 3)
   })
 
-  it('persists spec sessions on refresh', () => {
+  it('persists global and spec sessions on refresh', () => {
     cy.get('body').type('r')
 
     cy.waitForSpecToFinish({
       passCount: 1,
     })
 
-    cy.get('.command-name-session').should('contain', 'user1')
-    .find('.reporter-tag').should('contain', 'restored')
-
-    cy.get('.command-name-session').should('contain', 'user2')
-    .find('.reporter-tag').should('contain', 'restored')
+    cy.get('.reporter-tag').should('contain', 'restored').should('length', 3)
   })
 
-  it('does not persists spec sessions when selecting a different spec', () => {
+  it('persists global session and does not persists spec session when selecting a different spec', () => {
     cy.get('body').type('f')
-    cy.get('div[title="new_session.cy.js"]').click()
+    cy.get('div[title="blank_session.cy.js"]').click()
 
     cy.waitForSpecToFinish({
       passCount: 1,
     })
 
-    cy.get('.command-name-session').should('contain', 'user1')
+    cy.get('.command-name-session').eq(0).should('contain', 'spec_session')
     .find('.reporter-tag').should('contain', 'created')
+
+    cy.get('.command-name-session').eq(1).should('contain', 'global_session_1')
+    .find('.reporter-tag').should('contain', 'restored')
+  })
+
+  it('clears all sessions when selecting "clear all sessions"', () => {
+    cy.get('body').type('r')
+
+    cy.waitForSpecToFinish({
+      passCount: 1,
+    })
+
+    cy.get('.reporter-tag').should('contain', 'restored').should('length', 3)
+
+    cy.contains('Clear All Sessions').click()
+
+    cy.contains('Your tests are loading...')
+
+    cy.waitForSpecToFinish({
+      passCount: 1,
+    })
+
+    cy.get('.reporter-tag').should('contain', 'created').should('length', 3)
+  })
+})
+
+describe('global sessions', () => {
+  beforeEach(() => {
+    cy.scaffoldProject('session-and-origin-e2e-specs')
+    cy.openProject('session-and-origin-e2e-specs')
+    cy.startAppServer('e2e')
+    cy.visitApp()
+
+    cy.get('[data-cy-row="global_sessions.cy.js"]').click()
+    cy.waitForSpecToFinish({
+      passCount: 2,
+    })
+  })
+
+  it('creates global session', () => {
+    cy.contains('.test', 'creates global session').as('creates_global').click()
+    cy.get('@creates_global').within(() => {
+      cy.get('.command-name-session').should('contain', 'global_session_1')
+      .find('.reporter-tag').should('contain', 'created')
+    })
+  })
+
+  it('restores global session', () => {
+    cy.contains('.test', 'restores global session').as('restores_global').click()
+    cy.get('@restores_global').within(() => {
+      cy.get('.command-name-session').should('contain', 'global_session_1')
+      .find('.reporter-tag').should('contain', 'restored')
+    })
   })
 })

packages/app/src/runner/index.ts

@@ -67,7 +67,7 @@ export function getEventManager () {
 
 window.getEventManager = getEventManager
 
-let _autIframeModel: AutIframe
+let _autIframeModel: AutIframe | null
 
 /**
  * Creates an instance of an AutIframe model which ise used to control

packages/data-context/src/sources/HtmlDataSource.ts

@@ -42,7 +42,7 @@ export class HtmlDataSource {
     throw err
   }
 
-  getPropertiesFromLegacyConfig (cfg: any) {
+  getPropertiesFromServerConfig (cfg: any = {}) {
     const keys = [
       'baseUrl',
       'browserUrl',
@@ -62,7 +62,7 @@ export class HtmlDataSource {
   }
 
   async makeServeConfig () {
-    const propertiesFromLegacyConfig = this.getPropertiesFromLegacyConfig(this.ctx._apis.projectApi.getConfig() ?? {})
+    const propertiesFromLegacyConfig = this.getPropertiesFromServerConfig(this.ctx._apis.projectApi.getConfig())
 
     let cfg = { ...propertiesFromLegacyConfig }
 

packages/driver/cypress/e2e/commands/sessions/manager.cy.ts

@@ -28,6 +28,7 @@ describe('src/cy/commands/sessions/manager.ts', () => {
         'session_1': {
           id: 'session_1',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: true,
         },
       }
@@ -47,11 +48,13 @@ describe('src/cy/commands/sessions/manager.ts', () => {
         'session_1': {
           id: 'session_1',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: false,
         },
         'session_2': {
           id: 'session_2',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: true,
         },
       }
@@ -62,6 +65,7 @@ describe('src/cy/commands/sessions/manager.ts', () => {
         'session_3': {
           id: 'session_3',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: true,
         },
       }
@@ -96,11 +100,13 @@ describe('src/cy/commands/sessions/manager.ts', () => {
         'session_1': {
           id: 'session_1',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: false,
         },
         'session_2': {
           id: 'session_2',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: true,
         },
       }
@@ -135,11 +141,13 @@ describe('src/cy/commands/sessions/manager.ts', () => {
         'session_1': {
           id: 'session_1',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: false,
         },
         'session_2': {
           id: 'session_2',
           setup: () => {},
+          cacheAcrossSpecs: false,
           hydrated: true,
         },
       }
@@ -236,6 +244,7 @@ describe('src/cy/commands/sessions/manager.ts', () => {
         setup,
         validate: undefined,
         cookies: null,
+        cacheAcrossSpecs: false,
         localStorage: null,
         sessionStorage: null,
         hydrated: false,