@applitools/eyes-cypress 3.29.1 → 3.30.1

package/src/browser/eyesOpenMapping.js

@@ -14,8 +14,6 @@ const batchPropertiesRetriever = (args, appliConfFile) => {
   }
 }
 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: batchProperties('batchId', 'id'),
@@ -45,18 +43,7 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
     'batchSequenceName',
   ]
 
-  if (browsersInfo) {
-    if (Array.isArray(browsersInfo)) {
-      for (const [index, value] of browsersInfo.entries()) {
-        browsersInfo[index] = fillDefaultBrowserName(value)
-      }
-    } else {
-      browsersInfo = [fillDefaultBrowserName(browsersInfo)]
-    }
-  }
-
   const defaultMatchSettings = {
-    accessibilitySettings,
     matchLevel: args.matchLevel || appliConfFile.matchLevel,
     ignoreCaret: args.ignoreCaret || appliConfFile.ignoreCaret,
     useDom: args.useDom || appliConfFile.useDom,
@@ -75,27 +62,34 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
   }
 
   const mappedArgs = {
+    ...defaultMatchSettings,
     ...args,
-    browsersInfo,
-    defaultMatchSettings,
     batch,
   }
+  if (typeof args.viewportSize !== 'undefined' || typeof args.environment !== 'undefined') {
+    mappedArgs.environment = {viewportSize: args.viewportSize, ...args.environment}
+  }
 
-  return Object.assign({testName, dontCloseBatches: !shouldUseBrowserHooks}, appliConfFileCopy, mappedArgs)
+  return Object.assign({testName, keepBatchOpen: !shouldUseBrowserHooks}, appliConfFileCopy, mappedArgs)
 }
 
