@applitools/visual-grid-cli-utils 1.21.16 → 1.21.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/visual-grid-cli-utils",
-  "version": "1.21.16",
+  "version": "1.21.20",
   "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

@@ -1,7 +1,7 @@
 const retry = require('p-retry')
 const {fetch} = require('@applitools/http-commons')
 
-async function waitForRendering(vgUrl, renderId, authToken) {
+async function waitForRendering(vgUrl, renderId, authToken, waitTimeout = 10 * 60 * 1000) {
   return await retry(
     async () => {
       const response = await fetch(`${vgUrl}/render-status?render-id=${renderId}`, {
@@ -25,7 +25,7 @@ async function waitForRendering(vgUrl, renderId, authToken) {
       forever: true,
       minTimeout: 1000,
       maxTimeout: 1000,
-      maxRetryTime: 10 * 60 * 1000,
+      maxRetryTime: waitTimeout,
       onFailedAttempt: (err) => (err.message ? console.log(err.message) : undefined),
     },
   )

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,
@@ -41,7 +42,9 @@ async function main({
   viewRendering,
   canary,
   iosVersion,
+  timeout,
   options: optionsAsString,
+  selectorsToFindRegionsFor,
 }) {
   const options = parseJson(optionsAsString, 'options')
   options.chromeHeadless = headless
@@ -89,7 +92,9 @@ async function main({
           : undefined,
         region: region,
       },
-      selectorsToFindRegionsFor: rca && selector ? [selector] : undefined,
+      selectorsToFindRegionsFor: selectorsToFindRegionsFor
+        ? normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor)
+        : undefined,
       enableMultipleResultsPerSelector: true,
       sendDom: rca,
       agentId: `visual-grid-cli-utils/${require('../package.json').version}`,
@@ -120,6 +125,7 @@ async function main({
     vgUrl,
     reRenderId,
     authToken,
+    timeout,
   )
 
   if (err) {
@@ -151,17 +157,16 @@ 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')
     }
-  } else {
-    console.log('skipping writing image to file...')
+
+    if (selectorRegions) {
+      console.log('-----')
+      console.log(`selector regions output:`)
+      console.log(JSON.stringify(selectorRegions, null, 2))
+      console.log('-----')
+    }
   }
 
   if (viewRendering) {
@@ -171,17 +176,16 @@ async function main({
   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

@@ -179,6 +179,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 +219,12 @@ async function main(argv, {shouldExitOnError = false} = {}) {
           type: 'boolean',
           default: false,
         })
+        .option('timeout', {
+          alias: 't',
+          describe: 'Timeout for operation (ms)',
+          default: 60000,
+          type: 'number',
+        })
         .option('options', {
           describe: 'send visual grid options to rendering (json)',
           type: 'string',
@@ -382,10 +393,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',