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

package/CHANGELOG.md

@@ -3,15 +3,11 @@
 ## Unreleased
 
 
- ## 3.24.0-beta.2 - 2022/3/2
-
-- add bin folder
-
- ## 3.24.0-beta.1 - 2022/3/2
+## 3.25.0 - 2022/3/15
 
 - convert cypress to work on top of universal
-- updated to @applitools/logger@1.0.11 (from 1.0.9)
-- updated to @applitools/visual-grid-client@15.9.0 (from 15.8.57)
+- expose `cy.eyesGetAllTestResults`
+- updated to @applitools/visual-grid-client@15.10.1 (from 15.9.0)
 
 ## 3.23.9 - 2022/2/22
 

package/README.md

@@ -195,6 +195,7 @@ Applitools will take screenshots and perform the visual comparisons in the backg
     - [waitBeforeCapture](#waitBeforeCapture)
   - [Close](#Close)
   - [GetAllTestResults](#GetAllTestResults)
+  - [deletTestResults](#deleteTestResults)
 - [Concurrency](#Concurrency)
 - [Advanced configuration](#Advanced-configuration)
   - [Scoped configuration](#Here-are-the-available-configuration-properties)
@@ -526,12 +527,26 @@ This should be called after `close`. For example:
 
 ```js
 after(() => {
-  cy.eyesGetAllTestResults().then(results => {
-    console.log(results)
+  cy.eyesGetAllTestResults().then(summary => {
+    console.log(summary)
   })
 })
 ```
 
+#### deleteTestResults
+
+
+```js
+after(() => {
+  cy.eyesGetAllTestResults().then(summary => {
+    for(const result of summary.getAllResults()) {
+      await result.getTestResults().delete()
+    }
+  })
+})
+```
+
+
 ## Concurrency
 
 The default level of concurrency for free accounts is `5`. This means that only up to 5 visual tests can run in parallel, and therefore the execution might be slow.
@@ -561,6 +576,7 @@ The list above is also the order of precedence, which means that if you pass a p
 | `envName`                 | undefined                   | A name for the environment in which the application under test is running. |
 | `ignoreCaret`             | false                       | Whether to ignore or the blinking caret or not when comparing images. |
 | `matchLevel`              | Strict                      | The method to use when comparing two screenshots, which expresses the extent to which the two images are expected to match. Possible values are `Strict`, `Exact`, `Layout` and `Content`. Read more about match levels [here](http://support.applitools.com/customer/portal/articles/2088359). |
+| `branchName`              | default                     | The name of the current branch. |
 | `baselineBranchName`      | undefined                   | The name of the baseline branch. |
 | `parentBranchName`        | undefined                   | Sets the branch under which new branches are created. |
 | `saveFailedTests`         | false                       | Set whether or not failed tests are saved by default. |
@@ -579,21 +595,26 @@ The list above is also the order of precedence, which means that if you pass a p
 
 The following configuration properties cannot be defined using the first method of passing them to `cy.eyesOpen`. They should be defined either in the `applitools.config.js` file or as environment variables.
 
-| Property name             | Default value               | Description   |
-| -------------             |:-------------               |:-----------   |
-| `apiKey`                  | undefined                   | The API key used for working with the Applitools Eyes server. See more info in the [Applitools API key](#applitools-api-key) section above |
-| `showLogs`                | false                       | Whether or not you want to see logs of the Eyes-Cypress plugin. Logs are written to the same output of the Cypress process. |
-| `serverUrl`               | Default Eyes server URL     | The URL of Eyes server |
-| `proxy`                   | undefined                   | Sets the proxy settings to be used in network requests to Eyes server. This can be either a string to the proxy URI, or an object containing the URI, username and password.<br/><br/>For example:<br/>`{url: 'https://myproxy.com:443', username: 'my_user', password: 'my_password', isHttpOnly: false}`<br/>or:<br/>`"https://username:password@myproxy.com:443"`|
-| `isDisabled`              | false                       | If true, all calls to Eyes-Cypress commands will be silently ignored. |
-| `failCypressOnDiff`       | true                        | If true, then the Cypress test fails if an eyes visual test fails. If false and an eyes test fails, then the Cypress test does not fail. 
-| `tapDirPath`              | undefined                   | Directory path of a results file. If set, then a [TAP](https://en.wikipedia.org/wiki/Test_Anything_Protocol#Specification) file is created in this directory, the tap file name is created with the name [ISO-DATE](https://en.wikipedia.org/wiki/ISO_8601)\-eyes.tap and contains the Eyes test results (Note that because of a current Cypress [limitation](https://github.com/cypress-io/cypress-documentation/issues/818) the results are scoped per spec file, this means that the results file is created once for each spec file).|
-| `tapFileName`              | [ISO-DATE](https://en.wikipedia.org/wiki/ISO_8601)\-eyes.tap                   | The name of the tap file that is created in case `tapDirPath` is set
-| `testConcurrency`             | 5                          | The maximum number of tests that can run concurrently. The default value is the allowed amount for free accounts. For paid accounts, set this number to the quota set for your account. |
-|`dontCloseBatches`| false | If true, batches are not closed for  [notifyOnCompletion](#advanced-configuration).|
-|`disableBrowserFetching`| false | If true, page resources for rendering on the UFG will be fetched from outside of the browser.|
-|`enablePatterns`| false | |
-|`useDom`| false | |
+| Property name               | Default value               | Description   |
+| -------------               |:-------------               |:-----------   |
+| `apiKey`                    | undefined                   | The API key used for working with the Applitools Eyes server. See more info in the [Applitools API key](#applitools-api-key) section above |
+| `showLogs`                  | false                       | Whether or not you want to see logs of the Eyes-Cypress plugin. Logs are written to the same output of the Cypress process. |
+| `serverUrl`                 | Default Eyes server URL     | The URL of Eyes server |
+| `proxy`                     | undefined                   | Sets the proxy settings to be used in network requests to Eyes server. This can be either a string to the proxy URI, or an object containing the URI, username and password.<br/><br/>For example:<br/>`{url: 'https://myproxy.com:443', username: 'my_user', password: 'my_password', isHttpOnly: false}`<br/>or:<br/>`"https://username:password@myproxy.com:443"`|
+| `isDisabled`                | false                       | If true, all calls to Eyes-Cypress commands will be silently ignored. |
+| `failCypressOnDiff`         | true                        | If true, then the Cypress test fails if an eyes visual test fails. If false and an eyes test fails, then the Cypress test does not fail. 
+| `tapDirPath`                | undefined                   | Directory path of a results file. If set, then a [TAP](https://en.wikipedia.org/wiki/Test_Anything_Protocol#Specification) file is created in this directory, the tap file name is created with the name [ISO-DATE](https://en.wikipedia.org/wiki/ISO_8601)\-eyes.tap and contains the Eyes test results (Note that because of a current Cypress [limitation](https://github.com/cypress-io/cypress-documentation/issues/818) the results are scoped per spec file, this means that the results file is created once for each spec file).|
+| `testConcurrency`           | 5                           | The maximum number of tests that can run concurrently. The default value is the allowed amount for free accounts. For paid accounts, set this number to the quota set for your account. |
+|`dontCloseBatches`           | false                       | If true, batches are not closed for  [notifyOnCompletion](#advanced-configuration).|
+|`disableBrowserFetching`     | false                       | If true, page resources for rendering on the UFG will be fetched from outside of the browser.|
+|`enablePatterns`             | false                       | |
+|`useDom`                     | false                       | |
+| `batch`                     | undefined                   | An object which describes different aspects of the batch. The following lines in this table depict the various ways to configure the batch. |
+| `batch.id`                  | random                      | Provides ability to group tests into batches. Read more about batches [here](https://applitools.com/docs/topics/working-with-test-batches/how-to-group-tests-into-batches.html). |
+| `batch.name`                | The name of the first test in the batch                   | Provides a name to the batch (for display purpose only). |
+| `batch.sequenceName`        | undefined                   | Name for managing batch statistics. |
+| `batch.notifyOnCompletion`  | false                       | If `true` batch completion notifications are sent. |
+| `batch.properties`          | undefined                   | Custom properties for the entire batch. The format is an array of objects with name/value properties. For example: `[{name: 'My prop', value:'My value'}]`. |
 
 
 ### Method 1: Arguments for `cy.eyesOpen`

package/dist/browser/spec-driver.js

@@ -73,8 +73,12 @@ function findElements(context, selector, parent) {
     const root = parent !== null && parent !== void 0 ? parent : context;
     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;
+        const results = [];
+        const queryResult = document.evaluate(sel, context, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
+        for (let i = 0; i < queryResult.snapshotLength; i++) {
+            results.push(queryResult.snapshotItem(i));
+        }
+        return results;
     }
     else {
         return root.querySelectorAll(sel);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.24.0-beta.7",
+  "version": "3.25.0",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -12,20 +12,19 @@
     "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",
+    "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": "bongo preversion --skip-deps",
+    "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": "cd test/coverage/generic && cypress run ; cd -",
-    "test:coverage-custom": "cd test/coverage/generic && cypress run --config integrationFolder=cypress/integration-custom/",
+    "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": [
@@ -47,10 +46,11 @@
   },
   "dependencies": {
     "@applitools/dom-snapshot": "4.5.12",
-    "@applitools/eyes-universal": "1.1.1-beta.2",
+    "@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.9.0",
+    "@applitools/visual-grid-client": "15.10.1",
     "body-parser": "1.19.0",
     "chalk": "3.0.0",
     "cors": "2.8.5",
@@ -65,7 +65,8 @@
     "@applitools/sdk-release-kit": "0.13.11",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "1.0.8",
-    "@applitools/types": "^1.1.0",
+    "@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",
@@ -76,7 +77,7 @@
     "cookie-parser": "1.4.4",
     "cypress": "6.5.0",
     "cypress-new": "npm:cypress@9",
-    "eslint": "6.8.0",
+    "eslint": "8.10.0",
     "eslint-plugin-mocha-no-only": "1.1.0",
     "eslint-plugin-node": "7.0.1",
     "eslint-plugin-prettier": "2.7.0",

package/src/browser/commands.js

@@ -1,4 +1,4 @@
-/* global Cypress,cy,after,navigator */
+/* global Cypress,cy,after */
 'use strict';
 const spec = require('../../dist/browser/spec-driver');
 const Refer = require('./refer');
@@ -6,6 +6,7 @@ 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;
@@ -41,24 +42,25 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
     }
     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})
-    // }
+    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})
+    return new TestResultsSummary({summary, deleteTest});
   });
 });
 
-// class TestResultSummary {
-//   constructor({summary, deleteTest}) {
-//     // same as in eyes-api
-//   }
-// }
-
 if (shouldUseBrowserHooks) {
   after(() => {
     if (!manager) return;

package/src/browser/eyesCheckMapping.js

@@ -81,7 +81,7 @@ function convertFloatingRegion(floatingRegions) {
   if (!floatingRegions) return floatingRegions;
 
   return floatingRegions.map(region => {
-     const floatingRegion = {
+    const floatingRegion = {
       maxDownOffset: region.maxDownOffset || 0,
       maxLeftOffset: region.maxLeftOffset || 0,
       maxUpOffset: region.maxUpOffset || 0,
@@ -97,7 +97,7 @@ function convertFloatingRegion(floatingRegions) {
         height: region.height,
       };
     }
-    return floatingRegion
+    return floatingRegion;
   });
 }
 

package/src/browser/socket.js

@@ -1,3 +1,4 @@
+/* global WebSocket */
 const uuid = require('uuid');
 
 class Socket {

package/src/browser/spec-driver.ts

@@ -77,8 +77,14 @@ export function findElements(context: Context, selector: Selector, parent: Eleme
   const root = parent ?? context
   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;
+    const results = [];
+    const queryResult = document.evaluate(sel, context,
+        null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
+
+    for (let i = 0; i < queryResult.snapshotLength; i++) {
+        results.push(queryResult.snapshotItem(i));
+    }
+    return results;
   } else {
     return root.querySelectorAll(sel)
   }

package/src/plugin/handleTestResults.js

@@ -26,14 +26,10 @@ function printTestResults(testResultsArr) {
   }
 }
 function handleBatchResultsFile(results, tapFileConfig) {
-  try {
-    const formatter = new TestResultsFormatter(results);
-    const fileName = tapFileConfig.tapFileName || `${new Date().toISOString()}-eyes.tap`;
-    const tapFile = resolve(tapFileConfig.tapDirPath, fileName);
-    return writeFile(tapFile, formatter.asHierarchicTAPString(false, true));
-  } catch (ex) {
-    console.log(ex);
-  }
+  const formatter = new TestResultsFormatter(results);
+  const fileName = tapFileConfig.tapFileName || `${new Date().toISOString()}-eyes.tap`;
+  const tapFile = resolve(tapFileConfig.tapDirPath, fileName);
+  return writeFile(tapFile, formatter.asHierarchicTAPString(false, true));
 }
 
 module.exports = {printTestResults, handleBatchResultsFile};

package/src/plugin/hooks.js

@@ -20,7 +20,7 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
         const testResultsArr = [];
         for (const summary of summaries) {
           const testResults = summary.results.map(({testResults}) => testResults);
-          for(const result of testResults){
+          for (const result of testResults) {
             testResultsArr.push(new TestResults(result));
           }
         }
@@ -42,7 +42,7 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
 
         handleTestResults.printTestResults({testResults: testResultsArr, resultConfig});
       } finally {
-        closeUniversalServer();
+        await closeUniversalServer();
       }
     },
   };

package/src/plugin/server.js

@@ -5,10 +5,10 @@ const {makeServerProcess} = require('@applitools/eyes-universal');
 const {TestResults} = require('@applitools/visual-grid-client');
 const handleTestResults = require('./handleTestResults');
 
-function makeStartServer() {
+function makeStartServer({logger}) {
   return async function startServer() {
-    const {server, port} = await makeHandler({});
-    // const {port: universalPort, close: closeUniversalServer} = {port: 21077, close: () => {}}; //await makeServerProcess();
+    const {server, port} = await makeHandler({singleton: false});
+
     const {port: universalPort, close: closeUniversalServer} = await makeServerProcess();
 
     const managers = [];
@@ -18,7 +18,7 @@ function makeStartServer() {
       socketWithUniversal = connectSocket(`ws://localhost:${universalPort}/eyes`);
 
       socketWithUniversal.setPassthroughListener(message => {
-        console.log('<== ', message.toString().slice(0, 1000));
+        logger.log('<== ', message.toString().slice(0, 1000));
         const {name, payload} = JSON.parse(message);
         if (name === 'Core.makeManager') {
           managers.push({manager: payload.result, socketWithUniversal});
@@ -29,7 +29,7 @@ function makeStartServer() {
 
       socketWithClient.on('message', message => {
         const msg = JSON.parse(message);
-        console.log('==> ', message.toString().slice(0, 1000));
+        logger.log('==> ', message.toString().slice(0, 1000));
         if (msg.name === 'Test.printTestResults') {
           try {
             const resultArr = [];
@@ -89,7 +89,7 @@ function makeStartServer() {
     function closeBatches(settings) {
       if (socketWithUniversal)
         return socketWithUniversal.request('Core.closeBatches', {settings}).catch(err => {
-          console.log('@@@', err);
+          logger.log('@@@', err);
         });
     }
   };

package/src/plugin/startPlugin.js

@@ -2,10 +2,12 @@
 const makePluginExport = require('./pluginExport');
 const makeConfig = require('./config');
 const makeStartServer = require('./server');
+const {makeLogger} = require('@applitools/logger');
 
 const {config, eyesConfig} = makeConfig();
+const logger = makeLogger({level: config.showLogs ? 'info' : 'silent', label: 'eyes'});
 
-const startServer = makeStartServer();
+const startServer = makeStartServer({logger});
 
 module.exports = makePluginExport({
   startServer,

package/dist/browser/spec-driver.d.ts

@@ -1,17 +0,0 @@
-export declare type Selector = string;
-export declare type Context = Document;
-export declare type Element = HTMLElement;
-export declare function executeScript(context: Context, script: string, arg: any): any;
-export declare function isDriver(driver: Context): boolean;
-export declare function parentContext(currentContext: Context): Context;
-export declare function mainContext(): Context;
-export declare function isElement(element: Element): boolean;
-export declare function getViewportSize(): Object;
-export declare function setViewportSize(vs: any): void;
-export declare function findElement(context: Context, element: Selector, type: string, parent: Context): Node;
-export declare function findElements(context: Context, element: Selector, type: string, parent: Context): Node[];
-export declare function isSelector(selector: Selector): boolean;
-export declare function getTitle(context: Context): string;
-export declare function getUrl(context: Context): string;
-export declare function childContext(_context: Context, element: HTMLIFrameElement): Context;
-export declare function getCookies(): Promise<any>;

package/src/browser/TestResultContainerData.js

@@ -1,44 +0,0 @@
- class TestResultContainerData  {
-  /** @internal */
-  constructor(container, deleteTest) {
-    this.#container = container // eslint-disable-line
-    this.#deleteTest = deleteTest // eslint-disable-line
-  }
-
-  get testResults() {
-    return this.container.testResults
-  }
-  getTestResults() {
-    return new TestResultsData(this.container.testResults, this.deleteTest.bind({batchId: this.container.testResults.batchId, secretToken: this.container.testResults.secretToken}))
-  }
-
-  get exception() {
-    return this.container.exception
-  }
-  getException() {
-    return this.exception
-  }
-
-  get browserInfo() {
-    return this.container.browserInfo
-  }
-
-  getBrowserInfo() {
-    return this.browserInfo
-  }
-
-  /** @internal */
-  toObject() {
-    return this.container
-  }
-
-  /** @internal */
-  toJSON() {
-    return utils.general.toJSON(this.container)
-  }
-
-  /** @internal */
-  toString() {
-    return `${this.testResults ? this.testResults : ''} - ${this.exception ? this.exception : ''}`
-  }
-}

package/src/browser/TestResultsSummary.js

@@ -1,53 +0,0 @@
-const TestResultContainerData = require('./TestResultContainerData');
-class TestResultsSummary {
-  constructor({summary, deleteTest}) {
-    // same as in eyes-api
-    if (!summary) return;
-    this.results = summary.results.map(
-      container => new TestResultContainerData({container, deleteTest}),
-    );
-    this.passed = summary.passed;
-    this.unresolved = summary.unresolved;
-    this.failed = summary.failed;
-    this.exceptions = summary.exceptions;
-    this.mismatches = summary.mismatches;
-    this.missing = summary.missing;
-    this.matches = summary.matches;
-  }
-
-  getAllResults() {
-    return this.results;
-  }
-
-  [Symbol.iterator]() {
-    return this.results[Symbol.iterator]();
-  }
-
-  /** @internal */
-  toJSON() {
-    return this.results.map(container => utils.general.toJSON(container));
-  }
-
-  /** @internal */
-  toString() {
-    return (
-      'result summary {' +
-      '\n\tpassed=' +
-      this.passed +
-      '\n\tunresolved=' +
-      this.unresolved +
-      '\n\tfailed=' +
-      this.failed +
-      '\n\texceptions=' +
-      this.exceptions +
-      '\n\tmismatches=' +
-      this.mismatches +
-      '\n\tmissing=' +
-      this.missing +
-      '\n\tmatches=' +
-      this.matches +
-      '\n}'
-    );
-  }
-}
-module.exports = TestResultsSummary;