@applitools/eyes-cypress 3.29.1 → 3.30.1

package/CHANGELOG.md

@@ -12,6 +12,21 @@
 
 
 
+## 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
+- Crop screenshot image base on account info
+### Bug fixes
+- Fixed slowness during ufg tests
+- Upgrade to core@v2
+
 ## 3.29.1 - 2023/2/2
 
 ### Features

package/README.md

@@ -108,17 +108,23 @@ For `typescript` use you must add the following code to your `tsconfig.json`:
 
 Eyes-Cypress ships with official type declarations for TypeScript. This allows you to add eyes commands to your TypeScript tests.
 
-Add this file to your project with either: 
+Add this file to your project using one of the following two options:
 1. Adding the path to your [tsconfig](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) file:
+
+```json
+{
+  ...
+  "compilerOptions": {
+    ...
+    "types": ["@applitools/eyes-cypress", "cypress", "node"]
+    ...
+  }
+}
+```
+
+2. Create `index.d.ts` file under `cypress/support` folder that contains:
     ```
-    {
-      "files": ["./node_modules/@applitools/eyes-cypress/index.d.ts"],
-      ...
-    }
-    ```
-2. Copying the file to to your [cypress/support/](https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests.html#Folder-Structure) dir:
-    ```
-    cp node_modules/@applitools/eyes-cypress/index.d.ts ./cypress/support/    
+      import "@applitools/eyes-cypress"
     ```
 ### Applitools API key
 
@@ -269,6 +275,7 @@ Applitools will take screenshots and perform the visual comparisons in the backg
         - [`visualGridOptions`](#visualgridoptions)
         - [`coded regions-regionId`](#regionId)
         - [`lazy loading`](#lazy-loading)
+        - [Density metrics](#density-metrics-densitymetrics)
       - [Close](#close)
       - [GetAllTestResults](#getalltestresults)
       - [deleteTestResults](#deletetestresults)
@@ -751,7 +758,7 @@ It's possible to have the SDK scroll the entire page (or a specific length of th
 
 ```js
 // lazy loads with sensible defaults
-cy.eyesCheckWindow(lazyload:{})
+cy.eyesCheckWindow({lazyload:{}})
 
 // lazy loads with options specified
 cy.eyesCheckWindow({lazyLoad: {
@@ -761,6 +768,23 @@ cy.eyesCheckWindow({lazyLoad: {
 }})
 ```
 
+##### Density metrics (`densityMetrics`)
+
+In order to set the density metrics for the screenshot, use the `densityMetrics` method. This method accepts a object value with the following properties:
+
+- `xdpi` - The exact physical pixels per inch of the screen in the X dimension.
+- `ydpi` - The exact physical pixels per inch of the screen in the Y dimension.
+- `scaleRatio` - The scale ratio.
+
+```js
+// set density metrics
+cy.eyesCheckWindow({
+  densityMetrics:
+    xdpi: 100,
+    ydpi: 100,
+    scaleRatio: 1
+})
+```
 
 #### Close
 

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)
@@ -17,18 +17,18 @@ function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer }
                 const summaries = await closeManager();
                 let testResults;
                 for (const summary of summaries) {
-                    testResults = summary.results.map(({ testResults }) => testResults);
+                    testResults = summary.results.map(({ result }) => 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,
                     });
                 }
                 if (config.appliConfFile.tapDirPath) {
-                    await handleTestResults_1.default.handleBatchResultsFile(testResults, {
+                    handleTestResults_1.default.handleBatchResultsFile(testResults, {
                         tapDirPath: config.appliConfFile.tapDirPath,
                         tapFileName: config.appliConfFile.tapFileName,
                     });

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;
@@ -55,10 +55,10 @@ function makePluginExport({ startServer, eyesConfig }) {
             return pluginInitArgs;
         }
         return function getCloseServer() {
-            return eyesServer.close();
+            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

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const webSocket_1 = __importDefault(require("./webSocket"));
-const eyes_universal_1 = require("@applitools/eyes-universal");
+const core_1 = require("@applitools/core");
 const handleTestResults_1 = __importDefault(require("./handleTestResults"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
@@ -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,10 +29,12 @@ 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, eyes_universal_1.makeServerProcess)({
+        const { port: universalPort, close: closeUniversalServer } = await (0, core_1.makeCoreServerProcess)({
             idleTimeout: 0,
             shutdownMode: 'stdin',
             forkOptions,
@@ -101,14 +103,11 @@ function makeStartServer({ logger }) {
             closeUniversalServer,
         };
         function closeManager() {
-            return Promise.all(managers.map(({ manager, socketWithUniversal }) => socketWithUniversal.request('EyesManager.closeManager', {
-                manager,
-                throwErr: false,
-            })));
+            return Promise.all(managers.map(({ manager, socketWithUniversal }) => socketWithUniversal.request('EyesManager.getResults', { manager, settings: { throwErr: false } })));
         }
         function closeBatches(settings) {
             if (socketWithUniversal)
-                return socketWithUniversal.request('Core.closeBatches', { settings }).catch((err) => {
+                return socketWithUniversal.request('Core.closeBatch', { settings }).catch((err) => {
                     logger.log('@@@', err);
                 });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.29.1",
+  "version": "3.30.1",
   "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",
@@ -45,7 +47,7 @@
     "cypress12": "./node_modules/cypress12/bin/cypress",
     "test:ts:run:12": "yarn cypress12 run --project ./test/e2e/ts --config-file ./cypress-12.config.ts",
     "test:ts:run": "yarn test:ts:run:legacy && yarn test:ts:run:9",
-    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
     "test:e2e": "mkdir -p test/fixtures/testAppCopies && mocha --no-timeouts 'test/e2e/**/*.test.js'",
     "test:components": "cd test/components && yarn && npx cypress run --component",
     "cypress": "cypress open --config-file test/fixtures/cypress-play.json",
@@ -54,11 +56,12 @@
     "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",
-    "postversion": "bongo postversion --skip-release-notification"
+    "postversion": "bongo postversion"
   },
   "husky": {
     "hooks": {
@@ -66,12 +69,11 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "1.4.6",
-    "@applitools/eyes-api": "1.13.1",
-    "@applitools/eyes-universal": "2.18.0",
+    "@applitools/core": "2.4.3",
+    "@applitools/eyes-api": "1.13.12",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.43",
-    "@applitools/utils": "1.3.28",
+    "@applitools/logger": "1.1.48",
+    "@applitools/utils": "1.3.32",
     "boxen": "5.1.2",
     "chalk": "3.0.0",
     "semver": "7.3.8",
@@ -80,20 +82,17 @@
     "ws": "8.5.0"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "^1.2.11",
-    "@applitools/bongo": "^2.2.2",
-    "@applitools/scripts": "1.2.0",
-    "@applitools/sdk-coverage-tests": "^2.7.8",
+    "@applitools/api-extractor": "^1.2.12",
+    "@applitools/bongo": "^3.0.2",
+    "@applitools/sdk-coverage-tests": "^3.0.0",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.22",
-    "@applitools/test-utils": "1.5.11",
+    "@applitools/test-server": "1.1.28",
+    "@applitools/test-utils": "1.5.14",
     "@types/node": "12",
     "@types/semver": "^7.3.13",
     "@types/uuid": "^9.0.0",
     "@types/which": "^2.0.1",
     "@types/ws": "^8.2.2",
-    "@typescript-eslint/eslint-plugin": "^5.47.1",
-    "@typescript-eslint/parser": "^5.47.1",
     "chai": "4.2.0",
     "chai-spies": "1.0.0",
     "cookie-parser": "1.4.4",
@@ -101,13 +100,10 @@
     "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-config-prettier": "^8.5.0",
-    "eslint-plugin-mocha-no-only": "1.1.0",
-    "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-mocha-no-only": "1.1.1",
     "husky": "4.3.8",
     "lodash.omit": "4.5.0",
     "mocha": "8.0.1",

package/src/browser/commands.js

@@ -4,18 +4,31 @@ const spec = require('../../dist/browser/spec-driver')
 const Refer = require('./refer')
 const Socket = require('./socket')
 const {socketCommands} = require('./socketCommands')
-const {eyesOpenMapValues} = require('./eyesOpenMapping')
+const {eyesOpenMapValues, eyesOpenToCheckMapValues} = require('./eyesOpenMapping')
 const {eyesCheckMapValues} = require('./eyesCheckMapping')
 const {TestResultsSummary} = require('@applitools/eyes-api')
 const refer = new Refer()
 const socket = new Socket()
 const throwErr = Cypress.config('failCypressOnDiff')
 socketCommands(socket, refer)
-let connectedToUniversal = false
 
 let manager,
   eyes,
-  closePromiseArr = []
+  closePromiseArr = [],
+  _summary,
+  connectedToUniversal,
+  openToCheckSettingsArgs
+
+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}]}
+  })
+  _summary = await _summary
+
+  return _summary
+}
 
 function getGlobalConfigProperty(prop) {
   const property = Cypress.config(prop)
@@ -34,8 +47,6 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
       isCurrentTestDisabled = false
       return
     }
-    await Promise.all(closePromiseArr)
-    const summary = await socket.request('EyesManager.closeManager', {manager, throwErr})
 
     const deleteTest = ({settings: {testId, batchId, secretToken}}) => {
       const {serverUrl, proxy, apiKey} = Cypress.config('appliConfFile')
@@ -50,9 +61,7 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
         },
       })
     }
-    summary.results = summary.results.map(res => {
-      return {...res, result: res.testResults, error: res.exception, renderer: res.browserInfo}
-    })
+    const summary = await getSummary()
     return new TestResultsSummary({summary, deleteTest})
   })
 })
@@ -73,9 +82,9 @@ if (shouldUseBrowserHooks || Cypress.config('eyesFailCypressOnDiff')) {
         tapFileName: Cypress.config('appliConfFile').tapFileName,
         shouldCreateTapFile: shouldUseBrowserHooks,
       }
-      await Promise.all(closePromiseArr)
-      const summary = await socket.request('EyesManager.closeManager', {manager, throwErr})
-      const testResults = summary.results.map(({testResults}) => testResults)
+
+      const summary = await getSummary()
+      const testResults = summary.results.map(({result}) => result)
       const message = await socket.request('Test.printTestResults', {testResults, resultConfig})
       if (
         !!getGlobalConfigProperty('eyesFailCypressOnDiff') &&
@@ -105,38 +114,37 @@ Cypress.Commands.add('eyesOpen', function (args = {}) {
 
   return cy.then({timeout: 86400000}, async () => {
     setRootContext()
-    const driver = refer.ref(cy.state('window').document)
+    const target = refer.ref(cy.state('window').document)
 
     if (!connectedToUniversal) {
       socket.connect(`wss://localhost:${Cypress.config('eyesPort')}/eyes`)
       connectedToUniversal = true
-      socket.emit('Core.makeSDK', {
-        name: 'eyes.cypress',
-        version: require('../../package.json').version,
-        commands: Object.keys(spec).concat(['isSelector', 'isDriver', 'isElement']), // TODO fix spec.isSelector and spec.isDriver and spec.isElement in driver utils
+      socket.emit('Core.makeCore', {
+        agentId: `eyes.cypress/${require('../../package.json').version}`,
+        cwd: Cypress.config('projectRoot'),
+        spec: Object.keys(spec).concat(['isSelector', 'isDriver', 'isElement']), // TODO fix spec.isSelector and spec.isDriver and spec.isElement in driver
       })
 
       manager =
         manager ||
         (await socket.request(
           'Core.makeManager',
-          Object.assign({}, {concurrency: Cypress.config('eyesTestConcurrency')}, {legacy: false, type: 'vg'}),
+          Object.assign({}, {concurrency: Cypress.config('eyesTestConcurrency')}, {type: 'ufg'}),
         ))
     }
 
     const appliConfFile = Cypress.config('appliConfFile')
-    const config = eyesOpenMapValues({
+
+    openToCheckSettingsArgs = eyesOpenToCheckMapValues(args)
+
+    const settings = eyesOpenMapValues({
       args,
       appliConfFile,
       testName,
       shouldUseBrowserHooks,
-      defaultBrowser: {
-        width: Cypress.config('viewportWidth'),
-        height: Cypress.config('viewportHeight'),
-        name: 'chrome',
-      },
     })
-    eyes = await socket.request('EyesManager.openEyes', {manager, driver, config})
+
+    eyes = await socket.request('EyesManager.openEyes', {manager, target, settings})
   })
 })
 
@@ -145,16 +153,20 @@ Cypress.Commands.add('eyesCheckWindow', (args = {}) =>
     if (isCurrentTestDisabled) return
 
     setRootContext()
-    const driver = refer.ref(cy.state('window').document)
+    const target = refer.ref(cy.state('window').document)
 
     Cypress.log({name: 'Eyes: check window'})
 
-    const checkSettings = eyesCheckMapValues({args, refer})
+    const settings = eyesCheckMapValues({
+      args: {...openToCheckSettingsArgs, ...args},
+      refer,
+      appliConfFile: Cypress.config('appliConfFile'),
+    })
 
     return socket.request('Eyes.check', {
       eyes,
-      settings: checkSettings,
-      driver,
+      settings,
+      target,
     })
   }),
 )
@@ -169,11 +181,12 @@ Cypress.Commands.add('eyesClose', () => {
       return
     }
 
-    // intentionally not returning the result in order to not wait on the close promise
-    const p = socket.request('Eyes.close', {eyes, throwErr: false}).catch(err => {
+    // Eyes.close in core is not waiting on results anymore. So we should return it in order to await it
+    const p = socket.request('Eyes.close', {eyes}).catch(err => {
       console.log('Error in cy.eyesClose', err)
     })
     closePromiseArr.push(p)
+    return p
   })
 })
 

package/src/browser/eyesCheckMapping.js

@@ -1,9 +1,12 @@
 /* global Node */
-function eyesCheckMapValues({args, refer}) {
+function eyesCheckMapValues({openToCheckSettingsArgs, args, refer, appliConfFile}) {
   if (typeof args === `string`) {
     args = {tag: args}
   }
-  const config = args // just did it for having less git changes at this moment
+  args = {...openToCheckSettingsArgs, ...args}
+  if (typeof args.waitBeforeCapture !== 'number') args.waitBeforeCapture = appliConfFile.waitBeforeCapture
+  let accessibilitySettings = args.accessibilitySettings || appliConfFile.accessibilityValidation
+
   const mappedValues = [
     'tag',
     'scriptHooks',
@@ -20,56 +23,75 @@ function eyesCheckMapValues({args, refer}) {
 
   let regionSettings = {}
   let shadowDomSettings = {}
+
+  let renderers = args.renderers || args.browser || appliConfFile.browser
+  if (renderers) {
+    if (Array.isArray(renderers)) {
+      for (const [index, value] of renderers.entries()) {
+        renderers[index] = fillDefaultBrowserName(value)
+      }
+    } else {
+      renderers = [fillDefaultBrowserName(renderers)]
+    }
+  }
+
   const checkSettings = {
-    name: config.tag,
-    hooks: config.scriptHooks,
-    ignoreRegions: convertPaddedRegion(config.ignore),
-    floatingRegions: convertFloatingRegion(config.floating),
-    strictRegions: convertPaddedRegion(config.strict),
-    layoutRegions: convertPaddedRegion(config.layout),
-    contentRegions: convertPaddedRegion(config.content),
-    accessibilityRegions: convertAccessabilityRegions(config.accessibility),
+    name: args.tag,
+    hooks: args.scriptHooks,
+    ignoreRegions: convertPaddedRegion(args.ignore),
+    floatingRegions: convertFloatingRegion(args.floating),
+    strictRegions: convertPaddedRegion(args.strict),
+    layoutRegions: convertPaddedRegion(args.layout),
+    contentRegions: convertPaddedRegion(args.content),
+    accessibilityRegions: convertAccessabilityRegions(args.accessibility),
+    renderers,
+  }
+  if (args.variationGroupId) {
+    checkSettings.userCommandId = args.variationGroupId
+  }
+  if (args.accessibilitySettings) {
+    checkSettings.accessibilitySettings = accessibilitySettings
   }
 
-  if (config.target === 'region') {
-    if (!Array.isArray(config.selector)) {
-      if (config.element) {
-        if (isHTMLElement(config.element)) {
+  if (args.target === 'region') {
+    if (!Array.isArray(args.selector)) {
+      if (args.element) {
+        if (isHTMLElement(args.element)) {
           regionSettings = {
-            region: Object.assign(refer.ref(config.element), {type: 'element'}),
+            region: Object.assign(refer.ref(args.element), {type: 'element'}),
           }
         } else {
           // JQuery element
           regionSettings = {
-            region: Object.assign(refer.ref(config.element[0]), {type: 'element'}),
+            region: Object.assign(refer.ref(args.element[0]), {type: 'element'}),
           }
         }
       } else if (
-        config.region &&
-        config.region.hasOwnProperty('top') &&
-        config.region.hasOwnProperty('left') &&
-        config.region.hasOwnProperty('width') &&
-        config.region.hasOwnProperty('height')
+        args.region &&
+        args.region.hasOwnProperty('top') &&
+        args.region.hasOwnProperty('left') &&
+        args.region.hasOwnProperty('width') &&
+        args.region.hasOwnProperty('height')
       ) {
         regionSettings = {
           region: {
-            y: config.region.top,
-            x: config.region.left,
-            width: config.region.width,
-            height: config.region.height,
+            y: args.region.top,
+            x: args.region.left,
+            width: args.region.width,
+            height: args.region.height,
           },
         }
-      } else if (!config.hasOwnProperty('selector')) {
+      } else if (!args.hasOwnProperty('selector')) {
         regionSettings = {
-          region: config.region,
+          region: args.region,
         }
       } else {
         regionSettings = {
-          region: config.selector,
+          region: args.selector,
         }
       }
     } else {
-      const selectors = config.selector
+      const selectors = args.selector
       for (let i = selectors.length - 1; i > -1; i--) {
         if (i === selectors.length - 1) {
           shadowDomSettings['shadow'] = selectors[i].selector
@@ -88,12 +110,12 @@ function eyesCheckMapValues({args, refer}) {
   }
 
   for (const val of mappedValues) {
-    if (config.hasOwnProperty(val)) {
-      delete config[val]
+    if (args.hasOwnProperty(val)) {
+      delete args[val]
     }
   }
 
-  return Object.assign({}, checkSettings, regionSettings, config)
+  return Object.assign({}, checkSettings, regionSettings, args)
 
   // #region helper functions
 
@@ -176,10 +198,12 @@ function eyesCheckMapValues({args, refer}) {
 
     for (const region of floatingRegions) {
       const floatingRegion = {
-        maxDownOffset: region.maxDownOffset || 0,
-        maxLeftOffset: region.maxLeftOffset || 0,
-        maxUpOffset: region.maxUpOffset || 0,
-        maxRightOffset: region.maxRightOffset || 0,
+        offset: {
+          bottom: region.maxDownOffset || 0,
+          left: region.maxLeftOffset || 0,
+          top: region.maxUpOffset || 0,
+          right: region.maxRightOffset || 0,
+        },
       }
       if (region.hasOwnProperty('selector')) {
         floatingRegion.region = region.selector
@@ -191,7 +215,7 @@ function eyesCheckMapValues({args, refer}) {
           floating.push(Object.assign({}, region, floatingRegion, {region: element}))
         }
       } else if (region.hasOwnProperty('region')) {
-        floating.push(region)
+        floating.push({offset: floatingRegion.offset, ...region})
       } else {
         floatingRegion.region = {
           y: region.top,
@@ -233,4 +257,18 @@ function isHTMLElement(element) {
   return element.nodeType && element.nodeType === Node.ELEMENT_NODE
 }
 
+function fillDefaultBrowserName(browser) {
+  if (!browser.iosDeviceInfo && !browser.chromeEmulationInfo) {
+    if (!browser.name) {
+      browser.name = 'chrome'
+    }
+    if (browser.deviceName) {
+      browser = {chromeEmulationInfo: browser}
+    }
+    return browser
+  } else {
+    return browser
+  }
+}
+
 module.exports = {eyesCheckMapValues}