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

package/src/plugin/errorDigest.js

@@ -1,96 +1,96 @@
-'use strict';
-
-const colors = {
-  green: '\x1b[32m',
-  red: '\x1b[31m',
-  teal: '\x1b[38;5;86m',
-  orange: '\x1b[38;5;214m',
-  reset: '\x1b[0m',
-};
-
-const formatByStatus = {
-  Passed: {
-    color: 'green',
-    symbol: '\u2713',
-    title: tests => `Passed - ${tests} tests`,
-  },
-  Failed: {
-    color: 'red',
-    symbol: '\u2716',
-    title: tests => `Errors - ${tests} tests`,
-  },
-  Unresolved: {
-    color: 'orange',
-    symbol: '\u26A0',
-    title: tests => `Diffs detected - ${tests} tests`,
-  },
-};
-
-function errorDigest({passed, failed, diffs, logger, isInteractive}) {
-  logger.log('errorDigest: diff errors', diffs);
-  logger.log('errorDigest: test errors', failed);
-
-  const testResultsUrl = diffs.length ? colorify(diffs[0].getUrl(), 'teal') : '';
-  const testResultsPrefix = testResultsUrl ? 'See details at:' : '';
-  const footer = testResultsUrl
-    ? `\n${indent()}${colorify(testResultsPrefix)} ${testResultsUrl}`
-    : '';
-  return (
-    colorify('Eyes-Cypress detected diffs or errors during execution of visual tests.') +
-    colorify(` ${testResultsPrefix} ${testResultsUrl}`) +
-    testResultsToString(passed, 'Passed') +
-    testResultsToString(diffs, 'Unresolved') +
-    testResultsToString(failed, 'Failed') +
-    footer +
-    '\n\n'
-  );
-
-  function testResultsToString(testResultsArr, category) {
-    const {color, title, symbol, chalkFunction} = formatByStatus[category];
-    const results = testResultsArr.reduce((acc, testResults) => {
-      if (!testResults.isEmpty) {
-        const error = hasError(testResults) ? stringifyError(testResults) : undefined;
-        acc.push(
-          `${colorify(symbol, color)} ${colorify(error || stringifyTestResults(testResults))}`,
-        );
-      }
-      return acc;
-    }, []);
-
-    const coloredTitle = results.length
-      ? colorify(title(results.length), color, chalkFunction)
-      : '';
-    return testResultsSection(coloredTitle, results);
-  }
-
-  function colorify(msg, color = 'reset') {
-    return isInteractive ? msg : `${colors[color]}${msg}${colors.reset}`;
-  }
-}
-
-function stringifyTestResults(testResults) {
-  const hostDisplaySize = testResults.getHostDisplaySize();
-  const viewport = hostDisplaySize ? `[${hostDisplaySize}]` : '';
-  const testName = `${testResults.getName()} ${viewport}`;
-  return testName + (testResults.error ? ` : ${testResults.error}` : '');
-}
-
-function testResultsSection(title, results) {
-  return results.length ? `${indent()}${title}${indent(3)}${results.join(indent(3))}` : '';
-}
-
-function stringifyError(testResults) {
-  return testResults.error
-    ? stringifyTestResults(testResults)
-    : `[Eyes test not started] : ${testResults}`;
-}
-
-function indent(spaces = 2) {
-  return `\n   ${'  '.repeat(spaces)}`;
-}
-
-function hasError(testResult) {
-  return testResult.error || testResult instanceof Error;
-}
-
-module.exports = errorDigest;
+'use strict';
+
+const colors = {
+  green: '\x1b[32m',
+  red: '\x1b[31m',
+  teal: '\x1b[38;5;86m',
+  orange: '\x1b[38;5;214m',
+  reset: '\x1b[0m',
+};
+
+const formatByStatus = {
+  Passed: {
+    color: 'green',
+    symbol: '\u2713',
+    title: tests => `Passed - ${tests} tests`,
+  },
+  Failed: {
+    color: 'red',
+    symbol: '\u2716',
+    title: tests => `Errors - ${tests} tests`,
+  },
+  Unresolved: {
+    color: 'orange',
+    symbol: '\u26A0',
+    title: tests => `Diffs detected - ${tests} tests`,
+  },
+};
+
+function errorDigest({passed, failed, diffs, logger, isInteractive}) {
+  logger.log('errorDigest: diff errors', diffs);
+  logger.log('errorDigest: test errors', failed);
+
+  const testResultsUrl = diffs.length ? colorify(diffs[0].getUrl(), 'teal') : '';
+  const testResultsPrefix = testResultsUrl ? 'See details at:' : '';
+  const footer = testResultsUrl
+    ? `\n${indent()}${colorify(testResultsPrefix)} ${testResultsUrl}`
+    : '';
+  return (
+    colorify('Eyes-Cypress detected diffs or errors during execution of visual tests.') +
+    colorify(` ${testResultsPrefix} ${testResultsUrl}`) +
+    testResultsToString(passed, 'Passed') +
+    testResultsToString(diffs, 'Unresolved') +
+    testResultsToString(failed, 'Failed') +
+    footer +
+    '\n\n'
+  );
+
+  function testResultsToString(testResultsArr, category) {
+    const {color, title, symbol, chalkFunction} = formatByStatus[category];
+    const results = testResultsArr.reduce((acc, testResults) => {
+      if (!testResults.isEmpty) {
+        const error = hasError(testResults) ? stringifyError(testResults) : undefined;
+        acc.push(
+          `${colorify(symbol, color)} ${colorify(error || stringifyTestResults(testResults))}`,
+        );
+      }
+      return acc;
+    }, []);
+
+    const coloredTitle = results.length
+      ? colorify(title(results.length), color, chalkFunction)
+      : '';
+    return testResultsSection(coloredTitle, results);
+  }
+
+  function colorify(msg, color = 'reset') {
+    return isInteractive ? msg : `${colors[color]}${msg}${colors.reset}`;
+  }
+}
+
+function stringifyTestResults(testResults) {
+  const hostDisplaySize = testResults.getHostDisplaySize();
+  const viewport = hostDisplaySize ? `[${hostDisplaySize}]` : '';
+  const testName = `${testResults.getName()} ${viewport}`;
+  return testName + (testResults.error ? ` : ${testResults.error}` : '');
+}
+
+function testResultsSection(title, results) {
+  return results.length ? `${indent()}${title}${indent(3)}${results.join(indent(3))}` : '';
+}
+
+function stringifyError(testResults) {
+  return testResults.error
+    ? stringifyTestResults(testResults)
+    : `[Eyes test not started] : ${testResults}`;
+}
+
+function indent(spaces = 2) {
+  return `\n   ${'  '.repeat(spaces)}`;
+}
+
+function hasError(testResult) {
+  return testResult.error || testResult instanceof Error;
+}
+
+module.exports = errorDigest;

