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

package/CHANGELOG.md

@@ -2,9 +2,9 @@
 
 ## Unreleased
 
-
- ## 3.24.0-beta.2 - 2022/3/2
-
+
+ ## 3.24.0-beta.2 - 2022/3/2
+
 - add bin folder
 
  ## 3.24.0-beta.1 - 2022/3/2

package/README.md

@@ -522,11 +522,15 @@ cy.eyesClose();
 #### GetAllTestResults
 
 Returns an object with the applitools test results from a given test / test file.
-This should be called after `close`
+This should be called after `close`. For example:
 
 ```js
- cy.eyesGetAllTestResults()
- ```
+after(() => {
+  cy.eyesGetAllTestResults().then(results => {
+    console.log(results)
+  })
+})
+```
 
 ## Concurrency
 

package/dist/browser/spec-driver.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
 function executeScript(context, script, arg) {
-    // context = getCurrenctContext(context)
+    context = refreshContext(context);
     let scriptToExecute;
     if (script.includes('dom-snapshot') ||
         script.includes('dom-capture') ||
@@ -55,10 +55,11 @@ function transformSelector(selector) {
 }
 exports.transformSelector = transformSelector;
 function findElement(context, selector, parent) {
-    // context = getCurrenctContext(context)
+    context = refreshContext(context);
+    const eyesSelector = selector;
     const root = parent !== null && parent !== void 0 ? parent : context;
-    const sel = typeof selector === 'string' ? selector : selector.selector;
-    if (typeof selector !== 'string' && selector.type === 'xpath') {
+    const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
+    if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
         return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
     }
     else {
@@ -67,10 +68,11 @@ function findElement(context, selector, parent) {
 }
 exports.findElement = findElement;
 function findElements(context, selector, parent) {
-    // context = getCurrenctContext(context)
+    context = refreshContext(context);
+    const eyesSelector = selector;
     const root = parent !== null && parent !== void 0 ? parent : context;
-    const sel = typeof selector === 'string' ? selector : selector.selector;
-    if (typeof selector !== 'string' && selector.type === 'xpath') {
+    const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
+    if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
         // TODO return multiple
         return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
     }
@@ -80,12 +82,12 @@ function findElements(context, selector, parent) {
 }
 exports.findElements = findElements;
 function getTitle(context) {
-    // context = getCurrenctContext(context)
+    context = refreshContext(context);
     return context.title;
 }
 exports.getTitle = getTitle;
 function getUrl(context) {
-    // context = getCurrenctContext(context)
+    context = refreshContext(context);
     return context.location.href;
 }
 exports.getUrl = getUrl;
@@ -95,7 +97,7 @@ function getCookies() {
 }
 exports.getCookies = getCookies;
 // we need to method to reset the context in case the user called open before visit
-function getCurrenctContext(context) {
+function refreshContext(context) {
     //@ts-ignore
     return (context && context.defaultView) ? context : cy.state('window').document;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.24.0-beta.2",
+  "version": "3.24.0-beta.5",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -47,7 +47,7 @@
   },
   "dependencies": {
     "@applitools/dom-snapshot": "4.5.12",
-    "@applitools/eyes-universal": "1.1.0",
+    "@applitools/eyes-universal": "1.1.1-beta.1",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "1.0.11",
     "@applitools/visual-grid-client": "15.9.0",

package/src/browser/commands.js

@@ -32,15 +32,35 @@ const shouldUseBrowserHooks =
   (getGlobalConfigProperty('isInteractive') ||
     !getGlobalConfigProperty('eyesIsGlobalHooksSupported'));
 
-Cypress.Commands.add('eyesGetAllTestResults', async () => {
-  if (isCurrentTestDisabled) {
-    isCurrentTestDisabled = false;
-    return;
-  }
-  await Promise.all(closePromiseArr);
-  return socket.request('EyesManager.closeAllEyes', {manager, throwErr});
+Cypress.Commands.add('eyesGetAllTestResults', () => {
+  return cy.then({timeout: 86400000}, async () => {
+    if (isCurrentTestDisabled) {
+      isCurrentTestDisabled = false;
+      return;
+    }
+    await Promise.all(closePromiseArr);
+    const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});
+    return summary // TODO delete this line
+
+
+    // // TODO wrap with TestResultSummary class
+    // const deleteTest = ({testId, batchId, secretToken}) => {
+    //   const {serverUrl, proxy, apiKey} = Cypress.config('appliConfFile')
+    //   return socket.request('Core.deleteTest', {testId, batchId, secretToken, serverUrl, proxy, apiKey})
+    // }
+
+    // return new TestResultsSummary({summary, deleteTest})
+  });
 });
 
+
+// class TestResultSummary {
+//   constructor({summary, deleteTest}) {
+//     // same as in eyes-api
+//   }
+// }
+
+
 if (shouldUseBrowserHooks) {
   after(() => {
     if (!manager) return;
@@ -57,7 +77,8 @@ if (shouldUseBrowserHooks) {
         tapFileName: Cypress.config('appliConfFile').tapFileName,
       };
       await Promise.all(closePromiseArr);
-      const testResults = await socket.request('EyesManager.closeAllEyes', {manager, throwErr});
+      const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});
+      const testResults = summary.results.map(({testResults}) => testResults)
       const message = await socket.request('Test.printTestResults', {testResults, resultConfig});
       if (
         !!getGlobalConfigProperty('eyesFailCypressOnDiff') &&

package/src/browser/eyesCheckMapping.js

@@ -22,11 +22,11 @@ function toCheckWindowConfiguration(config = {}) {
     name: config.tag,
     scriptHooks: config.hooks,
     ignoreRegions: config.ignore,
-    floatingRegions: config.floating,
+    floatingRegions: convertFloatingRegion(config.floating),
     strictRegions: config.strict,
     layoutRegions: config.layout,
     contentRegions: config.content,
-    accessibilityRegions: config.accessibility,
+    accessibilityRegions: convertAccessabilityRegions(config.accessibility),
   };
 
   if (config.target === 'region') {
@@ -68,4 +68,36 @@ function toCheckWindowConfiguration(config = {}) {
   return Object.assign({}, checkSettings, regionSettings, config);
 }
 
+function convertAccessabilityRegions(accessibilityRegions) {
+  if (!accessibilityRegions) return accessibilityRegions;
+
+  return accessibilityRegions.map(region => ({
+    region: region.selector,
+    type: region.accessibilityType,
+  }))
+}
+
+function convertFloatingRegion(floatingRegions){
+  if(!floatingRegions) return floatingRegions
+
+  return floatingRegions.map(region => {
+    const floatingRegion = {
+      maxDownOffset: region.maxDownOffset || 0,
+      maxLeftOffset: region.maxLeftOffset || 0,
+      maxUpOffset: region.maxUpOffset || 0,
+      maxRightOffset: region.maxRightOffset || 0
+    }
+    if(region.hasOwnProperty('selector')){
+      floatingRegion.region = region.selector
+    } else {
+      floatingRegion.region = {
+        top: region.top,
+        left: region.left,
+        width: region.width,
+        height: region.height,
+      }
+    }
+  })
+}
+
 module.exports = {eyesCheckMapValues};

package/src/browser/eyesOpenMapping.js

@@ -1,5 +1,15 @@
 function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks}) {
   let browsersInfo = args.browser || appliConfFile.browser;
+  let accessibilitySettings = args.accessibilityValidation || appliConfFile.accessibilityValidation;
+  const mappedValues = [
+    'accessibilityValidation',
+    'browser',
+    'useDom',
+    'matchLevel',
+    'enablePatterns',
+    'ignoreDisplacements',
+    'ignoreCaret',
+  ];
 
   if (browsersInfo) {
     if (Array.isArray(browsersInfo)) {
@@ -10,14 +20,30 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
     }
   }
 
+  const defaultMatchSettings = {
+    accessibilitySettings,
+    matchLevel: args.matchLevel || appliConfFile.matchLevel,
+    ignoreCaret: args.ignoreCaret || appliConfFile.ignoreCaret,
+    useDom: args.useDom || appliConfFile.useDom,
+    enablePatterns: args.enablePatterns || appliConfFile.enablePatterns,
+    ignoreDisplacements: args.ignoreDisplacements || appliConfFile.ignoreDisplacements,
+  };
+
+  for (const val of mappedValues) {
+    if (args.hasOwnProperty(val)) {
+      delete args[val];
+    }
+    if (appliConfFile.hasOwnProperty(val)) {
+      delete appliConfFile[val];
+    }
+  }
+
   const mappedArgs = {
     ...args,
     browsersInfo,
+    defaultMatchSettings,
   };
 
-  delete mappedArgs.browser;
-  delete appliConfFile.browser;
-
   return Object.assign(
     {testName, dontCloseBatches: !shouldUseBrowserHooks},
     appliConfFile,

package/src/browser/spec-driver.ts

@@ -1,9 +1,10 @@
-export type Selector = (string | {selector: string; type?: string}) & {__applitoolsBrand?: never};
+type EyesSelector = {selector: string; type?: string}
+export type Selector = (string | EyesSelector) & {__applitoolsBrand?: never};
 export type Context = Document & {__applitoolsBrand?: never};
 export type Element = HTMLElement & {__applitoolsBrand?: never};
 
 export function executeScript(context: Context, script: string, arg: any): any {     
-  context = getCurrenctContext(context)
+  context = refreshContext(context)
 
       let scriptToExecute;
       if (
@@ -52,17 +53,18 @@ export function setViewportSize(vs: any): void {
 }
 
 export function transformSelector(selector: Selector): Selector {
-  if (selector.hasOwnProperty('selector') && (!selector.hasOwnProperty('type') || selector.type === 'css')) {
-    return selector.selector
+  if (selector.hasOwnProperty('selector') && (!selector.hasOwnProperty('type') || (selector as EyesSelector).type === 'css')) {
+    return (selector as EyesSelector).selector
   }
   return selector
 }
 
 export function findElement(context: Context, selector: Selector, parent?: Element) {
-  // context = getCurrenctContext(context)
+  context = refreshContext(context)
+  const eyesSelector = (selector as EyesSelector)
   const root = parent ?? context
-  const sel = typeof selector === 'string' ? selector : selector.selector
-  if (typeof selector !== 'string' && selector.type === 'xpath') {
+  const sel = typeof selector === 'string' ? selector : eyesSelector.selector
+  if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
     return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
   } else {
     return root.querySelector(sel)
@@ -70,10 +72,11 @@ export function findElement(context: Context, selector: Selector, parent?: Eleme
 }
 
 export function findElements(context: Context, selector: Selector, parent: Element){
-  context = getCurrenctContext(context)
+  context = refreshContext(context)
+  const eyesSelector = (selector as EyesSelector)
   const root = parent ?? context
-  const sel = typeof selector === 'string' ? selector : selector.selector
-  if (typeof selector !== 'string' && selector.type === 'xpath') {
+  const sel = typeof selector === 'string' ? selector : eyesSelector.selector
+  if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
     // TODO return multiple
     return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
   } else {
@@ -82,12 +85,12 @@ export function findElements(context: Context, selector: Selector, parent: Eleme
 }
 
 export function getTitle(context: Context): string {
-  context = getCurrenctContext(context)
+  context = refreshContext(context)
   return context.title
 }
 
 export function getUrl(context: Context): string {
-  context = getCurrenctContext(context)
+  context = refreshContext(context)
   return context.location.href
 }
 
@@ -97,7 +100,7 @@ export function getCookies(): Array<any> {
 }
 
 // we need to method to reset the context in case the user called open before visit
-function getCurrenctContext(context: Context){
+function refreshContext(context: Context) {
   //@ts-ignore
   return (context && context.defaultView) ? context : cy.state('window').document
 }

package/src/plugin/hooks.js

@@ -3,7 +3,7 @@ const flatten = require('lodash.flatten');
 const {TestResults} = require('@applitools/visual-grid-client');
 const handleTestResults = require('./handleTestResults');
 
-function makeGlobalRunHooks({closeAllEyes, closeBatches, closeUniversalServer}) {
+function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer}) {
   return {
     'before:run': ({config}) => {
       if (!config.isTextTerminal) return;
@@ -17,7 +17,8 @@ function makeGlobalRunHooks({closeAllEyes, closeBatches, closeUniversalServer})
           eyesFailCypressOnDiff: config.eyesFailCypressOnDiff,
           isTextTerminal: config.isTextTerminal,
         };
-        const testResults = await closeAllEyes();
+        const summary = await closeManager();
+        const testResults = summary.results.map(({testResults}) => testResults);
         const testResultsArr = [];
         for (const result of flatten(testResults)) {
           testResultsArr.push(new TestResults(result));