@applitools/visual-grid-cli-utils 1.21.37 → 1.21.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/visual-grid-cli-utils",
-  "version": "1.21.37",
+  "version": "1.21.39",
   "description": "",
   "main": "src/visual-grid-cli-utils.js",
   "engines": {
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@applitools/dom-snapshot": "^4.5.7",
-    "@applitools/eyes-images": "^4.21.0",
+    "@applitools/eyes-images": "4.21.0",
     "@applitools/functional-commons": "^1.6.0",
     "@applitools/http-commons": "^2.4.3",
     "@applitools/screenshot-stitching-client": "^8.0.15",
@@ -49,7 +49,7 @@
     "mime-types": "^2.1.32",
     "nursery": "^4.0.3",
     "p-retry": "^4.6.1",
-    "puppeteer": "^5.5.0",
+    "puppeteer": "^24.34.0",
     "throat": "^5.0.0",
     "uuid": "^8.3.2",
     "yargs": "^16.2.0"

package/src/compare.js

@@ -13,10 +13,10 @@ async function main(args) {
     runRerender(args.browser1.browser),
     runRerender(args.browser2.browser),
   ])
-  await compareWithEyes(results)
+  await compareWithEyes(results, args)
 }
 
-async function compareWithEyes(rerenderResults) {
+async function compareWithEyes(rerenderResults, args) {
   const eyes = new Eyes()
   let batchUrl
   try {
@@ -32,7 +32,10 @@ async function compareWithEyes(rerenderResults) {
     const uuid = randomUUID()
     let i = 0
     for (const result of rerenderResults) {
-      await eyes.open('VG-CLI compare', `Compare browsers ${uuid}`)
+      await eyes.open('VG-CLI compare', `Compare browsers ${uuid}`, {
+        width: args.width || 800,
+        height: args.height || 600,
+      })
       const {browser: name, image: file} = result
       const resp = await eyes.check(name, Target.image(file))
       batchUrl = batchUrl || eyes.getRunningSession().getUrl()

package/src/rerender.js

@@ -47,7 +47,17 @@ async function main({
   options: optionsAsString,
   selectorsToFindRegionsFor,
   vhsCompatibilityParams,
+  globalResourceMapPath,
+  originUrl,
 }) {
+  // Validate rdvsMetadata parameters
+  const hasGlobalResourceMapPath = !!globalResourceMapPath
+  const hasOriginUrl = !!originUrl
+  
+  if (hasGlobalResourceMapPath !== hasOriginUrl) {
+    throw new Error('Both --global-resource-map-path and --origin-url must be provided together')
+  }
+
   const options = parseJson(optionsAsString, 'options')
   options.chromeHeadless = headless
   const vgUrl = process.env.VG_URL || 'https://render-wus.applitools.com'
@@ -58,73 +68,83 @@ async function main({
   const {webhook, authToken} = await createSession(apiKey, serverUrl)
 
   const renderUrl = new URL('./render', vgUrl)
+  const requestBody = {
+    reRenderId: renderId,
+    accountOverride,
+    webhook,
+    renderInfo: {
+      emulationInfo: deviceEmulation
+        ? {deviceName: deviceEmulation, screenOrientation: deviceOrientation}
+        : undefined,
+      iosDeviceInfo: iosDeviceName
+        ? {
+            name: iosDeviceName,
+            screenOrientation: iosDeviceOrientation,
+            version: canary ? 'canary' : iosVersion,
+          }
+        : undefined,
+      vhsCompatibilityParams: vhsCompatibilityParams
+        ? {
+            UIKitLinkTimeVersionNumber: vhsCompatibilityParams[0],
+            UIKitRunTimeVersionNumber: vhsCompatibilityParams[1],
+          }
+        : undefined,
+      androidDeviceInfo: androidDeviceName
+        ? {
+            name: androidDeviceName,
+            screenOrientation: androidDeviceOrientation,
+            version: canary ? 'canary' : androidVersion,
+          }
+        : undefined,
+      vhsType: androidDeviceName ? androidVhsType : undefined,
+      width: deviceEmulation || iosDeviceName ? undefined : width,
+      height: deviceEmulation || iosDeviceName ? undefined : height,
+      target,
+      selector: selector
+        ? {selector, type: selector.startsWith('//') ? 'xpath' : 'css'}
+        : chainedSelectors
+        ? normalizeChainedSelectorsArray(chainedSelectors)
+        : undefined,
+      region: region,
+    },
+    selectorsToFindRegionsFor: selectorsToFindRegionsFor
+      ? normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor)
+      : undefined,
+    enableMultipleResultsPerSelector: true,
+    includeFullPageSize,
+    sendDom: rca,
+    agentId: `visual-grid-cli-utils/${require('../package.json').version}`,
+    // browser: {
+    //   name: iosDeviceName ? 'safari' : canary ? convertBrowserNameToCanary(browser) : browser,
+    // },
+    // platform: {name: iosDeviceName ? 'ios' : undefined},
+    browser: native
+      ? undefined
+      : {
+          name: iosDeviceName ? 'safari' : canary ? convertBrowserNameToCanary(browser) : browser,
+        },
+    platform: {
+      name: iosDeviceName ? 'ios' : androidDeviceName ? 'android' : undefined,
+      type: native ? 'native' : undefined,
+    },
+    scriptHooks: {
+      beforeCaptureScreenshot: bcsHook,
+    },
+    options,
+  }
+
+  // Add rdvsMetadata if both parameters are provided
+  if (hasGlobalResourceMapPath && hasOriginUrl) {
+    requestBody.rdvsMetadata = {
+      globalResourceMapPath,
+      originUrl,
+    }
+  }
+
   const response = await fetch(renderUrl, {
     method: 'POST',
     headers: {'content-type': 'application/json', 'X-Auth-Token': authToken},
-    body: JSON.stringify({
-      reRenderId: renderId,
-      accountOverride,
-      webhook,
-      renderInfo: {
-        emulationInfo: deviceEmulation
-          ? {deviceName: deviceEmulation, screenOrientation: deviceOrientation}
-          : undefined,
-        iosDeviceInfo: iosDeviceName
-          ? {
-              name: iosDeviceName,
-              screenOrientation: iosDeviceOrientation,
-              version: canary ? 'canary' : iosVersion,
-            }
-          : undefined,
-        vhsCompatibilityParams: vhsCompatibilityParams
-          ? {
-              UIKitLinkTimeVersionNumber: vhsCompatibilityParams[0],
-              UIKitRunTimeVersionNumber: vhsCompatibilityParams[1],
-            }
-          : undefined,
-        androidDeviceInfo: androidDeviceName
-          ? {
-              name: androidDeviceName,
-              screenOrientation: androidDeviceOrientation,
-              version: canary ? 'canary' : androidVersion,
-            }
-          : undefined,
-        vhsType: androidDeviceName ? androidVhsType : undefined,
-        width: deviceEmulation || iosDeviceName ? undefined : width,
-        height: deviceEmulation || iosDeviceName ? undefined : height,
-        target,
-        selector: selector
-          ? {selector, type: selector.startsWith('//') ? 'xpath' : 'css'}
-          : chainedSelectors
-          ? normalizeChainedSelectorsArray(chainedSelectors)
-          : undefined,
-        region: region,
-      },
-      selectorsToFindRegionsFor: selectorsToFindRegionsFor
-        ? normalizeSelectorsToFindRegionsForArray(selectorsToFindRegionsFor)
-        : undefined,
-      enableMultipleResultsPerSelector: true,
-      includeFullPageSize,
-      sendDom: rca,
-      agentId: `visual-grid-cli-utils/${require('../package.json').version}`,
-      // browser: {
-      //   name: iosDeviceName ? 'safari' : canary ? convertBrowserNameToCanary(browser) : browser,
-      // },
-      // platform: {name: iosDeviceName ? 'ios' : undefined},
-      browser: native
-        ? undefined
-        : {
-            name: iosDeviceName ? 'safari' : canary ? convertBrowserNameToCanary(browser) : browser,
-          },
-      platform: {
-        name: iosDeviceName ? 'ios' : androidDeviceName ? 'android' : undefined,
-        type: native ? 'native' : undefined,
-      },
-      scriptHooks: {
-        beforeCaptureScreenshot: bcsHook,
-      },
-      options,
-    }),
+    body: JSON.stringify(requestBody),
   })
   if (!response.ok) await throwErrorFromBadStatus(renderUrl, response)
 

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

@@ -239,6 +239,16 @@ async function main(argv, {shouldExitOnError = false} = {}) {
         .option('options', {
           describe: 'send visual grid options to rendering (json)',
           type: 'string',
+        })
+        .option('global-resource-map-path', {
+          alias: 'grm',
+          describe: 'global resource map path for rdvsMetadata',
+          type: 'string',
+        })
+        .option('origin-url', {
+          alias: 'ou',
+          describe: 'origin URL for rdvsMetadata',
+          type: 'string',
         }),
     )
     .command(