package/src/plugin/getErrorsAndDiffs.js

@@ -1,34 +1,34 @@
-'use strict';
-
-function getErrorsAndDiffs(testResultsArr) {
-  return testResultsArr.reduce(
-    ({failed, diffs, passed}, testResults) => {
-      if (testResults instanceof Error || testResults.error) {
-        failed.push(testResults);
-      } else {
-        const testStatus = testResults.getStatus();
-        if (testStatus === 'Passed') {
-          passed.push(testResults);
-        } else {
-          if (testStatus === 'Unresolved') {
-            if (testResults.getIsNew()) {
-              testResults.error = new Error(
-                `${testResults.getName()}. Please approve the new baseline at ${testResults.getUrl()}`,
-              );
-              failed.push(testResults);
-            } else {
-              diffs.push(testResults);
-            }
-          } else if (testStatus === 'Failed') {
-            failed.push(testResults);
-          }
-        }
-      }
-
-      return {failed, diffs, passed};
-    },
-    {failed: [], diffs: [], passed: []},
-  );
-}
-
-module.exports = getErrorsAndDiffs;
+'use strict';
+
+function getErrorsAndDiffs(testResultsArr) {
+  return testResultsArr.reduce(
+    ({failed, diffs, passed}, testResults) => {
+      if (testResults instanceof Error || testResults.error) {
+        failed.push(testResults);
+      } else {
+        const testStatus = testResults.getStatus();
+        if (testStatus === 'Passed') {
+          passed.push(testResults);
+        } else {
+          if (testStatus === 'Unresolved') {
+            if (testResults.getIsNew()) {
+              testResults.error = new Error(
+                `${testResults.getName()}. Please approve the new baseline at ${testResults.getUrl()}`,
+              );
+              failed.push(testResults);
+            } else {
+              diffs.push(testResults);
+            }
+          } else if (testStatus === 'Failed') {
+            failed.push(testResults);
+          }
+        }
+      }
+
+      return {failed, diffs, passed};
+    },
+    {failed: [], diffs: [], passed: []},
+  );
+}
+
+module.exports = getErrorsAndDiffs;

