@applitools/eyes-cypress 3.23.9 → 3.24.0-beta.0

package/src/plugin/server.js

@@ -1,46 +1,98 @@
-'use strict';
-const https = require('https');
-const fs = require('fs');
-const path = require('path');
-
-function makeStartServer({logger, app}) {
-  return function startServer() {
-    return new Promise((resolve, reject) => {
-      logger.log(`starting plugin server`);
-      const server = https.createServer(
-        {
-          key: fs.readFileSync(path.resolve(__dirname, '../pem/server.key')),
-          cert: fs.readFileSync(path.resolve(__dirname, '../pem/server.cert')),
-        },
-        app,
-      );
-      server.listen(0, err => {
-        if (err) {
-          logger.log('error starting plugin server', err);
-          reject(err);
-        } else {
-          logger.log(`plugin server running at port: ${server.address().port}`);
-          resolve({
-            eyesPort: server.address().port,
-            closeServer: server.close.bind(server),
-          });
-        }
-      });
-
-      server.on('error', err => {
-        if (err.code === 'EADDRINUSE') {
-          logger.log(
-            `error: plugin server could not start at port ${
-              server.address().port
-            }: port is already in use.`,
-          );
-        } else {
-          logger.log('error in plugin server:', err);
-        }
-        reject(err);
-      });
-    });
-  };
-}
-
-module.exports = makeStartServer;
+'use strict';
+const {makeHandler} = require('../../dist/plugin/handler');
+const connectSocket = require('./webSocket');
+const {makeServerProcess} = require('@applitools/eyes-universal');
+const {TestResults} = require('@applitools/visual-grid-client');
+const handleTestResults = require('./handleTestResults');
+
+function makeStartServer() {
+  return async function startServer() {
+    const {server, port} = await makeHandler({});
+    // const {port: universalPort, close: closeUniversalServer} = {port: 21077, close: () => {}}; //await makeServerProcess();
+    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess();
+
+    const managers = [];
+    let socketWithUniversal;
+
+    server.on('connection', socketWithClient => {
+      socketWithUniversal = connectSocket(`ws://localhost:${universalPort}/eyes`);
+
+      socketWithUniversal.setPassthroughListener(message => {
+        console.log('<== ', message.toString().slice(0, 1000));
+        const {name, payload} = JSON.parse(message);
+        if (name === 'Core.makeManager') {
+          managers.push({manager: payload.result, socketWithUniversal});
+        }
+
+        socketWithClient.send(message.toString());
+      });
+
+      socketWithClient.on('message', message => {
+        const msg = JSON.parse(message);
+        console.log('==> ', message.toString().slice(0, 1000));
+        if (msg.name === 'Test.printTestResults') {
+          try {
+            const resultArr = [];
+            for (const result of msg.payload.testResults) {
+              resultArr.push(new TestResults(result));
+            }
+            if (msg.payload.resultConfig.tapDirPath) {
+              handleTestResults.handleBatchResultsFile(resultArr, {
+                tapFileName: msg.payload.resultConfig.tapFileName,
+                tapDirPath: msg.payload.resultConfig.tapDirPath,
+              });
+            }
+            handleTestResults.printTestResults({
+              testResults: resultArr,
+              resultConfig: msg.payload.resultConfig,
+            });
+            socketWithClient.send(
+              JSON.stringify({
+                name: 'Test.printTestResults',
+                key: msg.key,
+                payload: {result: 'success'},
+              }),
+            );
+          } catch (ex) {
+            socketWithClient.send(
+              JSON.stringify({
+                name: 'Test.printTestResults',
+                key: msg.key,
+                payload: {result: ex.message.toString()},
+              }),
+            );
+          }
+        } else {
+          socketWithUniversal.send(message);
+        }
+      });
+    });
+
+    return {
+      server,
+      port,
+      closeAllEyes,
+      closeBatches,
+      closeUniversalServer,
+    };
+
+    function closeAllEyes() {
+      return Promise.all(
+        managers.map(({manager, socketWithUniversal}) =>
+          socketWithUniversal.request('EyesManager.closeAllEyes', {
+            manager,
+            throwErr: false,
+          }),
+        ),
+      );
+    }
+    function closeBatches(settings) {
+      if (socketWithUniversal)
+        return socketWithUniversal.request('Core.closeBatches', {settings}).catch(err => {
+          console.log('@@@', err);
+        });
+    }
+  };
+}
+
+module.exports = makeStartServer;

