@applitools/eyes-cypress 3.30.1 → 3.31.0

package/CHANGELOG.md

@@ -12,6 +12,19 @@
 
 
 
+## 3.31.0 - 2023/4/4
+
+### Features
+- Added `removeDuplicateTests` configuration to remove duplicated tests in the runner at the end of execution
+### Bug fixes
+- disableBrowserFetching change from open to check
+
+## 3.30.2 - 2023/3/28
+
+### Features
+### Bug fixes
+- map visualGridOptions to ufgOptions
+
 ## 3.30.1 - 2023/3/22
 
 ### Features

package/dist/plugin/config.js

@@ -32,7 +32,15 @@ const DEFAULT_TEST_CONCURRENCY = 5;
 const uuid = __importStar(require("uuid"));
 function makeConfig() {
     const config = utils.config.getConfig({
-        params: [...configParams_1.default, 'failCypressOnDiff', 'tapDirPath', 'tapFileName', 'disableBrowserFetching', 'testConcurrency'],
+        params: [
+            ...configParams_1.default,
+            'failCypressOnDiff',
+            'tapDirPath',
+            'tapFileName',
+            'disableBrowserFetching',
+            'testConcurrency',
+            'removeDuplicateTests',
+        ],
     });
     if ((!config.batch || !config.batch.id) && !config.batchId) {
         config.batch = { id: uuid.v4(), ...config.batch };
@@ -60,6 +68,7 @@ function makeConfig() {
         eyesDisableBrowserFetching: !!config.disableBrowserFetching,
         eyesTestConcurrency: config.testConcurrency || DEFAULT_TEST_CONCURRENCY,
         eyesWaitBeforeCapture: config.waitBeforeCapture,
+        eyesRemoveDuplicateTests: !!config.removeDuplicateTests,
     };
     return { config, eyesConfig };
 }

package/dist/plugin/configParams.js

@@ -43,5 +43,6 @@ const configParams = [
     'notifyOnCompletion',
     'batchNotify',
     'dontCloseBatches',
+    'removeDuplicateTests',
 ];
 exports.default = configParams;

package/dist/plugin/index.js

@@ -9,7 +9,7 @@ const server_1 = __importDefault(require("./server"));
 const logger_1 = require("@applitools/logger");
 const { config, eyesConfig } = (0, config_1.default)();
 const logger = (0, logger_1.makeLogger)({ level: config.showLogs ? 'info' : 'silent', label: 'eyes' });
-const startServer = (0, server_1.default)({ logger });
+const startServer = (0, server_1.default)({ logger, eyesConfig });
 const pluginExport = (0, pluginExport_1.default)({
     startServer,
     eyesConfig: Object.assign({}, eyesConfig, { appliConfFile: config }),

package/dist/plugin/server.js

@@ -13,7 +13,7 @@ const https_1 = require("https");
 const ws_1 = require("ws");
 const which_1 = __importDefault(require("which"));
 const util_1 = require("util");
-function makeStartServer({ logger }) {
+function makeStartServer({ logger, eyesConfig }) {
     return async function startServer(options) {
         const key = fs_1.default.readFileSync(path_1.default.resolve(__dirname, '../../src/pem/server.key'));
         const cert = fs_1.default.readFileSync(path_1.default.resolve(__dirname, '../../src/pem/server.cert'));
@@ -103,7 +103,10 @@ function makeStartServer({ logger }) {
             closeUniversalServer,
         };
         function closeManager() {
-            return Promise.all(managers.map(({ manager, socketWithUniversal }) => socketWithUniversal.request('EyesManager.getResults', { manager, settings: { throwErr: false } })));
+            return Promise.all(managers.map(({ manager, socketWithUniversal }) => socketWithUniversal.request('EyesManager.getResults', {
+                manager,
+                settings: { throwErr: false, removeDuplicateTests: eyesConfig.eyesRemoveDuplicateTests },
+            })));
         }
         function closeBatches(settings) {
             if (socketWithUniversal)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.30.1",
+  "version": "3.31.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -69,7 +69,7 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "2.4.3",
+    "@applitools/core": "2.4.7",
     "@applitools/eyes-api": "1.13.12",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "1.1.48",
@@ -83,11 +83,11 @@
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.12",
-    "@applitools/bongo": "^3.0.2",
+    "@applitools/bongo": "^3.0.3",
     "@applitools/sdk-coverage-tests": "^3.0.0",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "1.1.28",
-    "@applitools/test-utils": "1.5.14",
+    "@applitools/test-utils": "1.5.15",
     "@types/node": "12",
     "@types/semver": "^7.3.13",
     "@types/uuid": "^9.0.0",

package/src/browser/commands.js

@@ -22,9 +22,12 @@ let manager,
 async function getSummary() {
   if (_summary) return _summary
   await Promise.all(closePromiseArr)
-  _summary = socket.request('EyesManager.getResults', {manager, settings: {throwErr}}).catch(err => {
-    return {results: [{result: err.info.result}]}
-  })
+  const removeDuplicateTests = Cypress.config('eyesRemoveDuplicateTests')
+  _summary = socket
+    .request('EyesManager.getResults', {manager, settings: {throwErr, removeDuplicateTests}})
+    .catch(err => {
+      return {results: [{result: err.info.result}]}
+    })
   _summary = await _summary
 
   return _summary
@@ -127,10 +130,10 @@ Cypress.Commands.add('eyesOpen', function (args = {}) {
 
       manager =
         manager ||
-        (await socket.request(
-          'Core.makeManager',
-          Object.assign({}, {concurrency: Cypress.config('eyesTestConcurrency')}, {type: 'ufg'}),
-        ))
+        (await socket.request('Core.makeManager', {
+          concurrency: Cypress.config('eyesTestConcurrency'),
+          type: 'ufg',
+        }))
     }
 
     const appliConfFile = Cypress.config('appliConfFile')

package/src/browser/eyesCheckMapping.js

@@ -19,6 +19,9 @@ function eyesCheckMapValues({openToCheckSettingsArgs, args, refer, appliConfFile
     'region',
     'selector',
     'element',
+    'variationGroupId',
+    'accessibilitySettings',
+    'visualGridOptions',
   ]
 
   let regionSettings = {}
@@ -46,6 +49,8 @@ function eyesCheckMapValues({openToCheckSettingsArgs, args, refer, appliConfFile
     accessibilityRegions: convertAccessabilityRegions(args.accessibility),
     renderers,
   }
+  if (appliConfFile.disableBrowserFetching)
+    checkSettings.disableBrowserFetching = !!appliConfFile.disableBrowserFetching
   if (args.variationGroupId) {
     checkSettings.userCommandId = args.variationGroupId
   }
@@ -53,6 +58,10 @@ function eyesCheckMapValues({openToCheckSettingsArgs, args, refer, appliConfFile
     checkSettings.accessibilitySettings = accessibilitySettings
   }
 
+  if (args.visualGridOptions) {
+    checkSettings.ufgOptions = args.visualGridOptions
+  }
+
   if (args.target === 'region') {
     if (!Array.isArray(args.selector)) {
       if (args.element) {

package/src/plugin/config.ts

@@ -6,7 +6,15 @@ import {type EyesPluginConfig} from './'
 
 export default function makeConfig(): {config: any; eyesConfig: EyesPluginConfig} {
   const config = utils.config.getConfig({
-    params: [...configParams, 'failCypressOnDiff', 'tapDirPath', 'tapFileName', 'disableBrowserFetching', 'testConcurrency'],
+    params: [
+      ...configParams,
+      'failCypressOnDiff',
+      'tapDirPath',
+      'tapFileName',
+      'disableBrowserFetching',
+      'testConcurrency',
+      'removeDuplicateTests',
+    ],
   })
 
   if ((!config.batch || !config.batch.id) && !config.batchId) {
@@ -40,6 +48,7 @@ export default function makeConfig(): {config: any; eyesConfig: EyesPluginConfig
     eyesDisableBrowserFetching: !!config.disableBrowserFetching,
     eyesTestConcurrency: config.testConcurrency || DEFAULT_TEST_CONCURRENCY,
     eyesWaitBeforeCapture: config.waitBeforeCapture,
+    eyesRemoveDuplicateTests: !!config.removeDuplicateTests,
   }
 
   return {config, eyesConfig}

package/src/plugin/configParams.ts

@@ -41,6 +41,7 @@ const configParams = [
   'notifyOnCompletion',
   'batchNotify',
   'dontCloseBatches',
+  'removeDuplicateTests',
 ]
 
 export default configParams

package/src/plugin/index.ts

@@ -23,12 +23,13 @@ export type EyesPluginConfig = {
   eyesWaitBeforeCapture: number
   eyesPort?: number
   eyesIsGlobalHooksSupported?: boolean
+  eyesRemoveDuplicateTests?: boolean
 }
 
 const {config, eyesConfig} = makeConfig()
 const logger = makeLogger({level: config.showLogs ? 'info' : 'silent', label: 'eyes'})
 
-const startServer = makeStartServer({logger})
+const startServer = makeStartServer({logger, eyesConfig})
 
 const pluginExport = makePluginExport({
   startServer,

package/src/plugin/server.ts

@@ -10,6 +10,7 @@ import which from 'which'
 import {type Logger} from '@applitools/logger'
 import {AddressInfo} from 'net'
 import {promisify} from 'util'
+import {EyesPluginConfig} from './index'
 export type StartServerReturn = {
   server: Omit<SocketWithUniversal, 'disconnect' | 'ref' | 'unref' | 'send' | 'request' | 'setPassthroughListener'>
   port: number
@@ -18,7 +19,7 @@ export type StartServerReturn = {
   closeUniversalServer: () => void
 }
 
-export default function makeStartServer({logger}: {logger: Logger}) {
+export default function makeStartServer({logger, eyesConfig}: {logger: Logger; eyesConfig: EyesPluginConfig}) {
   return async function startServer(options?: Cypress.PluginConfigOptions): Promise<StartServerReturn> {
     const key = fs.readFileSync(path.resolve(__dirname, '../../src/pem/server.key'))
     const cert = fs.readFileSync(path.resolve(__dirname, '../../src/pem/server.cert'))
@@ -142,7 +143,10 @@ export default function makeStartServer({logger}: {logger: Logger}) {
     function closeManager() {
       return Promise.all(
         managers.map(({manager, socketWithUniversal}) =>
-          socketWithUniversal.request('EyesManager.getResults', {manager, settings: {throwErr: false}}),
+          socketWithUniversal.request('EyesManager.getResults', {
+            manager,
+            settings: {throwErr: false, removeDuplicateTests: eyesConfig.eyesRemoveDuplicateTests},
+          }),
         ),
       )
     }

package/types/expose.d.ts

@@ -538,6 +538,7 @@ export type EyesPluginConfig = {
     eyesWaitBeforeCapture: number;
     eyesPort?: number;
     eyesIsGlobalHooksSupported?: boolean;
+    eyesRemoveDuplicateTests?: boolean;
 };
 declare const _default: (pluginInitArgs: Cypress.ConfigOptions | NodeJS.Module) => Cypress.ConfigOptions | NodeJS.Module | (() => Promise<void>);
 export default _default;