package/src/plugin/handleTestResults.js

@@ -0,0 +1,39 @@
+const errorDigest = require('./errorDigest');
+const {makeLogger} = require('@applitools/logger');
+const getErrorsAndDiffs = require('./getErrorsAndDiffs');
+const {promisify} = require('util');
+const fs = require('fs');
+const writeFile = promisify(fs.writeFile);
+const {TestResultsFormatter} = require('@applitools/visual-grid-client');
+const {resolve} = require('path');
+
+function printTestResults(testResultsArr) {
+  const logger = makeLogger({
+    level: testResultsArr.resultConfig.showLogs ? 'info' : 'silent',
+    label: 'eyes',
+  });
+  const {passed, failed, diffs} = getErrorsAndDiffs(testResultsArr.testResults);
+  if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.eyesFailCypressOnDiff) {
+    throw new Error(
+      errorDigest({
+        passed,
+        failed,
+        diffs,
+        logger,
+        isInteractive: !testResultsArr.resultConfig.isTextTerminal,
+      }),
+    );
+  }
+}
+function handleBatchResultsFile(results, tapFileConfig) {
+  try {
+    const formatter = new TestResultsFormatter(results);
+    const fileName = tapFileConfig.tapFileName || `${new Date().toISOString()}-eyes.tap`;
+    const tapFile = resolve(tapFileConfig.tapDirPath, fileName);
+    return writeFile(tapFile, formatter.asHierarchicTAPString(false, true));
+  } catch (ex) {
+    console.log(ex);
+  }
+}
+
+module.exports = {printTestResults, handleBatchResultsFile};

package/src/plugin/handler.ts

@@ -0,0 +1,58 @@
+import {Server as HTTPServer, request} from 'http'
+import {Server as WSServer} from 'ws'
+
+const {name, version} = require('../../package.json') // TODO is the handshake needed at all?
+const TOKEN_HEADER = 'x-eyes-universal-token'
+const TOKEN = `${name}@${version}`
+
+// TODO make default port 0 and return actual port
+export async function makeHandler({port = 31077, singleton = true, lazy = false} = {}): Promise<{
+  server?: WSServer
+  port: number
+}> {
+  const http = new HTTPServer()
+  http.on('request', (request, response) => {
+    if (request.url === '/handshake') {
+      if (request.headers[TOKEN_HEADER] === TOKEN) {
+        response.writeHead(200, {[TOKEN_HEADER]: TOKEN})
+      } else {
+        response.writeHead(400)
+      }
+      response.end()
+    }
+  })
+
+  http.listen(port, 'localhost')
+
+  return new Promise((resolve, reject) => {
+    http.on('listening', () => {
+      const ws = new WSServer({server: http, path: '/eyes'})
+      ws.on('close', () => http.close())
+      resolve({server: ws, port})
+    })
+
+    http.on('error', async (err: Error & {code: string}) => {
+      if (!lazy && err.code === 'EADDRINUSE') {
+        if (singleton && (await isHandshakable(port))) {
+          return resolve({port})
+        } else {
+          return resolve(await makeHandler({port: port + 1, singleton}))
+        }
+      }
+      reject(err)
+    })
+  })
+}
+
+async function isHandshakable(port: number) {
+  return new Promise(resolve => {
+    const handshake = request(`http://localhost:${port}/handshake`, {
+      headers: {[TOKEN_HEADER]: TOKEN},
+    })
+    handshake.on('response', ({statusCode, headers}) => {
+      resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN)
+    })
+    handshake.on('error', () => resolve(false))
+    handshake.end()
+  })
+}

package/src/plugin/hooks.js

