Breaking snapshot functionality when running all tests, previous fix …

…breaks other functionality (Reopens #10) (Fixes #14)

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
 
 ## Releases
+### [1.2.5](https://github.com/meinaart/cypress-plugin-snapshots/compare/v1.2.4...v1.2.5) - 2019-01-11
+- Breaking snapshot functionality when running all tests, previous fix breaks other functionality (Reopens #10) (Fixes #14)
+
 ### [1.2.4](https://github.com/meinaart/cypress-plugin-snapshots/compare/v1.2.3...v1.2.4) - 2019-01-04
 - Fix broken `excludedFields` functionality
 

__tests__/plugin.test.js

@@ -32,6 +32,6 @@ describe('plugin', () => {
     const { initPlugin } = require('../plugin');
 
     initPlugin(on, globalConfig);
-    expect(on).toBeCalledTimes(3);
+    expect(on).toBeCalledTimes(2);
   });
 });

package.json

@@ -39,7 +39,6 @@
     "test": "jest & npm --prefix cypress run cy:run"
   },
   "dependencies": {
-    "@cypress/browserify-preprocessor": "^1.1.2",
     "bufferutil": "^4.0.0",
     "chalk": "^2.4.1",
     "diff2html": "^2.5.0",

plugin.js

@@ -2,7 +2,6 @@
 const { initConfig, CONFIG_KEY } = require('./src/config');
 const initServer = require('./src/server/initServer');
 const tasks = require('./src/tasks/');
-const initSetSpecInServer = require('./src/plugin/initSetSpecInServer');
 
 /**
  * Initializes the plugin:
@@ -15,7 +14,6 @@ function initPlugin(on, globalConfig = {
 }) {
   const config = initConfig(globalConfig.env[CONFIG_KEY]);
   initServer(config);
-  initSetSpecInServer(on, config);
 
   // Adding sub objects/keys to `Cypress.env` that don't exist in `cypress.json` doesn't work.
   // That's why the config is stringified and parsed again in `src/utils/commands/getConfig.js#fixConfig`.

src/server/actions.js

@@ -1,6 +1,4 @@
 module.exports = {
-  GET_SPEC: 'cypress-plugin-snapshot:getSpec',
   SAVE_IMAGE: 'cypress-plugin-snapshot:saveImage',
   SAVE_TEXT: 'cypress-plugin-snapshot:saveText',
-  SET_SPEC: 'cypress-plugin-snapshot:setSpec',
 };

src/server/initServer.js

@@ -1,13 +1,12 @@
 const http = require('http');
 const socketio = require('socket.io');
-const { GET_SPEC, SET_SPEC, SAVE_TEXT, SAVE_IMAGE } = require('./actions');
+const { SAVE_TEXT, SAVE_IMAGE } = require('./actions');
 const { saveSnapshot } = require('../utils/tasks/textSnapshots');
 const { saveImageSnapshot } = require('../utils/tasks/imageSnapshots');
 
 function initServer(config) {
   const server = http.createServer();
   const io = socketio(server);
-  let spec = {};
 
   io.on('connection', (client) => {
     const { token } = client.handshake.query;
@@ -25,18 +24,6 @@ function initServer(config) {
         }
       });
     }
-
-    client.on(GET_SPEC, (fn) => {
-      if (token === config.token) {
-        fn(spec);
-      }
-    });
-
-    client.on(SET_SPEC, (newSpec) => {
-      if (token === config.token) {
-        spec = newSpec;
-      }
-    })
   });
 
   server.listen(config.serverPort, config.serverHost);

src/utils/commands/cleanupSnapshots.js

@@ -4,6 +4,7 @@ const { formatNormalizedJson, } = require('../../utils/json');
 const getTextSnapshotFilename = require('../text/getSnapshotFilename');
 const { snapshotTitleIsUsed } = require('../../utils/snapshotTitles');
 const getConfig = require('./getConfig');
+const getSpec = require('./getSpec');
 const { NO_LOG } = require('../../constants');
 
 // Removes unused snapshots from snapshot file
@@ -13,23 +14,25 @@ function cleanUpSnapshots() {
     return;
   }
 
-  const filename = getTextSnapshotFilename(Cypress.spec.relative);
-  cy.readFile(filename, NO_LOG).then((content) => {
-    if (content) {
-      const snapshot = JSON.parse(content);
-      const keys = Object.keys(snapshot);
+  getSpec().then((spec) => {
+    const filename = getTextSnapshotFilename(spec.relative);
+    cy.readFile(filename, NO_LOG).then((content) => {
+      if (content) {
+        const snapshot = JSON.parse(content);
+        const keys = Object.keys(snapshot);
 
-      const cleanSnapshot = keys
-        .filter(snapshotTitleIsUsed)
-        .reduce((result, key) => {
-          result[key] = snapshot[key];
-          return result;
-        }, {});
+        const cleanSnapshot = keys
+          .filter(snapshotTitleIsUsed)
+          .reduce((result, key) => {
+            result[key] = snapshot[key];
+            return result;
+          }, {});
 
-      cy.writeFile(filename,
-        formatNormalizedJson(cleanSnapshot),
-        NO_LOG);
-    }
+        cy.writeFile(filename,
+          formatNormalizedJson(cleanSnapshot),
+          NO_LOG);
+      }
+    });
   });
 }
 

src/utils/commands/getSpec.js

@@ -1,9 +1,6 @@
-const getSpecFromServer = require('../../server/getSpec');
-const getConfig = require('./getConfig');
-
 async function getSpec() {
   if (Cypress.spec.absolute === '__all') {
-    return getSpecFromServer(getConfig());
+    throw new Error(`cypress-plugin-snapshots does not work when running all tests, this will be fixed once this bug is resolved: https://github.com/cypress-io/cypress/issues/3090`);
   }
 
   return Promise.resolve(Cypress.spec);