@applitools/eyes-cypress 3.27.9 → 3.28.1

package/src/browser/socket.js

@@ -1,144 +1,143 @@
 /* global WebSocket */
-const uuid = require('uuid');
+const uuid = require('uuid')
 
 class Socket {
   constructor() {
-    this._socket = null;
-    this._listeners = new Map();
-    this._queue = new Set();
+    this._socket = null
+    this._listeners = new Map()
+    this._queue = new Set()
   }
 
   attach(ws) {
-    if (!ws) return;
+    if (!ws) return
 
-    if (ws.readyState === WebSocket.CONNECTING) ws.addEventListener('open', () => this.attach(ws));
+    if (ws.readyState === WebSocket.CONNECTING) ws.addEventListener('open', () => this.attach(ws))
     else if (ws.readyState === WebSocket.OPEN) {
-      this._socket = ws;
-      this._queue.forEach(command => command());
-      this._queue.clear();
+      this._socket = ws
+      this._queue.forEach(command => command())
+      this._queue.clear()
 
       this._socket.addEventListener('message', message => {
-        const {name, key, payload} = this.deserialize(message);
-        const fns = this._listeners.get(name);
-        if (fns) fns.forEach(fn => fn(payload, key));
+        const {name, key, payload} = this.deserialize(message)
+        const fns = this._listeners.get(name)
+        if (fns) fns.forEach(fn => fn(payload, key))
         if (key) {
-          const fns = this._listeners.get(`${name}/${key}`);
-          if (fns) fns.forEach(fn => fn(payload, key));
+          const fns = this._listeners.get(`${name}/${key}`)
+          if (fns) fns.forEach(fn => fn(payload, key))
         }
-      });
+      })
       this._socket.addEventListener('close', () => {
-        const fns = this._listeners.get('close');
-        if (fns) fns.forEach(fn => fn());
-      });
+        const fns = this._listeners.get('close')
+        if (fns) fns.forEach(fn => fn())
+      })
     }
   }
 
   on(type, fn) {
-    const name = typeof type === 'string' ? type : `${type.name}/${type.key}`;
-    let fns = this._listeners.get(name);
+    const name = typeof type === 'string' ? type : `${type.name}/${type.key}`
+    let fns = this._listeners.get(name)
     if (!fns) {
-      fns = new Set();
-      this._listeners.set(name, fns);
+      fns = new Set()
+      this._listeners.set(name, fns)
     }
-    fns.add(fn);
-    return () => this.off(name, fn);
+    fns.add(fn)
+    return () => this.off(name, fn)
   }
 
   connect(url) {
-    const ws = new WebSocket(url);
-    this.attach(ws);
+    const ws = new WebSocket(url)
+    this.attach(ws)
   }
 
   disconnect() {
-    if (!this._socket) return;
-    this._socket.terminate();
-    this._socket = null;
+    if (!this._socket) return
+    this._socket.terminate()
+    this._socket = null
   }
 
   request(name, payload) {
     return new Promise((resolve, reject) => {
       try {
-        const key = uuid.v4();
-        this.emit({name, key}, payload);
+        const key = uuid.v4()
+        this.emit({name, key}, payload)
         this.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)
+        })
       } catch (ex) {
-        console.log(ex);
-        throw ex;
+        console.log(ex)
+        throw ex
       }