@@ -1,42 +1,49 @@
-'use strict';
-const makeWaitForBatch = require('./waitForBatch');
-const makeHandleBatchResultsFile = require('./makeHandleBatchResultsFile');
-const getErrorsAndDiffs = require('./getErrorsAndDiffs');
-const processCloseAndAbort = require('./processCloseAndAbort');
-const errorDigest = require('./errorDigest');
-const runningTests = require('./runningTests');
-
-function makeGlobalRunHooks({visualGridClient, logger}) {
-  let waitForBatch;
-
-  return {
-    'before:run': ({config}) => {
-      const {isTextTerminal, eyesTestConcurrency: testConcurrency} = config;
-      if (!config.isTextTerminal) return;
-
-      waitForBatch = makeWaitForBatch({
-        logger: (logger.extend && logger.extend('waitForBatch')) || console,
-        testConcurrency,
-        processCloseAndAbort,
-        getErrorsAndDiffs,
-        errorDigest,
-        isInteractive: !isTextTerminal,
-        handleBatchResultsFile: makeHandleBatchResultsFile(config),
-      });
-    },
-
-    'after:run': async ({config}) => {
-      if (!config.isTextTerminal) return;
-
-      try {
-        await waitForBatch(runningTests.tests, visualGridClient.closeBatch);
-      } catch (e) {
-        if (!!config.eyesFailCypressOnDiff) {
-          throw e;
-        }
-      }
-    },
-  };
-}
-
-module.exports = makeGlobalRunHooks;
+'use strict';
+const flatten = require('lodash.flatten');
+const {TestResults} = require('@applitools/visual-grid-client');
+const handleTestResults = require('./handleTestResults');
+
+function makeGlobalRunHooks({closeAllEyes, closeBatches, closeUniversalServer}) {
+  return {
+    'before:run': ({config}) => {
+      if (!config.isTextTerminal) return;
+    },
+
+    'after:run': async ({config}) => {
+      try {
+        if (!config.isTextTerminal) return;
+        const resultConfig = {
+          showLogs: config.showLogs,
+          eyesFailCypressOnDiff: config.eyesFailCypressOnDiff,
+          isTextTerminal: config.isTextTerminal,
+        };
+        const testResults = await closeAllEyes();
+        const testResultsArr = [];
+        for (const result of flatten(testResults)) {
+          testResultsArr.push(new TestResults(result));
+        }
+        if (!config.appliConfFile.dontCloseBatches) {
+          await closeBatches({
+            batchIds: [config.appliConfFile.batch.id],
+            serverUrl: config.appliConfFile.serverUrl,
+            proxy: config.appliConfFile.proxy,
+            apiKey: config.appliConfFile.apiKey,
+          });
+        }
+
+        if (config.appliConfFile.tapDirPath) {
+          await handleTestResults.handleBatchResultsFile(testResultsArr, {
+            tapDirPath: config.appliConfFile.tapDirPath,
+            tapFileName: config.appliConfFile.tapFileName,
+          });
+        }
+
+        handleTestResults.printTestResults({testResults: testResultsArr, resultConfig});
+      } finally {
+        closeUniversalServer();
+      }
+    },
+  };
+}
+
+module.exports = makeGlobalRunHooks;

package/src/plugin/isGlobalHooksSupported.js

@@ -1,13 +1,13 @@
-const CYPRESS_SUPPORTED_VERSION = '6.2.0';
-const CYPRESS_NO_FLAG_VERSION = '6.7.0';
-
-function isGlobalHooksSupported(config) {
-  const {version, experimentalRunEvents} = config;
-
-  return (
-    version >= CYPRESS_NO_FLAG_VERSION ||
-    (version >= CYPRESS_SUPPORTED_VERSION && !!experimentalRunEvents)
-  );
-}
-
-module.exports = isGlobalHooksSupported;
+const CYPRESS_SUPPORTED_VERSION = '6.2.0';
+const CYPRESS_NO_FLAG_VERSION = '6.7.0';
+
+function isGlobalHooksSupported(config) {
+  const {version, experimentalRunEvents} = config;
+
+  return (
+    version >= CYPRESS_NO_FLAG_VERSION ||
+    (version >= CYPRESS_SUPPORTED_VERSION && !!experimentalRunEvents)
+  );
+}
+
+module.exports = isGlobalHooksSupported;

package/src/plugin/pluginExport.js