package/src/plugin/startPlugin.js

@@ -1,34 +1,13 @@
-'use strict';
-const {makeVisualGridClient} = require('@applitools/visual-grid-client');
-const {makeLogger} = require('@applitools/logger');
-const makeStartServer = require('./server');
-const makePluginExport = require('./pluginExport');
-const {startApp} = require('./app');
-const getErrorsAndDiffs = require('./getErrorsAndDiffs');
-const processCloseAndAbort = require('./processCloseAndAbort');
-const errorDigest = require('./errorDigest');
-const makeHandlers = require('./handlers');
-const makeConfig = require('./config');
-const makeGlobalRunHooks = require('./hooks');
-
-const {config, eyesConfig} = makeConfig();
-const logger = makeLogger({level: config.showLogs ? 'info' : 'silent', label: 'eyes'});
-
-const visualGridClient = makeVisualGridClient({...config, logger: logger.extend('vgc')});
-
-const handlers = makeHandlers({
-  logger,
-  config,
-  visualGridClient,
-  processCloseAndAbort,
-  getErrorsAndDiffs,
-  errorDigest,
-});
-
-const globalHooks = makeGlobalRunHooks({visualGridClient, logger});
-
-const app = startApp({handlers, logger});
-const startServer = makeStartServer({app, logger});
-logger.log('eyes-cypress plugin running with config:', config);
-
-module.exports = makePluginExport({startServer, eyesConfig, globalHooks});
+'use strict';
+const makePluginExport = require('./pluginExport');
+const makeConfig = require('./config');
+const makeStartServer = require('./server');
+
+const {config, eyesConfig} = makeConfig();
+
+const startServer = makeStartServer();
+
+module.exports = makePluginExport({
+  startServer,
+  eyesConfig: Object.assign({}, eyesConfig, {appliConfFile: config}),
+});

package/src/plugin/webSocket.js

@@ -0,0 +1,130 @@
+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;
+
+  attach();
+
+  function attach() {
+    if (socket.readyState === WebSocket.CONNECTING) socket.on('open', () => attach(socket));
+    else if (socket.readyState === WebSocket.OPEN) {
+      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));
+
+        if (!fns && !keyListeners && passthroughListener) {
+          passthroughListener(message);
+        }
+      });
+    }
+  }
+
+  function disconnect() {
+    if (!socket) return;
+    socket.terminate();
+    isReady = false;
+    passthroughListener = null;
+    queue.clear();
+  }
+
+  function setPassthroughListener(fn) {
+    passthroughListener = fn;
+  }
+
+  function send(message) {
+    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);
+    if (!fns) {
+      fns = new Set();
+      listeners.set(name, fns);
+    }
+    fns.add(fn);
+    return () => off(name, fn);
+  }
+
+  function once(type, fn) {
+    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;
+  }
+
+  function emit(type, payload) {
+    return send(serialize(type, payload));
+  }
+
+  function request(name, payload) {
+    return new Promise((resolve, reject) => {
+      const key = uuid();
+      emit({name, key}, payload);
+      once({name, key}, response => {
+        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);
+  }
+
+  function unref() {
+    const command = () => socket._socket.unref();
+    if (isReady) command();
+    else queue.add(command);
+    return () => queue.delete(command);
+  }
+
+  return {
+    setPassthroughListener,
+    send,
+    on,
+    once,
+    off,
+    request,
+    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);
+}
+
+function deserialize(message) {
+  return JSON.parse(message);
+}
+
+module.exports = connectSocket;

package/src/setup/addEyesCommands.js

@@ -1,24 +1,24 @@
-'use strict';
-
-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));
-}
-
-function addEyesCommands(content) {
-  if (content.includes(oldName)) {
-    return content.replace(oldName, 'eyes-cypress');
-  }
-  const lines = content.split('\n');
-  let i = 0;
-  while (shouldSkipLine(lines[i++])) {}
-  let index = i === 1 ? i : i - 1;
-  lines.splice(index, 0, commandsImport);
-
-  return lines.join('\n');
-}
-
-module.exports = addEyesCommands;
-module.exports.commandsImport = commandsImport;
+'use strict';
+
+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));
+}
+
+function addEyesCommands(content) {
+  if (content.includes(oldName)) {
+    return content.replace(oldName, 'eyes-cypress');
+  }
+  const lines = content.split('\n');
+  let i = 0;
+  while (shouldSkipLine(lines[i++])) {}
+  let index = i === 1 ? i : i - 1;
+  lines.splice(index, 0, commandsImport);
+
+  return lines.join('\n');
+}
+
+module.exports = addEyesCommands;
+module.exports.commandsImport = commandsImport;

