feat: recompute data session if options change (#117)

cypress/e2e/changes/data-options-change.cy.js

@@ -0,0 +1,43 @@
+// @ts-check
+
+import '../../../src'
+
+describe('data options change', () => {
+  const name = 'data-options-change-example'
+
+  beforeEach(() => {
+    // force starting fresh
+    Cypress.clearDataSession(name)
+  })
+
+  it('invalidates the session', () => {
+    const stub1 = cy.stub().as('setup').returns(42)
+    const setup = () => stub1()
+
+    cy.dataSession({ name, setup })
+      .then(function (value) {
+        expect(value, 'yielded').to.equal(42)
+        expect(stub1).to.be.calledOnce
+        stub1.resetHistory()
+      })
+      .then(() => {
+        // using exactly same parameters does not recreate anything
+        cy.log('**same data session options**')
+        cy.dataSession({ name, setup })
+          .then(function (value) {
+            expect(value, 'yielded').to.equal(42)
+            expect(stub1).to.not.be.called
+          })
+          .then(() => {
+            // adding parameter "expires" invalidates the data session
+            cy.log('**changed options**')
+            cy.dataSession({ name, setup, expires: 10_000 }).then(function (
+              value,
+            ) {
+              expect(value, 'yielded').to.equal(42)
+              expect(stub1).to.be.calledOnce
+            })
+          })
+      })
+  })
+})

cypress/e2e/setup-changes.cy.js → cypress/e2e/changes/setup-changes.cy.js

@@ -1,6 +1,6 @@
 // @ts-check
 
-import '../../src'
+import '../../../src'
 
 describe('setup function changes', () => {
   const name = 'setup-changes-example'

src/index.js

@@ -132,7 +132,11 @@ Cypress.Commands.add(
       })
     }
 
-    const setupSource = setup.toString()
+    // we want to recompute the data session if the user changes
+    // any of its options or the code in the setup callback function
+    const setupSource =
+      JSON.stringify({ expires, shareAcrossSpecs, dependsOn, showValue }) +
+      setup.toString()
 
     const saveData = (data) => {
       if (data === undefined) {