@@ -1,57 +1,60 @@
-'use strict';
-const isGlobalHooksSupported = require('./isGlobalHooksSupported');
-const {presult} = require('@applitools/functional-commons');
-
-function makePluginExport({startServer, eyesConfig, globalHooks}) {
-  return function pluginExport(pluginModule) {
-    let closeEyesServer;
-    const pluginModuleExports = pluginModule.exports;
-    pluginModule.exports = async function(...args) {
-      const {eyesPort, closeServer} = await startServer();
-      closeEyesServer = closeServer;
-      const [origOn, config] = args;
-      const isGlobalHookCalledFromUserHandlerMap = new Map();
-      eyesConfig.eyesIsGlobalHooksSupported = isGlobalHooksSupported(config);
-      const moduleExportsResult = await pluginModuleExports(onThatCallsUserDefinedHandler, config);
-
-      if (eyesConfig.eyesIsGlobalHooksSupported) {
-        for (const [eventName, eventHandler] of Object.entries(globalHooks)) {
-          if (!isGlobalHookCalledFromUserHandlerMap.get(eventName)) {
-            origOn.call(this, eventName, eventHandler);
-          }
-        }
-      }
-
-      return Object.assign({}, eyesConfig, {eyesPort}, moduleExportsResult);
-
-      // This piece of code exists because at the point of writing, Cypress does not support multiple event handlers:
-      // https://github.com/cypress-io/cypress/issues/5240#issuecomment-948277554
-      // So we wrap Cypress' `on` function in order to wrap the user-defined handler. This way we can call our own handler
-      // in addition to the user's handler
-      function onThatCallsUserDefinedHandler(eventName, handler) {
-        const isRunEvent = eventName === 'before:run' || eventName === 'after:run';
-        let handlerToCall = handler;
-        if (eyesConfig.eyesIsGlobalHooksSupported && isRunEvent) {
-          handlerToCall = handlerThatCallsUserDefinedHandler;
-          isGlobalHookCalledFromUserHandlerMap.set(eventName, true);
-        }
-        return origOn.call(this, eventName, handlerToCall);
-
-        async function handlerThatCallsUserDefinedHandler() {
-          const [err] = await presult(
-            Promise.resolve(globalHooks[eventName].apply(this, arguments)),
-          );
-          await handler.apply(this, arguments);
-          if (err) {
-            throw err;
-          }
-        }
-      }
-    };
-    return function getCloseServer() {
-      return closeEyesServer;
-    };
-  };
-}
-
-module.exports = makePluginExport;
+'use strict';
+const isGlobalHooksSupported = require('./isGlobalHooksSupported');
+const {presult} = require('@applitools/functional-commons');
+const makeGlobalRunHooks = require('./hooks');
+
+function makePluginExport({startServer, eyesConfig}) {
+  return function pluginExport(pluginModule) {
+    let eyesServer;
+    const pluginModuleExports = pluginModule.exports;
+    pluginModule.exports = async function(...args) {
+      const {server, port, closeAllEyes, closeBatches, closeUniversalServer} = await startServer();
+      eyesServer = server;
+
+      const globalHooks = makeGlobalRunHooks({closeAllEyes, closeBatches, closeUniversalServer});
+
+      const [origOn, config] = args;
+      const isGlobalHookCalledFromUserHandlerMap = new Map();
+      eyesConfig.eyesIsGlobalHooksSupported = isGlobalHooksSupported(config);
+      const moduleExportsResult = await pluginModuleExports(onThatCallsUserDefinedHandler, config);
+      if (eyesConfig.eyesIsGlobalHooksSupported) {
+        for (const [eventName, eventHandler] of Object.entries(globalHooks)) {
+          if (!isGlobalHookCalledFromUserHandlerMap.get(eventName)) {
+            origOn.call(this, eventName, eventHandler);
+          }
+        }
+      }
+
+      return Object.assign({}, eyesConfig, {eyesPort: port}, moduleExportsResult);
+
+      // This piece of code exists because at the point of writing, Cypress does not support multiple event handlers:
+      // https://github.com/cypress-io/cypress/issues/5240#issuecomment-948277554
+      // So we wrap Cypress' `on` function in order to wrap the user-defined handler. This way we can call our own handler
+      // in addition to the user's handler
+      function onThatCallsUserDefinedHandler(eventName, handler) {
+        const isRunEvent = eventName === 'before:run' || eventName === 'after:run';
+        let handlerToCall = handler;
+        if (eyesConfig.eyesIsGlobalHooksSupported && isRunEvent) {
+          handlerToCall = handlerThatCallsUserDefinedHandler;
+          isGlobalHookCalledFromUserHandlerMap.set(eventName, true);
+        }
+        return origOn.call(this, eventName, handlerToCall);
+
+        async function handlerThatCallsUserDefinedHandler() {
+          const [err] = await presult(
+            Promise.resolve(globalHooks[eventName].apply(this, arguments)),
+          );
+          await handler.apply(this, arguments);
+          if (err) {
+            throw err;
+          }
+        }
+      }
+    };
+    return function getCloseServer() {
+      return eyesServer.close();
+    };
+  };
+}
+
+module.exports = makePluginExport;