package/src/setup/addEyesCypressPlugin.js

@@ -1,15 +1,15 @@
-'use strict';
-
-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}`);
-  } else {
-    return content.replace(oldName, 'eyes-cypress');
-  }
-}
-
-module.exports = addEyesCypressPlugin;
-module.exports.pluginRequire = pluginRequire;
+'use strict';
+
+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}`);
+  } else {
+    return content.replace(oldName, 'eyes-cypress');
+  }
+}
+
+module.exports = addEyesCypressPlugin;
+module.exports.pluginRequire = pluginRequire;

package/src/setup/getCypressConfig.js

@@ -1,16 +1,16 @@
-'use strict';
-
-const {readFileSync} = require('fs');
-const {resolve} = require('path');
-const chalk = require('chalk');
-
-function getCypressConfig(cwd) {
-  const cypressConfigPath = resolve(cwd, 'cypress.json');
-  try {
-    return JSON.parse(readFileSync(cypressConfigPath));
-  } catch (ex) {
-    console.log(chalk.red('cypress.json not found at ', cypressConfigPath));
-  }
-}
-
-module.exports = getCypressConfig;
+'use strict';
+
+const {readFileSync} = require('fs');
+const {resolve} = require('path');
+const chalk = require('chalk');
+
+function getCypressConfig(cwd) {
+  const cypressConfigPath = resolve(cwd, 'cypress.json');
+  try {
+    return JSON.parse(readFileSync(cypressConfigPath));
+  } catch (ex) {
+    console.log(chalk.red('cypress.json not found at ', cypressConfigPath));
+  }
+}
+
+module.exports = getCypressConfig;

package/src/setup/getFilePath.js

@@ -1,22 +1,22 @@
-'use strict';
-
-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', 'eyes-index.d.ts'),
-  }[type];
-
-  if (type === 'typeScript' && cypressConfig && cypressConfig[`supportFile`]) {
-    const supportDir = dirname(cypressConfig[`supportFile`]);
-    filePath = resolve(supportDir, 'eyes-index.d.ts');
-  }
-
-  filePath = (cypressConfig && cypressConfig[`${type}File`]) || filePath;
-
-  return resolve(cwd, filePath);
-}
-
-module.exports = getFilePath;
+'use strict';
+
+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', 'eyes-index.d.ts'),
+  }[type];
+
+  if (type === 'typeScript' && cypressConfig && cypressConfig[`supportFile`]) {
+    const supportDir = dirname(cypressConfig[`supportFile`]);
+    filePath = resolve(supportDir, 'eyes-index.d.ts');
+  }
+
+  filePath = (cypressConfig && cypressConfig[`${type}File`]) || filePath;
+
+  return resolve(cwd, filePath);
+}
+
+module.exports = getFilePath;

package/src/setup/handleCommands.js

