@applitools/eyes-cypress 3.27.1 → 3.27.3

package/CHANGELOG.md

@@ -10,6 +10,25 @@
 
 
 
+## 3.27.3 - 2022/10/19
+
+### Features
+- Changed default value of `sendDom` from `true` to dynamically calculated
+### Bug fixes
+- Fix chrome emulation environment structure
+- Fixed issue with ufg renders failing intermittently
+- Fixed issue with universal process spawning is failing due to a timeout
+
+## 3.27.2 - 2022/10/9
+
+### Features
+- Don't fail `eyes.open` when there is a failure to set viewport size in `UFG`.
+- Using `lazyLoad.waitingTime` as a delay between stitches by default
+- Deprecated "Content" match level value in favor of "IgnoreColors"
+### Bug fixes
+- Internal Infrastructure update
+- Fixed bug when error was thrown when coded region wasn't found using selector
+
 ## 3.27.1 - 2022/8/1
 
 ### Features

package/README.md

@@ -662,7 +662,7 @@ cy.get('.region.two:nth-child(2)').then(el => {
       cy.eyesCheckWindow({
         fully: false,
         ignore: [
-          {type: 'css', selector: '.region.three:nth-child(3n)'},
+          {region: {type: 'css', selector: '.region.three:nth-child(3n)'}, regionId: 'region3'},
           {type: 'xpath', selector: '//div[@class="region one"][3]'},
           {element: el, regionId: 'my-region-id'},
         ],
@@ -716,7 +716,7 @@ after(() => {
 
 ```js
 after(() => {
-  cy.eyesGetAllTestResults().then(summary => {
+  cy.eyesGetAllTestResults().then(async summary => {
     for(const result of summary.getAllResults()) {
       await result.getTestResults().delete()
     }

package/bin/eyes-setup.js

@@ -2,38 +2,30 @@
 'use strict';
 
 const chalk = require('chalk');
-const {handlePlugin} = require('../src/setup/handlePlugin');
-const {handleCommands, handlerCommandsCypress10} = require('../src/setup/handleCommands');
-const {handleTypeScript, handlerTypeScriptCypress10} = require('../src/setup/handleTypeScript');
-const {version} = require('../package');
-const fs = require('fs');
+const handlePlugin = require('../src/setup/handlePlugin');
+const handleCommands = require('../src/setup/handleCommands');
+const {handleTypeScript} = require('../src/setup/handleTypeScript');
+const getCypressVersion = require('../src/setup/getCypressVersion');
+const getCypressPaths = require('../src/setup/getCypressPaths');
+
 const cwd = process.cwd();
 const semver = require('semver');
+const {version} = require('../package');
 
-console.log(chalk.cyan('Setup eyes-cypress', version));
-const packageJson = JSON.parse(fs.readFileSync('package.json'));
-let cypressVersion;
+console.log(chalk.cyan('Setup Eyes-Cypress', version));
 
-if (packageJson.dependencies && packageJson.dependencies.cypress) {
-  cypressVersion = packageJson.dependencies.cypress;
-} else if (packageJson.devDependencies && packageJson.devDependencies.cypress) {
-  cypressVersion = packageJson.devDependencies.cypress;
-}
-const logStr = `Cypress version that was found ${cypressVersion}`;
+const cypressVersion = getCypressVersion();
+console.log(chalk.cyan(`Cypress version: ${cypressVersion}`));
+
+const isCypress10 = semver.satisfies(cypressVersion, '>=10.0.0');
 try {
-  if (semver.satisfies(semver.coerce(String(cypressVersion)), '>=10.0.0')) {
-    console.log(chalk.cyan(logStr, ' (above v10 handler)'));
-    handlePlugin(cwd, true);
-    const supportFilePath = handlerCommandsCypress10(cwd);
-    handlerTypeScriptCypress10(supportFilePath);
-  } else {
-    console.log(chalk.cyan(logStr));
-    handlePlugin(cwd, false);
-    handleCommands(cwd);
-    handleTypeScript(cwd);
-  }
-} catch (e) {
-  console.log(chalk.red('Setup error:\n', e));
+  const {plugin, support, typescript} = getCypressPaths({cwd, isCypress10});
+  handlePlugin(plugin);
+  handleCommands(support);
+  handleTypeScript(typescript);
+} catch (err) {
+  console.log(chalk.red(`Setup error:\n${err.message}`));
+  process.exit(1);
 }
 
 console.log(chalk.cyan('Setup done!'));

package/dist/browser/spec-driver.js

@@ -42,8 +42,8 @@ function getViewportSize() {
     //@ts-ignore
     const currWindow = cy.state('window');
     const viewportSize = {
-        width: Math.max(currWindow.document.documentElement.clientWidth || 0, currWindow.innerWidth || 0),
-        height: Math.max(currWindow.document.documentElement.clientHeight || 0, currWindow.innerHeight || 0)
+        width: currWindow.innerWidth || currWindow.document.documentElement.clientWidth || currWindow.document.body.clientWidth,
+        height: currWindow.innerHeight || currWindow.document.documentElement.clientHeight || currWindow.document.body.clientHeight
     };
     return viewportSize;
 }

package/index.d.ts

@@ -1,6 +1,4 @@
 /// <reference types="cypress" />
-
-import type * as types from '@applitools/types'
 import type * as api from '@applitools/eyes-api'
 
 type MaybeArray<T> = T | T[]
@@ -9,7 +7,7 @@ type LegacyRegion = {left: number; top: number; width: number; height: number}
 type Selector = {selector: string; type?: 'css' | 'xpath', nodeType?: 'element' | 'shadow-root'} | 'string'
 type Element = HTMLElement | JQuery<HTMLElement>
 
-interface CypressCheckSettings extends types.CheckSettings<Element, Selector> {
+interface CypressCheckSettings extends api.CheckSettingsPlain<Element, Selector>{
   tag?: CypressCheckSettings['name']
 
   target?: 'window' | 'region'
@@ -21,13 +19,14 @@ interface CypressCheckSettings extends types.CheckSettings<Element, Selector> {
   content?: MaybeArray<CypressCheckSettings['contentRegions'][number] | LegacyRegion>
   strict?: MaybeArray<CypressCheckSettings['strictRegions'][number] | LegacyRegion>
   floating?: MaybeArray<CypressCheckSettings['floatingRegions'][number] | (({element: Element} | Selector | LegacyRegion) & {maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number})>
-  accessibility?: MaybeArray<CypressCheckSettings['accessibilityRegions'][number] | (({element: Element} | Selector | LegacyRegion) & {accessibilityType?: types.AccessibilityRegionType})>
-
+  accessibility?: MaybeArray<CypressCheckSettings['accessibilityRegions'][number] | (({element: Element} | Selector | LegacyRegion) & {accessibilityType?: api.AccessibilityRegionTypePlain})>
   scriptHooks?: CypressCheckSettings['hooks']
+  ignoreCaret?: boolean
+  ignoreDisplacements?: boolean
 }
 
-interface CypressEyesConfig extends types.EyesConfig<Element, Selector> {
-  browser?: MaybeArray<CypressEyesConfig['browsersInfo'][number] | {deviceName: string; screenOrientation?: types.ScreenOrientation; name?: string}>
+interface CypressEyesConfig extends api.ConfigurationPlain<Element, Selector> {
+  browser?: MaybeArray<CypressEyesConfig['browsersInfo'][number] | {deviceName: string; screenOrientation?: api.ScreenOrientationPlain; name?: string}>
 
   batchId?: CypressEyesConfig['batch']['id']
   batchName?: CypressEyesConfig['batch']['name']
@@ -36,10 +35,7 @@ interface CypressEyesConfig extends types.EyesConfig<Element, Selector> {
 
   envName?: CypressEyesConfig['environmentName']
 
-  ignoreCaret?: CypressEyesConfig['defaultMatchSettings']['ignoreCaret']
-  matchLevel?: CypressEyesConfig['defaultMatchSettings']['matchLevel']
   accessibilitySettings?: CypressEyesConfig['defaultMatchSettings']['accessibilitySettings']
-  ignoreDisplacements?: CypressEyesConfig['defaultMatchSettings']['ignoreDisplacements']
 }
 
 declare global {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.27.1",
+  "version": "3.27.3",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -35,7 +35,7 @@
     "test:ts": "yarn test:ts:compile && yarn test:ts:run",
     "test:ts:compile": "tsc --project test/e2e/ts/cypress",
     "test:ts:run": "cypress run --config-file test/e2e/ts/cypress-ts.json",
-    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
     "test:e2e": "mkdir -p test/fixtures/testAppCopies && mocha --no-timeouts 'test/e2e/**/*.test.js'",
     "cypress": "cypress open --config-file test/fixtures/cypress-play.json",
     "cypress:new": "cd test/play && yarn && npx cypress open",
@@ -45,7 +45,7 @@
     "render": "run(){ npx cypress run --config integrationFolder=test/fixtures/testApp/cypress/render,pluginsFile=test/fixtures/testApp/cypress/plugins/index-render.js,supportFile=test/fixtures/testApp/cypress/support/index-run.js --env url=$1; }; run",
     "prepublish:setup": "sudo apt-get install xvfb",
     "deps": "bongo deps",
-    "preversion": "yarn build && bongo preversion --skip-deps --verifyPendingChanges",
+    "preversion": "yarn build && bongo preversion --skip-deps --verifyPendingChanges --skipVerifyInstalledVersions",
     "version": "bongo version --withPendingChanges",
     "postversion": "bongo postversion --skip-release-notification"
   },
@@ -55,24 +55,24 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.7.5",
-    "@applitools/eyes-universal": "2.10.3",
+    "@applitools/core": "1.2.0",
+    "@applitools/eyes-api": "1.9.0",
+    "@applitools/eyes-universal": "2.16.5",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.15",
-    "@applitools/visual-grid-client": "15.13.13",
+    "@applitools/logger": "1.1.27",
     "chalk": "3.0.0",
+    "semver": "7.3.7",
     "uuid": "8.3.2",
     "ws": "8.5.0"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.6",
-    "@applitools/scripts": "1.1.0",
+    "@applitools/bongo": "^2.2.0",
+    "@applitools/scripts": "1.2.0",
     "@applitools/sdk-coverage-tests": "^2.3.20",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.4",
-    "@applitools/test-utils": "1.4.3",
-    "@applitools/types": "^1.5.8",
-    "@applitools/utils": "1.3.10",
+    "@applitools/test-server": "1.1.6",
+    "@applitools/test-utils": "1.5.2",
+    "@applitools/utils": "1.3.13",
     "@types/node": "12",
     "@types/ws": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^5.10.2",
@@ -80,7 +80,7 @@
     "chai": "4.2.0",
     "chai-spies": "1.0.0",
     "cookie-parser": "1.4.4",
-    "cypress": "8.0.0",
+    "cypress": "9.7.0",
     "eslint": "8.10.0",
     "eslint-plugin-mocha-no-only": "1.1.0",
     "eslint-plugin-node": "7.0.1",
@@ -92,8 +92,7 @@
     "ncp": "2.0.0",
     "node-fetch": "2.6.0",
     "prettier": "1.19.1",
-    "semver": "^7.3.7",
-    "typescript": "4.6.4"
+    "typescript": "4.8.4"
   },
   "engines": {
     "node": ">=12.13.0"

package/src/browser/commands.js

@@ -38,7 +38,7 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
     await Promise.all(closePromiseArr);
     const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});
 
-    const deleteTest = ({testId, batchId, secretToken}) => {
+    const deleteTest = ({settings: {testId, batchId, secretToken}}) => {
       const {serverUrl, proxy, apiKey} = Cypress.config('appliConfFile');
       return socket.request('Core.deleteTest', {
         settings: {
@@ -51,7 +51,9 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
         },
       });
     };
-
+    summary.results = summary.results.map(res => {
+      return {...res, result: res.testResults, error: res.exception, renderer: res.browserInfo};
+    });
     return new TestResultsSummary({summary, deleteTest});
   });
 });

package/src/browser/eyesCheckMapping.js

@@ -36,14 +36,29 @@ function eyesCheckMapValues({args, refer}) {
       if (config.element) {
         if (isHTMLElement(config.element)) {
           regionSettings = {
-            region: refer.ref(config.element),
+            region: Object.assign(refer.ref(config.element), {type: 'element'}),
           };
         } else {
           // JQuery element
           regionSettings = {
-            region: refer.ref(config.element[0]),
+            region: Object.assign(refer.ref(config.element[0]), {type: 'element'}),
           };
         }
+      } else if (
+        config.region &&
+        config.region.hasOwnProperty('top') &&
+        config.region.hasOwnProperty('left') &&
+        config.region.hasOwnProperty('width') &&
+        config.region.hasOwnProperty('height')
+      ) {
+        regionSettings = {
+          region: {
+            y: config.region.top,
+            x: config.region.left,
+            width: config.region.width,
+            height: config.region.height,
+          },
+        };
       } else if (!config.hasOwnProperty('selector')) {
         regionSettings = {
           region: config.region,
@@ -128,8 +143,8 @@ function eyesCheckMapValues({args, refer}) {
         }
       } else {
         accessabilityRegion.region = {
-          top: region.top,
-          left: region.left,
+          y: region.top,
+          x: region.left,
           width: region.width,
           height: region.height,
         };
@@ -161,8 +176,8 @@ function eyesCheckMapValues({args, refer}) {
         }
       } else {
         floatingRegion.region = {
-          top: region.top,
-          left: region.left,
+          y: region.top,
+          x: region.left,
           width: region.width,
           height: region.height,
         };
@@ -178,11 +193,13 @@ function eyesCheckMapValues({args, refer}) {
     const elements = [];
     for (const region of regions) {
       if (isHTMLElement(region)) {
-        elements.push(refer.ref(region));
+        elements.push(Object.assign(refer.ref(region), {type: 'element'}));
       } else if (region.jquery) {
         region.each(function() {
           // there's a small chance that `this` is not an HTML element. So we just verify it.
-          elements.push(isHTMLElement(this) ? refer.ref(this) : this);
+          elements.push(
+            isHTMLElement(this) ? Object.assign(refer.ref(this), {type: 'element'}) : this,
+          );
         });
       } else {
         elements.push(region);

package/src/browser/eyesOpenMapping.js

@@ -47,10 +47,11 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
 
   if (browsersInfo) {
     if (Array.isArray(browsersInfo)) {
-      browsersInfo.forEach(fillDefaultBrowserName);
+      for (const [index, value] of browsersInfo.entries()) {
+        browsersInfo[index] = fillDefaultBrowserName(value);
+      }
     } else {
-      fillDefaultBrowserName(browsersInfo);
-      browsersInfo = [browsersInfo];
+      browsersInfo = [fillDefaultBrowserName(browsersInfo)];
     }
   }
 
@@ -90,6 +91,12 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
 function fillDefaultBrowserName(browser) {
   if (!browser.name && !browser.iosDeviceInfo && !browser.chromeEmulationInfo) {
     browser.name = 'chrome';
+    if (browser.deviceName) {
+      browser = {chromeEmulationInfo: browser};
+    }
+    return browser;
+  } else {
+    return browser;
   }
 }
 

package/src/browser/refer.js

@@ -14,16 +14,19 @@ class Refer {
   }
 
   check(value) {
-    return (
-      value &&
-      (value.nodeType === Node.ELEMENT_NODE ||
-        value.nodeType === Node.DOCUMENT_NODE ||
-        value.ownerDocument ||
-        (value.constructor && value.constructor.name === 'Window'))
-    );
+    if (!value) return;
+    if (value.nodeType === Node.ELEMENT_NODE) {
+      return 'element';
+    } else if (value.nodeType === Node.DOCUMENT_NODE || value.ownerDocument) {
+      return 'context';
+    } else if (value.constructor && value.constructor.name === 'Window') {
+      return 'driver';
+    }
   }
+
   ref(value, parentRef) {
-    if (this.check(value)) {
+    const refType = this.check(value);
+    if (refType) {
       const ref = uuid.v4();
       this.store.set(ref, value);
       if (parentRef) {
@@ -34,7 +37,7 @@ class Refer {
         }
         childRefs.add({[REF_ID]: ref});
       }
-      return {[REF_ID]: ref};
+      return {[REF_ID]: ref, type: refType};
     } else if (Array.isArray(value)) {
       return value.map(value => this.ref(value, parentRef));
     } else if (typeof value === 'object' && value !== null) {

package/src/browser/socketCommands.js

@@ -1,12 +1,14 @@
+/* global Node */
 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 refer.ref(res);
+    return res ? refer.ref(res) : res;
   });
+
   socket.command('Driver.mainContext', () => {
-    return refer.ref(spec.mainContext());
+    return refer.ref(spec.mainContext()), {type: 'context'};
   });
 
   socket.command('Driver.parentContext', ({context}) => {
@@ -42,12 +44,12 @@ function socketCommands(socket, refer) {
     );
   });
 
-  socket.command('Driver.getUrl', context => {
-    return spec.getUrl(refer.deref(context));
+  socket.command('Driver.getUrl', ({driver}) => {
+    return spec.getUrl(refer.deref(driver));
   });
 
-  socket.command('Driver.getTitle', context => {
-    return spec.getTitle(refer.deref(context.driver));
+  socket.command('Driver.getTitle', ({driver}) => {
+    return spec.getTitle(refer.deref(driver));
   });
 
   socket.command('Driver.getCookies', async () => {

package/src/browser/spec-driver.ts

@@ -47,8 +47,8 @@ export function getViewportSize(): Object {
   //@ts-ignore
   const currWindow = cy.state('window')
   const viewportSize = {
-    width: Math.max(currWindow.document.documentElement.clientWidth || 0, currWindow.innerWidth || 0),
-    height: Math.max(currWindow.document.documentElement.clientHeight || 0, currWindow.innerHeight || 0)
+    width:  currWindow.innerWidth || currWindow.document.documentElement.clientWidth || currWindow.document.body.clientWidth,
+    height: currWindow.innerHeight || currWindow.document.documentElement.clientHeight || currWindow.document.body.clientHeight
   };
   return viewportSize;
 }

package/src/plugin/config.js

@@ -1,6 +1,6 @@
 'use strict';
 const utils = require('@applitools/utils');
-const {configParams, TypeUtils} = require('@applitools/visual-grid-client');
+const {configParams} = require('./configParams');
 const DEFAULT_TEST_CONCURRENCY = 5;
 const uuid = require('uuid');
 
@@ -24,11 +24,11 @@ function makeConfig() {
     config.failCypressOnDiff = false;
   }
 
-  if (TypeUtils.isString(config.showLogs)) {
+  if (utils.types.isString(config.showLogs)) {
     config.showLogs = config.showLogs === 'true' || config.showLogs === '1';
   }
 
-  if (TypeUtils.isString(config.testConcurrency)) {
+  if (utils.types.isString(config.testConcurrency)) {
     config.testConcurrency = Number(config.testConcurrency);
   }
 

package/src/plugin/configParams.js

@@ -0,0 +1,48 @@
+'use strict';
+
+const configParams = [
+  'appName',
+  'testName',
+  'displayName',
+  'browser',
+  'url',
+  'apiKey',
+  'showLogs',
+  'batch',
+  'batchId',
+  'batchName',
+  'batchSequenceName',
+  'batchSequence',
+  'properties',
+  'baselineBranchName',
+  'baselineBranch',
+  'baselineEnvName',
+  'baselineName',
+  'envName',
+  'ignoreCaret',
+  'isDisabled',
+  'matchLevel',
+  'parentBranchName',
+  'parentBranch',
+  'branchName',
+  'branch',
+  'proxy',
+  'autProxy',
+  'saveDiffs',
+  'saveFailedTests',
+  'saveNewTests',
+  'compareWithParentBranch',
+  'ignoreBaseline',
+  'serverUrl',
+  'concurrency',
+  'testConcurrency',
+  'useDom',
+  'enablePatterns',
+  'ignoreDisplacements',
+  'accessibilitySettings',
+  'notifyOnCompletion',
+  'batchNotify',
+  'dontCloseBatches',
+];
+
+module.exports = {configParams};

package/src/plugin/errorDigest.js

@@ -30,7 +30,7 @@ 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 testResultsUrl = diffs.length ? colorify(diffs[0].url, 'teal') : '';
   const testResultsPrefix = testResultsUrl ? 'See details at:' : '';
   const footer = testResultsUrl
     ? `\n${indent()}${colorify(testResultsPrefix)} ${testResultsUrl}`
@@ -69,9 +69,9 @@ function errorDigest({passed, failed, diffs, logger, isInteractive}) {
 }
 
 function stringifyTestResults(testResults) {
-  const hostDisplaySize = testResults.getHostDisplaySize();
-  const viewport = hostDisplaySize ? `[${hostDisplaySize}]` : '';
-  const testName = `${testResults.getName()} ${viewport}`;
+  const hostDisplaySize = testResults.hostDisplaySize;
+  const viewport = hostDisplaySize ? `[${hostDisplaySize.width}x${hostDisplaySize.height}]` : '';
+  const testName = `${testResults.name} ${viewport}`;
   return testName + (testResults.error ? ` : ${testResults.error}` : '');
 }
 

package/src/plugin/getErrorsAndDiffs.js

@@ -1,19 +1,18 @@
 '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();
+        const testStatus = testResults.status;
         if (testStatus === 'Passed') {
           passed.push(testResults);
         } else {
           if (testStatus === 'Unresolved') {
-            if (testResults.getIsNew()) {
+            if (testResults.isNew) {
               testResults.error = new Error(
-                `${testResults.getName()}. Please approve the new baseline at ${testResults.getUrl()}`,
+                `${testResults.name}. Please approve the new baseline at ${testResults.url}`,
               );
               failed.push(testResults);
             } else {

package/src/plugin/handleTestResults.js

@@ -4,7 +4,7 @@ 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 {formatters} = require('@applitools/core');
 const {resolve} = require('path');
 
 function printTestResults(testResultsArr) {
@@ -12,6 +12,7 @@ function printTestResults(testResultsArr) {
     level: testResultsArr.resultConfig.showLogs ? 'info' : 'silent',
     label: 'eyes',
   });
+  if (!testResultsArr.testResults) return;
   const {passed, failed, diffs} = getErrorsAndDiffs(testResultsArr.testResults);
   if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.eyesFailCypressOnDiff) {
     throw new Error(
@@ -26,10 +27,12 @@ function printTestResults(testResultsArr) {
   }
 }
 function handleBatchResultsFile(results, tapFileConfig) {
-  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));
+  return writeFile(
+    tapFile,
+    formatters.toHierarchicTAPString(results, {includeSubTests: false, markNewAsPassed: true}),
+  );
 }
 
 module.exports = {printTestResults, handleBatchResultsFile};

package/src/plugin/hooks.js

@@ -1,5 +1,4 @@
 'use strict';
-const {TestResults} = require('@applitools/visual-grid-client');
 const handleTestResults = require('./handleTestResults');
 
 function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer}) {
@@ -17,12 +16,10 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
           isTextTerminal: config.isTextTerminal,
         };
         const summaries = await closeManager();
-        const testResultsArr = [];
+
+        let testResults;
         for (const summary of summaries) {
-          const testResults = summary.results.map(({testResults}) => testResults);
-          for (const result of testResults) {
-            testResultsArr.push(new TestResults(result));
-          }
+          testResults = summary.results.map(({testResults}) => testResults);
         }
         if (!config.appliConfFile.dontCloseBatches) {
           await closeBatches({
@@ -34,13 +31,13 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
         }
 
         if (config.appliConfFile.tapDirPath) {
-          await handleTestResults.handleBatchResultsFile(testResultsArr, {
+          await handleTestResults.handleBatchResultsFile(testResults, {
             tapDirPath: config.appliConfFile.tapDirPath,
             tapFileName: config.appliConfFile.tapFileName,
           });
         }
 
-        handleTestResults.printTestResults({testResults: testResultsArr, resultConfig});
+        handleTestResults.printTestResults({testResults, resultConfig});
       } finally {
         await closeUniversalServer();
       }

package/src/plugin/server.js

@@ -1,7 +1,6 @@
 'use strict';
 const connectSocket = require('./webSocket');
 const {makeServerProcess} = require('@applitools/eyes-universal');
-const {TestResults} = require('@applitools/visual-grid-client');
 const handleTestResults = require('./handleTestResults');
 const path = require('path');
 const fs = require('fs');
@@ -36,6 +35,7 @@ function makeStartServer({logger}) {
       cert: path.resolve(__dirname, '../pem/server.cert'),
       detached: false,
       idleTimeout: 0,
+      shutdownMode: 'stdin',
     });
 
     const managers = [];
@@ -69,18 +69,14 @@ function makeStartServer({logger}) {
           socketWithUniversal.send(newMessage);
         } else 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, {
+              handleTestResults.handleBatchResultsFile(msg.payload.testResults, {
                 tapFileName: msg.payload.resultConfig.tapFileName,
                 tapDirPath: msg.payload.resultConfig.tapDirPath,
               });
             }
             handleTestResults.printTestResults({
-              testResults: resultArr,
+              testResults: msg.payload.testResults,
               resultConfig: msg.payload.resultConfig,
             });
             socketWithClient.send(

package/src/setup/getCypressPaths.js

@@ -0,0 +1,78 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+function getCypressPaths({cwd, isCypress10}) {
+  if (isCypress10) {
+    return getCypressPaths10AndAbove(cwd);
+  } else {
+    return getCypressPaths9AndBelow(cwd);
+  }
+}
+
+function getCypressPaths10AndAbove(cwd) {
+  const cypressConfigPath = path.resolve(cwd, 'cypress.config.js');
+  if (fs.existsSync(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;
+    return {
+      config: cypressConfigPath,
+      plugin: cypressConfigPath,
+      support: supportFilePath,
+      typescript: typeScriptFilePath,
+    };
+  } 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.`,
+    );
+  }
+}
+
+function getSupportFilePathFromCypress10Config({cwd, configContent}) {
+  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);
+  } else {
+    if (fs.existsSync(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');
+    } else if (fs.existsSync(path.resolve(cwd, 'cypress/support/component.js'))) {
+      supportFilePath = path.resolve(cwd, 'cypress/support/component.js');
+    }
+  }
+  return supportFilePath;
+}
+
+function getCypressPaths9AndBelow(cwd) {
+  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;
+      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}`);
+    }
+  } 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;

package/src/setup/getCypressVersion.js

@@ -0,0 +1,13 @@
+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;
+}
+
+module.exports = getCypressVersion;

package/src/setup/handleCommands.js

@@ -1,57 +1,23 @@
 'use strict';
 
 const fs = require('fs');
-const path = require('path');
-
 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.'));
-  }
-}
-
-function handlerCommandsCypress10(cwd) {
-  const configContent = fs.readFileSync(path.resolve(cwd, 'cypress.config.js'), 'utf-8');
-  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);
-  } else {
-    if (fs.existsSync(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');
-    } else if (fs.existsSync(path.resolve(cwd, 'cypress/support/component.js'))) {
-      supportFilePath = path.resolve(cwd, 'cypress/support/component.js');
-    }
-  }
 
+function handleCommands(supportFilePath) {
   if (supportFilePath) {
-    const commandsFileContent = fs.readFileSync(supportFilePath, 'utf-8');
-    if (!isCommandsDefined(commandsFileContent)) {
-      writeFileSync(supportFilePath, addEyesCommands(commandsFileContent));
+    const supportFileContent = fs.readFileSync(supportFilePath, 'utf-8');
+
+    if (!isCommandsDefined(supportFileContent)) {
+      fs.writeFileSync(supportFilePath, addEyesCommands(supportFileContent));
       console.log(chalk.cyan('Commands defined.'));
     } else {
       console.log(chalk.cyan('Commands already defined.'));
     }
   } else {
-    throw new Error('Commands file not found!');
+    throw new Error('Commands could not be defined. Support file could not be found');
   }
-  return supportFilePath;
 }
 
-module.exports = {handleCommands, handlerCommandsCypress10};
+module.exports = handleCommands;

package/src/setup/handlePlugin.js

@@ -1,31 +1,19 @@
 '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');
 const fs = require('fs');
-const path = require('path');
 
-function handlePlugin(cwd, isCypress10) {
-  let fileContent, filePath;
-  if (!isCypress10) {
-    const cypressConfig = getCypressConfig(cwd);
-    filePath = getFilePath('plugins', cypressConfig, cwd);
-    fileContent = readFileSync(filePath).toString();
-  } else {
-    filePath = path.resolve(cwd, 'cypress.config.js');
-    fileContent = fs.readFileSync(filePath, 'utf-8');
-  }
+function handlePlugin(pluginsFilePath) {
+  const fileContent = fs.readFileSync(pluginsFilePath, 'utf-8');
 
   if (!isPluginDefined(fileContent)) {
-    writeFileSync(filePath, addEyesCypressPlugin(fileContent));
+    fs.writeFileSync(pluginsFilePath, addEyesCypressPlugin(fileContent));
     console.log(chalk.cyan('Plugins defined.'));
   } else {
     console.log(chalk.cyan('Plugins already defined'));
   }
 }
 
-module.exports = {handlePlugin};
+module.exports = handlePlugin;

package/src/setup/handleTypeScript.js

@@ -1,33 +1,15 @@
 '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"`;
-const {resolve, dirname} = require('path');
 
-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.'));
-  }
-}
-
-function handlerTypeScriptCypress10(suportFilePath) {
-  const supportDir = dirname(suportFilePath);
-  const typeScriptFilePath = resolve(supportDir, 'index.d.ts');
+function handleTypeScript(typeScriptFilePath) {
   if (!existsSync(typeScriptFilePath)) {
     writeFileSync(typeScriptFilePath, eyesIndexContent);
-    console.log(chalk.cyan('Typescript defined.'));
+    console.log(chalk.cyan('TypeScript defined.'));
   } else {
-    console.log(chalk.cyan('Typescript already defined.'));
+    console.log(chalk.cyan('TypeScript already defined.'));
   }
 }
 
-module.exports = {handleTypeScript, handlerTypeScriptCypress10};
-module.exports.eyesIndexContent = eyesIndexContent;
+module.exports = {handleTypeScript, eyesIndexContent};

package/src/setup/getCypressConfig.js

@@ -1,16 +0,0 @@
-'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;