@applitools/eyes-cypress 3.27.2 → 3.27.3

package/CHANGELOG.md

@@ -10,6 +10,15 @@
 
 
 
+## 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

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[]
@@ -21,14 +19,14 @@ interface CypressCheckSettings extends api.CheckSettingsPlain<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 api.ConfigurationPlain<Element, Selector> {
-  browser?: MaybeArray<CypressEyesConfig['browsersInfo'][number] | {deviceName: string; screenOrientation?: types.ScreenOrientation; name?: string}>
+  browser?: MaybeArray<CypressEyesConfig['browsersInfo'][number] | {deviceName: string; screenOrientation?: api.ScreenOrientationPlain; name?: string}>
 
   batchId?: CypressEyesConfig['batch']['id']
   batchName?: CypressEyesConfig['batch']['name']

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.27.2",
+  "version": "3.27.3",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -55,11 +55,11 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.8.5",
-    "@applitools/eyes-universal": "2.16.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.26",
-    "@applitools/visual-grid-client": "15.14.1",
+    "@applitools/logger": "1.1.27",
     "chalk": "3.0.0",
     "semver": "7.3.7",
     "uuid": "8.3.2",
@@ -70,10 +70,9 @@
     "@applitools/scripts": "1.2.0",
     "@applitools/sdk-coverage-tests": "^2.3.20",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.5",
+    "@applitools/test-server": "1.1.6",
     "@applitools/test-utils": "1.5.2",
-    "@applitools/types": "^1.5.19",
-    "@applitools/utils": "1.3.12",
+    "@applitools/utils": "1.3.13",
     "@types/node": "12",
     "@types/ws": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^5.10.2",
@@ -93,7 +92,7 @@
     "ncp": "2.0.0",
     "node-fetch": "2.6.0",
     "prettier": "1.19.1",
-    "typescript": "4.6.4"
+    "typescript": "4.8.4"
   },
   "engines": {
     "node": ">=12.13.0"

package/src/browser/commands.js

@@ -52,7 +52,7 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
       });
     };
     summary.results = summary.results.map(res => {
-      return {...res, result: res.testResults, error: res.exception};
+      return {...res, result: res.testResults, error: res.exception, renderer: res.browserInfo};
     });
     return new TestResultsSummary({summary, deleteTest});
   });

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/socketCommands.js

@@ -78,19 +78,6 @@ function socketCommands(socket, refer) {
       return arg;
     }
   }
-
-  function getType(value) {
-    if (!value) return;
-    if (value.nodeType === Node.ELEMENT_NODE) {
-      return 'element';
-    } else if (
-      value.nodeType === Node.DOCUMENT_NODE ||
-      value.ownerDocument ||
-      (value.constructor && value.constructor.name === 'Window')
-    ) {
-      return 'context';
-    }
-  }
 }
 
 module.exports = {socketCommands};

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');
@@ -70,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(