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

package/package.json

@@ -1,97 +1,98 @@
-{
-  "name": "@applitools/eyes-cypress",
-  "version": "3.24.0-beta.5",
-  "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.1-beta.1",
-    "@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"
-    }
-  }
-}
+{
+  "name": "@applitools/eyes-cypress",
+  "version": "3.25.0",
+  "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": "eslint \"**/*.js\"",
+    "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn test:coverage",
+    "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": "yarn build && bongo preversion --skip-deps",
+    "version": "bongo version",
+    "postversion": "bongo postversion --skip-release-notification",
+    "deps": "bongo deps",
+    "generate:tests": "coverage-tests generate",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic &&  unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) cypress run ; cd -",
+    "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-api": "1.2.0",
+    "@applitools/eyes-universal": "2.0.1",
+    "@applitools/functional-commons": "1.6.0",
+    "@applitools/logger": "1.0.11",
+    "@applitools/visual-grid-client": "15.10.1",
+    "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/test-utils": "1.1.5",
+    "@applitools/types": "^1.2.2",
+    "@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": "8.10.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"
+    }
+  }
+}

package/src/browser/commands.js

@@ -1,188 +1,188 @@
-/* global Cypress,cy,after,navigator */
-'use strict';
-const spec = require('../../dist/browser/spec-driver');
-const Refer = require('./refer');
-const Socket = require('./socket');
-const {socketCommands} = require('./socketCommands');
-const {eyesOpenMapValues} = require('./eyesOpenMapping');
-const {eyesCheckMapValues} = require('./eyesCheckMapping');
-
-const refer = new Refer(value => {
-  if (!value || !value.constructor || !value.constructor.name) return false;
-  const name = value.constructor.name;
-  return name === 'HTMLDocument' || name === 'Window' || value.ownerDocument;
-});
-const socket = new Socket();
-const throwErr = Cypress.config('failCypressOnDiff');
-socketCommands(socket, refer);
-let connectedToUniversal = false;
-
-let manager,
-  eyes,
-  closePromiseArr = [];
-
-function getGlobalConfigProperty(prop) {
-  const property = Cypress.config(prop);
-  const shouldParse = ['eyesBrowser', 'eyesLayoutBreakpoints'];
-  return property ? (shouldParse.includes(prop) ? JSON.parse(property) : property) : undefined;
-}
-
-const shouldUseBrowserHooks =
-  !getGlobalConfigProperty('eyesIsDisabled') &&
-  (getGlobalConfigProperty('isInteractive') ||
-    !getGlobalConfigProperty('eyesIsGlobalHooksSupported'));
-
-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;
-    return cy.then({timeout: 86400000}, async () => {
-      if (isCurrentTestDisabled) {
-        isCurrentTestDisabled = false;
-        return;
-      }
-      const resultConfig = {
-        showLogs: Cypress.config('appliConfFile').showLogs,
-        eyesFailCypressOnDiff: Cypress.config('eyesFailCypressOnDiff'),
-        isTextTerminal: Cypress.config('isTextTerminal'),
-        tapDirPath: Cypress.config('appliConfFile').tapDirPath,
-        tapFileName: Cypress.config('appliConfFile').tapFileName,
-      };
-      await Promise.all(closePromiseArr);
-      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') &&
-        message &&
-        message.includes('Eyes-Cypress detected diffs or errors')
-      ) {
-        throw new Error(message);
-      }
-    });
-  });
-}
-
-let isCurrentTestDisabled;
-
-Cypress.Commands.add('eyesOpen', function(args = {}) {
-  Cypress.log({name: 'Eyes: open'});
-  Cypress.config('eyesOpenArgs', args);
-  const {title: testName} = this.currentTest || this.test || Cypress.currentTest;
-
-  if (Cypress.config('eyesIsDisabled') && args.isDisabled === false) {
-    throw new Error(
-      `Eyes-Cypress is disabled by an env variable or in the applitools.config.js file, but the "${testName}" test was passed isDisabled:false. A single test cannot be enabled when Eyes.Cypress is disabled through the global configuration. Please remove "isDisabled:false" from cy.eyesOpen() for this test, or enable Eyes.Cypress in the global configuration, either by unsetting the APPLITOOLS_IS_DISABLED env var, or by deleting 'isDisabled' from the applitools.config.js file.`,
-    );
-  }
-  isCurrentTestDisabled = getGlobalConfigProperty('eyesIsDisabled') || args.isDisabled;
-  if (isCurrentTestDisabled) return;
-
-  return cy.then({timeout: 86400000}, async () => {
-    setRootContext();
-    const driver = refer.ref(cy.state('window').document);
-
-    if (!connectedToUniversal) {
-      socket.connect(`ws://localhost:${Cypress.config('eyesPort')}/eyes`);
-      connectedToUniversal = true;
-      socket.emit('Core.makeSDK', {
-        name: 'eyes.cypress',
-        version: require('../../package.json').version,
-        commands: Object.keys(spec).concat(['isSelector', 'isDriver', 'isElement']), // TODO fix spec.isSelector and spec.isDriver and spec.isElement in driver utils
-        cwd: process.cwd(),
-      });
-
-      manager =
-        manager ||
-        (await socket.request(
-          'Core.makeManager',
-          Object.assign(
-            {},
-            {concurrency: Cypress.config('eyesTestConcurrency')},
-            {legacy: false, type: 'vg'},
-          ),
-        ));
-    }
-
-    const appliConfFile = Cypress.config('appliConfFile');
-    const config = eyesOpenMapValues({
-      args,
-      appliConfFile,
-      testName,
-      shouldUseBrowserHooks,
-      defaultBrowser: {
-        width: Cypress.config('viewportWidth'),
-        height: Cypress.config('viewportHeight'),
-        name: 'chrome',
-      },
-    });
-    eyes = await socket.request('EyesManager.openEyes', {manager, driver, config});
-  });
-});
-
-Cypress.Commands.add('eyesCheckWindow', args =>
-  cy.then({timeout: 86400000}, () => {
-    if (isCurrentTestDisabled) return;
-
-    setRootContext();
-
-    Cypress.log({name: 'Eyes: check window'});
-
-    const checkSettings = eyesCheckMapValues({args});
-
-    return socket.request('Eyes.check', {
-      eyes,
-      settings: checkSettings,
-    });
-  }),
-);
-
-Cypress.Commands.add('eyesClose', () => {
-  return cy.then({timeout: 86400000}, () => {
-    if (isCurrentTestDisabled) return;
-
-    Cypress.log({name: 'Eyes: close'});
-    if (isCurrentTestDisabled) {
-      isCurrentTestDisabled = false;
-      return;
-    }
-
-    // intentionally not returning the result in order to not wait on the close promise
-    const p = socket.request('Eyes.close', {eyes, throwErr: false}).catch(err => {
-      console.log('Error in cy.eyesClose', err);
-    });
-    closePromiseArr.push(p);
-  });
-});
-
-function setRootContext() {
-  cy.state('window').document['applitools-marker'] = 'root-context';
-}
+/* global Cypress,cy,after */
+'use strict';
+const spec = require('../../dist/browser/spec-driver');
+const Refer = require('./refer');
+const Socket = require('./socket');
+const {socketCommands} = require('./socketCommands');
+const {eyesOpenMapValues} = require('./eyesOpenMapping');
+const {eyesCheckMapValues} = require('./eyesCheckMapping');
+const {TestResultsSummary} = require('@applitools/eyes-api');
+
+const refer = new Refer(value => {
+  if (!value || !value.constructor || !value.constructor.name) return false;
+  const name = value.constructor.name;
+  return name === 'HTMLDocument' || name === 'Window' || value.ownerDocument;
+});
+const socket = new Socket();
+const throwErr = Cypress.config('failCypressOnDiff');
+socketCommands(socket, refer);
+let connectedToUniversal = false;
+
+let manager,
+  eyes,
+  closePromiseArr = [];
+
+function getGlobalConfigProperty(prop) {
+  const property = Cypress.config(prop);
+  const shouldParse = ['eyesBrowser', 'eyesLayoutBreakpoints'];
+  return property ? (shouldParse.includes(prop) ? JSON.parse(property) : property) : undefined;
+}
+
+const shouldUseBrowserHooks =
+  !getGlobalConfigProperty('eyesIsDisabled') &&
+  (getGlobalConfigProperty('isInteractive') ||
+    !getGlobalConfigProperty('eyesIsGlobalHooksSupported'));
+
+Cypress.Commands.add('eyesGetAllTestResults', () => {
+  Cypress.log({name: 'Eyes: getAllTestResults'});
+  return cy.then({timeout: 86400000}, async () => {
+    if (isCurrentTestDisabled) {
+      isCurrentTestDisabled = false;
+      return;
+    }
+    await Promise.all(closePromiseArr);
+    const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});
+
+    const deleteTest = ({testId, batchId, secretToken}) => {
+      const {serverUrl, proxy, apiKey} = Cypress.config('appliConfFile');
+      return socket.request('Core.deleteTest', {
+        settings: {
+          testId,
+          batchId,
+          secretToken,
+          serverUrl,
+          proxy,
+          apiKey,
+        },
+      });
+    };
+
+    return new TestResultsSummary({summary, deleteTest});
+  });
+});
+
+if (shouldUseBrowserHooks) {
+  after(() => {
+    if (!manager) return;
+    return cy.then({timeout: 86400000}, async () => {
+      if (isCurrentTestDisabled) {
+        isCurrentTestDisabled = false;
+        return;
+      }
+      const resultConfig = {
+        showLogs: Cypress.config('appliConfFile').showLogs,
+        eyesFailCypressOnDiff: Cypress.config('eyesFailCypressOnDiff'),
+        isTextTerminal: Cypress.config('isTextTerminal'),
+        tapDirPath: Cypress.config('appliConfFile').tapDirPath,
+        tapFileName: Cypress.config('appliConfFile').tapFileName,
+      };
+      await Promise.all(closePromiseArr);
+      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') &&
+        message &&
+        message.includes('Eyes-Cypress detected diffs or errors')
+      ) {
+        throw new Error(message);
+      }
+    });
+  });
+}
+
+let isCurrentTestDisabled;
+
+Cypress.Commands.add('eyesOpen', function(args = {}) {
+  Cypress.log({name: 'Eyes: open'});
+  Cypress.config('eyesOpenArgs', args);
+  const {title: testName} = this.currentTest || this.test || Cypress.currentTest;
+
+  if (Cypress.config('eyesIsDisabled') && args.isDisabled === false) {
+    throw new Error(
+      `Eyes-Cypress is disabled by an env variable or in the applitools.config.js file, but the "${testName}" test was passed isDisabled:false. A single test cannot be enabled when Eyes.Cypress is disabled through the global configuration. Please remove "isDisabled:false" from cy.eyesOpen() for this test, or enable Eyes.Cypress in the global configuration, either by unsetting the APPLITOOLS_IS_DISABLED env var, or by deleting 'isDisabled' from the applitools.config.js file.`,
+    );
+  }
+  isCurrentTestDisabled = getGlobalConfigProperty('eyesIsDisabled') || args.isDisabled;
+  if (isCurrentTestDisabled) return;
+
+  return cy.then({timeout: 86400000}, async () => {
+    setRootContext();
+    const driver = refer.ref(cy.state('window').document);
+
+    if (!connectedToUniversal) {
+      socket.connect(`ws://localhost:${Cypress.config('eyesPort')}/eyes`);
+      connectedToUniversal = true;
+      socket.emit('Core.makeSDK', {
+        name: 'eyes.cypress',
+        version: require('../../package.json').version,
+        commands: Object.keys(spec).concat(['isSelector', 'isDriver', 'isElement']), // TODO fix spec.isSelector and spec.isDriver and spec.isElement in driver utils
+        cwd: process.cwd(),
+      });
+
+      manager =
+        manager ||
+        (await socket.request(
+          'Core.makeManager',
+          Object.assign(
+            {},
+            {concurrency: Cypress.config('eyesTestConcurrency')},
+            {legacy: false, type: 'vg'},
+          ),
+        ));
+    }
+
+    const appliConfFile = Cypress.config('appliConfFile');
+    const config = eyesOpenMapValues({
+      args,
+      appliConfFile,
+      testName,
+      shouldUseBrowserHooks,
+      defaultBrowser: {
+        width: Cypress.config('viewportWidth'),
+        height: Cypress.config('viewportHeight'),
+        name: 'chrome',
+      },
+    });
+    eyes = await socket.request('EyesManager.openEyes', {manager, driver, config});
+  });
+});
+
+Cypress.Commands.add('eyesCheckWindow', args =>
+  cy.then({timeout: 86400000}, () => {
+    if (isCurrentTestDisabled) return;
+
+    setRootContext();
+
+    Cypress.log({name: 'Eyes: check window'});
+
+    const checkSettings = eyesCheckMapValues({args});
+
+    return socket.request('Eyes.check', {
+      eyes,
+      settings: checkSettings,
+    });
+  }),
+);
+
+Cypress.Commands.add('eyesClose', () => {
+  return cy.then({timeout: 86400000}, () => {
+    if (isCurrentTestDisabled) return;
+
+    Cypress.log({name: 'Eyes: close'});
+    if (isCurrentTestDisabled) {
+      isCurrentTestDisabled = false;
+      return;
+    }
+
+    // intentionally not returning the result in order to not wait on the close promise
+    const p = socket.request('Eyes.close', {eyes, throwErr: false}).catch(err => {
+      console.log('Error in cy.eyesClose', err);
+    });
+    closePromiseArr.push(p);
+  });
+});
+
+function setRootContext() {
+  cy.state('window').document['applitools-marker'] = 'root-context';
+}