-function fillDefaultBrowserName(browser) {
-  if (!browser.iosDeviceInfo && !browser.chromeEmulationInfo) {
-    if (!browser.name) {
-      browser.name = 'chrome'
-    }
-    if (browser.deviceName) {
-      browser = {chromeEmulationInfo: browser}
+function eyesOpenToCheckMapValues(args) {
+  const {browser, waitBeforeCapture, layoutBreakpoints, accessibilityValidation} = args
+
+  const openToCheckSettingsArgs = {
+    browser,
+    waitBeforeCapture,
+    layoutBreakpoints,
+  }
+
+  if (accessibilityValidation) {
+    const {level, guidelinesVersion} = accessibilityValidation
+    openToCheckSettingsArgs.accessibilitySettings = {
+      level,
+      version: guidelinesVersion,
     }
-    return browser
-  } else {
-    return browser
   }
+  return openToCheckSettingsArgs
 }
 
-module.exports = {eyesOpenMapValues}
+module.exports = {eyesOpenMapValues, eyesOpenToCheckMapValues}

package/src/expose.ts

@@ -8,6 +8,7 @@
  **/
 /// <reference types="cypress" />
 import type * as api from '@applitools/eyes-api'
+import type * as core from '@applitools/core'
 import {type EyesSelector, type TestResultsStatus} from '@applitools/eyes-api'
 
 export type {EyesSelector, TestResultsStatus}
@@ -15,11 +16,12 @@ export type {EyesSelector, TestResultsStatus}
 type MaybeArray<T> = T | T[]
 
 type LegacyRegion = {left: number; top: number; width: number; height: number}
-type Selector = {selector: string; type?: 'css' | 'xpath'; nodeType?: 'element' | 'shadow-root'} | 'string'
+type Selector = {selector: string; type?: 'css' | 'xpath'; nodeType?: 'element' | 'shadow-root'} | string
 type Element = HTMLElement | JQuery<HTMLElement>
 type ElementWithOptions = {element: Element; regionId?: string; padding?: any}
+type SpecType = core.SpecType<unknown, unknown, Element, Selector>
 
-export type CypressCheckSettings = api.CheckSettingsAutomationPlain<Element, Selector> & {
+export type CypressCheckSettings = api.CheckSettingsAutomationPlain<SpecType> & {
   tag?: CypressCheckSettings['name']
 
   target?: 'window' | 'region'
@@ -47,7 +49,7 @@ export type CypressCheckSettings = api.CheckSettingsAutomationPlain<Element, Sel
   ignoreCaret?: boolean
   ignoreDisplacements?: boolean
 }
-export type CypressEyesConfig = api.ConfigurationPlain<Element, Selector> & {
+export type CypressEyesConfig = api.ConfigurationPlain<SpecType> & {
   browser?: MaybeArray<
     | NonNullable<CypressEyesConfig['browsersInfo']>[number]
     | {deviceName: string; screenOrientation?: api.ScreenOrientationPlain; name?: string}

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>
 } {
@@ -35,11 +40,11 @@ export default function makeGlobalRunHooks({closeManager, closeBatches, closeUni
 
         let testResults
         for (const summary of summaries) {
-          testResults = summary.results.map(({testResults}: any) => testResults)
+          testResults = summary.results.map(({result}: any) => result)
         }
         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,
@@ -47,7 +52,7 @@ export default function makeGlobalRunHooks({closeManager, closeBatches, closeUni
         }
 
         if (config.appliConfFile.tapDirPath) {
-          await handleTestResults.handleBatchResultsFile(testResults, {
+          handleTestResults.handleBatchResultsFile(testResults, {
             tapDirPath: config.appliConfFile.tapDirPath,
             tapFileName: config.appliConfFile.tapFileName,
           })

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
@@ -55,14 +62,14 @@ export default function makePluginExport({startServer, eyesConfig}: any) {
       return pluginInitArgs
     }
     return function getCloseServer() {
-      return eyesServer.close()
+      return new Promise<void>(res => eyesServer.close(() => res()))
     }
 
     async function setupNodeEvents(
       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,7 +1,5 @@
 import connectSocket, {type SocketWithUniversal} from './webSocket'
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import {makeServerProcess} from '@applitools/eyes-universal'
+import {type CloseBatchSettings, makeCoreServerProcess} from '@applitools/core'
 import handleTestResults from './handleTestResults'
 import path from 'path'
 import fs from 'fs'
@@ -12,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({
@@ -40,11 +45,22 @@ 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')
     }
 
-    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess({
+    const {port: universalPort, close: closeUniversalServer} = await makeCoreServerProcess({
       idleTimeout: 0,
       shutdownMode: 'stdin',
       forkOptions,
@@ -126,16 +142,13 @@ export default function makeStartServer({logger}: {logger: Logger}) {
     function closeManager() {
       return Promise.all(
         managers.map(({manager, socketWithUniversal}) =>
-          socketWithUniversal.request('EyesManager.closeManager', {
-            manager,
-            throwErr: false,
-          }),
+          socketWithUniversal.request('EyesManager.getResults', {manager, settings: {throwErr: false}}),
         ),
       )
     }
-    function closeBatches(settings: any) {
+    function closeBatches(settings: CloseBatchSettings | CloseBatchSettings[]) {
       if (socketWithUniversal)
-        return socketWithUniversal.request('Core.closeBatches', {settings}).catch((err: Error) => {
+        return socketWithUniversal.request('Core.closeBatch', {settings}).catch((err: Error) => {
           logger.log('@@@', err)
         })
     }

package/src/setup/handlePlugin.js

@@ -25,7 +25,7 @@ export default ${chalk.green.bold('eyesPlugin(')}definedConfig({
   //...
 })${chalk.green.bold(')')}
 
-For more information, visit Eyes-Cypress documentation https://www.npmjs.com/package/@applitools/eyes-cypress (manual configuration section)
+For more information, visit Eyes-Cypress documentation https://applitools.com/docs/api-ref/sdk-api/cypress/typescript
 `,
         {padding: 1, borderColor: 'cyan'},
       ),