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

package/bin/eyes-setup.js

@@ -1,21 +1,21 @@
-#!/usr/bin/env node
-'use strict';
-
-const chalk = require('chalk');
-const handlePlugin = require('../src/setup/handlePlugin');
-const handleCommands = require('../src/setup/handleCommands');
-const handleTypeScript = require('../src/setup/handleTypeScript');
-const {version} = require('../package');
-const cwd = process.cwd();
-
-console.log(chalk.cyan('Setup eyes-cypress', version));
-
-try {
-  handlePlugin(cwd);
-  handleCommands(cwd);
-  handleTypeScript(cwd);
-} catch (e) {
-  console.log(chalk.red('Setup error:\n', e));
-}
-
-console.log(chalk.cyan('Setup done!'));
+#!/usr/bin/env node
+'use strict';
+
+const chalk = require('chalk');
+const handlePlugin = require('../src/setup/handlePlugin');
+const handleCommands = require('../src/setup/handleCommands');
+const handleTypeScript = require('../src/setup/handleTypeScript');
+const {version} = require('../package');
+const cwd = process.cwd();
+
+console.log(chalk.cyan('Setup eyes-cypress', version));
+
+try {
+  handlePlugin(cwd);
+  handleCommands(cwd);
+  handleTypeScript(cwd);
+} catch (e) {
+  console.log(chalk.red('Setup error:\n', e));
+}
+
+console.log(chalk.cyan('Setup done!'));

package/commands.js

@@ -1,2 +1,2 @@
-'use strict';
-require('./src/browser/commands');
+'use strict';
+require('./src/browser/commands');

package/dist/browser/spec-driver.js

