@applitools/eyes-cypress 3.27.6 → 3.27.8

package/CHANGELOG.md

@@ -10,6 +10,23 @@
 
 
 
+
+## 3.27.8 - 2022/11/19
+
+### Features
+### Bug fixes
+- Handle cases where cypress report showed tests pass when differences were found
+
+## 3.27.7 - 2022/11/17
+
+### Features
+- Added new selector extensions `child` and `fallback`
+- Use user agent metadata to improve browser environment detection logic
+- Use APPLITOOLS_CONCURRENCY env variable to specify concurrency
+### Bug fixes
+- Support parallel run of multiple `Cypress` instances
+- Add support for regionId and padding for accessibility and floating regions
+
 ## 3.27.6 - 2022/10/28
 
 ### Features

package/README.md

@@ -505,7 +505,24 @@ cy.get('some-region').then(el => {
      // will add padding of 20px to all JQuery elements at the top, button, right and left of the region
     ignore: {element: el, padding: 20},
     // will add padding for a DOM element on the top of the region
-    content: {element: el[0], padding: {top:10}}
+    content: {element: el[0], padding: {top:10}},
+    accessibility: {
+          region: {
+            accessibilityType: 'LargeText',
+            selector: 'accessibilityRegion',
+          },
+          padding: {left: 5},
+    },
+  floating:{
+          region: {
+            selector: 'floatingRegion',
+          },
+          maxDownOffset: 3,
+          maxLeftOffset: 20,
+          maxRightOffset: 30,
+          maxUpOffset: 3,
+          padding: {top: 20},
+        },
   })
 
 })
