@applitools/visual-grid-cli-utils 1.21.41 → 1.21.43

package/package.json

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

package/src/view-rendering.js

@@ -1,10 +1,118 @@
 'use strict'
 const {exec} = require('child_process')
+const retry = require('p-retry')
 const createSession = require('./commons/create-session')
 const calculateViewRenderingUrl = require('./commons/view-rendering-url')
 const {fetch, throwErrorFromBadStatus} = require('@applitools/http-commons')
 const fs = require('fs')
 
+async function waitForParsedStatus(vgUrl, renderId, authToken, waitTimeout = 5 * 60 * 1000) {
+  console.log(`[2/3] Waiting for parsing to complete...`)
+  let attemptCount = 0
+  const startTime = Date.now()
+  return await retry(
+    async () => {
+      attemptCount++
+      const response = await fetch(`${vgUrl}/render-status?render-id=${renderId}`, {
+        headers: {'X-Auth-Token': authToken},
+      })
+      if (!response.ok) {
+        throw new Error(
+          `failed to get rendering status. Error from Visual Grid: ${await response.text()}`,
+        )
+      }
+      const {status, error, rdvsMetadata, url} = await response.json()
+      if (status === 'error') {
+        throw new retry.AbortError(`Rendering failed: ${error}`)
+      } else if (status === 'parsed') {
+        const elapsed = ((Date.now() - startTime) / 1000).toFixed(1)
+        console.log(`      ✓ Parsing completed (${elapsed}s)`)
+        // Return the rdvsMetadata and url from the job
+        return {
+          rdvsMetadata,
+          url,
+        }
+      } else {
+        // Only log every 5 attempts to reduce noise
+        if (attemptCount % 5 === 0) {
+          const elapsed = ((Date.now() - startTime) / 1000).toFixed(0)
+          console.log(`      Status: ${status} (${elapsed}s elapsed)...`)
+        }
+        // Still processing (rendering or other status)
+        throw new Error(`Status is ${status}, waiting for parsed`)
+      }
+    },
+    {
+      forever: true,
+      minTimeout: 1000,
+      maxTimeout: 1000,
+      maxRetryTime: waitTimeout,
+      onFailedAttempt: () => {}, // Suppress default error logging
+    },
+  )
+}
+
+async function tryNewViewRenderingEndpoint(vgUrl, renderId, authToken, apiKey, serverUrl) {
+  try {
+    console.log(`[1/3] Starting resource parsing for render: ${renderId}`)
+    // Step 1: Call rerender API with parseResourcesOnly flag
+    const renderUrl = new URL('./render', vgUrl)
+    const {webhook, authToken: sessionAuthToken} = await createSession(apiKey, serverUrl)
+
+    const rerenderResponse = await fetch(renderUrl, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        'X-Auth-Token': sessionAuthToken,
+      },
+      body: JSON.stringify({
+        reRenderId: renderId,
+        webhook,
+        parseResourcesOnly: true,
+        agentId: `visual-grid-cli-utils/${require('../package.json').version}`,
+        options: {
+          parseResourcesOnly: true,
+        },
+      }),
+    })
+
+    if (!rerenderResponse.ok) {
+      const errorBody = await rerenderResponse.text()
+      return {
+        success: false,
+        error: `Rerender API failed - HTTP ${rerenderResponse.status}: ${errorBody}`,
+      }
+    }
+
+    const {renderId: parseRenderId} = await rerenderResponse.json()
+    console.log(`      ✓ Parse job created: ${parseRenderId}`)
+
+    // Step 2: Wait for "parsed" status
+    const parsedResult = await waitForParsedStatus(vgUrl, parseRenderId, sessionAuthToken)
+
+    // Step 3: Check if we have the required data
+    if (parsedResult.rdvsMetadata && parsedResult.url) {
+      console.log(`[3/3] Building view URL...`)
+      console.log(`      ✓ Resource tree ready`)
+      return {
+        success: true,
+        url: parsedResult.url,
+        rdvsMetadata: parsedResult.rdvsMetadata,
+      }
+    } else {
+      return {
+        success: false,
+        error: `Parsed result missing required fields (rdvsMetadata, url)`,
+      }
+    }
+  } catch (error) {
+    return {
+      success: false,
+      error: error.message || String(error),
+    }
+  }
+}
+
 async function main({
   apiKey,
   browser,
@@ -24,7 +132,26 @@ async function main({
     ? {authToken}
     : await createSession(apiKey, serverUrl)
 
-  const viewRenderingUrl = calculateViewRenderingUrl(renderId, finalAuthToken, accountOverride)
+  const vgUrl = process.env.VG_URL || 'https://render-wus.applitools.com'
+
+  // Try new view-rendering endpoint with rerender API
+  const result = await tryNewViewRenderingEndpoint(
+    vgUrl,
+    renderId,
+    finalAuthToken,
+    apiKey,
+    serverUrl,
+  )
+
+  let viewRenderingUrl
+  if (result.success) {
+    console.log('\n✓ Successfully generated view URL via new endpoint')
+    viewRenderingUrl = result.url
+  } else {
+    console.debug(`  (${result.error})`)
+    console.log('\n⚠ Legacy method used: Render ID predates SSA refactor.')
+    viewRenderingUrl = calculateViewRenderingUrl(renderId, finalAuthToken, accountOverride)
+  }
 
   if (downloadVhsFolder) {
     let response = await fetch(viewRenderingUrl)
@@ -42,9 +169,12 @@ async function main({
     const resource = await response.buffer()
     const fname = `${downloadVhsFolder}/${renderId}.vhs`
     fs.writeFileSync(fname, resource)
-    console.log('Wrote file: ' + fname)
+    console.log('\n✓ Wrote file: ' + fname)
   } else {
+    console.log('\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━')
+    console.log('View Rendering URL:')
     console.log(viewRenderingUrl)
+    console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━')
   }
 
   if (browser) {