@applitools/eyes-cypress 3.25.4 → 3.25.7

package/CHANGELOG.md

@@ -5,6 +5,28 @@
 
 
 
+
+
+## 3.25.7 - 2022/5/6
+
+### Features
+### Bug fixes
+- update the README entry 'saveNewTests'
+- added `properties` and `notifyOnCompletion` as optional Types of Batch (for TS)
+
+## 3.25.6 - 2022/4/25
+
+### Features
+### Bug fixes
+- 'batch.properties' and 'batch.notifyOnCompletion' not propagated correctly
+- 'batch.name' was overridden in case 'batch.id' was not defined
+
+## 3.25.5 - 2022/4/19
+
+### Features
+### Bug fixes
+- fix beforeCaptureScreenshot hook not being respected
+
 ## 3.25.4 - 2022/4/15
 
 ### Features

package/README.md

@@ -580,7 +580,7 @@ The list above is also the order of precedence, which means that if you pass a p
 | `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. |
-| `saveNewTests`            | false                       | Set whether or not new tests are saved by default. |
+| `saveNewTests`            | true                       | Set whether or not new tests are saved by default. |
 | `properties`              | undefined                   | Custom properties for the eyes test. The format is an array of objects with name/value properties. For example: `[{name: 'My prop', value:'My value'}]`. |
 | `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                       |  |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.25.4",
+  "version": "3.25.7",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -46,11 +46,11 @@
   },
   "dependencies": {
     "@applitools/dom-snapshot": "4.5.12",
-    "@applitools/eyes-api": "1.3.0",
-    "@applitools/eyes-universal": "2.2.0",
+    "@applitools/eyes-api": "1.3.1",
+    "@applitools/eyes-universal": "2.5.1",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.0.12",
-    "@applitools/visual-grid-client": "15.12.1",
+    "@applitools/logger": "1.1.2",
+    "@applitools/visual-grid-client": "15.12.13",
     "body-parser": "1.19.0",
     "chalk": "3.0.0",
     "cors": "2.8.5",
@@ -65,8 +65,8 @@
     "@applitools/sdk-coverage-tests": "^2.3.18",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "1.0.8",
-    "@applitools/test-utils": "1.3.1",
-    "@applitools/types": "^1.3.1",
+    "@applitools/test-utils": "1.3.2",
+    "@applitools/types": "^1.4.2",
     "@applitools/utils": "1.2.14",
     "@types/node": "17.0.13",
     "@types/ws": "^8.2.2",

package/src/browser/eyesCheckMapping.js

@@ -5,7 +5,7 @@ function eyesCheckMapValues({args}) {
 function toCheckWindowConfiguration(config = {}) {
   const mappedValues = [
     'tag',
-    'hooks',
+    'scriptHooks',
     'ignore',
     'floating',
     'strict',
@@ -20,7 +20,7 @@ function toCheckWindowConfiguration(config = {}) {
   let shadowDomSettings = {};
   const checkSettings = {
     name: config.tag,
-    scriptHooks: config.hooks,
+    hooks: config.scriptHooks,
     ignoreRegions: config.ignore,
     floatingRegions: convertFloatingRegion(config.floating),
     strictRegions: config.strict,

package/src/browser/eyesOpenMapping.js

@@ -1,29 +1,35 @@
+const batchPropertiesRetriever = (args, appliConfFile) => {
+  return function(prop, nestedProp) {
+    nestedProp = nestedProp || prop;
+    if (args.hasOwnProperty(prop)) {
+      return args[prop];
+    } else if (args.batch && args.batch.hasOwnProperty(nestedProp)) {
+      return args.batch[nestedProp];
+    } else if (appliConfFile.hasOwnProperty(prop)) {
+      return appliConfFile[prop];
+    } else if (appliConfFile.batch && appliConfFile.batch.hasOwnProperty(nestedProp)) {
+      return appliConfFile.batch[nestedProp];
+    }
+    return undefined;
+  };
+};
 function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks}) {
   let browsersInfo = args.browser || appliConfFile.browser;
   let accessibilitySettings = args.accessibilityValidation || appliConfFile.accessibilityValidation;
+  const batchProperties = batchPropertiesRetriever(args, appliConfFile);
   const batch = {
-    id:
-      args.batchId ||
-      (args.batch ? args.batch.id : undefined) ||
-      appliConfFile.batchId ||
-      (appliConfFile.batch ? appliConfFile.batch.id : undefined),
-    name:
-      args.batchName ||
-      (args.batch ? args.batch.name : undefined) ||
-      appliConfFile.batchName ||
-      (appliConfFile.batch ? appliConfFile.batch.name : undefined),
-    sequenceName:
-      args.batchSequenceName ||
-      (args.batch ? args.batch.sequenceName : undefined) ||
-      appliConfFile.batchSequenceName ||
-      (appliConfFile.batch ? appliConfFile.batch.sequenceName : undefined),
+    id: batchProperties('batchId', 'id'),
+    name: batchProperties('batchName', 'name'),
+    sequenceName: batchProperties('batchSequenceName', 'sequenceName'),
+    notifyOnCompletion: batchProperties('notifyOnCompletion'),
+    properties:
+      (args.batch ? args.batch.properties : undefined) ||
+      (appliConfFile.batch ? appliConfFile.batch.properties : undefined),
   };
-
-  if (!batch.name) {
-    delete batch['name'];
-  }
-  if (!batch.sequenceName) {
-    delete batch['sequenceName'];
+  for (let prop in batch) {
+    if (typeof batch[prop] === 'undefined') {
+      delete batch[prop];
+    }
   }
 
   const mappedValues = [

package/src/plugin/config.js

@@ -16,9 +16,7 @@ function makeConfig() {
   });
 
   if ((!config.batch || !config.batch.id) && !config.batchId) {
-    config.batch = {
-      id: uuid.v4(),
-    };
+    config.batch = {id: uuid.v4(), ...config.batch};
   }
 
   if (config.failCypressOnDiff === '0') {