-    });
+    })
   }
 
   command(name, fn) {
     this.on(name, async (payload, key) => {
       try {
-        const result = await fn(payload);
-        this.emit({name, key}, {result});
+        const result = await fn(payload)
+        this.emit({name, key}, {result})
       } catch (error) {
-        console.log(error);
-        this.emit({name, key}, {error});
+        console.log(error)
+        this.emit({name, key}, {error})
       }
-    });
+    })
   }
 
   subscribe(name, publisher, fn) {
-    const subscription = uuid.v4();
-    this.emit(name, {publisher, subscription});
-    const off = this.on({name, key: subscription}, fn);
-    return () => (this.emit({name, key: subscription}), off());
+    const subscription = uuid.v4()
+    this.emit(name, {publisher, subscription})
+    const off = this.on({name, key: subscription}, fn)
+    return () => (this.emit({name, key: subscription}), off())
   }
 
   once(type, fn) {
-    const off = this.on(type, (...args) => (fn(...args), this.off()));
-    return off;
+    const off = this.on(type, (...args) => (fn(...args), this.off()))
+    return off
   }
 
   off(name, fn) {
-    if (!fn) return this._listeners.delete(name);
-    const fns = this._listeners.get(name);
-    if (!fns) return false;
-    const existed = fns.delete(fn);
-    if (!fns.size) this._listeners.delete(name);
-    return existed;
+    if (!fn) return this._listeners.delete(name)
+    const fns = this._listeners.get(name)
+    if (!fns) return false
+    const existed = fns.delete(fn)
+    if (!fns.size) this._listeners.delete(name)
+    return existed
   }
 
   emit(type, payload) {
     try {
-      const command = () => this._socket.send(this.serialize(type, payload));
-      if (this._socket) command();
-      else this._queue.add(command);
-      return () => this._queue.delete(command);
+      const command = () => this._socket.send(this.serialize(type, payload))
+      if (this._socket) command()
+      else this._queue.add(command)
+      return () => this._queue.delete(command)
     } catch (ex) {
-      console.log(ex);
-      throw ex;
+      console.log(ex)
+      throw ex
     }
   }
 
   ref() {
-    const command = () => this._socket._socket.ref();
-    if (this._socket) command();
-    else this._queue.add(command);
-    return () => this._queue.delete(command);
+    const command = () => this._socket._socket.ref()
+    if (this._socket) command()
+    else this._queue.add(command)
+    return () => this._queue.delete(command)
   }
 
   unref() {
-    const command = () => this._socket._socket.unref();
-    if (this._socket) command();
-    else this._queue.add(command);
-    return () => this._queue.delete(command);
+    const command = () => this._socket._socket.unref()
+    if (this._socket) command()
+    else this._queue.add(command)
+    return () => this._queue.delete(command)
   }
 
   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)
   }
 
   deserialize(message) {
-    return JSON.parse(message.data);
+    return JSON.parse(message.data)
   }
 }
 
-module.exports = Socket;
+module.exports = Socket

package/src/browser/socketCommands.js