@@ -662,10 +679,27 @@ cy.get('.region.two:nth-child(2)').then(el => {
       cy.eyesCheckWindow({
         fully: false,
         ignore: [
-          {region: {type: 'css', selector: '.region.three:nth-child(3n)'}, regionId: 'region3'},
-          {type: 'xpath', selector: '//div[@class="region one"][3]'},
+          {region: {type: 'css', selector: 'ignore1'}, regionId: 'region3'},
+          {type: 'xpath', selector: 'ignore2'},
           {element: el, regionId: 'my-region-id'},
         ],
+        accessibility: [{
+            region: {
+              accessibilityType: 'LargeText',
+              selector: 'accessibilityRegion',
+            },
+            regionId: 'accesibility-regionId',
+        },],
+        floating: [{
+          region: {
+            selector: 'floatingRegion',
+          },
+          maxDownOffset: 3,
+          maxLeftOffset: 20,
+          maxRightOffset: 30,
+          maxUpOffset: 3,
+          regionId: 'floating-regionId',
+        }]
       });
 })
 ```

package/index.d.ts

@@ -7,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 api.CheckSettingsPlain<Element, Selector>{
+interface CypressCheckSettings extends api.CheckSettingsAutomationPlain<Element, Selector>{
   tag?: CypressCheckSettings['name']
 
   target?: 'window' | 'region'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.27.6",
+  "version": "3.27.8",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -56,11 +56,11 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "1.2.7",
-    "@applitools/eyes-api": "1.9.1",
-    "@applitools/eyes-universal": "2.16.9",
+    "@applitools/core": "1.2.12",
+    "@applitools/eyes-api": "1.10.4",
+    "@applitools/eyes-universal": "2.17.2",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.27",
+    "@applitools/logger": "1.1.30",
     "chalk": "3.0.0",
     "semver": "7.3.8",
     "uuid": "8.3.2",
@@ -70,11 +70,11 @@
   "devDependencies": {
     "@applitools/bongo": "^2.2.0",
     "@applitools/scripts": "1.2.0",
-    "@applitools/sdk-coverage-tests": "^2.3.20",
+    "@applitools/sdk-coverage-tests": "^2.7.8",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.8",
+    "@applitools/test-server": "1.1.10",
     "@applitools/test-utils": "1.5.2",
-    "@applitools/utils": "1.3.13",
+    "@applitools/utils": "1.3.16",
     "@types/node": "12",
     "@types/which": "^2.0.1",
     "@types/ws": "^8.2.2",

package/src/browser/commands.js

@@ -58,7 +58,7 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
   });
 });
 
-if (shouldUseBrowserHooks) {
+if (shouldUseBrowserHooks || Cypress.config('eyesFailCypressOnDiff')) {
   after(() => {
     if (!manager) return;
     return cy.then({timeout: 86400000}, async () => {
@@ -72,6 +72,7 @@ if (shouldUseBrowserHooks) {
         isTextTerminal: Cypress.config('isTextTerminal'),
         tapDirPath: Cypress.config('appliConfFile').tapDirPath,
         tapFileName: Cypress.config('appliConfFile').tapFileName,
+        shouldCreateTapFile: shouldUseBrowserHooks,
       };
       await Promise.all(closePromiseArr);
       const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});

package/src/browser/eyesCheckMapping.js

@@ -119,6 +119,10 @@ function eyesCheckMapValues({args, refer}) {
           resRegions = [...resRegions, ...refElements(region)];
         }
       } else {
+        if (region.selector && !region.type) {
+          region.region = region.selector;
+          delete region.selector;
+        }
         resRegions.push(region);
       }
     }
@@ -141,6 +145,10 @@ function eyesCheckMapValues({args, refer}) {
         for (const element of elements) {
           accessibility.push(Object.assign({}, accessabilityRegion, {region: element}));
         }
+      } else if (region.hasOwnProperty('region')) {
+        region.type = region.region.accessibilityType;
+        delete region.region.accessibilityType;
+        accessibility.push(region);
       } else {
         accessabilityRegion.region = {
           y: region.top,
@@ -174,6 +182,8 @@ function eyesCheckMapValues({args, refer}) {
         for (const element of elements) {
           floating.push(Object.assign({}, floatingRegion, {region: element}));
         }
+      } else if (region.hasOwnProperty('region')) {
+        floating.push(region);
       } else {
         floatingRegion.region = {
           y: region.top,

package/src/plugin/hooks.js

@@ -10,11 +10,6 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
     'after:run': async ({config}) => {
       try {
         if (!config.isTextTerminal) return;
-        const resultConfig = {
-          showLogs: config.showLogs,
-          eyesFailCypressOnDiff: config.eyesFailCypressOnDiff,
-          isTextTerminal: config.isTextTerminal,
-        };
         const summaries = await closeManager();
 
         let testResults;
@@ -36,8 +31,6 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
             tapFileName: config.appliConfFile.tapFileName,
           });
         }
-
-        handleTestResults.printTestResults({testResults, resultConfig});
       } finally {
         await closeUniversalServer();
       }

package/src/plugin/server.js

@@ -46,18 +46,18 @@ function makeStartServer({logger}) {
     }
 
     const {port: universalPort, close: closeUniversalServer} = await makeServerProcess({
-      key: path.resolve(__dirname, '../pem/server.key'),
-      cert: path.resolve(__dirname, '../pem/server.cert'),
       idleTimeout: 0,
       shutdownMode: 'stdin',
       forkOptions,
+      singleton: false,
+      portResolutionMode: 'random',
     });
 
     const managers = [];
     let socketWithUniversal;
 
     wss.on('connection', socketWithClient => {
-      socketWithUniversal = connectSocket(`wss://localhost:${universalPort}/eyes`);
+      socketWithUniversal = connectSocket(`ws://localhost:${universalPort}/eyes`);
 
       socketWithUniversal.setPassthroughListener(message => {
         logger.log('<== ', message.toString().slice(0, 1000));
@@ -84,7 +84,10 @@ function makeStartServer({logger}) {
           socketWithUniversal.send(newMessage);
         } else if (msg.name === 'Test.printTestResults') {
           try {
-            if (msg.payload.resultConfig.tapDirPath) {
+            if (
+              msg.payload.resultConfig.tapDirPath &&
+              msg.payload.resultConfig.shouldCreateTapFile
+            ) {
               handleTestResults.handleBatchResultsFile(msg.payload.testResults, {
                 tapFileName: msg.payload.resultConfig.tapFileName,
                 tapDirPath: msg.payload.resultConfig.tapDirPath,