@lambdatest/smartui-cli 4.0.7 → 4.0.9

package/README.md

@@ -0,0 +1,68 @@
+# SmartUI-CLI
+
+<img height="400" src="https://user-images.githubusercontent.com/126776938/232535511-8d51cf1b-1a33-48fc-825c-b13e7a9ec388.png">
+
+<p align="center">
+  <a href="https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Blog</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Docs</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Learning Hub</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/newsletter/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Newsletter</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/certifications/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Certifications</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.youtube.com/c/LambdaTest" target="_bank">YouTube</a>
+</p>
+&emsp;
+&emsp;
+&emsp;
+
+
+
+[<img height="58" width="200" src="https://user-images.githubusercontent.com/70570645/171866795-52c11b49-0728-4229-b073-4b704209ddde.png">](https://accounts.lambdatest.com/register?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
+
+
+The **SmartUI-CLI** allows you to capture visual snapshots of your web applications, upload images, and run visual regression tests using [LambdaTest's SmartUI](https://www.lambdatest.com/visual-regression-testing) platform directly from the command line.
+
+- [Installation](#installation)
+- [Commands](#commands)
+- [Documentation](#documentation)
+- [Issues](#issues)
+
+## Installation
+
+```sh-session
+$ npm install smartui-cli
+```
+
+**Note:**  
+If you face any problems executing tests with SmartUI-CLI `versions >= v4.x.x`, upgrade your Node.js version to `v20.3` or above.
+
+## Commands
+- `npx smartui exec` - Capture DOM assets for visual testing across multiple browsers and resolutions.
+- `npx smartui capture` - Bulk capture static URLs for visual testing.
+- `npx smartui upload` - Upload custom images or screenshots for visual comparison.
+- `npx smartui upload-figma` - Upload Figma design images for visual comparison.
+- `npx smartui config` - Creates configuration file according to the usecase.
+
+### Documentation
+
+In addition to its core functionalities, the SmartUI CLI leverages LambdaTest's cloud infrastructure for robust, scalable visual regression testing across various browsers and devices.
+
+- [SmartUI Selenium SDK](https://www.lambdatest.com/support/docs/smartui-selenium-java-sdk) - A complete SDK to capture DOM assets for visual tests.
+- [LambdaTest Documentation](https://www.lambdatest.com/support/docs/) - Official LambdaTest documentation for SmartUI and other integrations.
+- [Bulk capturing static URLs with SmartUI](https://www.lambdatest.com/support/docs/smartui-cli/) - Documentation for capturing satatic urls in bulk with SmartUI
+- [Bring your own screenshots](https://www.lambdatest.com/support/docs/smartui-cli-upload/) - Documentation for capturing satatic urls in bulk
+- [Figma CLI](https://www.lambdatest.com/support/docs/smartui-cli-figma/) - Documentation for uploading figma components to SmartUI
+
+### Issues
+
+If you encounter problems with SmartUI-CLI, [add an issue on GitHub](https://github.com/LambdaTest/smartui-cli/issues/new).
+
+For other support issues, reach out via [LambdaTest Support](https://www.lambdatest.com/support).
+
+------
+
+[Know more](https://www.lambdatest.com/visual-regression-testing) about SmartUI and it's AI enabled comparison engines.

package/dist/index.cjs

@@ -4,7 +4,7 @@
 var commander = require('commander');
 var which = require('which');
 var listr2 = require('listr2');
-var chalk7 = require('chalk');
+var chalk6 = require('chalk');
 var path2 = require('path');
 var fastify = require('fastify');
 var fs5 = require('fs');
@@ -21,7 +21,7 @@ var sharp = require('sharp');
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var which__default = /*#__PURE__*/_interopDefault(which);
-var chalk7__default = /*#__PURE__*/_interopDefault(chalk7);
+var chalk6__default = /*#__PURE__*/_interopDefault(chalk6);
 var path2__default = /*#__PURE__*/_interopDefault(path2);
 var fastify__default = /*#__PURE__*/_interopDefault(fastify);
 var fs5__default = /*#__PURE__*/_interopDefault(fs5);
@@ -187,6 +187,9 @@ var constants_default = {
   MOBILE_OS_IOS: "ios",
   MOBILE_ORIENTATION_PORTRAIT: "portrait",
   MOBILE_ORIENTATION_LANDSCAPE: "landscape",
+  // build status
+  BUILD_COMPLETE: "completed",
+  BUILD_ERROR: "error",
   // CI
   GITHUB_API_HOST: "https://api.github.com",
   // log file path
@@ -196,6 +199,8 @@ var constants_default = {
   FILE_EXTENSION_GIFS: "gif",
   // Default scrollTime
   DEFAULT_SCROLL_TIME: 8,
+  // Default page load time
+  DEFAULT_PAGE_LOAD_TIMEOUT: 18e4,
   // Magic Numbers 
   MAGIC_NUMBERS: [
     { ext: "jpg", magic: Buffer.from([255, 216, 255]) },
@@ -888,7 +893,7 @@ var logger = winston.createLogger({
       let message = typeof info.message === "object" ? JSON.stringify(info.message).trim() : info.message.trim();
       switch (info.level) {
         case "warn":
-          message = chalk7__default.default.yellow(message);
+          message = chalk6__default.default.yellow(message);
           break;
       }
       return info.level === "info" ? message : `[${contextString}:${info.level}] ` + message;
@@ -915,11 +920,11 @@ var startServer_default = (ctx) => {
       updateLogContext({ task: "startServer" });
       try {
         ctx2.server = yield server_default(ctx2);
-        task.output = chalk7__default.default.gray(`listening on port ${(_a = ctx2.server.addresses()[0]) == null ? void 0 : _a.port}`);
+        task.output = chalk6__default.default.gray(`listening on port ${(_a = ctx2.server.addresses()[0]) == null ? void 0 : _a.port}`);
         task.title = "SmartUI started";
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(error.message);
+        task.output = chalk6__default.default.gray(error.message);
         throw new Error("SmartUI server setup failed");
       }
     }),
@@ -933,11 +938,11 @@ var auth_default = (ctx) => {
       updateLogContext({ task: "auth" });
       try {
         yield ctx2.client.auth(ctx2.log);
-        task.output = chalk7__default.default.gray(`using project token '******#${ctx2.env.PROJECT_TOKEN.split("#").pop()}'`);
+        task.output = chalk6__default.default.gray(`using project token '******#${ctx2.env.PROJECT_TOKEN.split("#").pop()}'`);
         task.title = "Authenticated with SmartUI";
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(error.message);
+        task.output = chalk6__default.default.gray(error.message);
         throw new Error("Authentication failed");
       }
     }),
@@ -946,7 +951,7 @@ var auth_default = (ctx) => {
 };
 
 // package.json
-var version = "4.0.7";
+var version = "4.0.9";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -956,7 +961,8 @@ var package_default = {
   ],
   scripts: {
     build: "tsup",
-    release: "pnpm run build && pnpm publish --access public --no-git-checks"
+    release: "pnpm run build && pnpm publish --access public --no-git-checks",
+    "local-build": "pnpm run build && pnpm pack"
   },
   bin: {
     smartui: "./dist/index.cjs"
@@ -1047,6 +1053,13 @@ var httpClient = class {
       }
     }, log2);
   }
+  getScreenshotData(buildId, baseline, log2) {
+    return this.request({
+      url: "/screenshot",
+      method: "GET",
+      params: { buildId, baseline }
+    }, log2);
+  }
   finalizeBuild(buildId, totalSnapshots, log2) {
     let params = { buildId };
     if (totalSnapshots > -1)
@@ -1090,13 +1103,13 @@ var httpClient = class {
     }).then(() => {
       log2.debug(`${ssName} for ${browserName} ${viewport} uploaded successfully`);
     }).catch((error) => {
-      if (error.response) {
+      log2.error(`Unable to upload screenshot ${JSON.stringify(error)}`);
+      if (error && error.response && error.response.data && error.response.data.error) {
         throw new Error(error.response.data.error.message);
       }
-      if (error.request) {
-        throw new Error(error.toJSON().message);
+      if (error) {
+        throw new Error(JSON.stringify(error));
       }
-      throw new Error(error.message);
     });
   }
   checkUpdate(log2) {
@@ -1169,6 +1182,9 @@ var ctx_default = (options) => {
   let extensionFiles;
   let ignoreStripExtension;
   let ignoreFilePattern;
+  let parallelObj;
+  let fetchResultObj;
+  let fetchResultsFileObj;
   try {
     if (options.config) {
       config = JSON.parse(fs5__default.default.readFileSync(options.config, "utf-8"));
@@ -1188,6 +1204,18 @@ var ctx_default = (options) => {
     extensionFiles = options.files || ["png", "jpeg", "jpg"];
     ignoreStripExtension = options.removeExtensions || false;
     ignoreFilePattern = options.ignoreDir || [];
+    parallelObj = options.parallel ? options.parallel === true ? 1 : options.parallel : 1;
+    if (options.fetchResults) {
+      if (options.fetchResults !== true && !options.fetchResults.endsWith(".json")) {
+        console.error("Error: The file extension for --fetch-results must be .json");
+        process.exit(1);
+      }
+      fetchResultObj = true;
+      fetchResultsFileObj = options.fetchResults === true ? "results.json" : options.fetchResults;
+    } else {
+      fetchResultObj = false;
+      fetchResultsFileObj = "";
+    }
   } catch (error) {
     console.log(`[smartui] Error: ${error.message}`);
     process.exit();
@@ -1241,14 +1269,17 @@ var ctx_default = (options) => {
     },
     args: {},
     options: {
-      parallel: options.parallel ? true : false,
+      parallel: parallelObj,
+      force: options.force ? true : false,
       markBaseline: options.markBaseline ? true : false,
       buildName: options.buildName || "",
       port,
       ignoreResolutions: resolutionOff,
       fileExtension: extensionFiles,
       stripExtension: ignoreStripExtension,
-      ignorePattern: ignoreFilePattern
+      ignorePattern: ignoreFilePattern,
+      fetchResults: fetchResultObj,
+      fetchResultsFileName: fetchResultsFileObj
     },
     cliVersion: version,
     totalSnapshots: -1
@@ -1315,11 +1346,11 @@ var getGitInfo_default = (ctx) => {
       }
       try {
         ctx2.git = git_default(ctx2);
-        task.output = chalk7__default.default.gray(`branch: ${ctx2.git.branch}, commit: ${ctx2.git.commitId}, author: ${ctx2.git.commitAuthor}`);
+        task.output = chalk6__default.default.gray(`branch: ${ctx2.git.branch}, commit: ${ctx2.git.commitId}, author: ${ctx2.git.commitAuthor}`);
         task.title = "Fetched git information";
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(`${error.message}`);
+        task.output = chalk6__default.default.gray(`${error.message}`);
         throw new Error("Error fetching git repo details");
       }
     }),
@@ -1339,127 +1370,18 @@ var createBuild_default = (ctx) => {
           url: resp.data.buildURL,
           baseline: resp.data.baseline
         };
-        task.output = chalk7__default.default.gray(`build id: ${resp.data.buildId}`);
+        task.output = chalk6__default.default.gray(`build id: ${resp.data.buildId}`);
         task.title = "SmartUI build created";
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(error.message);
+        task.output = chalk6__default.default.gray(error.message);
         throw new Error("SmartUI build creation failed");
       }
     }),
     rendererOptions: { persistentOutput: true }
   };
 };
-var exec_default = (ctx) => {
-  var _a;
-  return {
-    title: `Executing '${(_a = ctx.args.execCommand) == null ? void 0 : _a.join(" ")}'`,
-    task: (ctx2, task) => __async(void 0, null, function* () {
-      updateLogContext({ task: "exec" });
-      return new Promise((resolve, reject) => {
-        var _a2, _b, _c;
-        const childProcess = spawn__default.default(ctx2.args.execCommand[0], (_a2 = ctx2.args.execCommand) == null ? void 0 : _a2.slice(1));
-        let totalOutput = "";
-        const output = listr2.createWritable((chunk) => {
-          totalOutput += chunk;
-          task.output = chalk7__default.default.gray(totalOutput);
-        });
-        (_b = childProcess.stdout) == null ? void 0 : _b.pipe(output);
-        (_c = childProcess.stderr) == null ? void 0 : _c.pipe(output);
-        childProcess.on("error", (error) => {
-          var _a3;
-          task.output = chalk7__default.default.gray(`error: ${error.message}`);
-          throw new Error(`Execution of '${(_a3 = ctx2.args.execCommand) == null ? void 0 : _a3.join(" ")}' failed`);
-        });
-        childProcess.on("close", (code, signal) => __async(void 0, null, function* () {
-          var _a3;
-          if (code !== null) {
-            task.title = `Execution of '${(_a3 = ctx2.args.execCommand) == null ? void 0 : _a3.join(" ")}' completed; exited with code ${code}`;
-          } else if (signal !== null) {
-            throw new Error(`Child process killed with signal ${signal}`);
-          }
-          resolve();
-        }));
-      });
-    }),
-    rendererOptions: { persistentOutput: true },
-    exitOnError: false
-  };
-};
-var processSnapshot_default = (ctx) => {
-  return {
-    title: `Processing snapshots`,
-    task: (ctx2, task) => __async(void 0, null, function* () {
-      var _a, _b;
-      try {
-        if (ctx2.config.delayedUpload) {
-          ctx2.log.debug("started after processing because of delayedUpload");
-          (_a = ctx2.snapshotQueue) == null ? void 0 : _a.startProcessingfunc();
-        }
-        yield new Promise((resolve) => {
-          let output2 = "";
-          const intervalId = setInterval(() => {
-            var _a2, _b2, _c;
-            if (((_a2 = ctx2.snapshotQueue) == null ? void 0 : _a2.isEmpty()) && !((_b2 = ctx2.snapshotQueue) == null ? void 0 : _b2.isProcessing())) {
-              clearInterval(intervalId);
-              resolve();
-            } else {
-              task.title = `Processing snapshot ${(_c = ctx2.snapshotQueue) == null ? void 0 : _c.getProcessingSnapshot()}`;
-            }
-          }, 500);
-        });
-        let output = "";
-        for (let snapshot of (_b = ctx2.snapshotQueue) == null ? void 0 : _b.getProcessedSnapshots()) {
-          if (snapshot.error)
-            output += `${chalk7__default.default.red("\u2717")} ${chalk7__default.default.gray(`${snapshot.name}
-[error] ${snapshot.error}`)}
-`;
-          else
-            output += `${chalk7__default.default.green("\u2713")} ${chalk7__default.default.gray(snapshot.name)}
-${snapshot.warnings.length ? chalk7__default.default.gray(`[warning] ${snapshot.warnings.join("\n[warning] ")}
-`) : ""}`;
-        }
-        task.output = output;
-        task.title = "Processed snapshots";
-      } catch (error) {
-        ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(error.message);
-        throw new Error("Processing of snapshots failed");
-      }
-    }),
-    rendererOptions: { persistentOutput: true }
-  };
-};
-var finalizeBuild_default = (ctx) => {
-  return {
-    title: `Finalizing build`,
-    task: (ctx2, task) => __async(void 0, null, function* () {
-      var _a, _b;
-      updateLogContext({ task: "finalizeBuild" });
-      try {
-        yield ctx2.client.finalizeBuild(ctx2.build.id, ctx2.totalSnapshots, ctx2.log);
-        task.output = chalk7__default.default.gray(`build url: ${ctx2.build.url}`);
-        task.title = "Finalized build";
-      } catch (error) {
-        ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(error.message);
-        throw new Error("Finalize build failed");
-      }
-      try {
-        yield (_a = ctx2.browser) == null ? void 0 : _a.close();
-        ctx2.log.debug(`Closed browser`);
-        yield (_b = ctx2.server) == null ? void 0 : _b.close();
-        ctx2.log.debug(`Closed server`);
-        let resp = yield ctx2.client.getS3PreSignedURL(ctx2);
-        yield ctx2.client.uploadLogs(ctx2, resp.data.url);
-        fs5.unlinkSync(constants_default.LOG_FILE_PATH);
-      } catch (error) {
-        ctx2.log.debug(error);
-      }
-    }),
-    rendererOptions: { persistentOutput: true }
-  };
-};
+var isPollingActive = false;
 function delDir(dir) {
   if (fs5__default.default.existsSync(dir)) {
     fs5__default.default.rmSync(dir, { recursive: true });
@@ -1493,8 +1415,10 @@ function scrollToBottomAndBackToTop({
 }
 function launchBrowsers(ctx) {
   return __async(this, null, function* () {
+    var _a;
     let browsers = {};
-    let launchOptions = { headless: true };
+    const isHeadless = ((_a = process.env.HEADLESS) == null ? void 0 : _a.toLowerCase()) === "false" ? false : true;
+    let launchOptions = { headless: isHeadless };
     if (ctx.config.web) {
       for (const browser of ctx.config.web.browsers) {
         switch (browser) {
@@ -1634,6 +1558,197 @@ function getRenderViewportsForOptions(options) {
     ...mobileRenderViewports[constants_default.MOBILE_OS_ANDROID]
   ];
 }
+process.on("SIGINT", () => {
+  if (isPollingActive) {
+    console.log("Fetching results interrupted. Exiting...");
+    isPollingActive = false;
+  } else {
+    console.log("\nExiting gracefully...");
+  }
+  process.exit(0);
+});
+function startPolling(ctx, task) {
+  return __async(this, null, function* () {
+    ctx.log.info("Fetching results in progress....");
+    isPollingActive = true;
+    const intervalId = setInterval(() => __async(this, null, function* () {
+      if (!isPollingActive) {
+        clearInterval(intervalId);
+        return;
+      }
+      try {
+        const resp = yield ctx.client.getScreenshotData(ctx.build.id, ctx.build.baseline, ctx.log);
+        if (!resp.build) {
+          ctx.log.info("Error: Build data is null.");
+          clearInterval(intervalId);
+          isPollingActive = false;
+        }
+        fs5__default.default.writeFileSync(ctx.options.fetchResultsFileName, JSON.stringify(resp, null, 2));
+        ctx.log.debug(`Updated results in ${ctx.options.fetchResultsFileName}`);
+        if (resp.build.build_status_ind === constants_default.BUILD_COMPLETE || resp.build.build_status_ind === constants_default.BUILD_ERROR) {
+          clearInterval(intervalId);
+          ctx.log.info(`Fetching results completed. Final results written to ${ctx.options.fetchResultsFileName}`);
+          isPollingActive = false;
+          let totalScreenshotsWithMismatches = 0;
+          let totalVariantsWithMismatches = 0;
+          const totalScreenshots = Object.keys(resp.screenshots || {}).length;
+          let totalVariants = 0;
+          for (const [screenshot, variants] of Object.entries(resp.screenshots || {})) {
+            let screenshotHasMismatch = false;
+            let variantMismatchCount = 0;
+            totalVariants += variants.length;
+            for (const variant of variants) {
+              if (variant.mismatch_percentage > 0) {
+                screenshotHasMismatch = true;
+                variantMismatchCount++;
+              }
+            }
+            if (screenshotHasMismatch) {
+              totalScreenshotsWithMismatches++;
+              totalVariantsWithMismatches += variantMismatchCount;
+            }
+          }
+          ctx.log.info(
+            chalk6__default.default.green.bold(
+              `
+Summary of Mismatches:
+${chalk6__default.default.yellow("Total Variants with Mismatches:")} ${chalk6__default.default.white(totalVariantsWithMismatches)} out of ${chalk6__default.default.white(totalVariants)}
+${chalk6__default.default.yellow("Total Screenshots with Mismatches:")} ${chalk6__default.default.white(totalScreenshotsWithMismatches)} out of ${chalk6__default.default.white(totalScreenshots)}
+${chalk6__default.default.yellow("Branch Name:")} ${chalk6__default.default.white(resp.build.branch)}
+${chalk6__default.default.yellow("Project Name:")} ${chalk6__default.default.white(resp.project.name)}
+${chalk6__default.default.yellow("Build ID:")} ${chalk6__default.default.white(resp.build.build_id)}
+`
+            )
+          );
+        }
+      } catch (error) {
+        if (error.message.includes("ENOTFOUND")) {
+          ctx.log.error("Error: Network error occurred while fetching build results. Please check your connection and try again.");
+          clearInterval(intervalId);
+        } else {
+          ctx.log.error(`Error fetching screenshot data: ${error.message}`);
+        }
+        clearInterval(intervalId);
+        isPollingActive = false;
+      }
+    }), 5e3);
+  });
+}
+
+// src/tasks/exec.ts
+var exec_default = (ctx) => {
+  var _a;
+  return {
+    title: `Executing '${(_a = ctx.args.execCommand) == null ? void 0 : _a.join(" ")}'`,
+    task: (ctx2, task) => __async(void 0, null, function* () {
+      if (ctx2.options.fetchResults) {
+        startPolling(ctx2);
+      }
+      updateLogContext({ task: "exec" });
+      return new Promise((resolve, reject) => {
+        var _a2, _b, _c;
+        const childProcess = spawn__default.default(ctx2.args.execCommand[0], (_a2 = ctx2.args.execCommand) == null ? void 0 : _a2.slice(1));
+        let totalOutput = "";
+        const output = listr2.createWritable((chunk) => {
+          totalOutput += chunk;
+          task.output = chalk6__default.default.gray(totalOutput);
+        });
+        (_b = childProcess.stdout) == null ? void 0 : _b.pipe(output);
+        (_c = childProcess.stderr) == null ? void 0 : _c.pipe(output);
+        childProcess.on("error", (error) => {
+          var _a3;
+          task.output = chalk6__default.default.gray(`error: ${error.message}`);
+          throw new Error(`Execution of '${(_a3 = ctx2.args.execCommand) == null ? void 0 : _a3.join(" ")}' failed`);
+        });
+        childProcess.on("close", (code, signal) => __async(void 0, null, function* () {
+          var _a3;
+          if (code !== null) {
+            task.title = `Execution of '${(_a3 = ctx2.args.execCommand) == null ? void 0 : _a3.join(" ")}' completed; exited with code ${code}`;
+          } else if (signal !== null) {
+            throw new Error(`Child process killed with signal ${signal}`);
+          }
+          resolve();
+        }));
+      });
+    }),
+    rendererOptions: { persistentOutput: true },
+    exitOnError: false
+  };
+};
+var processSnapshot_default = (ctx) => {
+  return {
+    title: `Processing snapshots`,
+    task: (ctx2, task) => __async(void 0, null, function* () {
+      var _a, _b;
+      try {
+        if (ctx2.config.delayedUpload) {
+          ctx2.log.debug("started after processing because of delayedUpload");
+          (_a = ctx2.snapshotQueue) == null ? void 0 : _a.startProcessingfunc();
+        }
+        yield new Promise((resolve) => {
+          let output2 = "";
+          const intervalId = setInterval(() => {
+            var _a2, _b2, _c;
+            if (((_a2 = ctx2.snapshotQueue) == null ? void 0 : _a2.isEmpty()) && !((_b2 = ctx2.snapshotQueue) == null ? void 0 : _b2.isProcessing())) {
+              clearInterval(intervalId);
+              resolve();
+            } else {
+              task.title = `Processing snapshot ${(_c = ctx2.snapshotQueue) == null ? void 0 : _c.getProcessingSnapshot()}`;
+            }
+          }, 500);
+        });
+        let output = "";
+        for (let snapshot of (_b = ctx2.snapshotQueue) == null ? void 0 : _b.getProcessedSnapshots()) {
+          if (snapshot.error)
+            output += `${chalk6__default.default.red("\u2717")} ${chalk6__default.default.gray(`${snapshot.name}
+[error] ${snapshot.error}`)}
+`;
+          else
+            output += `${chalk6__default.default.green("\u2713")} ${chalk6__default.default.gray(snapshot.name)}
+${snapshot.warnings.length ? chalk6__default.default.gray(`[warning] ${snapshot.warnings.join("\n[warning] ")}
+`) : ""}`;
+        }
+        task.output = output;
+        task.title = "Processed snapshots";
+      } catch (error) {
+        ctx2.log.debug(error);
+        task.output = chalk6__default.default.gray(error.message);
+        throw new Error("Processing of snapshots failed");
+      }
+    }),
+    rendererOptions: { persistentOutput: true }
+  };
+};
+var finalizeBuild_default = (ctx) => {
+  return {
+    title: `Finalizing build`,
+    task: (ctx2, task) => __async(void 0, null, function* () {
+      var _a, _b;
+      updateLogContext({ task: "finalizeBuild" });
+      try {
+        yield ctx2.client.finalizeBuild(ctx2.build.id, ctx2.totalSnapshots, ctx2.log);
+        task.output = chalk6__default.default.gray(`build url: ${ctx2.build.url}`);
+        task.title = "Finalized build";
+      } catch (error) {
+        ctx2.log.debug(error);
+        task.output = chalk6__default.default.gray(error.message);
+        throw new Error("Finalize build failed");
+      }
+      try {
+        yield (_a = ctx2.browser) == null ? void 0 : _a.close();
+        ctx2.log.debug(`Closed browser`);
+        yield (_b = ctx2.server) == null ? void 0 : _b.close();
+        ctx2.log.debug(`Closed server`);
+        let resp = yield ctx2.client.getS3PreSignedURL(ctx2);
+        yield ctx2.client.uploadLogs(ctx2, resp.data.url);
+        fs5.unlinkSync(constants_default.LOG_FILE_PATH);
+      } catch (error) {
+        ctx2.log.debug(error);
+      }
+    }),
+    rendererOptions: { persistentOutput: true }
+  };
+};
 var MAX_RESOURCE_SIZE = 15 * 1024 ** 2;
 var ALLOWED_RESOURCES = ["document", "stylesheet", "image", "media", "font", "other"];
 var ALLOWED_STATUSES = [200, 201];
@@ -1641,18 +1756,19 @@ var REQUEST_TIMEOUT = 1e4;
 var MIN_VIEWPORT_HEIGHT = 1080;
 function processSnapshot(snapshot, ctx) {
   return __async(this, null, function* () {
-    var _a;
+    var _a, _b;
     updateLogContext({ task: "discovery" });
     ctx.log.debug(`Processing snapshot ${snapshot.name} ${snapshot.url}`);
+    const isHeadless = ((_a = process.env.HEADLESS) == null ? void 0 : _a.toLowerCase()) === "false" ? false : true;
     let launchOptions = {
-      headless: true,
+      headless: isHeadless,
       args: constants_default.LAUNCH_ARGS
     };
     let contextOptions = {
       javaScriptEnabled: ctx.config.cliEnableJavaScript,
       userAgent: constants_default.CHROME_USER_AGENT
     };
-    if (!((_a = ctx.browser) == null ? void 0 : _a.isConnected())) {
+    if (!((_b = ctx.browser) == null ? void 0 : _b.isConnected())) {
       if (ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY)
         launchOptions.proxy = { server: ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY };
       ctx.browser = yield test.chromium.launch(launchOptions);
@@ -2210,7 +2326,7 @@ var Queue = class {
 
 // src/commander/exec.ts
 var command = new commander.Command();
-command.name("exec").description("Run test commands around SmartUI").argument("<command...>", "Command supplied for running tests").option("-P, --port <number>", "Port number for the server").action(function(execCommand, _, command5) {
+command.name("exec").description("Run test commands around SmartUI").argument("<command...>", "Command supplied for running tests").option("-P, --port <number>", "Port number for the server").option("--fetch-results [filename]", "Fetch results and optionally specify an output file, e.g., <filename>.json").action(function(execCommand, _, command5) {
   return __async(this, null, function* () {
     let ctx = ctx_default(command5.optsWithGlobals());
     if (!which__default.default.sync(execCommand[0], { nothrow: true })) {
@@ -2319,7 +2435,7 @@ configFigma.name("config:create-figma").description("Create figma designs config
 });
 function captureScreenshotsForConfig(_0, _1, _2, _3, _4) {
   return __async(this, arguments, function* (ctx, browsers, { name, url, waitForTimeout }, browserName, renderViewports) {
-    let pageOptions = { waitUntil: process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || "load" };
+    let pageOptions = { waitUntil: process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || "load", timeout: ctx.config.waitForPageRender || constants_default.DEFAULT_PAGE_LOAD_TIMEOUT };
     let ssId = name.toLowerCase().replace(/\s/g, "_");
     let context;
     let contextOptions = {};
@@ -2414,13 +2530,13 @@ function captureScreenshots(ctx) {
         else
           yield captureScreenshotsSync(ctx, staticConfig, browsers);
         delDir(`screenshots/${staticConfig.name.toLowerCase().replace(/\s/g, "_")}`);
-        output += `${chalk7__default.default.gray(staticConfig.name)} ${chalk7__default.default.green("\u2713")}
+        output += `${chalk6__default.default.gray(staticConfig.name)} ${chalk6__default.default.green("\u2713")}
 `;
         ctx.task.output = output;
         capturedScreenshots++;
       } catch (error) {
         ctx.log.debug(`screenshot capture failed for ${JSON.stringify(staticConfig)}; error: ${error}`);
-        output += `${chalk7__default.default.gray(staticConfig.name)} ${chalk7__default.default.red("\u2717")}
+        output += `${chalk6__default.default.gray(staticConfig.name)} ${chalk6__default.default.red("\u2717")}
 `;
         ctx.task.output = output;
       }
@@ -2532,21 +2648,113 @@ function uploadScreenshots(ctx) {
     }
   });
 }
+function captureScreenshotsConcurrent(ctx) {
+  return __async(this, null, function* () {
+    delDir("screenshots");
+    let totalSnapshots = ctx.webStaticConfig && ctx.webStaticConfig.length;
+    let browserInstances = ctx.options.parallel || 1;
+    let optimizeBrowserInstances = 0;
+    optimizeBrowserInstances = Math.floor(Math.log2(totalSnapshots));
+    if (optimizeBrowserInstances < 1) {
+      optimizeBrowserInstances = 1;
+    }
+    if (optimizeBrowserInstances > browserInstances) {
+      optimizeBrowserInstances = browserInstances;
+    }
+    if (ctx.options.force && browserInstances > 1) {
+      optimizeBrowserInstances = browserInstances;
+    }
+    let urlsPerInstance = 0;
+    if (optimizeBrowserInstances == 1) {
+      urlsPerInstance = totalSnapshots;
+    } else {
+      urlsPerInstance = Math.ceil(totalSnapshots / optimizeBrowserInstances);
+    }
+    ctx.log.debug(`*** browserInstances requested ${ctx.options.parallel} `);
+    ctx.log.debug(`*** optimizeBrowserInstances  ${optimizeBrowserInstances} `);
+    ctx.log.debug(`*** urlsPerInstance  ${urlsPerInstance}`);
+    ctx.task.output = `URLs : ${totalSnapshots} || Parallel Browser Instances: ${optimizeBrowserInstances}
+`;
+    let staticURLChunks = splitURLs(ctx.webStaticConfig, urlsPerInstance);
+    let totalCapturedScreenshots = 0;
+    let output = "";
+    const responses = yield Promise.all(staticURLChunks.map((urlConfig) => __async(this, null, function* () {
+      let { capturedScreenshots, finalOutput } = yield processChunk(ctx, urlConfig);
+      return { capturedScreenshots, finalOutput };
+    })));
+    responses.forEach((response) => {
+      totalCapturedScreenshots += response.capturedScreenshots;
+      output += response.finalOutput;
+    });
+    delDir("screenshots");
+    return { totalCapturedScreenshots, output };
+  });
+}
+function splitURLs(arr, chunkSize) {
+  const result = [];
+  for (let i = 0; i < arr.length; i += chunkSize) {
+    result.push(arr.slice(i, i + chunkSize));
+  }
+  return result;
+}
+function processChunk(ctx, urlConfig) {
+  return __async(this, null, function* () {
+    let browsers = {};
+    let capturedScreenshots = 0;
+    let finalOutput = "";
+    try {
+      browsers = yield launchBrowsers(ctx);
+    } catch (error) {
+      yield closeBrowsers(browsers);
+      ctx.log.debug(error);
+      throw new Error(`Failed launching browsers ${error}`);
+    }
+    for (let staticConfig of urlConfig) {
+      try {
+        yield captureScreenshotsAsync(ctx, staticConfig, browsers);
+        delDir(`screenshots/${staticConfig.name.toLowerCase().replace(/\s/g, "_")}`);
+        let output = `${chalk6__default.default.gray(staticConfig.name)} ${chalk6__default.default.green("\u2713")}
+`;
+        ctx.task.output = ctx.task.output ? ctx.task.output + output : output;
+        finalOutput += output;
+        capturedScreenshots++;
+      } catch (error) {
+        ctx.log.debug(`screenshot capture failed for ${JSON.stringify(staticConfig)}; error: ${error}`);
+        let output = `${chalk6__default.default.gray(staticConfig.name)} ${chalk6__default.default.red("\u2717")}
+`;
+        ctx.task.output += output;
+        finalOutput += output;
+      }
+    }
+    yield closeBrowsers(browsers);
+    return { capturedScreenshots, finalOutput };
+  });
+}
 var captureScreenshots_default = (ctx) => {
   return {
     title: "Capturing screenshots",
     task: (ctx2, task) => __async(void 0, null, function* () {
       try {
         ctx2.task = task;
+        if (ctx2.options.fetchResults) {
+          startPolling(ctx2, task);
+        }
         updateLogContext({ task: "capture" });
-        let { capturedScreenshots, output } = yield captureScreenshots(ctx2);
-        if (capturedScreenshots != ctx2.webStaticConfig.length) {
-          throw new Error(output);
+        if (ctx2.options.parallel) {
+          let { totalCapturedScreenshots, output } = yield captureScreenshotsConcurrent(ctx2);
+          if (totalCapturedScreenshots != ctx2.webStaticConfig.length) {
+            throw new Error(output);
+          }
+        } else {
+          let { capturedScreenshots, output } = yield captureScreenshots(ctx2);
+          if (capturedScreenshots != ctx2.webStaticConfig.length) {
+            throw new Error(output);
+          }
         }
         task.title = "Screenshots captured successfully";
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(`${error.message}`);
+        task.output = chalk6__default.default.gray(`${error.message}`);
         throw new Error("Capturing screenshots failed");
       }
     }),
@@ -2557,21 +2765,26 @@ var captureScreenshots_default = (ctx) => {
 
 // src/commander/capture.ts
 var command2 = new commander.Command();
-command2.name("capture").description("Capture screenshots of static sites").argument("<file>", "Web static config file").option("--parallel", "Capture parallely on all browsers").action(function(file, _, command5) {
+command2.name("capture").description("Capture screenshots of static sites").argument("<file>", "Web static config file").option("-C, --parallel [number]", "Specify the number of instances per browser", parseInt).option("-F, --force", "forcefully apply the specified parallel instances per browser").option("--fetch-results [filename]", "Fetch results and optionally specify an output file, e.g., <filename>.json").action(function(file, _, command5) {
   return __async(this, null, function* () {
     let ctx = ctx_default(command5.optsWithGlobals());
     if (!fs5__default.default.existsSync(file)) {
-      console.log(`Error: Web Static Config file ${file} not found.`);
+      ctx.log.error(`Web Static Config file ${file} not found.`);
       return;
     }
     try {
       ctx.webStaticConfig = JSON.parse(fs5__default.default.readFileSync(file, "utf8"));
       if (!validateWebStaticConfig(ctx.webStaticConfig))
         throw new Error(validateWebStaticConfig.errors[0].message);
+      if (ctx.webStaticConfig && ctx.webStaticConfig.length === 0) {
+        ctx.log.error(`No URLs found in the specified config file -> ${file}`);
+        return;
+      }
     } catch (error) {
-      console.log(`[smartui] Error: Invalid Web Static Config; ${error.message}`);
+      ctx.log.error(`Invalid Web Static Config; ${error.message}`);
       return;
     }
+    ctx.log.debug(ctx.config);
     let tasks = new listr2.Listr(
       [
         auth_default(),
@@ -2605,12 +2818,15 @@ var uploadScreenshots_default = (ctx) => {
     task: (ctx2, task) => __async(void 0, null, function* () {
       try {
         ctx2.task = task;
+        if (ctx2.options.fetchResults) {
+          startPolling(ctx2, task);
+        }
         updateLogContext({ task: "upload" });
         yield uploadScreenshots(ctx2);
         task.title = "Screenshots uploaded successfully";
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(`${error.message}`);
+        task.output = chalk6__default.default.gray(`${error.message}`);
         throw new Error("Uploading screenshots failed");
       }
     }),
@@ -2625,7 +2841,7 @@ command3.name("upload").description("Upload screenshots from given directory").a
   return val.split(",").map((ext) => ext.trim().toLowerCase());
 }).option("-E, --removeExtensions", "Strips file extensions from snapshot names").option("-i, --ignoreDir <patterns>", "Comma-separated list of directories to ignore", (val) => {
   return val.split(",").map((pattern) => pattern.trim());
-}).action(function(directory, _, command5) {
+}).option("--fetch-results [filename]", "Fetch results and optionally specify an output file, e.g., <filename>.json").action(function(directory, _, command5) {
   return __async(this, null, function* () {
     let ctx = ctx_default(command5.optsWithGlobals());
     if (!fs5__default.default.existsSync(directory)) {
@@ -2705,7 +2921,7 @@ var uploadFigmaDesigns_default2 = (ctx) => {
         ctx2.log.debug(`Figma designs processed: ${results}`);
       } catch (error) {
         ctx2.log.debug(error);
-        task.output = chalk7__default.default.gray(`${error.message}`);
+        task.output = chalk6__default.default.gray(`${error.message}`);
         throw new Error("Uploading Figma designs failed");
       }
     }),
@@ -2771,16 +2987,16 @@ var commander_default = program;
       let { data: { latestVersion, deprecated, additionalDescription } } = yield client.checkUpdate(log2);
       log2.info(`
 LambdaTest SmartUI CLI v${package_default.version}`);
-      log2.info(chalk7__default.default.yellow(`${additionalDescription}`));
+      log2.info(chalk6__default.default.yellow(`${additionalDescription}`));
       if (deprecated) {
         log2.warn(`This version is deprecated. A new version ${latestVersion} is available!`);
       } else if (package_default.version !== latestVersion) {
-        log2.info(chalk7__default.default.green(`A new version ${latestVersion} is available!`));
+        log2.info(chalk6__default.default.green(`A new version ${latestVersion} is available!`));
       } else
-        log2.info(chalk7__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
+        log2.info(chalk6__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
     } catch (error) {
       log2.debug(error);
-      log2.info(chalk7__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
+      log2.info(chalk6__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
     }
     commander_default.parse();
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.0.7",
+  "version": "4.0.9",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"
@@ -43,6 +43,7 @@
   },
   "scripts": {
     "build": "tsup",
-    "release": "pnpm run build && pnpm publish --access public --no-git-checks"
+    "release": "pnpm run build && pnpm publish --access public --no-git-checks",
+    "local-build": "pnpm run build && pnpm pack"
   }
 }