@applitools/eyes-cypress 3.28.0 → 3.28.2

package/src/plugin/webSocket.js

@@ -1,107 +1,107 @@
-const WebSocket = require('ws');
-const {v4: uuid} = require('uuid');
+const WebSocket = require('ws')
+const {v4: uuid} = require('uuid')
 
 function connectSocket(url) {
-  const socket = new WebSocket(url);
-  let passthroughListener;
-  const listeners = new Map();
-  const queue = new Set();
-  let isReady = false;
+  const socket = new WebSocket(url)
+  let passthroughListener
+  const listeners = new Map()
+  const queue = new Set()
+  let isReady = false
 
-  attach();
+  attach()
 
   function attach() {
-    if (socket.readyState === WebSocket.CONNECTING) socket.on('open', () => attach(socket));
+    if (socket.readyState === WebSocket.CONNECTING) socket.on('open', () => attach(socket))
     else if (socket.readyState === WebSocket.OPEN) {
-      isReady = true;
-      queue.forEach(command => command());
-      queue.clear();
+      isReady = true
+      queue.forEach(command => command())
+      queue.clear()
 
       socket.on('message', message => {
-        const {name, key, payload} = deserialize(message);
-        const fns = listeners.get(name);
-        const keyListeners = key && listeners.get(`${name}/${key}`);
-        if (fns) fns.forEach(fn => fn(payload, key));
-        if (keyListeners) keyListeners.forEach(fn => fn(payload, key));
+        const {name, key, payload} = deserialize(message)
+        const fns = listeners.get(name)
+        const keyListeners = key && listeners.get(`${name}/${key}`)
+        if (fns) fns.forEach(fn => fn(payload, key))
+        if (keyListeners) keyListeners.forEach(fn => fn(payload, key))
 
         if (!fns && !keyListeners && passthroughListener) {
-          passthroughListener(message);
+          passthroughListener(message)
         }
-      });
+      })
     }
   }
 
   function disconnect() {
-    if (!socket) return;
-    socket.terminate();
-    isReady = false;
-    passthroughListener = null;
-    queue.clear();
+    if (!socket) return
+    socket.terminate()
+    isReady = false
+    passthroughListener = null
+    queue.clear()
   }
 
   function setPassthroughListener(fn) {
-    passthroughListener = fn;
+    passthroughListener = fn
   }
 
   function send(message) {
-    const command = () => socket.send(message);
-    if (isReady) command();
-    else queue.add(command);
-    return () => queue.delete(command);
+    const command = () => socket.send(message)
+    if (isReady) command()
+    else queue.add(command)
+    return () => queue.delete(command)
   }
 
   function on(type, fn) {
-    const name = typeof type === 'string' ? type : `${type.name}/${type.key}`;
-    let fns = listeners.get(name);
+    const name = typeof type === 'string' ? type : `${type.name}/${type.key}`
+    let fns = listeners.get(name)
     if (!fns) {
-      fns = new Set();
-      listeners.set(name, fns);
+      fns = new Set()
+      listeners.set(name, fns)
     }
-    fns.add(fn);
-    return () => off(name, fn);
+    fns.add(fn)
+    return () => off(name, fn)
   }
 
   function once(type, fn) {
-    const off = on(type, (...args) => (fn(...args), off()));
-    return off;
+    const off = on(type, (...args) => (fn(...args), off()))
+    return off
   }
 
   function off(name, fn) {
-    if (!fn) return listeners.delete(name);
-    const fns = listeners.get(name);
-    if (!fns) return false;
-    const existed = fns.delete(fn);
-    if (!fns.size) listeners.delete(name);
-    return existed;
+    if (!fn) return listeners.delete(name)
+    const fns = listeners.get(name)
+    if (!fns) return false
+    const existed = fns.delete(fn)
+    if (!fns.size) listeners.delete(name)
+    return existed
   }
 
   function emit(type, payload) {
-    return send(serialize(type, payload));
+    return send(serialize(type, payload))
   }
 
   function request(name, payload) {
     return new Promise((resolve, reject) => {
-      const key = uuid();
-      emit({name, key}, payload);
+      const key = uuid()
+      emit({name, key}, payload)
       once({name, key}, response => {
-        if (response.error) return reject(response.error);
-        return resolve(response.result);
-      });
-    });
+        if (response.error) return reject(response.error)
+        return resolve(response.result)
+      })
+    })
   }
 
   function ref() {
-    const command = () => socket._socket.ref();
-    if (isReady) command();
-    else queue.add(command);
-    return () => queue.delete(command);
+    const command = () => socket._socket.ref()
+    if (isReady) command()
+    else queue.add(command)
+    return () => queue.delete(command)
   }
 
   function unref() {
-    const command = () => socket._socket.unref();
-    if (isReady) command();
-    else queue.add(command);
-    return () => queue.delete(command);
+    const command = () => socket._socket.unref()
+    if (isReady) command()
+    else queue.add(command)
+    return () => queue.delete(command)
   }
 
   return {
@@ -114,17 +114,16 @@ function connectSocket(url) {
     disconnect,
     ref,
     unref,
-  };
+  }
 }
 
 function serialize(type, payload) {
-  const message =
-    typeof type === 'string' ? {name: type, payload} : {name: type.name, key: type.key, payload};
-  return JSON.stringify(message);
+  const message = typeof type === 'string' ? {name: type, payload} : {name: type.name, key: type.key, payload}
+  return JSON.stringify(message)
 }
 
 function deserialize(message) {
-  return JSON.parse(message);
+  return JSON.parse(message)
 }
 
