@applitools/eyes-cypress 3.23.3 → 3.23.7

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 ## Unreleased
 
 
+## 3.23.7 - 2022/1/28
+
+- add concurrency limitation on local server
+
+## 3.23.6 - 2022/1/20
+
+- fix global hook overrides
+- updated to @applitools/visual-grid-client@15.8.62 (from 15.8.57)
+
+## 3.23.5 - 2022/1/6
+
+- updated to @applitools/dom-snapshot@4.5.12 (from 4.5.11)
+- updated to @applitools/logger@1.0.9 (from 1.0.6)
+- updated to @applitools/visual-grid-client@15.8.57 (from 15.8.50)
+
+## 3.23.4 - 2021/12/9
+
+- updated to @applitools/visual-grid-client@15.8.50 (from 15.8.49)
+
  ## 3.23.3 - 2021/11/24
 
  - add timeout before capturing dom snapshot

package/README.md

@@ -540,9 +540,6 @@ The list above is also the order of precedence, which means that if you pass a p
 | -------------             |:-------------               |:-----------   |
 | `testName`                | The value of Cypress's test title | Test name. If this is not specified, the test name will be the title of the `it` block where the test is running.    |
 | `browser`                 | { width: 800, height: 600, name: 'chrome' } | The size and browser of the generated screenshots. This doesn't need to be the same as the browser that Cypress is running. It could be a different size and also a different browser. For more info and possible values, see the [browser section below](#configuring-the-browser).|
-| `batchId`                 | 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). |
-| `batchName`               | The name of the first test in the batch                   | Provides a name to the batch (for display purpose only). |
-| `batchSequenceName`               | undefined | Name for managing batch statistics. |
 | `baselineEnvName`         | undefined                   | The name of the environment of the baseline. |
 | `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. |
@@ -555,7 +552,6 @@ The list above is also the order of precedence, which means that if you pass a p
 | `ignoreDisplacements`     | false                       | Sets whether Test Manager should intially display mismatches for image features that have only been displaced, as opposed to real mismatches. |
 | `compareWithParentBranch` | false                       |  |
 | `ignoreBaseline`          | false                       |  |
-| `notifyOnCompletion`  | false | If `true` batch completion notifications are sent. |
 | `accessibilityValidation` | undefined | An object that specifies the accessibility level and guidelines version to use for the screenshots. Possible values for **level** are `None`, `AA` and `AAA`, and possible values for **guidelinesVersion** are `WCAG_2_0` and `WCAG_2_1`. For example: `{level: 'AA', guidelinesVersion: 'WCAG_2_0'}`|
 | `visualGridOptions` | undefined | An object that specifies options to configure renderings on the Ultrafast grid. See more information [here](#visualgridoptions) |
 |`layoutBreakpoints`| undefined | When set to `true`, a snapshot of the DOM will be taken once for each browser/device size in the `browser` configuration. For optimization purposes, an array of numbers can be passed. The DOM snapshot will be taken once for every **width** in the array. For more information, see [layoutBreakpoints](#layoutBreakpoints)|
@@ -565,20 +561,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).|
-| `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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.23.3",
+  "version": "3.23.7",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -16,7 +16,8 @@
     "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",
-    "preversion": "bongo preversion --skip-deps && yarn test",
+    "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",
@@ -39,22 +40,22 @@
     "directory": "packages/eyes-cypress"
   },
   "dependencies": {
-    "@applitools/dom-snapshot": "4.5.11",
+    "@applitools/dom-snapshot": "4.5.12",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.0.6",
-    "@applitools/visual-grid-client": "15.8.49",
+    "@applitools/logger": "1.0.9",
+    "@applitools/visual-grid-client": "15.8.62",
     "body-parser": "1.19.0",
     "chalk": "3.0.0",
     "cors": "2.8.5",
     "express": "4.17.1",
-    "lodash.flatten": "4.4.0"
+    "lodash.flatten": "4.4.0",
+    "throat": "6.0.1"
   },
   "devDependencies": {
-    "@applitools/scripts": "^1.0.1",
-    "@applitools/sdk-release-kit": "0.13.4",
-    "@applitools/sdk-shared": "0.9.9",
+    "@applitools/scripts": "^1.1.0",
+    "@applitools/sdk-release-kit": "0.13.11",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.0.7",
+    "@applitools/test-server": "1.0.8",
     "chai": "^4.2.0",
     "chai-spies": "^1.0.0",
     "cookie-parser": "^1.4.4",
@@ -68,7 +69,7 @@
     "mocha": "^8.0.1",
     "morgan": "^1.9.1",
     "ncp": "^2.0.0",
-    "node-fetch": "^2.6.0",
+    "node-fetch": "^2.6.7",
     "prettier": "^1.19.1",
     "typescript": "^3.9.2"
   },

package/src/browser/commands.js

@@ -53,7 +53,7 @@ Cypress.Commands.add('eyesOpen', function(args = {}) {
   Cypress.config('eyesOpenArgs', args);
   Cypress.log({name: 'Eyes: open'});
   const userAgent = navigator.userAgent;
-  const {title: testName} = this.currentTest || this.test;
+  const {title: testName} = this.currentTest || this.test || Cypress.currentTest;
   const {browser: eyesOpenBrowser, isDisabled} = args;
   const globalBrowser = getGlobalConfigProperty('eyesBrowser');
   const defaultBrowser = {

package/src/browser/makeSend.js

@@ -1,7 +1,9 @@
 'use strict';
+const throat = require('throat');
+const CONCURRENCY_LIMITATION = 100;
 
 function makeSend(port, fetch) {
-  return function send({
+  const send = function send({
     command,
     data,
     method = 'POST',
@@ -13,6 +15,8 @@ function makeSend(port, fetch) {
       headers,
     });
   };
+
+  return throat(CONCURRENCY_LIMITATION, send);
 }
 
 module.exports = makeSend;

package/src/plugin/pluginExport.js

@@ -10,14 +10,18 @@ function makePluginExport({startServer, eyesConfig, globalHooks}) {
       const {eyesPort, closeServer} = await startServer();
       closeEyesServer = closeServer;
       const [origOn, config] = args;
-      let isGlobalHookCalledFromUserHandler = false;
+      const isGlobalHookCalledFromUserHandlerMap = new Map();
       eyesConfig.eyesIsGlobalHooksSupported = isGlobalHooksSupported(config);
       const moduleExportsResult = await pluginModuleExports(onThatCallsUserDefinedHandler, config);
-      if (eyesConfig.eyesIsGlobalHooksSupported && !isGlobalHookCalledFromUserHandler) {
+
+      if (eyesConfig.eyesIsGlobalHooksSupported) {
         for (const [eventName, eventHandler] of Object.entries(globalHooks)) {
-          origOn.call(this, eventName, eventHandler);
+          if (!isGlobalHookCalledFromUserHandlerMap.get(eventName)) {
+            origOn.call(this, eventName, eventHandler);
+          }
         }
       }
+
       return Object.assign({}, eyesConfig, {eyesPort}, moduleExportsResult);
 
       // This piece of code exists because at the point of writing, Cypress does not support multiple event handlers:
@@ -29,7 +33,7 @@ function makePluginExport({startServer, eyesConfig, globalHooks}) {
         let handlerToCall = handler;
         if (eyesConfig.eyesIsGlobalHooksSupported && isRunEvent) {
           handlerToCall = handlerThatCallsUserDefinedHandler;
-          isGlobalHookCalledFromUserHandler = true;
+          isGlobalHookCalledFromUserHandlerMap.set(eventName, true);
         }
         return origOn.call(this, eventName, handlerToCall);