@applitools/eyes-cypress 3.26.1 → 3.26.2

package/CHANGELOG.md

@@ -8,6 +8,17 @@
 
 
 
+
+## 3.26.2 - 2022/6/8
+
+### Features
+- add support for secure websocket
+- Allowed `` values in custom properties
+### Bug fixes
+- Fix incorrect test results when dealing with a page that contains CORS iframes
+- Fixed broken links to enums implementation in the README.md
+- Fix calling `waitBeforeCapture` when failed to set required viewport size
+
 ## 3.26.1 - 2022/6/2
 
 ### Features

package/README.md

@@ -173,43 +173,66 @@ Applitools will take screenshots and perform the visual comparisons in the backg
 <br/>
 
 ### Index
-- [Commands](#Commands)
-  - [Open](#Open)
-  - [CheckWindow](#Check-window)
-    - [tag](#tag)
-    - [target](#target)
-    - [fully](#fully)
-    - [selector](#selector)
-    - [region](#region)
-    - [ignore](#ignore)
-    - [floating](#floating)
-    - [layout](#layout)
-    - [strict](#strict)
-    - [content](#content)
-    - [accessibility](#accessibility)
-    - [region in shadow DOM](#region-in-shadow-dom)
-    - [scriptHooks](#scriptHooks)
-    - [layoutBreakpoints](#layoutBreakpoints)
-    - [sendDom](#sendDom)
-    - [variationGroupId](#variationGroupId)
-    - [waitBeforeCapture](#waitBeforeCapture)
-  - [Close](#Close)
-  - [GetAllTestResults](#GetAllTestResults)
-  - [deletTestResults](#deleteTestResults)
-- [Concurrency](#Concurrency)
-- [Advanced configuration](#Advanced-configuration)
-  - [Scoped configuration](#Here-are-the-available-configuration-properties)
-  - [Global configuration](#global-configuration-properties)
-  - [Examples](#Method-1-Arguments-for-cyeyesOpen)
-    - [Arguments for `cy.eyesOpen`](#Method-1-Arguments-for-cyeyesOpen)
-    - [Environment variables](#Method-2-Environment-variables)
-    - [The `applitools.config.js` file](#Method-3-The-applitoolsconfigjs-file)
-- [Configuring the browser](#Configuring-the-browser)
-  - [Device emulation](#Device-emulation)
-- [IDE Code Completion](#Intelligent-Code-Completion)
-  - [Triple slash directives](#1-Triple-slash-directives)
-  - [Reference type declarations via `tsconfig`](#2-Reference-type-declarations-via-tsconfig)
-- [Troubleshooting](#Troubleshooting)
+- [Eyes-Cypress](#eyes-cypress)
+  - [Installation](#installation)
+    - [Install npm package](#install-npm-package)
+    - [Configure plugin and commands](#configure-plugin-and-commands)
+      - [Automatic configuration](#automatic-configuration)
+      - [Manual configuration](#manual-configuration)
+        - [1. Configure Eyes-Cypress plugin](#1-configure-eyes-cypress-plugin)
+        - [2. Configure custom commands](#2-configure-custom-commands)
+        - [3. (Optional) TypeScript configuration](#3-optional-typescript-configuration)
+    - [Applitools API key](#applitools-api-key)
+    - [Eyes server URL (optional)](#eyes-server-url-optional)
+  - [Usage](#usage)
+    - [Example](#example)
+    - [Best practice for using the SDK](#best-practice-for-using-the-sdk)
+    - [Index](#index)
+    - [Commands](#commands)
+      - [Open](#open)
+      - [Check window](#check-window)
+        - [Arguments to `cy.eyesCheckWindow`](#arguments-to-cyeyescheckwindow)
+        - [`tag`](#tag)
+        - [`target`](#target)
+        - [`fully`](#fully)
+        - [`selector`](#selector)
+        - [`region`](#region)
+        - [`element`](#element)
+        - [`ignore`](#ignore)
+        - [`floating`](#floating)
+        - [`layout`](#layout)
+        - [`strict`](#strict)
+        - [`content`](#content)
+        - [`accessibility`](#accessibility)
+        - [`region in shadow DOM`](#region-in-shadow-dom)
+        - [`scriptHooks`](#scripthooks)
+        - [`layoutBreakpoints`](#layoutbreakpoints)
+        - [`sendDom`](#senddom)
+        - [`variationGroupId`](#variationgroupid)
+        - [`waitBeforeCapture`](#waitbeforecapture)
+        - [`useDom`](#usedom)
+        - [`enablePatterns`](#enablepatterns)
+        - [`matchLevel`](#matchlevel)
+        - [`visualGridOptions`](#visualgridoptions)
+      - [Close](#close)
+      - [GetAllTestResults](#getalltestresults)
+      - [deleteTestResults](#deletetestresults)
+  - [Concurrency](#concurrency)
+  - [Advanced configuration](#advanced-configuration)
+    - [Here are the available configuration properties:](#here-are-the-available-configuration-properties)
+    - [Global configuration properties:](#global-configuration-properties)
+    - [Method 1: Arguments for `cy.eyesOpen`](#method-1-arguments-for-cyeyesopen)
+    - [Method 2: Environment variables](#method-2-environment-variables)
+    - [Method 3: The `applitools.config.js` file](#method-3-the-applitoolsconfigjs-file)
+  - [Configuring the browser](#configuring-the-browser)
+    - [Previous browser versions](#previous-browser-versions)
+    - [Getting a screenshot of multiple browsers in parallel](#getting-a-screenshot-of-multiple-browsers-in-parallel)
+    - [Device emulation](#device-emulation)
+    - [iOS device](#ios-device)
+  - [Intelligent Code Completion](#intelligent-code-completion)
+      - [There are two ways you can add Eyes-Cypress intelliSense to your tests:](#there-are-two-ways-you-can-add-eyes-cypress-intellisense-to-your-tests)
+    - [1. Triple slash directives](#1-triple-slash-directives)
+    - [2. Reference type declarations via `tsconfig`](#2-reference-type-declarations-via-tsconfig)
 
 <br/><hr/><br/>
 
@@ -827,7 +850,7 @@ cy.eyesOpen({
 
 Possible values for screen orientation are `landscape` and `portrait`, and if no value is specified, the default is `portrait`.
 
-The list of device names is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/DeviceName.js
+The list of device names is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/DeviceName.ts
 
 In addition, it's possible to use chrome's device emulation with custom viewport sizes, pixel density and mobile mode, by passing `deviceScaleFactor` and `mobile` in addition to `width` and `height`. For example:
 
@@ -859,7 +882,7 @@ cy.eyesOpen({
 })
 ```
 
-The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/IosDeviceName.js
+The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/IosDeviceName.ts
 
 Possible values for `iosVersion` are:
 

package/dist/browser/spec-driver.js

@@ -2,7 +2,6 @@
 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 = refreshContext(context);
     let scriptToExecute;
     if (script.includes('dom-snapshot') ||
         script.includes('dom-capture') ||
@@ -23,13 +22,20 @@ function mainContext() {
 }
 exports.mainContext = mainContext;
 function parentContext(context) {
-    if (!context)
-        return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+    // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+    if (!context) {
+        throw new Error('Context is not accessible');
+    }
+    ;
     return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
 }
 exports.parentContext = parentContext;
 function childContext(_context, element) {
-    return element.contentDocument; // null in case of cross origin iframe
+    if (element.contentDocument)
+        return element.contentDocument;
+    else {
+        throw new Error('Context is not accessible');
+    }
 }
 exports.childContext = childContext;
 function getViewportSize() {
@@ -55,7 +61,6 @@ function transformSelector(selector) {
 }
 exports.transformSelector = transformSelector;
 function findElement(context, selector, parent) {
-    context = refreshContext(context);
     const eyesSelector = selector;
     const root = parent !== null && parent !== void 0 ? parent : context;
     const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
@@ -68,7 +73,6 @@ function findElement(context, selector, parent) {
 }
 exports.findElement = findElement;
 function findElements(context, selector, parent) {
-    context = refreshContext(context);
     const eyesSelector = selector;
     const root = parent !== null && parent !== void 0 ? parent : context;
     const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
@@ -86,12 +90,10 @@ function findElements(context, selector, parent) {
 }
 exports.findElements = findElements;
 function getTitle(context) {
-    context = refreshContext(context);
     return context.title;
 }
 exports.getTitle = getTitle;
 function getUrl(context) {
-    context = refreshContext(context);
     return context.location.href;
 }
 exports.getUrl = getUrl;
@@ -100,11 +102,6 @@ function getCookies() {
     return Cypress.automation('get:cookies', {});
 }
 exports.getCookies = getCookies;
-// we need to method to reset the context in case the user called open before visit
-function refreshContext(context) {
-    //@ts-ignore
-    return (context && context.defaultView) ? context : cy.state('window').document;
-}
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 // export function visit(page: Driver, url: string): Promise<void>; (??)
 // export function isStaleElementError(err: any): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.26.1",
+  "version": "3.26.2",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -50,24 +50,24 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.5.2",
-    "@applitools/eyes-universal": "2.6.1",
+    "@applitools/eyes-api": "1.5.4",
+    "@applitools/eyes-universal": "2.7.1",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.8",
-    "@applitools/visual-grid-client": "15.12.38",
+    "@applitools/logger": "1.1.10",
+    "@applitools/visual-grid-client": "15.12.41",
     "chalk": "3.0.0",
     "uuid": "8.3.2",
     "ws": "8.5.0"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.1",
+    "@applitools/bongo": "^2.1.4",
     "@applitools/scripts": "1.1.0",
     "@applitools/sdk-coverage-tests": "^2.3.18",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "1.0.10",
     "@applitools/test-utils": "1.3.2",
-    "@applitools/types": "^1.4.5",
-    "@applitools/utils": "1.3.3",
+    "@applitools/types": "^1.4.7",
+    "@applitools/utils": "1.3.6",
     "@types/node": "12",
     "@types/ws": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^5.10.2",

package/src/browser/commands.js

@@ -110,7 +110,7 @@ Cypress.Commands.add('eyesOpen', function(args = {}) {
     const driver = refer.ref(cy.state('window').document);
 
     if (!connectedToUniversal) {
-      socket.connect(`ws://localhost:${Cypress.config('eyesPort')}/eyes`);
+      socket.connect(`wss://localhost:${Cypress.config('eyesPort')}/eyes`);
       connectedToUniversal = true;
       socket.emit('Core.makeSDK', {
         name: 'eyes.cypress',
@@ -152,6 +152,7 @@ Cypress.Commands.add('eyesCheckWindow', (args = {}) =>
     if (isCurrentTestDisabled) return;
 
     setRootContext();
+    const driver = refer.ref(cy.state('window').document);
 
     Cypress.log({name: 'Eyes: check window'});
 
@@ -160,6 +161,7 @@ Cypress.Commands.add('eyesCheckWindow', (args = {}) =>
     return socket.request('Eyes.check', {
       eyes,
       settings: checkSettings,
+      driver,
     });
   }),
 );

package/src/browser/spec-driver.ts

@@ -4,7 +4,6 @@ export type Context = Document & {__applitoolsBrand?: never};
 export type Element = HTMLElement & {__applitoolsBrand?: never};
 
 export function executeScript(context: Context, script: string, arg: any): any {     
-  context = refreshContext(context)
 
       let scriptToExecute;
       if (
@@ -28,13 +27,20 @@ export function mainContext(): Context {
 }
 
 export function parentContext(context: Context): Context {
-  if (!context) return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+  // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+  if (!context) {
+    throw new Error('Context is not accessible')
+  }; 
   
   return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument
 }
 
 export function childContext(_context: Context, element: HTMLIFrameElement): Context {
-  return element.contentDocument // null in case of cross origin iframe
+  if(element.contentDocument)
+    return element.contentDocument
+  else {
+    throw new Error('Context is not accessible')
+  }
 }
 
 export function getViewportSize(): Object {
@@ -60,7 +66,6 @@ export function transformSelector(selector: Selector): Selector {
 }
 
 export function findElement(context: Context, selector: Selector, parent?: Element) {
-  context = refreshContext(context)
   const eyesSelector = (selector as EyesSelector)
   const root = parent ?? context
   const sel = typeof selector === 'string' ? selector : eyesSelector.selector
@@ -72,7 +77,6 @@ export function findElement(context: Context, selector: Selector, parent?: Eleme
 }
 
 export function findElements(context: Context, selector: Selector, parent: Element){
-  context = refreshContext(context)
   const eyesSelector = (selector as EyesSelector)
   const root = parent ?? context
   const sel = typeof selector === 'string' ? selector : eyesSelector.selector
@@ -91,12 +95,10 @@ export function findElements(context: Context, selector: Selector, parent: Eleme
 }
 
 export function getTitle(context: Context): string {
-  context = refreshContext(context)
   return context.title
 }
 
 export function getUrl(context: Context): string {
-  context = refreshContext(context)
   return context.location.href
 }
 
@@ -105,11 +107,6 @@ export function getCookies(): Array<any> {
   return Cypress.automation('get:cookies', {})
 }
 
-// we need to method to reset the context in case the user called open before visit
-function refreshContext(context: Context) {
-  //@ts-ignore
-  return (context && context.defaultView) ? context : cy.state('window').document
-}
 
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 

package/src/plugin/server.js

@@ -1,21 +1,46 @@
 'use strict';
-const {makeHandler} = require('../../dist/plugin/handler');
 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');
+const {Server: HttpsServer} = require('https');
+const {Server: WSServer} = require('ws');
 
 function makeStartServer({logger}) {
   return async function startServer() {
-    const {server, port} = await makeHandler({singleton: false});
+    const key = fs.readFileSync(path.resolve(__dirname, '../pem/server.key'));
+    const cert = fs.readFileSync(path.resolve(__dirname, '../pem/server.cert'));
+    let port;
 
-    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess();
+    const https = new HttpsServer({
+      key,
+      cert,
+    });
+    await https.listen(0, err => {
+      if (err) {
+        logger.log('error starting plugin server', err);
+      } else {
+        logger.log(`plugin server running at port: ${https.address().port}`);
+        port = https.address().port;
+      }
+    });
+
+    const wss = new WSServer({server: https, path: '/eyes', maxPayload: 254 * 1024 * 1024});
+
+    wss.on('close', () => https.close());
+
+    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess({
+      key: path.resolve(__dirname, '../pem/server.key'),
+      cert: path.resolve(__dirname, '../pem/server.cert'),
+    });
 
     const managers = [];
     let socketWithUniversal;
 
-    server.on('connection', socketWithClient => {
-      socketWithUniversal = connectSocket(`ws://localhost:${universalPort}/eyes`);
+    wss.on('connection', socketWithClient => {
+      socketWithUniversal = connectSocket(`wss://localhost:${universalPort}/eyes`);
 
       socketWithUniversal.setPassthroughListener(message => {
         logger.log('<== ', message.toString().slice(0, 1000));
@@ -69,7 +94,7 @@ function makeStartServer({logger}) {
     });
 
     return {
-      server,
+      server: wss,
       port,
       closeManager,
       closeBatches,

package/dist/plugin/handler.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeHandler = void 0;
-const http_1 = require("http");
-const ws_1 = require("ws");
-const { name, version } = require('../../package.json'); // TODO is the handshake needed at all?
-const TOKEN_HEADER = 'x-eyes-universal-token';
-const TOKEN = `${name}@${version}`;
-// TODO make default port 0 and return actual port
-async function makeHandler({ port = 31077, singleton = true, lazy = false } = {}) {
-    const http = new http_1.Server();
-    http.on('request', (request, response) => {
-        if (request.url === '/handshake') {
-            if (request.headers[TOKEN_HEADER] === TOKEN) {
-                response.writeHead(200, { [TOKEN_HEADER]: TOKEN });
-            }
-            else {
-                response.writeHead(400);
-            }
-            response.end();
-        }
-    });
-    http.listen(port, 'localhost');
-    return new Promise((resolve, reject) => {
-        http.on('listening', () => {
-            const ws = new ws_1.Server({ server: http, path: '/eyes' });
-            ws.on('close', () => http.close());
-            resolve({ server: ws, port });
-        });
-        http.on('error', async (err) => {
-            if (!lazy && err.code === 'EADDRINUSE') {
-                if (singleton && (await isHandshakable(port))) {
-                    return resolve({ port });
-                }
-                else {
-                    return resolve(await makeHandler({ port: port + 1, singleton }));
-                }
-            }
-            reject(err);
-        });
-    });
-}
-exports.makeHandler = makeHandler;
-async function isHandshakable(port) {
-    return new Promise(resolve => {
-        const handshake = (0, http_1.request)(`http://localhost:${port}/handshake`, {
-            headers: { [TOKEN_HEADER]: TOKEN },
-        });
-        handshake.on('response', ({ statusCode, headers }) => {
-            resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN);
-        });
-        handshake.on('error', () => resolve(false));
-        handshake.end();
-    });
-}

package/src/plugin/handler.ts

@@ -1,58 +0,0 @@
-import {Server as HTTPServer, request} from 'http'
-import {Server as WSServer} from 'ws'
-
-const {name, version} = require('../../package.json') // TODO is the handshake needed at all?
-const TOKEN_HEADER = 'x-eyes-universal-token'
-const TOKEN = `${name}@${version}`
-
-// TODO make default port 0 and return actual port
-export async function makeHandler({port = 31077, singleton = true, lazy = false} = {}): Promise<{
-  server?: WSServer
-  port: number
-}> {
-  const http = new HTTPServer()
-  http.on('request', (request, response) => {
-    if (request.url === '/handshake') {
-      if (request.headers[TOKEN_HEADER] === TOKEN) {
-        response.writeHead(200, {[TOKEN_HEADER]: TOKEN})
-      } else {
-        response.writeHead(400)
-      }
-      response.end()
-    }
-  })
-
-  http.listen(port, 'localhost')
-
-  return new Promise((resolve, reject) => {
-    http.on('listening', () => {
-      const ws = new WSServer({server: http, path: '/eyes'})
-      ws.on('close', () => http.close())
-      resolve({server: ws, port})
-    })
-
-    http.on('error', async (err: Error & {code: string}) => {
-      if (!lazy && err.code === 'EADDRINUSE') {
-        if (singleton && (await isHandshakable(port))) {
-          return resolve({port})
-        } else {
-          return resolve(await makeHandler({port: port + 1, singleton}))
-        }
-      }
-      reject(err)
-    })
-  })
-}
-
-async function isHandshakable(port: number) {
-  return new Promise(resolve => {
-    const handshake = request(`http://localhost:${port}/handshake`, {
-      headers: {[TOKEN_HEADER]: TOKEN},
-    })
-    handshake.on('response', ({statusCode, headers}) => {
-      resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN)
-    })
-    handshake.on('error', () => resolve(false))
-    handshake.end()
-  })
-}