@applitools/eyes-cypress 3.30.0 → 3.30.2

package/CHANGELOG.md

@@ -12,6 +12,19 @@
 
 
 
+## 3.30.2 - 2023/3/28
+
+### Features
+### Bug fixes
+- map visualGridOptions to ufgOptions
+
+## 3.30.1 - 2023/3/22
+
+### Features
+### Bug fixes
+- Fixed cypress 8 not working with core v2
+- Fixed closeBatch issue
+
 ## 3.30.0 - 2023/3/19
 
 ### Features

package/dist/plugin/hooks.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const handleTestResults_1 = __importDefault(require("./handleTestResults"));
-function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer }) {
+function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer, }) {
     return {
         'before:run': ({ config }) => {
             if (!config.isTextTerminal)
@@ -21,7 +21,7 @@ function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer }
                 }
                 if (!config.appliConfFile.dontCloseBatches) {
                     await closeBatches({
-                        batchIds: [config.appliConfFile.batchId || config.appliConfFile.batch.id],
+                        batchId: config.appliConfFile.batchId || config.appliConfFile.batch.id,
                         serverUrl: config.appliConfFile.serverUrl,
                         proxy: config.appliConfFile.proxy,
                         apiKey: config.appliConfFile.apiKey,

package/dist/plugin/pluginExport.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const isGlobalHooksSupported_1 = __importDefault(require("./isGlobalHooksSupported"));
 const functional_commons_1 = require("@applitools/functional-commons");
 const hooks_1 = __importDefault(require("./hooks"));
-function makePluginExport({ startServer, eyesConfig }) {
+function makePluginExport({ startServer, eyesConfig, }) {
     return function pluginExport(pluginInitArgs) {
         let eyesServer, pluginModuleExports, pluginExportsE2E, pluginExportsComponent;
         let pluginExports;
@@ -58,7 +58,7 @@ function makePluginExport({ startServer, eyesConfig }) {
             return new Promise(res => eyesServer.close(() => res()));
         };
         async function setupNodeEvents(origOn, cypressConfig) {
-            const { server, port, closeManager, closeBatches, closeUniversalServer } = await startServer();
+            const { server, port, closeManager, closeBatches, closeUniversalServer } = await startServer(cypressConfig);
             eyesServer = server;
             const globalHooks = (0, hooks_1.default)({
                 closeManager,

package/dist/plugin/server.js

@@ -14,7 +14,7 @@ const ws_1 = require("ws");
 const which_1 = __importDefault(require("which"));
 const util_1 = require("util");
 function makeStartServer({ logger }) {
-    return async function startServer() {
+    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'));
         const https = new https_1.Server({
@@ -29,7 +29,9 @@ function makeStartServer({ logger }) {
             detached: true,
         };
         const cypressVersion = require('cypress/package.json').version;
-        if ((0, semver_1.lt)(cypressVersion, '7.0.0')) {
+        const isCypressVersionBelow7 = (0, semver_1.lt)(cypressVersion, '7.0.0');
+        const isNodeVersionSystem = !!(options === null || options === void 0 ? void 0 : options.nodeVersion) && options.nodeVersion !== 'system';
+        if (isCypressVersionBelow7 || isNodeVersionSystem) {
             forkOptions.execPath = await (0, which_1.default)('node');
         }
         const { port: universalPort, close: closeUniversalServer } = await (0, core_1.makeCoreServerProcess)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.30.0",
+  "version": "3.30.2",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -36,6 +36,8 @@
     "test:ts": "yarn test:ts:compile && yarn test:ts:run",
     "test:ts:compile": "tsc --project test/e2e/ts/cypress",
     "test:ts:run:legacy": "yarn cypress9 run --config-file ./test/e2e/ts/cypress-ts-legacy.json",
+    "cypress8": "./node_modules/cypress8/bin/cypress",
+    "test:ts:run:8": "yarn cypress8 run --project ./test/e2e/ts --config-file ./cypress-8.config.ts",
     "cypress9": "./node_modules/cypress9/bin/cypress",
     "test:ts:run:9": "yarn cypress9 run --project ./test/e2e/ts --config-file ./cypress-9.config.ts",
     "cypress10": "./node_modules/cypress10/bin/cypress",
@@ -54,7 +56,8 @@
     "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",
+    "setup": "yarn xvfb:setup",
+    "xvfb:setup": "sudo apt-get install -y xvfb; Xvfb -ac $DISPLAY -screen 0 1280x1024x16 & echo 'Run xvfb'; sleep 10",
     "deps": "bongo deps",
     "preversion": "yarn build && bongo preversion --skip-deps --verifyPendingChanges --skipVerifyInstalledVersions",
     "version": "bongo version --withPendingChanges",
@@ -66,7 +69,7 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "2.4.2",
+    "@applitools/core": "2.4.3",
     "@applitools/eyes-api": "1.13.12",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "1.1.48",
@@ -80,7 +83,7 @@
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.12",
-    "@applitools/bongo": "^3.0.1",
+    "@applitools/bongo": "^3.0.3",
     "@applitools/sdk-coverage-tests": "^3.0.0",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "1.1.28",
@@ -97,6 +100,7 @@
     "cypress10": "npm:cypress@^10.0.0",
     "cypress11": "npm:cypress@^11.0.0",
     "cypress12": "npm:cypress@^12.0.0",
+    "cypress8": "npm:cypress@^8.7.0",
     "cypress9": "npm:cypress@^9.0.0",
     "eslint": "8.10.0",
     "eslint-plugin-mocha-no-only": "1.1.1",

package/src/browser/eyesCheckMapping.js

@@ -19,6 +19,9 @@ function eyesCheckMapValues({openToCheckSettingsArgs, args, refer, appliConfFile
     'region',
     'selector',
     'element',
+    'variationGroupId',
+    'accessibilitySettings',
+    'visualGridOptions',
   ]
 
   let regionSettings = {}
@@ -53,6 +56,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/hooks.ts

@@ -1,4 +1,5 @@
 import handleTestResults from './handleTestResults'
+import {type StartServerReturn} from './server'
 export type EyesCypressAction = 'before:run' | 'after:run'
 
 declare global {
@@ -9,7 +10,7 @@ declare global {
         dontCloseBatches: boolean
         batch: any
         serverUrl: string
-        proxy: string
+        proxy: any // TODO: add proxy type
         apiKey: string
         batchId: string
         tapDirPath: string
@@ -19,7 +20,11 @@ declare global {
   }
 }
 
-export default function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer}: any): {
+export default function makeGlobalRunHooks({
+  closeManager,
+  closeBatches,
+  closeUniversalServer,
+}: Omit<StartServerReturn, 'server' | 'port'>): {
   'after:run': (results: CypressCommandLine.CypressRunResult) => void | Promise<void>
   'before:run': (runDetails: Cypress.BeforeRunDetails) => void | Promise<void>
 } {
@@ -39,7 +44,7 @@ export default function makeGlobalRunHooks({closeManager, closeBatches, closeUni
         }
         if (!config.appliConfFile.dontCloseBatches) {
           await closeBatches({
-            batchIds: [config.appliConfFile.batchId || config.appliConfFile.batch.id],
+            batchId: config.appliConfFile.batchId || config.appliConfFile.batch.id,
             serverUrl: config.appliConfFile.serverUrl,
             proxy: config.appliConfFile.proxy,
             apiKey: config.appliConfFile.apiKey,

package/src/plugin/index.ts

@@ -22,6 +22,7 @@ export type EyesPluginConfig = {
   eyesTestConcurrency: number
   eyesWaitBeforeCapture: number
   eyesPort?: number
+  eyesIsGlobalHooksSupported?: boolean
 }
 
 const {config, eyesConfig} = makeConfig()

package/src/plugin/pluginExport.ts

@@ -3,8 +3,15 @@ import isGlobalHooksSupported from './isGlobalHooksSupported'
 import {presult} from '@applitools/functional-commons'
 import makeGlobalRunHooks from './hooks'
 import {type EyesPluginConfig} from './'
+import {type StartServerReturn} from './server'
 
-export default function makePluginExport({startServer, eyesConfig}: any) {
+export default function makePluginExport({
+  startServer,
+  eyesConfig,
+}: {
+  startServer: (options?: Cypress.PluginConfigOptions) => Promise<StartServerReturn>
+  eyesConfig: EyesPluginConfig
+}) {
   return function pluginExport(pluginInitArgs: Cypress.ConfigOptions | NodeJS.Module) {
     let eyesServer: any, pluginModuleExports: any, pluginExportsE2E: any, pluginExportsComponent: any
     let pluginExports
@@ -62,7 +69,7 @@ export default function makePluginExport({startServer, eyesConfig}: any) {
       origOn: Cypress.PluginEvents,
       cypressConfig: Cypress.PluginConfigOptions,
     ): Promise<EyesPluginConfig> {
-      const {server, port, closeManager, closeBatches, closeUniversalServer} = await startServer()
+      const {server, port, closeManager, closeBatches, closeUniversalServer} = await startServer(cypressConfig)
       eyesServer = server
 
       const globalHooks: any = makeGlobalRunHooks({

package/src/plugin/server.ts

@@ -1,5 +1,5 @@
 import connectSocket, {type SocketWithUniversal} from './webSocket'
-import {makeCoreServerProcess} from '@applitools/core'
+import {type CloseBatchSettings, makeCoreServerProcess} from '@applitools/core'
 import handleTestResults from './handleTestResults'
 import path from 'path'
 import fs from 'fs'
@@ -10,9 +10,16 @@ import which from 'which'
 import {type Logger} from '@applitools/logger'
 import {AddressInfo} from 'net'
 import {promisify} from 'util'
+export type StartServerReturn = {
+  server: Omit<SocketWithUniversal, 'disconnect' | 'ref' | 'unref' | 'send' | 'request' | 'setPassthroughListener'>
+  port: number
+  closeManager: () => Promise<any[]>
+  closeBatches: (settings: CloseBatchSettings | CloseBatchSettings[]) => Promise<void>
+  closeUniversalServer: () => void
+}
 
 export default function makeStartServer({logger}: {logger: Logger}) {
-  return async function startServer() {
+  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'))
     const https = new HttpsServer({
@@ -38,7 +45,18 @@ export default function makeStartServer({logger}: {logger: Logger}) {
     // `cypress` version below `7.0.0` has an old Electron version which not support async shell process.
     // By passing `execPath` with the node process cwd it will switch the `node` process to be the like the OS have
     // and will not use the unsupported `Cypress Helper.app` with the not supported shell process Electron
-    if (semverLt(cypressVersion, '7.0.0')) {
+    const isCypressVersionBelow7 = semverLt(cypressVersion, '7.0.0')
+
+    // `nodeVersion` property set the way the `node` process will be executed
+    // if set to `system` it will use the `node` process that the OS have
+    // if set to `bundled` it will use the `node` process that the `Cypress Helper.app` have
+    //
+    // [doc link](https://docs.cypress.io/guides/references/configuration#Node-version)
+    //
+    // this is why if `nodeVersion` exits and not set to `system` we need to tell to the `universal` server the `execPath` to `node`
+    const isNodeVersionSystem = !!options?.nodeVersion && options.nodeVersion !== 'system'
+
+    if (isCypressVersionBelow7 || isNodeVersionSystem) {
       forkOptions.execPath = await which('node')
     }
 
@@ -128,7 +146,7 @@ export default function makeStartServer({logger}: {logger: Logger}) {
         ),
       )
     }
-    function closeBatches(settings: any) {
+    function closeBatches(settings: CloseBatchSettings | CloseBatchSettings[]) {
       if (socketWithUniversal)
         return socketWithUniversal.request('Core.closeBatch', {settings}).catch((err: Error) => {
           logger.log('@@@', err)

package/types/expose.d.ts

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