@@ -1,83 +1,72 @@
-/* global Node */
-const spec = require('../../dist/browser/spec-driver');
+const spec = require('../../dist/browser/spec-driver')
 
 function socketCommands(socket, refer) {
   socket.command('Driver.executeScript', ({context, script, arg = []}) => {
-    const res = spec.executeScript(refer.deref(context), script, derefArgs(arg));
-    return res ? refer.ref(res) : res;
-  });
+    const res = spec.executeScript(refer.deref(context), script, derefArgs(arg))
+    return res ? refer.ref(res) : res
+  })
 
   socket.command('Driver.mainContext', () => {
-    return refer.ref(spec.mainContext()), {type: 'context'};
-  });
+    return refer.ref(spec.mainContext()), {type: 'context'}
+  })
 
   socket.command('Driver.parentContext', ({context}) => {
-    return refer.ref(spec.parentContext(refer.deref(context)));
-  });
+    return refer.ref(spec.parentContext(refer.deref(context)))
+  })
 
   socket.command('Driver.childContext', ({context, element}) => {
-    return refer.ref(spec.childContext(refer.deref(context), refer.deref(element)));
-  });
+    return refer.ref(spec.childContext(refer.deref(context), refer.deref(element)))
+  })
 
   socket.command('Driver.getViewportSize', () => {
-    return spec.getViewportSize();
-  });
+    return spec.getViewportSize()
+  })
   socket.command('Driver.setViewportSize', vs => {
-    spec.setViewportSize(vs);
-  });
+    spec.setViewportSize(vs)
+  })
   socket.command('Driver.findElement', ({context, selector, parent}) => {
-    const element = spec.findElement(
-      refer.deref(context),
-      spec.transformSelector(selector),
-      refer.deref(parent),
-    );
-    return element === null ? element : refer.ref(element, context);
-  });
+    const element = spec.findElement(refer.deref(context), spec.transformSelector(selector), refer.deref(parent))
+    return element === null ? element : refer.ref(element, context)
+  })
   socket.command('Driver.findElements', ({context, selector, parent}) => {
-    const elements = spec.findElements(
-      refer.deref(context),
-      spec.transformSelector(selector),
-      refer.deref(parent),
-    );
-    return Array.prototype.map.call(elements, element =>
-      element === null ? element : refer.ref(element, context),
-    );
-  });
+    const elements = spec.findElements(refer.deref(context), spec.transformSelector(selector), refer.deref(parent))
+    return Array.prototype.map.call(elements, element => (element === null ? element : refer.ref(element, context)))
+  })
 
   socket.command('Driver.getUrl', ({driver}) => {
-    return spec.getUrl(refer.deref(driver));
-  });
+    return spec.getUrl(refer.deref(driver))
+  })
 
   socket.command('Driver.getTitle', ({driver}) => {
-    return spec.getTitle(refer.deref(driver));
-  });
+    return spec.getTitle(refer.deref(driver))
+  })
 
   socket.command('Driver.getCookies', async () => {
-    return await spec.getCookies();
-  });
+    return await spec.getCookies()
+  })
 
   // utils
 
   function derefArgs(arg) {
-    const derefArg = [];
+    const derefArg = []
     if (Array.isArray(arg)) {
       for (const argument of arg) {
         if (Array.isArray(argument)) {
-          derefArg.push(derefArgs(argument));
+          derefArg.push(derefArgs(argument))
         } else {
-          derefArg.push(refer.deref(argument));
+          derefArg.push(refer.deref(argument))
         }
       }
-      return derefArg;
+      return derefArg
     } else if (typeof arg === 'object') {
       for (const [key, value] of Object.entries(arg)) {
-        derefArg[key] = refer.deref(value);
+        derefArg[key] = refer.deref(value)
       }
-      return derefArg;
+      return derefArg
     } else {
-      return arg;
+      return arg
     }
   }
 }
 
-module.exports = {socketCommands};
+module.exports = {socketCommands}

package/src/plugin/concurrencyMsg.js