-module.exports = connectSocket;
+module.exports = connectSocket

package/src/setup/addEyesCommands.js

@@ -1,24 +1,24 @@
-'use strict';
+'use strict'
 
-const commandsImport = `\nimport '@applitools/eyes-cypress/commands'\n`;
-const oldName = `eyes.cypress`;
+const commandsImport = `\nimport '@applitools/eyes-cypress/commands'\n`
+const oldName = `eyes.cypress`
 
 function shouldSkipLine(line) {
-  return line && (line.trim() === '' || /^\s*['"]use strict/.test(line) || /^\s*\/\//.test(line));
+  return line && (line.trim() === '' || /^\s*['"]use strict/.test(line) || /^\s*\/\//.test(line))
 }
 
 function addEyesCommands(content) {
   if (content.includes(oldName)) {
-    return content.replace(oldName, 'eyes-cypress');
+    return content.replace(oldName, 'eyes-cypress')
   }
-  const lines = content.split('\n');
-  let i = 0;
+  const lines = content.split('\n')
+  let i = 0
   while (shouldSkipLine(lines[i++])) {}
-  let index = i === 1 ? i : i - 1;
-  lines.splice(index, 0, commandsImport);
+  let index = i === 1 ? i : i - 1
+  lines.splice(index, 0, commandsImport)
 
-  return lines.join('\n');
+  return lines.join('\n')
 }
 
-module.exports = addEyesCommands;
-module.exports.commandsImport = commandsImport;
+module.exports = addEyesCommands
+module.exports.commandsImport = commandsImport

package/src/setup/addEyesCypressPlugin.js

@@ -1,14 +1,14 @@
-'use strict';
+'use strict'
 
-const pluginRequire = `\n\nrequire('@applitools/eyes-cypress')(module);\n`;
-const oldName = `eyes.cypress`;
+const pluginRequire = `\n\nrequire('@applitools/eyes-cypress')(module);\n`
+const oldName = `eyes.cypress`
 
 function addEyesCypressPlugin(content) {
   if (!content.includes(oldName)) {
-    return content.replace(/([\s\S])$/, `$1${pluginRequire}`);
+    return content.replace(/([\s\S])$/, `$1${pluginRequire}`)
   } else {
-    return content.replace(oldName, 'eyes-cypress');
+    return content.replace(oldName, 'eyes-cypress')
   }
 }
 
-module.exports = {addEyesCypressPlugin, pluginRequire};
+module.exports = {addEyesCypressPlugin, pluginRequire}

package/src/setup/getCypressPaths.js

@@ -1,13 +1,13 @@
-'use strict';
+'use strict'
 
-const fs = require('fs');
-const path = require('path');
+const fs = require('fs')
+const path = require('path')
 
 function getCypressPaths({cwd, isCypress10}) {
   if (isCypress10) {
-    return getCypressPaths10AndAbove(cwd);
+    return getCypressPaths10AndAbove(cwd)
   } else {
-    return getCypressPaths9AndBelow(cwd);
+    return getCypressPaths9AndBelow(cwd)
   }
 }
 
@@ -16,70 +16,66 @@ function getCypressPaths10AndAbove(cwd) {
     ? path.resolve(cwd, 'cypress.config.js')
     : fs.existsSync(path.resolve(cwd, 'cypress.config.ts'))
     ? path.resolve(cwd, 'cypress.config.ts')
-    : undefined;
+    : undefined
 
   if (cypressConfigPath) {
-    const configContent = fs.readFileSync(cypressConfigPath, 'utf-8');
-    const supportFilePath = getSupportFilePathFromCypress10Config({cwd, configContent});
-    const typeScriptFilePath = supportFilePath
-      ? path.resolve(path.dirname(supportFilePath), 'index.d.ts')
-      : undefined;
+    const configContent = fs.readFileSync(cypressConfigPath, 'utf-8')
+    const supportFilePath = getSupportFilePathFromCypress10Config({cwd, configContent})
+    const typeScriptFilePath = supportFilePath ? path.resolve(path.dirname(supportFilePath), 'index.d.ts') : undefined
     return {
       config: cypressConfigPath,
       plugin: cypressConfigPath,
       support: supportFilePath,
       typescript: typeScriptFilePath,
-    };
+    }
   } else {
     throw new Error(
       `No configuration file found at ${cwd}. This is usually caused by setting up Eyes before setting up Cypress. Please run "npx cypress open" first.`,
-    );
+    )
   }
 }
 
 function getSupportFilePathFromCypress10Config({cwd, configContent}) {
-  let supportFilePath;
+  let supportFilePath
   if (configContent.includes('supportFile')) {
-    const regex = new RegExp(/(?:supportFile:)(?:\s*)(.*)/g);
-    const filePath = regex.exec(configContent)[1].replace(/['|"|,]*/g, '');
-    supportFilePath = path.resolve(cwd, filePath);
+    const regex = new RegExp(/(?:supportFile:)(?:\s*)(.*)/g)
+    const filePath = regex.exec(configContent)[1].replace(/['|"|,]*/g, '')
+    supportFilePath = path.resolve(cwd, filePath)
   } else {
     if (fs.existsSync(path.resolve(cwd, 'cypress/support/e2e.js'))) {
-      supportFilePath = path.resolve(cwd, 'cypress/support/e2e.js');
+      supportFilePath = path.resolve(cwd, 'cypress/support/e2e.js')
     } else if (fs.existsSync(path.resolve(cwd, 'cypress/support/e2e.ts'))) {
-      supportFilePath = path.resolve(cwd, 'cypress/support/e2e.ts');
+      supportFilePath = path.resolve(cwd, 'cypress/support/e2e.ts')
     } else if (fs.existsSync(path.resolve(cwd, 'cypress/support/component.js'))) {
-      supportFilePath = path.resolve(cwd, 'cypress/support/component.js');
+      supportFilePath = path.resolve(cwd, 'cypress/support/component.js')
     } else if (fs.existsSync(path.resolve(cwd, 'cypress/support/component.ts'))) {
-      supportFilePath = path.resolve(cwd, 'cypress/support/component.ts');
+      supportFilePath = path.resolve(cwd, 'cypress/support/component.ts')
     }
   }
-  return supportFilePath;
+  return supportFilePath
 }
 
 function getCypressPaths9AndBelow(cwd) {
-  const cypressConfigPath = path.resolve(cwd, 'cypress.json');
+  const cypressConfigPath = path.resolve(cwd, 'cypress.json')
   if (fs.existsSync(cypressConfigPath)) {
     try {
-      const configContent = JSON.parse(fs.readFileSync(cypressConfigPath));
-      const supportFilePath = path.resolve(configContent.supportFile || 'cypress/support/index.js');
-      const typeScriptFilePath = supportFilePath
-        ? path.resolve(path.dirname(supportFilePath), 'index.d.ts')
-        : undefined;
+      const configContent = JSON.parse(fs.readFileSync(cypressConfigPath))
+      const supportFilePath = path.resolve(configContent.supportFile || 'cypress/support/index.js')
+      const typeScriptFilePath = supportFilePath ? path.resolve(path.dirname(supportFilePath), 'index.d.ts') : undefined
       return {
         config: cypressConfigPath,
         plugin: path.resolve(cwd, configContent.pluginsFile || 'cypress/plugins/index.js'),
         support: supportFilePath,
         typescript: typeScriptFilePath,
-      };
+      }
     } catch (err) {
-      throw new Error(`cypress.json at ${cypressConfigPath} is not a valid JSON: ${err.message}`);
+      throw new Error(`cypress.json at ${cypressConfigPath} is not a valid JSON: ${err.message}`)
     }
   } else {
     throw new Error(
       `No configuration file found at ${cypressConfigPath}. This is usually caused by setting up Eyes before setting up Cypress. Please run "npx cypress open" first.`,
-    );
+    )
   }
 }
 
-module.exports = getCypressPaths;
+module.exports = getCypressPaths

package/src/setup/getCypressVersion.js

@@ -1,13 +1,11 @@
-const fs = require('fs');
-const path = require('path');
-const cwd = process.cwd();
+const fs = require('fs')
+const path = require('path')
+const cwd = process.cwd()
 
 function getCypressVersion() {
-  const cypressPackage = require.resolve('cypress', {paths: [cwd]});
-  const packageJson = JSON.parse(
-    fs.readFileSync(path.resolve(path.dirname(cypressPackage), 'package.json')),
-  );
-  return packageJson.version;
+  const cypressPackage = require.resolve('cypress', {paths: [cwd]})
+  const packageJson = JSON.parse(fs.readFileSync(path.resolve(path.dirname(cypressPackage), 'package.json')))
+  return packageJson.version
 }
 
-module.exports = getCypressVersion;
+module.exports = getCypressVersion

package/src/setup/getFilePath.js

@@ -1,22 +1,22 @@
-'use strict';
+'use strict'
 
-const {resolve, join, dirname} = require('path');
+const {resolve, join, dirname} = require('path')
 
 function getFilePath(type, cypressConfig, cwd) {
   let filePath = {
     plugins: join('cypress', 'plugins', 'index.js'),
     support: join('cypress', 'support', 'index.js'),
     typeScript: join('cypress', 'support', 'index.d.ts'),
-  }[type];
+  }[type]
 
   if (type === 'typeScript' && cypressConfig && cypressConfig[`supportFile`]) {
-    const supportDir = dirname(cypressConfig[`supportFile`]);
-    filePath = resolve(supportDir, 'index.d.ts');
+    const supportDir = dirname(cypressConfig[`supportFile`])
+    filePath = resolve(supportDir, 'index.d.ts')
   }
 
-  filePath = (cypressConfig && cypressConfig[`${type}File`]) || filePath;
+  filePath = (cypressConfig && cypressConfig[`${type}File`]) || filePath
 
-  return resolve(cwd, filePath);
+  return resolve(cwd, filePath)
 }
 
-module.exports = getFilePath;
+module.exports = getFilePath

package/src/setup/handleCommands.js

@@ -1,23 +1,23 @@
-'use strict';
+'use strict'
 
-const fs = require('fs');
-const chalk = require('chalk');
-const addEyesCommands = require('./addEyesCommands');
-const isCommandsDefined = require('./isCommandsDefined');
+const fs = require('fs')
+const chalk = require('chalk')
+const addEyesCommands = require('./addEyesCommands')
+const isCommandsDefined = require('./isCommandsDefined')
 
 function handleCommands(supportFilePath) {
   if (supportFilePath) {
-    const supportFileContent = fs.readFileSync(supportFilePath, 'utf-8');
+    const supportFileContent = fs.readFileSync(supportFilePath, 'utf-8')
 
     if (!isCommandsDefined(supportFileContent)) {
-      fs.writeFileSync(supportFilePath, addEyesCommands(supportFileContent));
-      console.log(chalk.cyan('Commands defined.'));
+      fs.writeFileSync(supportFilePath, addEyesCommands(supportFileContent))
+      console.log(chalk.cyan('Commands defined.'))
     } else {
-      console.log(chalk.cyan('Commands already defined.'));
+      console.log(chalk.cyan('Commands already defined.'))
     }
   } else {
-    throw new Error('Commands could not be defined. Support file could not be found');
+    throw new Error('Commands could not be defined. Support file could not be found')
   }
 }
 
-module.exports = handleCommands;
+module.exports = handleCommands

package/src/setup/handlePlugin.js

@@ -1,19 +1,19 @@
-'use strict';
+'use strict'
 
-const chalk = require('chalk');
-const {addEyesCypressPlugin} = require('./addEyesCypressPlugin');
-const isPluginDefined = require('./isPluginDefined');
-const fs = require('fs');
+const chalk = require('chalk')
+const {addEyesCypressPlugin} = require('./addEyesCypressPlugin')
+const isPluginDefined = require('./isPluginDefined')
+const fs = require('fs')
 
 function handlePlugin(pluginsFilePath) {
-  const fileContent = fs.readFileSync(pluginsFilePath, 'utf-8');
+  const fileContent = fs.readFileSync(pluginsFilePath, 'utf-8')
 
   if (!isPluginDefined(fileContent)) {
-    fs.writeFileSync(pluginsFilePath, addEyesCypressPlugin(fileContent));
-    console.log(chalk.cyan('Plugins defined.'));
+    fs.writeFileSync(pluginsFilePath, addEyesCypressPlugin(fileContent))
+    console.log(chalk.cyan('Plugins defined.'))
   } else {
-    console.log(chalk.cyan('Plugins already defined'));
+    console.log(chalk.cyan('Plugins already defined'))
   }
 }
 
-module.exports = handlePlugin;
+module.exports = handlePlugin

package/src/setup/handleTypeScript.js

@@ -1,15 +1,15 @@
-'use strict';
-const chalk = require('chalk');
-const {writeFileSync, existsSync} = require('fs');
-const eyesIndexContent = `import "@applitools/eyes-cypress"`;
+'use strict'
+const chalk = require('chalk')
+const {writeFileSync, existsSync} = require('fs')
+const eyesIndexContent = `import "@applitools/eyes-cypress"`
 
 function handleTypeScript(typeScriptFilePath) {
   if (!existsSync(typeScriptFilePath)) {
-    writeFileSync(typeScriptFilePath, eyesIndexContent);
-    console.log(chalk.cyan('TypeScript defined.'));
+    writeFileSync(typeScriptFilePath, eyesIndexContent)
+    console.log(chalk.cyan('TypeScript defined.'))
   } else {
-    console.log(chalk.cyan('TypeScript already defined.'));
+    console.log(chalk.cyan('TypeScript already defined.'))
   }
 }
 
-module.exports = {handleTypeScript, eyesIndexContent};
+module.exports = {handleTypeScript, eyesIndexContent}

package/src/setup/isCommandsDefined.js

@@ -1,7 +1,7 @@
-'use strict';
+'use strict'
 
 function isCommandsDefined(content) {
-  return !!content.match(/['"]@applitools\/eyes-cypress\/commands['"]\s*/);
+  return !!content.match(/['"]@applitools\/eyes-cypress\/commands['"]\s*/)
 }
 
-module.exports = isCommandsDefined;
+module.exports = isCommandsDefined

package/src/setup/isPluginDefined.js

@@ -1,7 +1,7 @@
-'use strict';
+'use strict'
 
 function isPluginDefined(content) {
-  return !!content.match(/require\s*\(\s*['"]@applitools\/eyes-cypress['"]\s*\)/);
+  return !!content.match(/require\s*\(\s*['"]@applitools\/eyes-cypress['"]\s*\)/)
 }
 
-module.exports = isPluginDefined;
+module.exports = isPluginDefined