@applitools/eyes-cypress 3.26.3 → 3.26.6

package/CHANGELOG.md

@@ -9,6 +9,26 @@
 
 
 
+## 3.26.6 - 2022/7/15
+
+### Features
+- Internal architecture fixes
+### Bug fixes
+
+## 3.26.5 - 2022/7/12
+
+### Features
+### Bug fixes
+- Support string tag name in eyesCheck
+
+## 3.26.4 - 2022/7/7
+
+### Features
+- Add support for cypress 10
+### Bug fixes
+- Fix use cases where we fail to serialize elements
+- Fixed bug where a failure in a single UFG environment fails all other environments in the same configuration
+
 ## 3.26.3 - 2022/6/17
 
 ### Features

package/README.md

@@ -27,9 +27,12 @@ The above command will add the necessary imports to your cypress `pluginsFile` a
 #### Manual configuration
 
 ##### 1. Configure Eyes-Cypress plugin
-
+<br>
+ 
 Eyes-Cypress acts as a [Cypress plugin](https://docs.cypress.io/guides/tooling/plugins-guide.html), so it should be configured as such.
-Unfortunately there's no easy way to do this automatically, so you need to manually add the following code to your `pluginsFile`:
+Unfortunately there's no easy way to do this automatically, so you need to manually:
+ #### Cypress version < 10:
+Add the following code to your `pluginsFile`:
 
 **Important**: add this code **after** the definition of `module.exports`:
 
@@ -38,7 +41,16 @@ require('@applitools/eyes-cypress')(module)
 ```
 
 Normally, this is `cypress/plugins/index.js`. You can read more about it in Cypress' docs [here](https://docs.cypress.io/guides/references/configuration.html#Folders-Files).
+<br>
+
+ #### Cypress version >= 10:
 
+ Add the following code to your `cypress.config.js` file after `module.exports`:
+
+```js
+require('@applitools/eyes-cypress')(module)
+```
+This file is normally at the root of the project
 ##### 2. Configure custom commands
 
 Eyes-Cypress exposes new commands to your tests. This means that more methods will be available on the `cy` object. To enable this, it's required to configure these custom commands.
@@ -48,7 +60,7 @@ As with the plugin, there's no automatic way to configure this in cypress, so yo
 import '@applitools/eyes-cypress/commands'
 ```
 
-Normally, this is `cypress/support/index.js`. You can read more about it in Cypress' docs [here](https://docs.cypress.io/guides/references/configuration.html#Folders-Files).
+Normally, this is `cypress/support/index.js` for cypress version < 10 and `cypress/support/e2e.js` for cypress version >= 10. You can read more about it in Cypress' docs [here](https://docs.cypress.io/guides/references/configuration.html#Folders-Files).
 
 ##### 3. (Optional) TypeScript configuration
 
@@ -66,8 +78,6 @@ Add this file to your project with either:
       ```
       cp node_modules/@applitools/eyes-cypress/eyes-index.d.ts ./cypress/support/    
       ```
-
-
 ### Applitools API key
 
 In order to authenticate via the Applitools server, you need to supply the Eyes-Cypress SDK with the API key you got from Applitools. Read more about how to obtain the API key [here](https://applitools.com/docs/topics/overview/obtain-api-key.html).

package/bin/eyes-setup.js

@@ -2,18 +2,34 @@
 '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 {handlePlugin} = require('../src/setup/handlePlugin');
+const {handleCommands, handlerCommandsCypress10} = require('../src/setup/handleCommands');
+const {handleTypeScript, handlerTypeScriptCypress10} = require('../src/setup/handleTypeScript');
 const {version} = require('../package');
+const fs = require('fs');
 const cwd = process.cwd();
 
 console.log(chalk.cyan('Setup eyes-cypress', version));
+const packageJson = JSON.parse(fs.readFileSync('package.json'));
+let cypressVersion;
 
+if (packageJson.dependencies && packageJson.dependencies.cypress) {
+  cypressVersion = packageJson.dependencies.cypress;
+} else if (packageJson.devDependencies && packageJson.devDependencies.cypress) {
+  cypressVersion = packageJson.devDependencies.cypress;
+}
+console.log(chalk.cyan('Cypress version that was found', cypressVersion));
+const isCypress10 = parseFloat(cypressVersion, 10) >= 10 ? true : false;
 try {
-  handlePlugin(cwd);
-  handleCommands(cwd);
-  handleTypeScript(cwd);
+  if (!isCypress10) {
+    handlePlugin(cwd, isCypress10);
+    handleCommands(cwd);
+    handleTypeScript(cwd);
+  } else {
+    handlePlugin(cwd, isCypress10);
+    const supportFilePath = handlerCommandsCypress10(cwd);
+    handlerTypeScriptCypress10(supportFilePath);
+  }
 } catch (e) {
   console.log(chalk.red('Setup error:\n', e));
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.26.3",
+  "version": "3.26.6",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
-    "directory": "packages/eyes-cypress"
+    "directory": "js/packages/eyes-cypress"
   },
   "license": "SEE LICENSE IN LICENSE",
   "aliases": [
@@ -29,17 +29,18 @@
     "build": "tsc",
     "generate:tests": "coverage-tests generate",
     "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn test:ts && yarn test:coverage",
+    "test:sanity": "yarn test:unit && yarn test:it && yarn test:ts",
     "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'",
+    "test:it": "yarn build && mocha --no-timeouts 'test/it/**/*.test.js'",
+    "test:ts": "yarn test:ts:compile && yarn test:ts:run",
     "test:ts:compile": "tsc --project test/e2e/ts/cypress",
     "test:ts:run": "cypress run --config-file test/e2e/ts/cypress-ts.json",
-    "test:ts": "yarn test:ts:compile && yarn test:ts:run",
-    "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",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
+    "test:e2e": "mkdir -p test/fixtures/testAppCopies && mocha --no-timeouts 'test/e2e/**/*.test.js'",
     "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:new": "cd test/play && yarn && npx cypress open",
     "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:run:new": "cd test/play && yarn && npx cypress run --spec=../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",
     "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",
     "prepublish:setup": "sudo apt-get install xvfb",
@@ -54,24 +55,24 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.7.0",
-    "@applitools/eyes-universal": "2.9.1",
+    "@applitools/eyes-api": "1.7.4",
+    "@applitools/eyes-universal": "2.9.7",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.12",
-    "@applitools/visual-grid-client": "15.12.45",
+    "@applitools/logger": "1.1.15",
+    "@applitools/visual-grid-client": "15.13.6",
     "chalk": "3.0.0",
     "uuid": "8.3.2",
     "ws": "8.5.0"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.5",
+    "@applitools/bongo": "^2.1.6",
     "@applitools/scripts": "1.1.0",
-    "@applitools/sdk-coverage-tests": "^2.3.18",
+    "@applitools/sdk-coverage-tests": "^2.3.19",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.1",
-    "@applitools/test-utils": "1.3.3",
-    "@applitools/types": "^1.5.3",
-    "@applitools/utils": "1.3.8",
+    "@applitools/test-server": "1.1.4",
+    "@applitools/test-utils": "1.4.2",
+    "@applitools/types": "^1.5.5",
+    "@applitools/utils": "1.3.10",
     "@types/node": "12",
     "@types/ws": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^5.10.2",
@@ -79,8 +80,7 @@
     "chai": "4.2.0",
     "chai-spies": "1.0.0",
     "cookie-parser": "1.4.4",
-    "cypress": "6.5.0",
-    "cypress-new": "npm:cypress@9",
+    "cypress": "8.0.0",
     "eslint": "8.10.0",
     "eslint-plugin-mocha-no-only": "1.1.0",
     "eslint-plugin-node": "7.0.1",

package/src/browser/commands.js

@@ -116,7 +116,6 @@ Cypress.Commands.add('eyesOpen', function(args = {}) {
         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 =

package/src/browser/eyesCheckMapping.js

@@ -1,5 +1,8 @@
 /* global Node */
 function eyesCheckMapValues({args, refer}) {
+  if (typeof args === `string`) {
+    args = {tag: args};
+  }
   const config = args; // just did it for having less git changes at this moment
   const mappedValues = [
     'tag',
@@ -12,6 +15,7 @@ function eyesCheckMapValues({args, refer}) {
     'accessibility',
     'region',
     'selector',
+    'element',
   ];
 
   let regionSettings = {};

package/src/plugin/isGlobalHooksSupported.js

@@ -5,8 +5,9 @@ function isGlobalHooksSupported(config) {
   const {version, experimentalRunEvents} = config;
 
   return (
-    version >= CYPRESS_NO_FLAG_VERSION ||
-    (version >= CYPRESS_SUPPORTED_VERSION && !!experimentalRunEvents)
+    parseFloat(version, 10) >= parseFloat(CYPRESS_NO_FLAG_VERSION, 10) ||
+    (parseFloat(version, 10) >= parseFloat(CYPRESS_SUPPORTED_VERSION, 10) &&
+      !!experimentalRunEvents)
   );
 }
 

package/src/plugin/pluginExport.js

@@ -6,8 +6,10 @@ const makeGlobalRunHooks = require('./hooks');
 function makePluginExport({startServer, eyesConfig}) {
   return function pluginExport(pluginModule) {
     let eyesServer;
-    const pluginModuleExports = pluginModule.exports;
-    pluginModule.exports = async function(...args) {
+    const pluginModuleExports = pluginModule.exports.e2e
+      ? pluginModule.exports.e2e.setupNodeEvents
+      : pluginModule.exports;
+    const setupNodeEvents = async function(...args) {
       const {server, port, closeManager, closeBatches, closeUniversalServer} = await startServer();
       eyesServer = server;
 
@@ -51,6 +53,11 @@ function makePluginExport({startServer, eyesConfig}) {
         }
       }
     };
+    if (pluginModule.exports.e2e) {
+      pluginModule.exports.e2e.setupNodeEvents = setupNodeEvents;
+    } else {
+      pluginModule.exports = setupNodeEvents;
+    }
     return function getCloseServer() {
       return eyesServer.close();
     };

package/src/plugin/server.js

@@ -34,6 +34,8 @@ function makeStartServer({logger}) {
     const {port: universalPort, close: closeUniversalServer} = await makeServerProcess({
       key: path.resolve(__dirname, '../pem/server.key'),
       cert: path.resolve(__dirname, '../pem/server.cert'),
+      detached: false,
+      idleTimeout: 0,
     });
 
     const managers = [];
@@ -55,7 +57,17 @@ function makeStartServer({logger}) {
       socketWithClient.on('message', message => {
         const msg = JSON.parse(message);
         logger.log('==> ', message.toString().slice(0, 1000));
-        if (msg.name === 'Test.printTestResults') {
+        if (msg.name === 'Core.makeSDK') {
+          const newMessage = Buffer.from(
+            JSON.stringify({
+              name: msg.name,
+              key: msg.key,
+              payload: Object.assign(msg.payload, {cwd: process.cwd()}),
+            }),
+            'utf-8',
+          );
+          socketWithUniversal.send(newMessage);
+        } else if (msg.name === 'Test.printTestResults') {
           try {
             const resultArr = [];
             for (const result of msg.payload.testResults) {

package/src/setup/addEyesCypressPlugin.js

@@ -11,5 +11,4 @@ function addEyesCypressPlugin(content) {
   }
 }
 
-module.exports = addEyesCypressPlugin;
-module.exports.pluginRequire = pluginRequire;
+module.exports = {addEyesCypressPlugin, pluginRequire};

package/src/setup/handleCommands.js

@@ -1,5 +1,8 @@
 'use strict';
 
+const fs = require('fs');
+const path = require('path');
+
 const chalk = require('chalk');
 const {readFileSync, writeFileSync} = require('fs');
 const addEyesCommands = require('./addEyesCommands');
@@ -20,4 +23,33 @@ function handleCommands(cwd) {
   }
 }
 
-module.exports = handleCommands;
+function handlerCommandsCypress10(cwd) {
+  const configContent = fs.readFileSync(path.resolve(cwd, 'cypress.config.js'), 'utf-8');
+  let supportFilePath;
+  if (configContent.includes('supportFile')) {
+    const regex = new RegExp(/(?:supportFile:)(?:\s*)(.*)/g);
+    const filePath = regex.exec(configContent)[1].replace(/['|"|,]*/g, '');
+    supportFilePath = path.resolve(cwd, filePath);
+  } else {
+    if (fs.existsSync(path.resolve(cwd, 'cypress/support/e2e.js'))) {
+      supportFilePath = path.resolve(cwd, 'cypress/support/e2e.js');
+    } else if (fs.existsSync(path.resolve(cwd, 'cypress/support/component.js'))) {
+      supportFilePath = path.resolve(cwd, 'cypress/support/component.js');
+    }
+  }
+
+  if (supportFilePath) {
+    const commandsFileContent = fs.readFileSync(supportFilePath, 'utf-8');
+    if (!isCommandsDefined(commandsFileContent)) {
+      writeFileSync(supportFilePath, addEyesCommands(commandsFileContent));
+      console.log(chalk.cyan('Commands defined.'));
+    } else {
+      console.log(chalk.cyan('Commands already defined.'));
+    }
+  } else {
+    throw new Error('Commands file not found!');
+  }
+  return supportFilePath;
+}
+
+module.exports = {handleCommands, handlerCommandsCypress10};

package/src/setup/handlePlugin.js

@@ -2,22 +2,30 @@
 
 const {readFileSync, writeFileSync} = require('fs');
 const chalk = require('chalk');
-const addEyesCypressPlugin = require('./addEyesCypressPlugin');
+const {addEyesCypressPlugin} = require('./addEyesCypressPlugin');
 const isPluginDefined = require('./isPluginDefined');
 const getFilePath = require('./getFilePath');
 const getCypressConfig = require('./getCypressConfig');
+const fs = require('fs');
+const path = require('path');
 
-function handlePlugin(cwd) {
-  const cypressConfig = getCypressConfig(cwd);
-  const pluginsFilePath = getFilePath('plugins', cypressConfig, cwd);
-  const pluginsFileContent = readFileSync(pluginsFilePath).toString();
+function handlePlugin(cwd, isCypress10) {
+  let fileContent, filePath;
+  if (!isCypress10) {
+    const cypressConfig = getCypressConfig(cwd);
+    filePath = getFilePath('plugins', cypressConfig, cwd);
+    fileContent = readFileSync(filePath).toString();
+  } else {
+    filePath = path.resolve(cwd, 'cypress.config.js');
+    fileContent = fs.readFileSync(filePath, 'utf-8');
+  }
 
-  if (!isPluginDefined(pluginsFileContent)) {
-    writeFileSync(pluginsFilePath, addEyesCypressPlugin(pluginsFileContent));
+  if (!isPluginDefined(fileContent)) {
+    writeFileSync(filePath, addEyesCypressPlugin(fileContent));
     console.log(chalk.cyan('Plugins defined.'));
   } else {
     console.log(chalk.cyan('Plugins already defined'));
   }
 }
 
-module.exports = handlePlugin;
+module.exports = {handlePlugin};

package/src/setup/handleTypeScript.js

@@ -4,6 +4,7 @@ const {writeFileSync, existsSync} = require('fs');
 const getFilePath = require('./getFilePath');
 const getCypressConfig = require('./getCypressConfig');
 const eyesIndexContent = `import "@applitools/eyes-cypress"`;
+const {resolve, dirname} = require('path');
 
 function handleTypeScript(cwd) {
   const cypressConfig = getCypressConfig(cwd);
@@ -17,5 +18,16 @@ function handleTypeScript(cwd) {
   }
 }
 
-module.exports = handleTypeScript;
+function handlerTypeScriptCypress10(suportFilePath) {
+  const supportDir = dirname(suportFilePath);
+  const typeScriptFilePath = resolve(supportDir, 'index.d.ts');
+  if (!existsSync(typeScriptFilePath)) {
+    writeFileSync(typeScriptFilePath, eyesIndexContent);
+    console.log(chalk.cyan('Typescript defined.'));
+  } else {
+    console.log(chalk.cyan('Typescript already defined.'));
+  }
+}
+
+module.exports = {handleTypeScript, handlerTypeScriptCypress10};
 module.exports.eyesIndexContent = eyesIndexContent;