@@ -1,8 +1,8 @@
-'use strict';
-const chalk = require('chalk');
+'use strict'
+const chalk = require('chalk')
 const MSG = `
 Important notice: Your Applitools visual tests are currently running with a testConcurrency value of 5.
 This means that only up to 5 visual tests can run in parallel, and therefore the execution might be slower.
 If your Applitools license supports a higher concurrency level, learn how to configure it here: https://www.npmjs.com/package/@applitools/eyes-cypress#concurrency.
-Need a higher concurrency in your account? Email us @ sdr@applitools.com with your required concurrency level.`;
-module.exports = {concurrencyMsg: chalk.yellow(MSG), msgText: MSG};
+Need a higher concurrency in your account? Email us @ sdr@applitools.com with your required concurrency level.`
+module.exports = {concurrencyMsg: chalk.yellow(MSG), msgText: MSG}

package/src/plugin/config.js

@@ -1,8 +1,8 @@
-'use strict';
-const utils = require('@applitools/utils');
-const {configParams} = require('./configParams');
-const DEFAULT_TEST_CONCURRENCY = 5;
-const uuid = require('uuid');
+'use strict'
+const utils = require('@applitools/utils')
+const {configParams} = require('./configParams')
+const DEFAULT_TEST_CONCURRENCY = 5
+const uuid = require('uuid')
 
 function makeConfig() {
   const config = utils.config.getConfig({
@@ -14,27 +14,27 @@ function makeConfig() {
       'disableBrowserFetching',
       'testConcurrency',
     ],
-  });
+  })
 
   if ((!config.batch || !config.batch.id) && !config.batchId) {
-    config.batch = {id: uuid.v4(), ...config.batch};
+    config.batch = {id: uuid.v4(), ...config.batch}
   }
 
   if (config.failCypressOnDiff === '0') {
-    config.failCypressOnDiff = false;
+    config.failCypressOnDiff = false
   }
 
   if (utils.types.isString(config.showLogs)) {
-    config.showLogs = config.showLogs === 'true' || config.showLogs === '1';
+    config.showLogs = config.showLogs === 'true' || config.showLogs === '1'
   }
 
   if (utils.types.isString(config.testConcurrency)) {
-    config.testConcurrency = Number(config.testConcurrency);
+    config.testConcurrency = Number(config.testConcurrency)
   }
 
   if (config.accessibilityValidation) {
-    config.accessibilitySettings = config.accessibilityValidation;
-    delete config.accessiblityValidation;
+    config.accessibilitySettings = config.accessibilityValidation
+    delete config.accessiblityValidation
   }
 
   const eyesConfig = {
@@ -43,14 +43,13 @@ function makeConfig() {
     eyesIsDisabled: !!config.isDisabled,
     eyesBrowser: JSON.stringify(config.browser),
     eyesLayoutBreakpoints: JSON.stringify(config.layoutBreakpoints),
-    eyesFailCypressOnDiff:
-      config.failCypressOnDiff === undefined ? true : !!config.failCypressOnDiff,
+    eyesFailCypressOnDiff: config.failCypressOnDiff === undefined ? true : !!config.failCypressOnDiff,
     eyesDisableBrowserFetching: !!config.disableBrowserFetching,
     eyesTestConcurrency: config.testConcurrency || DEFAULT_TEST_CONCURRENCY,
     eyesWaitBeforeCapture: config.waitBeforeCapture,
-  };
+  }
 
-  return {config, eyesConfig};
+  return {config, eyesConfig}
 }
 
-module.exports = makeConfig;
+module.exports = makeConfig

package/src/plugin/configParams.js

@@ -1,4 +1,4 @@
-'use strict';
+'use strict'
 
 const configParams = [
   'appName',
@@ -43,6 +43,6 @@ const configParams = [
   'notifyOnCompletion',
   'batchNotify',
   'dontCloseBatches',
-];
+]
 
-module.exports = {configParams};
+module.exports = {configParams}

package/src/plugin/defaultPort.js

@@ -1 +1 @@
-module.exports = 7373;
+module.exports = 7373

package/src/plugin/errorDigest.js

@@ -1,4 +1,4 @@
-'use strict';
+'use strict'
 
 const colors = {
   green: '\x1b[32m',
@@ -6,7 +6,7 @@ const colors = {
   teal: '\x1b[38;5;86m',
   orange: '\x1b[38;5;214m',
   reset: '\x1b[0m',
-};
+}
 
 const formatByStatus = {
   Passed: {
@@ -24,73 +24,65 @@ const formatByStatus = {
     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);
+  logger.log('errorDigest: diff errors', diffs)
+  logger.log('errorDigest: test errors', failed)
 
-  const testResultsUrl = diffs.length ? colorify(diffs[0].url, 'teal') : '';
-  const testResultsPrefix = testResultsUrl ? 'See details at:' : '';
-  const footer = testResultsUrl
-    ? `\n${indent()}${colorify(testResultsPrefix)} ${testResultsUrl}`
-    : '';
+  const testResultsUrl = diffs.length ? colorify(` ${diffs[0].url} `, 'teal') : '' // the space around the url is for the link to be clickable in the cypress run
+  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}`) +
+    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 {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))}`,
-        );
+        const error = hasError(testResults) ? stringifyError(testResults) : undefined
+        acc.push(`${colorify(symbol, color)} ${colorify(error || stringifyTestResults(testResults))}`)
       }
-      return acc;
-    }, []);
+      return acc
+    }, [])
 
-    const coloredTitle = results.length
-      ? colorify(title(results.length), color, chalkFunction)
-      : '';
-    return testResultsSection(coloredTitle, results);
+    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}`;
+    return isInteractive ? msg : `${colors[color]}${msg}${colors.reset}`
   }
 }
 
 function stringifyTestResults(testResults) {
-  const hostDisplaySize = testResults.hostDisplaySize;
-  const viewport = hostDisplaySize ? `[${hostDisplaySize.width}x${hostDisplaySize.height}]` : '';
-  const testName = `${testResults.name} ${viewport}`;
-  return testName + (testResults.error ? ` : ${testResults.error}` : '');
+  const hostDisplaySize = testResults.hostDisplaySize
+  const viewport = hostDisplaySize ? `[${hostDisplaySize.width}x${hostDisplaySize.height}]` : ''
+  const testName = `${testResults.name} ${viewport}`
+  return testName + (testResults.error ? ` : ${testResults.error}` : '')
 }
 
 function testResultsSection(title, results) {
-  return results.length ? `${indent()}${title}${indent(3)}${results.join(indent(3))}` : '';
+  return results.length ? `${indent()}${title}${indent(3)}${results.join(indent(3))}` : ''
 }
 
 function stringifyError(testResults) {
-  return testResults.error
-    ? stringifyTestResults(testResults)
-    : `[Eyes test not started] : ${testResults}`;
+  return testResults.error ? stringifyTestResults(testResults) : `[Eyes test not started] : ${testResults}`
 }
 
 function indent(spaces = 2) {
-  return `\n   ${'  '.repeat(spaces)}`;
+  return `\n   ${'  '.repeat(spaces)}`
 }
 
 function hasError(testResult) {
-  return testResult.error || testResult instanceof Error;
+  return testResult.error || testResult instanceof Error
 }
 