@@ -1,23 +1,23 @@
-'use strict';
-
-const chalk = require('chalk');
-const {readFileSync, writeFileSync} = require('fs');
-const addEyesCommands = require('./addEyesCommands');
-const isCommandsDefined = require('./isCommandsDefined');
-const getFilePath = require('./getFilePath');
-const getCypressConfig = require('./getCypressConfig');
-
-function handleCommands(cwd) {
-  const cypressConfig = getCypressConfig(cwd);
-  const commandsFilePath = getFilePath('support', cypressConfig, cwd);
-  const commandsFileContent = readFileSync(commandsFilePath).toString();
-
-  if (!isCommandsDefined(commandsFileContent)) {
-    writeFileSync(commandsFilePath, addEyesCommands(commandsFileContent));
-    console.log(chalk.cyan('Commands defined.'));
-  } else {
-    console.log(chalk.cyan('Commands already defined.'));
-  }
-}
-
-module.exports = handleCommands;
+'use strict';
+
+const chalk = require('chalk');
+const {readFileSync, writeFileSync} = require('fs');
+const addEyesCommands = require('./addEyesCommands');
+const isCommandsDefined = require('./isCommandsDefined');
+const getFilePath = require('./getFilePath');
+const getCypressConfig = require('./getCypressConfig');
+
+function handleCommands(cwd) {
+  const cypressConfig = getCypressConfig(cwd);
+  const commandsFilePath = getFilePath('support', cypressConfig, cwd);
+  const commandsFileContent = readFileSync(commandsFilePath).toString();
+
+  if (!isCommandsDefined(commandsFileContent)) {
+    writeFileSync(commandsFilePath, addEyesCommands(commandsFileContent));
+    console.log(chalk.cyan('Commands defined.'));
+  } else {
+    console.log(chalk.cyan('Commands already defined.'));
+  }
+}
+
+module.exports = handleCommands;

package/src/setup/handlePlugin.js

@@ -1,23 +1,23 @@
-'use strict';
-
-const {readFileSync, writeFileSync} = require('fs');
-const chalk = require('chalk');
-const addEyesCypressPlugin = require('./addEyesCypressPlugin');
-const isPluginDefined = require('./isPluginDefined');
-const getFilePath = require('./getFilePath');
-const getCypressConfig = require('./getCypressConfig');
-
-function handlePlugin(cwd) {
-  const cypressConfig = getCypressConfig(cwd);
-  const pluginsFilePath = getFilePath('plugins', cypressConfig, cwd);
-  const pluginsFileContent = readFileSync(pluginsFilePath).toString();
-
-  if (!isPluginDefined(pluginsFileContent)) {
-    writeFileSync(pluginsFilePath, addEyesCypressPlugin(pluginsFileContent));
-    console.log(chalk.cyan('Plugins defined.'));
-  } else {
-    console.log(chalk.cyan('Plugins already defined'));
-  }
-}
-
-module.exports = handlePlugin;
+'use strict';
+
+const {readFileSync, writeFileSync} = require('fs');
+const chalk = require('chalk');
+const addEyesCypressPlugin = require('./addEyesCypressPlugin');
+const isPluginDefined = require('./isPluginDefined');
+const getFilePath = require('./getFilePath');
+const getCypressConfig = require('./getCypressConfig');
+
+function handlePlugin(cwd) {
+  const cypressConfig = getCypressConfig(cwd);
+  const pluginsFilePath = getFilePath('plugins', cypressConfig, cwd);
+  const pluginsFileContent = readFileSync(pluginsFilePath).toString();
+
+  if (!isPluginDefined(pluginsFileContent)) {
+    writeFileSync(pluginsFilePath, addEyesCypressPlugin(pluginsFileContent));
+    console.log(chalk.cyan('Plugins defined.'));
+  } else {
+    console.log(chalk.cyan('Plugins already defined'));
+  }
+}
+
+module.exports = handlePlugin;

package/src/setup/handleTypeScript.js

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

package/src/setup/isCommandsDefined.js

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

package/src/setup/isPluginDefined.js

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

package/test/fixtures/testAppCopies/.gitignore

@@ -1,2 +1,2 @@
-*
+*
 !.gitignore