feat: Support Cypress 10

BREAKING CHANGE: In Cypress 10, the 'integrationFolder' was removed from the
config. This value had been used to determine where to save and load the request
fixtures, so a new approach has been implemented and the plugin cannot find
previously created fixtures.

BREAKING CHANGE: The file extension of the recorded fixtures was changed to
'.cy-playback' to make it easier to identify that these files belong to the
plugin.

Author: Brent Schmidt

.gitattributes

@@ -1 +1 @@
-.cy-request binary
+.cy-playback binary

README.md

@@ -483,7 +483,7 @@ A "stale" entity becomes "fresh" when...
 ### The Recorded Fixtures File
 
 All the captured responses for a test are grouped together into a single
-`.cy-requests` file that is saved to the Cypress fixtures folder. A subdirectory
+`.cy-playbacks` file that is saved to the Cypress fixtures folder. A subdirectory
 is created in the fixtures folder for each spec file. Within that folder, a
 fixture file is created for each test in the spec file. The file name is a
 combination of the test's name and any `describe` blocks it is nested under.
@@ -509,9 +509,9 @@ Consider the following example spec file.
   ```
 * **Generated Fixture Files:**
   ```bash
-  ./cypress/fixtures/app/basic-spec/app-works.cy-requests
-  ./cypress/fixtures/app/basic-spec/app-still-works.cy-requests
-  ./cypress/fixtures/app/basic-spec/app-another-language-works.cy-requests
+  ./cypress/fixtures/app/basic-spec/app-works.cy-playbacks
+  ./cypress/fixtures/app/basic-spec/app-still-works.cy-playbacks
+  ./cypress/fixtures/app/basic-spec/app-another-language-works.cy-playbacks
   ```
 
 > ⚠️ As can seen, if the location of the spec file or the structure or name of
@@ -521,7 +521,7 @@ Consider the following example spec file.
 
 #### File Format
 
-The `.cy-requests` file is a binary file, which is created by JSON stringifying
+The `.cy-playbacks` file is a binary file, which is created by JSON stringifying
 the request matchers and requests and compressing that output with Node's
 `zlib.deflate` function. There are two reasons for this approach:
 

lib/.npmignore

@@ -2,7 +2,7 @@
 /*
 
 !commands/**/*
-!plugins/**/*
+!tasks/**/*
 !addCommands.js
 !addTasks.js
 

lib/addTasks.js

@@ -1,5 +1,5 @@
-const { readRequestsFromDisk } = require('./plugins/functions/readRequestsFromDisk');
-const { writeRequestsToDisk } = require('./plugins/functions/writeRequestsToDisk');
+const { readRequestsFromDisk } = require('./tasks/functions/readRequestsFromDisk');
+const { writeRequestsToDisk } = require('./tasks/functions/writeRequestsToDisk');
 
 module.exports = (on, config) => {
   on('task', {

lib/commands/constants.js

@@ -3,7 +3,7 @@ const ENV_MODE = 'PLAYBACK_MODE';
 /**
  * The current version of the serialized requests and responses.
  */
-const SERIALIZE_VERSION = 2;
+const SERIALIZE_VERSION = 3;
 
 module.exports = {
   CONFIG_KEY,

lib/commands/functions/getTestMetadata.js

@@ -4,16 +4,23 @@
  * @returns {{ file: string, title: string }}
  */
 function getTestMetadata(context) {
-  const test = context?.currentTest ?? context?.test ?? null;
-  if (!test) {
-    throw new Error('No "test" in context');
+  // The data we need is spread across two different properties in the context.
+  // - `currentTest` represents the test that is being run. It tends to be
+  //   present more reliably.
+  // - `test` is more specific and may actually be tied to a hook, such as
+  //   beforeEach / afterEach. It may not always be present. However, if
+  //   present, it's `file` property is a better relative path to the file for
+  //   the current test suite.
+  const { currentTest, test } = context ?? {};
+  if (!currentTest) {
+    throw new Error('No "currentTest" in context');
   }
 
-  const invocationDetails = test.invocationDetails || test.parent?.invocationDetails;
-  const file = invocationDetails?.absoluteFile;
+  const invocationDetails = currentTest.invocationDetails ?? currentTest.parent?.invocationDetails;
+  const file = test?.file ?? currentTest?.file ?? invocationDetails?.relativeFile;
 
-  let titles = [test.title];
-  let parent = test.parent;
+  let titles = [currentTest.title];
+  let parent = currentTest.parent;
   while (!parent.root) {
     titles.push(parent.title);
     parent = parent.parent;
@@ -28,11 +35,11 @@ function getTestMetadata(context) {
   }
   return {
     file,
-    state: test.state,
+    state: currentTest.state,
     title
   };
 }
 
 module.exports = {
   getTestMetadata
-};
+};

lib/commands/functions/tests/getTestMetadata.spec.js

@@ -1,8 +1,11 @@
 const { getTestMetadata } = require('../getTestMetadata');
 
-function getMockContext(testProp = 'test') {
+function getMockContext() {
   return {
-    [testProp]: {
+    test: {
+      file: 'relative/path/to/file.js',
+    },
+    currentTest: {
       title: 'does thing',
       state: 'passed',
       parent: {
@@ -16,7 +19,7 @@ function getMockContext(testProp = 'test') {
         }
       },
       invocationDetails: {
-        absoluteFile: '/path/to/file.js'
+        relativeFile: 'relative/path/to/file.js'
       }
     }
   };
@@ -25,25 +28,28 @@ function getMockContext(testProp = 'test') {
 describe('getTestMetadata', () => {
   describe('returns expected values', () => {
     const expected = {
-      file: '/path/to/file.js',
+      file: 'relative/path/to/file.js',
       state: 'passed',
       title: 'grandparent-parent-does thing'
     };
 
-    it('when context uses "currentTest"', () => {
-      expect(getTestMetadata(getMockContext('currentTest'))).to.eql(expected);
+    it('works with a fully defined context.', () => {
+      expect(getTestMetadata(getMockContext())).to.eql(expected);
     });
 
-    it('when context uses "test"', () => {
-      expect(getTestMetadata(getMockContext('test'))).to.eql(expected);
+    it('works with a missing "test" property in the context.', () => {
+      const context = getMockContext();
+      delete context.test;
+      expect(getTestMetadata(context)).to.eql(expected);
     });
   });
 
   describe('throws exceptions', () => {
     it('when missing "file"', () => {
       // Arrange
       const context = getMockContext();
-      delete context.test.invocationDetails;
+      delete context.test.file;
+      delete context.currentTest.invocationDetails;
 
       // Act / Assert
       expect(() => getTestMetadata(context)).to.throw()
@@ -53,17 +59,17 @@ describe('getTestMetadata', () => {
     it('when missing "title"', () => {
       // Arrange
       const context = getMockContext();
-      delete context.test.title;
-      context.test.parent = { root: true };
+      delete context.currentTest.title;
+      context.currentTest.parent = { root: true };
 
       // Act / Assert
       expect(() => getTestMetadata(context)).to.throw()
         .property('message').to.match(/Could not determine "title"/);
     });
 
-    it('when no "test" object on the context.', () => {
+    it('when no "currentTest" object on the context.', () => {
       expect(() => getTestMetadata()).to.throw()
-        .property('message').to.match(/No "test" in context/);
+        .property('message').to.match(/No "currentTest" in context/);
     });
   });
 });