-module.exports = errorDigest;
+module.exports = errorDigest

package/src/plugin/getErrorsAndDiffs.js

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

package/src/plugin/handleTestResults.js

@@ -1,19 +1,19 @@
-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 {formatters} = require('@applitools/core');
-const {resolve} = require('path');
+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 {formatters} = require('@applitools/core')
+const {resolve} = require('path')
 
 function printTestResults(testResultsArr) {
   const logger = makeLogger({
     level: testResultsArr.resultConfig.showLogs ? 'info' : 'silent',
     label: 'eyes',
-  });
-  if (!testResultsArr.testResults) return;
-  const {passed, failed, diffs} = getErrorsAndDiffs(testResultsArr.testResults);
+  })
+  if (!testResultsArr.testResults) return
+  const {passed, failed, diffs} = getErrorsAndDiffs(testResultsArr.testResults)
   if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.eyesFailCypressOnDiff) {
     throw new Error(
       errorDigest({
@@ -23,16 +23,13 @@ function printTestResults(testResultsArr) {
         logger,
         isInteractive: !testResultsArr.resultConfig.isTextTerminal,
       }),
-    );
+    )
   }
 }
 function handleBatchResultsFile(results, tapFileConfig) {
-  const fileName = tapFileConfig.tapFileName || `${new Date().toISOString()}-eyes.tap`;
-  const tapFile = resolve(tapFileConfig.tapDirPath, fileName);
-  return writeFile(
-    tapFile,
-    formatters.toHierarchicTAPString(results, {includeSubTests: false, markNewAsPassed: true}),
-  );
+  const fileName = tapFileConfig.tapFileName || `${new Date().toISOString()}-eyes.tap`
+  const tapFile = resolve(tapFileConfig.tapDirPath, fileName)
+  return writeFile(tapFile, formatters.toHierarchicTAPString(results, {includeSubTests: false, markNewAsPassed: true}))
 }
 
-module.exports = {printTestResults, handleBatchResultsFile};
+module.exports = {printTestResults, handleBatchResultsFile}