@@ -0,0 +1,104 @@
+"use strict";
+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)
+    let scriptToExecute;
+    if (script.includes('dom-snapshot') ||
+        script.includes('dom-capture') ||
+        script.includes('dom-shared')) {
+        scriptToExecute = script;
+    }
+    else {
+        const prepScirpt = script.replace('function(arg)', 'function func(arg)');
+        scriptToExecute = prepScirpt.concat(' return func(arg)');
+    }
+    const executor = new context.defaultView.Function('arg', scriptToExecute);
+    return executor(arg);
+}
+exports.executeScript = executeScript;
+function mainContext() {
+    //@ts-ignore
+    return cy.state('window').document;
+}
+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
+    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
+}
+exports.childContext = childContext;
+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)
+    };
+    return viewportSize;
+}
+exports.getViewportSize = getViewportSize;
+function setViewportSize(vs) {
+    //@ts-ignore
+    Cypress.action('cy:viewport:changed', { viewportWidth: vs.size.width, viewportHeight: vs.size.height });
+}
+exports.setViewportSize = setViewportSize;
+function transformSelector(selector) {
+    if (selector.hasOwnProperty('selector') && (!selector.hasOwnProperty('type') || selector.type === 'css')) {
+        return selector.selector;
+    }
+    return selector;
+}
+exports.transformSelector = transformSelector;
+function findElement(context, selector, parent) {
+    // context = getCurrenctContext(context)
+    const root = parent !== null && parent !== void 0 ? parent : context;
+    const sel = typeof selector === 'string' ? selector : selector.selector;
+    if (typeof selector !== 'string' && selector.type === 'xpath') {
+        return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+    }
+    else {
+        return root.querySelector(sel);
+    }
+}
+exports.findElement = findElement;
+function findElements(context, selector, parent) {
+    // context = getCurrenctContext(context)
+    const root = parent !== null && parent !== void 0 ? parent : context;
+    const sel = typeof selector === 'string' ? selector : selector.selector;
+    if (typeof selector !== 'string' && selector.type === 'xpath') {
+        // TODO return multiple
+        return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+    }
+    else {
+        return root.querySelectorAll(sel);
+    }
+}
+exports.findElements = findElements;
+function getTitle(context) {
+    // context = getCurrenctContext(context)
+    return context.title;
+}
+exports.getTitle = getTitle;
+function getUrl(context) {
+    // context = getCurrenctContext(context)
+    return context.location.href;
+}
+exports.getUrl = getUrl;
+function getCookies() {
+    //@ts-ignore
+    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 getCurrenctContext(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/dist/plugin/handler.js

@@ -0,0 +1,55 @@
+"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 = 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/eyes-index.d.ts

@@ -1,34 +1,34 @@
-/// <reference types="Cypress" />
-/// <reference types="@applitools/visual-grid-client" />
-
-declare namespace Cypress {
-    interface Chainable {
-      /**
-       * Create an Applitools test.
-       * This will start a session with the Applitools server.
-       * @example
-       * cy.eyesOpen({ appName: 'My App' })
-      */
-      eyesOpen(options?: Eyes.Open.Options): null // add isDisabled
-
-      /**
-       * Generate a screenshot of the current page and add it to the Applitools Test.
-       * @example
-       * cy.eyesCheckWindow()
-       *
-       * OR
-       *
-       * cy.eyesCheckWindow({
-       *  target: 'region',
-       *  selector: '.my-element'
-       * });
-      */
-      eyesCheckWindow(config?: Eyes.Check.Options|String): null
-
-      /**
-       * Close the applitools test and check that all screenshots are valid.
-       * @example cy.eyesClose()
-      */
-      eyesClose(): null
-    }
-  }
+/// <reference types="Cypress" />
+/// <reference types="@applitools/visual-grid-client" />
+
+declare namespace Cypress {
+    interface Chainable {
+      /**
+       * Create an Applitools test.
+       * This will start a session with the Applitools server.
+       * @example
+       * cy.eyesOpen({ appName: 'My App' })
+      */
+      eyesOpen(options?: Eyes.Open.Options): null // add isDisabled
+
+      /**
+       * Generate a screenshot of the current page and add it to the Applitools Test.
+       * @example
+       * cy.eyesCheckWindow()
+       *
+       * OR
+       *
+       * cy.eyesCheckWindow({
+       *  target: 'region',
+       *  selector: '.my-element'
+       * });
+      */
+      eyesCheckWindow(config?: Eyes.Check.Options|String): null
+
+      /**
+       * Close the applitools test and check that all screenshots are valid.
+       * @example cy.eyesClose()
+      */
+      eyesClose(): null
+    }
+  }

package/index.js

@@ -1,2 +1,2 @@
-'use strict';
-module.exports = require('./src/plugin/startPlugin');
+'use strict';
+module.exports = require('./src/plugin/startPlugin');

package/package.json

@@ -1,81 +1,97 @@
-{
-  "name": "@applitools/eyes-cypress",
-  "version": "3.23.9",
-  "main": "index.js",
-  "license": "SEE LICENSE IN LICENSE",
-  "bin": {
-    "eyes-setup": "./bin/eyes-setup.js"
-  },
-  "scripts": {
-    "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",
-    "test:unit": "mocha --no-timeouts 'test/unit/**/*.test.js'",
-    "test:it": "mocha --no-timeouts 'test/it/**/*.test.js'",
-    "test:e2e": "mkdir -p test/fixtures/testAppCopies && mocha --no-timeouts 'test/e2e/**/*.test.js'",
-    "lint": "eslint '**/*.js'",
-    "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn lint",
-    "cypress": "cd test/fixtures/testApp && cypress open --config integrationFolder=cypress/integration-play,pluginsFile=cypress/plugins/index-play.js,supportFile=cypress/support/index-play.js",
-    "cypress:run": "cd test/fixtures/testApp && cypress run --config integrationFolder=cypress/integration-run,pluginsFile=cypress/plugins/index-run.js,supportFile=cypress/support/index-run.js",
-    "cypress:play": "cd test/fixtures/testApp && cypress run --config integrationFolder=cypress/integration-play,pluginsFile=cypress/plugins/index-play.js,supportFile=cypress/support/index-run.js --spec=cypress/integration-play/play.js",
-    "gh:publish": "gh workflow run publish-cypress.yml --ref $(git rev-parse --abbrev-ref HEAD)",
-    "preversion": "bongo preversion --skip-deps",
-    "version": "bongo version",
-    "postversion": "bongo postversion --skip-release-notification",
-    "deps": "bongo deps",
-    "prepublish:setup": "sudo apt-get install xvfb"
-  },
-  "files": [
-    "src",
-    "bin",
-    "index.js",
-    "commands.js",
-    "eyes-index.d.ts"
-  ],
-  "types": "./eyes-index.d.ts",
-  "engines": {
-    "node": ">=8.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
-    "directory": "packages/eyes-cypress"
-  },
-  "dependencies": {
-    "@applitools/dom-snapshot": "4.5.12",
-    "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.0.11",
-    "@applitools/visual-grid-client": "15.9.0",
-    "body-parser": "1.19.0",
-    "chalk": "3.0.0",
-    "cors": "2.8.5",
-    "express": "4.17.1",
-    "lodash.flatten": "4.4.0",
-    "throat": "6.0.1"
-  },
-  "devDependencies": {
-    "@applitools/scripts": "^1.1.0",
-    "@applitools/sdk-release-kit": "0.13.11",
-    "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.0.8",
-    "chai": "^4.2.0",
-    "chai-spies": "^1.0.0",
-    "cookie-parser": "^1.4.4",
-    "cypress": "^6.5.0",
-    "eslint": "^6.8.0",
-    "eslint-plugin-mocha-no-only": "^1.1.0",
-    "eslint-plugin-node": "^7.0.1",
-    "eslint-plugin-prettier": "^2.7.0",
-    "husky": "^4.3.8",
-    "lodash.omit": "^4.5.0",
-    "mocha": "^8.0.1",
-    "morgan": "^1.9.1",
-    "ncp": "^2.0.0",
-    "node-fetch": "^2.6.7",
-    "prettier": "^1.19.1",
-    "typescript": "^3.9.2"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
-  }
-}
+{
+  "name": "@applitools/eyes-cypress",
+  "version": "3.24.0-beta.2",
+  "main": "index.js",
+  "license": "SEE LICENSE IN LICENSE",
+  "bin": {
+    "eyes-setup": "./bin/eyes-setup.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "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",
+    "test:unit": "mocha --no-timeouts 'test/unit/**/*.test.js'",
+    "test:it": "mocha --no-timeouts 'test/it/**/*.test.js'",
+    "test:e2e": "mkdir -p test/fixtures/testAppCopies && mocha --no-timeouts 'test/e2e/**/*.test.js'",
+    "lint": "echo 'lint'",
+    "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn lint",
+    "cypress": "cypress open --config-file test/fixtures/cypress-play.json",
+    "cypress:new": "node_modules/cypress-new/bin/cypress open --config-file test/fixtures/cypress-play.json",
+    "cypress:run": "cypress run --config-file test/fixtures/cypress-play.json --spec=test/fixtures/testApp/cypress/integration-play/play.js",
+    "cypress:run:new": "node_modules/cypress-new/bin/cypress run --config-file test/fixtures/cypress-play.json --spec=test/fixtures/testApp/cypress/integration-play/play.js",
+    "cypress:play": "cd test/fixtures/testApp && cypress run --config integrationFolder=cypress/integration-play,pluginsFile=cypress/plugins/index-play.js,supportFile=cypress/support/index-run.js --spec=cypress/integration-play/play.js",
+    "preversion": "bongo preversion --skip-deps",
+    "version": "bongo version",
+    "postversion": "bongo postversion --skip-release-notification",
+    "deps": "bongo deps",
+    "generate:tests": "coverage-tests generate",
+    "test:coverage": "cd test/coverage/generic && cypress run ; cd -",
+    "test:coverage-custom": "cd test/coverage/generic && cypress run --config integrationFolder=cypress/integration-custom/",
+    "prepublish:setup": "sudo apt-get install xvfb"
+  },
+  "files": [
+    "src",
+    "dist",
+    "bin",
+    "index.js",
+    "commands.js",
+    "eyes-index.d.ts"
+  ],
+  "types": "./eyes-index.d.ts",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/eyes-cypress"
+  },
+  "dependencies": {
+    "@applitools/dom-snapshot": "4.5.12",
+    "@applitools/eyes-universal": "1.1.0",
+    "@applitools/functional-commons": "1.6.0",
+    "@applitools/logger": "1.0.11",
+    "@applitools/visual-grid-client": "15.9.0",
+    "body-parser": "1.19.0",
+    "chalk": "3.0.0",
+    "cors": "2.8.5",
+    "express": "4.17.1",
+    "lodash.flatten": "4.4.0",
+    "uuid": "8.3.2",
+    "ws": "8.5.0"
+  },
+  "devDependencies": {
+    "@applitools/scripts": "1.1.0",
+    "@applitools/sdk-coverage-tests": "^2.3.18",
+    "@applitools/sdk-release-kit": "0.13.11",
+    "@applitools/snaptdout": "1.0.1",
+    "@applitools/test-server": "1.0.8",
+    "@applitools/types": "^1.1.0",
+    "@applitools/utils": "1.2.13",
+    "@types/node": "17.0.13",
+    "@types/ws": "^8.2.2",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "chai": "4.2.0",
+    "chai-spies": "1.0.0",
+    "cookie-parser": "1.4.4",
+    "cypress": "6.5.0",
+    "cypress-new": "npm:cypress@9",
+    "eslint": "6.8.0",
+    "eslint-plugin-mocha-no-only": "1.1.0",
+    "eslint-plugin-node": "7.0.1",
+    "eslint-plugin-prettier": "2.7.0",
+    "husky": "4.3.8",
+    "lodash.omit": "4.5.0",
+    "mocha": "8.0.1",
+    "morgan": "1.9.1",
+    "ncp": "2.0.0",
+    "node-fetch": "2.6.0",
+    "prettier": "1.19.1",
+    "typescript": "3.9.2"
+  },
+  "husky": {
+    "hooks": {
+      "pre-push": "yarn bongo lint"
+    }
+  }
+}