@applitools/visual-grid-cli-utils 1.21.18 → 1.21.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/visual-grid-cli-utils",
-  "version": "1.21.18",
+  "version": "1.21.22",
   "description": "",
   "main": "src/visual-grid-cli-utils.js",
   "engines": {

package/src/commons/normalizeChainedSelectorsArray.js

@@ -0,0 +1,15 @@
+'use strict'
+function normalizeChainedSelectorsArray(chainedSelectors) {
+  const cs = []
+  for (let i = 0; i < chainedSelectors.length; i += 2) {
+    cs.push({
+      selector: chainedSelectors[i],
+      type: chainedSelectors[i].startsWith('//') ? 'xpath' : 'css',
+      nodeType: i + 1 < chainedSelectors.length ? chainedSelectors[i + 1] : 'element',
+    })
+  }
+
+  return cs
+}
+
+module.exports = normalizeChainedSelectorsArray

package/src/commons/wait-for-rendering.js

@@ -12,13 +12,14 @@ async function waitForRendering(vgUrl, renderId, authToken, waitTimeout = 10 * 6
           `failed to get rendering status. Error from Visual Grid: ${await response.text()}`,
         )
       }
-      const {status, error, imageLocation, domLocation, selectorRegions} = await response.json()
+      const {status, error, imageLocation, domLocation, selectorRegions, fullPageSize} =
+        await response.json()
       if (status === 'error') {
         return [error]
       } else if (status === 'rendering') {
         throw new Error(``)
       } else {
-        return [undefined, imageLocation, domLocation, selectorRegions]
+        return [undefined, imageLocation, domLocation, selectorRegions, fullPageSize]
       }
     },
     {

package/src/rerender.js

@@ -10,6 +10,7 @@ const {writeImageLocationToFile, writeDomLocationToFile} = require('./write-imag
 const {plotDomCaptureToHtml} = require('./plot-dom-capture-to-html')
 const {convertBrowserNameToCanary} = require('./commons/parse-browser')
 const parseJson = require('./commons/parse-json.js')
+const normalizeChainedSelectorsArray = require('./commons/normalizeChainedSelectorsArray')
 
 async function main({
   apiKey,
@@ -39,10 +40,13 @@ async function main({
   rca,
   native,
   viewRendering,
+  includeFullPageSize,
   canary,
   iosVersion,
   timeout,
   options: optionsAsString,
+  selectorsToFindRegionsFor,
+  vhsCompatibilityParams,
 }) {
   const options = parseJson(optionsAsString, 'options')
   options.chromeHeadless = headless
@@ -72,6 +76,12 @@ async function main({
               version: canary ? 'canary' : iosVersion,
             }
           : undefined,
+        vhsCompatibilityParams: vhsCompatibilityParams
+          ? {
+              UIKitLinkTimeVersionNumber: vhsCompatibilityParams[0],
+              UIKitRunTimeVersionNumber: vhsCompatibilityParams[1],
+            }
+          : undefined,
         androidDeviceInfo: androidDeviceName
           ? {
               name: androidDeviceName,
@@ -90,8 +100,11 @@ async function main({
           : undefined,
         region: region,
       },
-      selectorsToFindRegionsFor: rca && selector ? [selector] : undefined,
+      selectorsToFindRegionsFor: selectorsToFindRegionsFor
+        ? normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor)
+        : undefined,
       enableMultipleResultsPerSelector: true,
+      includeFullPageSize,
       sendDom: rca,
       agentId: `visual-grid-cli-utils/${require('../package.json').version}`,
       // browser: {
@@ -117,7 +130,7 @@ async function main({
 
   const {renderId: reRenderId} = await response.json()
 
-  const [err, imageLocation, domLocation, selectorRegions] = await waitForRendering(
+  const [err, imageLocation, domLocation, selectorRegions, fullPageSize] = await waitForRendering(
     vgUrl,
     reRenderId,
     authToken,
@@ -153,35 +166,42 @@ async function main({
         outputFile: domSnapshotHtml,
       })
 
-      console.log(
-        `\n${domSnapshotOutputFile}: dom capture json${
-          selectorRegions && selectorRegions.length > 0 && selectorRegions[0].length > 0
-            ? `, at offset ${selectorRegions[0][0].x},${selectorRegions[0][0].y}`
-            : ''
-        }`,
-      )
+      console.log(`\n${domSnapshotOutputFile}: dom capture json`)
       console.log(domSnapshotHtml + ': dom capture rectangles')
     }
+
+    if (selectorRegions) {
+      console.log('-----')
+      console.log(`selector regions output:`)
+      console.log(JSON.stringify(selectorRegions, null, 2))
+      console.log('-----')
+    }
   }
 
   if (viewRendering) {
     console.log('\n' + calculateViewRenderingUrl(renderId, authToken))
   }
 
+  if (includeFullPageSize) {
+    console.log('-----')
+    console.log(`Full page size:`)
+    console.log(JSON.stringify(fullPageSize, null, 2))
+    console.log('-----')
+  }
+
   return {reRenderId}
 }
 
-function normalizeChainedSelectorsArray(chainedSelectors) {
-  const cs = []
-  for (let i = 0; i < chainedSelectors.length; i += 2) {
-    cs.push({
-      selector: chainedSelectors[i],
-      type: chainedSelectors[i].startsWith('//') ? 'xpath' : 'css',
-      nodeType: i + 1 < chainedSelectors.length ? chainedSelectors[i + 1] : 'element',
+function normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor) {
+  const arr = []
+  for (let i = 0; i < selectorsToFindRegionsFor.length; i += 2) {
+    arr.push({
+      selector: selectorsToFindRegionsFor[i],
+      type: selectorsToFindRegionsFor[i + 1],
     })
   }
 
-  return cs
+  return arr
 }
 
 module.exports = main

package/src/test-url.js

@@ -8,6 +8,7 @@ const createSession = require('./commons/create-session')
 const calculateViewRenderingUrl = require('./commons/view-rendering-url')
 const {convertBrowserNameToCanary} = require('./commons/parse-browser')
 const parseJson = require('./commons/parse-json.js')
+const normalizeChainedSelectorsArray = require('./commons/normalizeChainedSelectorsArray')
 
 async function main({
   apiKey,
@@ -16,6 +17,7 @@ async function main({
   height,
   target,
   selector,
+  chainedSelectors,
   rca,
   iosDeviceName,
   iosDeviceOrientation,
@@ -32,6 +34,7 @@ async function main({
   pns,
   canary,
   options: optionsAsString,
+  selectorsToFindRegionsFor,
 }) {
   debug('open done')
   const options = parseJson(optionsAsString, 'options')
@@ -113,10 +116,18 @@ async function main({
   checkWindow({
     snapshot: frame,
     url: frame.url,
-    target: selector ? 'region' : target,
-    selector: selector ? {selector, type: selector.startsWith('//') ? 'xpath' : 'css'} : undefined,
+    // target: selector ? 'region' : target,
+    sizeMode: selector ? 'region' : target,
+    selector: selector
+      ? {selector, type: selector.startsWith('//') ? 'xpath' : 'css'}
+      : chainedSelectors
+      ? normalizeChainedSelectorsArray(chainedSelectors)
+      : undefined,
     sendDom: rca,
     visualGridOptions: options,
+    ...(selectorsToFindRegionsFor && {
+      ignore: normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor),
+    }),
   })
   const results = await close(false)
   const result = results[0]
@@ -141,4 +152,16 @@ async function main({
   debug('browser closed')
 }
 
+function normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor) {
+  const arr = []
+  for (let i = 0; i < selectorsToFindRegionsFor.length; i += 2) {
+    arr.push({
+      selector: selectorsToFindRegionsFor[i],
+      type: selectorsToFindRegionsFor[i + 1],
+    })
+  }
+
+  return arr
+}
+
 module.exports = main

package/src/visual-grid-cli-utils.js

@@ -170,6 +170,11 @@ async function main(argv, {shouldExitOnError = false} = {}) {
           choices: ['viewport', 'full-page', 'selector', 'full-selector'],
           default: 'full-page',
         })
+        .option('vhs-compatibility-params', {
+          describe:
+            'should specify vhs compatibility params if running ios native jobs. Specify the value of UIKitLinkTimeVersionNumber followed by the value of UIKitRunTimeVersionNumber - e.g. --vhs-compatibility-params 4555 5067',
+          type: 'array',
+        })
         .option('selector', {
           describe: 'target a specific element (via CSS selector)',
           type: 'string',
@@ -179,6 +184,11 @@ async function main(argv, {shouldExitOnError = false} = {}) {
             'target an element inside a shadow-root or an iframe. Specify selectors in the following format: --chained-selectors "<selector1>" "<nodeType(iframe | shadow-root | element)>" "<selector2>" "<nodeType>"',
           type: 'array',
         })
+        .option('selectors-to-find-regions-for', {
+          describe:
+            'selectors to find regions for - Specify selectors in the following format: "<selector1>" "xpath || css" <selector2>" "xpath || css"...',
+          type: 'array',
+        })
         .option('region', {
           describe: 'target a specific region',
           type: 'string',
@@ -214,6 +224,12 @@ async function main(argv, {shouldExitOnError = false} = {}) {
           type: 'boolean',
           default: false,
         })
+        .option('includeFullPageSize', {
+          alias: 'f',
+          describe: 'output the full page size after rendering',
+          type: 'boolean',
+          default: false,
+        })
         .option('timeout', {
           alias: 't',
           describe: 'Timeout for operation (ms)',
@@ -388,10 +404,20 @@ async function main(argv, {shouldExitOnError = false} = {}) {
           choices: ['viewport', 'full-page', 'selector', 'full-selector'],
           default: 'full-page',
         })
+        .option('selectors-to-find-regions-for', {
+          describe:
+            'selectors to find regions for - Specify selectors in the following format: "<selector1>" "xpath || css" <selector2>" "xpath || css"...',
+          type: 'array',
+        })
         .option('selector', {
           describe: 'target a specific element (via CSS selector)',
           type: 'string',
         })
+        .option('chained-selectors', {
+          describe:
+            'target an element inside a shadow-root or an iframe. Specify selectors in the following format: --chained-selectors "<selector1>" "<nodeType(iframe | shadow-root | element)>" "<selector2>" "<nodeType>"',
+          type: 'array',
+        })
         .option('width', {
           describe: 'width of viewport',
           type: 'number',