@lambdatest/smartui-cli 4.1.14 → 4.1.16

package/dist/index.cjs

@@ -737,6 +737,18 @@ var ConfigSchema = {
     userAgent: {
       type: "string",
       errorMessage: "User Agent value must be a valid string"
+    },
+    requestHeaders: {
+      type: "array",
+      items: {
+        type: "object",
+        minProperties: 1,
+        additionalProperties: { type: "string" }
+      },
+      uniqueItems: true,
+      errorMessage: {
+        uniqueItems: "Invalid config; duplicates in requestHeaders"
+      }
     }
   },
   anyOf: [
@@ -1655,6 +1667,9 @@ var server_default = (ctx) => __async(void 0, null, function* () {
             console.log(`Failed to fetch capabilities for sessionId ${sessionId}: ${error.message}`);
           }
         }
+        if (capsBuildId && capsBuildId !== "") {
+          process.env.SMARTUI_BUILD_ID = capsBuildId;
+        }
       }
       ctx.testType = testType;
       (_c = ctx.snapshotQueue) == null ? void 0 : _c.enqueue(snapshot);
@@ -1856,7 +1871,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.14";
+var version = "4.1.16";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -2451,7 +2466,6 @@ var ctx_default = (options) => {
   try {
     if (options.config) {
       config = JSON.parse(fs5__default.default.readFileSync(options.config, "utf-8"));
-      logger_default.debug(`Config file ${options.config} loaded: ${JSON.stringify(config, null, 2)}`);
       if ((_a = config.web) == null ? void 0 : _a.resolutions) {
         config.web.viewports = config.web.resolutions;
         delete config.web.resolutions;
@@ -2531,7 +2545,8 @@ var ctx_default = (options) => {
       ignoreHTTPSErrors: (_i = config.ignoreHTTPSErrors) != null ? _i : false,
       skipBuildCreation: (_j = config.skipBuildCreation) != null ? _j : false,
       tunnel: tunnelObj,
-      userAgent: config.userAgent || ""
+      userAgent: config.userAgent || "",
+      requestHeaders: config.requestHeaders || {}
     },
     uploadFilePath: "",
     webStaticConfig: [],
@@ -2567,7 +2582,8 @@ var ctx_default = (options) => {
       fetchResults: fetchResultObj,
       fetchResultsFileName: fetchResultsFileObj,
       baselineBranch: options.baselineBranch || "",
-      baselineBuild: options.baselineBuild || ""
+      baselineBuild: options.baselineBuild || "",
+      githubURL: options.githubURL || ""
     },
     cliVersion: version,
     totalSnapshots: -1,
@@ -2615,6 +2631,10 @@ var git_default = (ctx) => {
       ctx.env.SMART_GIT = false;
     }
   }
+  let githubURL;
+  if (ctx.options.githubURL && ctx.options.githubURL.startsWith("https://")) {
+    githubURL = ctx.options.githubURL;
+  }
   if (ctx.env.SMARTUI_GIT_INFO_FILEPATH) {
     let gitInfo = JSON.parse(fs5__default.default.readFileSync(ctx.env.SMARTUI_GIT_INFO_FILEPATH, "utf-8"));
     if (ctx.options.markBaseline) {
@@ -2626,7 +2646,7 @@ var git_default = (ctx) => {
       commitId: gitInfo.commit_id.slice(0, 6) || "",
       commitMessage: gitInfo.commit_body || "",
       commitAuthor: gitInfo.commit_author || "",
-      githubURL: ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}` : "",
+      githubURL: githubURL ? githubURL : ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}` : "",
       baselineBranch: ctx.options.baselineBranch || ctx.env.BASELINE_BRANCH || ""
     };
   } else {
@@ -2646,7 +2666,7 @@ var git_default = (ctx) => {
       commitId: res[0] || "",
       commitMessage: res[2] || "",
       commitAuthor: res[7] || "",
-      githubURL: ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : "",
+      githubURL: githubURL ? githubURL : ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : "",
       baselineBranch: ctx.options.baselineBranch || ctx.env.BASELINE_BRANCH || ""
     };
   }
@@ -2664,6 +2684,9 @@ var getGitInfo_default = (ctx) => {
       try {
         ctx2.git = git_default(ctx2);
         task.output = chalk__default.default.gray(`branch: ${ctx2.git.branch}, commit: ${ctx2.git.commitId}, author: ${ctx2.git.commitAuthor}`);
+        if (ctx2.git.githubURL && ctx2.git.githubURL !== "") {
+          task.output += chalk__default.default.gray(`, githubURL: ${ctx2.git.githubURL}`);
+        }
         task.title = "Fetched git information";
       } catch (error) {
         ctx2.log.debug(error);
@@ -2691,6 +2714,8 @@ var createBuildExec_default = (ctx) => {
               baseline: resp.data.baseline,
               useKafkaFlow: resp.data.useKafkaFlow || false
             };
+            process.env.SMARTUI_BUILD_ID = resp.data.buildId;
+            process.env.SMARTUI_BUILD_NAME = resp.data.buildName;
           } else if (resp && resp.error) {
             if (resp.error.message) {
               ctx2.log.error(`Error while creation of build: ${resp.error.message}`);
@@ -2779,6 +2804,10 @@ var exec_default = (ctx) => {
           var _a3;
           if (code !== null) {
             task.title = `Execution of '${(_a3 = ctx2.args.execCommand) == null ? void 0 : _a3.join(" ")}' completed; exited with code ${code}`;
+            if (code !== 0) {
+              reject();
+              process.exitCode = code;
+            }
           } else if (signal !== null) {
             throw new Error(`Child process killed with signal ${signal}`);
           }
@@ -2814,11 +2843,12 @@ var processSnapshot_default = (ctx) => {
         });
         let output = "";
         for (let snapshot of (_b = ctx2.snapshotQueue) == null ? void 0 : _b.getProcessedSnapshots()) {
-          if (snapshot.error)
+          if (snapshot.error) {
             output += `${chalk__default.default.red("\u2717")} ${chalk__default.default.gray(`${snapshot.name}
 [error] ${snapshot.error}`)}
 `;
-          else
+            process.exitCode = 1;
+          } else
             output += `${chalk__default.default.green("\u2713")} ${chalk__default.default.gray(snapshot.name)}
 ${snapshot.warnings.length ? chalk__default.default.gray(`[warning] ${snapshot.warnings.join("\n[warning] ")}
 `) : ""}`;
@@ -2828,6 +2858,7 @@ ${snapshot.warnings.length ? chalk__default.default.gray(`[warning] ${snapshot.w
       } catch (error) {
         ctx2.log.debug(error);
         task.output = chalk__default.default.gray(error.message);
+        process.exitCode = 1;
         throw new Error("Processing of snapshots failed");
       }
     }),
@@ -2923,6 +2954,9 @@ function prepareSnapshot(snapshot, ctx) {
     if (ctx.config.basicAuthorization) {
       processedOptions.basicAuthorization = ctx.config.basicAuthorization;
     }
+    if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
+      processedOptions.requestHeaders = ctx.config.requestHeaders;
+    }
     ctx.config.allowedHostnames.push(new URL(snapshot.url).hostname);
     processedOptions.allowedHostnames = ctx.config.allowedHostnames;
     processedOptions.skipCapturedCookies = ctx.env.SMARTUI_DO_NOT_USE_CAPTURED_COOKIES;
@@ -3068,6 +3102,9 @@ function processSnapshot(snapshot, ctx) {
       browsers: {}
     };
     let processedOptions = {};
+    if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
+      processedOptions.requestHeaders = ctx.config.requestHeaders;
+    }
     let globalViewport = "";
     let globalBrowser = constants_default.CHROME;
     let launchOptions = {
@@ -3142,6 +3179,13 @@ function processSnapshot(snapshot, ctx) {
           let token = Buffer.from(`${ctx.config.basicAuthorization.username}:${ctx.config.basicAuthorization.password}`).toString("base64");
           requestOptions.headers.Authorization = `Basic ${token}`;
         }
+        if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
+          ctx.config.requestHeaders.forEach((headerObj) => {
+            Object.entries(headerObj).forEach(([key, value]) => {
+              requestOptions.headers[key] = value;
+            });
+          });
+        }
         let response, body;
         if (requestUrl === snapshot.url) {
           response = {
@@ -3981,6 +4025,7 @@ command.name("exec").description("Run test commands around SmartUI").argument("<
       yield tasks.run(ctx);
     } catch (error) {
       ctx.log.info("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
+      process.exitCode = 1;
       throw new Error();
     }
   });
@@ -4178,6 +4223,8 @@ var createBuild_default = (ctx) => {
             baseline: resp.data.baseline,
             useKafkaFlow: resp.data.useKafkaFlow || false
           };
+          process.env.SMARTUI_BUILD_ID = resp.data.buildId;
+          process.env.SMARTUI_BUILD_NAME = resp.data.buildName;
         } else if (resp && resp.error) {
           if (resp.error.message) {
             ctx2.log.error(`Error while creation of build: ${resp.error.message}`);
@@ -4620,6 +4667,7 @@ command2.name("capture").description("Capture screenshots of static sites").argu
       yield tasks.run(ctx);
     } catch (error) {
       console.log("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
+      process.exitCode = 1;
     }
   });
 });
@@ -4694,6 +4742,7 @@ command3.name("upload").description("Upload screenshots from given directory").a
       yield tasks.run(ctx);
     } catch (error) {
       console.log("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
+      process.exitCode = 1;
     }
   });
 });
@@ -5004,6 +5053,7 @@ uploadWebFigmaCommand.name("upload-figma-web").description("Capture figma screen
       verifyFigmaWebConfig(ctx);
     } catch (error) {
       ctx.log.error(chalk__default.default.red(`Invalid figma-web config; ${error.message}`));
+      process.exitCode = 1;
       return;
     }
     let tasks = new listr2.Listr(
@@ -5056,6 +5106,7 @@ uploadAppFigmaCommand.name("upload-figma-app").description("Capture figma screen
       verifyFigmaWebConfig(ctx);
     } catch (error) {
       ctx.log.error(chalk__default.default.red(`Invalid figma-app config; ${error.message}`));
+      process.exitCode = 1;
       return;
     }
     let tasks = new listr2.Listr(
@@ -5399,6 +5450,7 @@ command8.name("build").description("Merge a source build into the target build")
       yield tasks.run(ctx);
     } catch (error) {
       console.error("Error during merge operation:", error);
+      process.exitCode = 1;
     }
   });
 });
@@ -5411,7 +5463,7 @@ var merge_default = program;
 
 // src/commander/commander.ts
 var program2 = new commander.Command();
-program2.name("smartui").description("CLI to help you run your SmartUI tests on LambdaTest platform").version(`v${version}`).option("-c --config <filepath>", "Config file path").option("--markBaseline", "Mark this build baseline").option("--baselineBranch <string>", "Mark this build baseline").option("--baselineBuild <string>", "Mark this build baseline").addCommand(exec_default2).addCommand(capture_default).addCommand(configWeb).addCommand(configStatic).addCommand(upload_default).addCommand(server_default2).addCommand(stopServer_default).addCommand(merge_default).addCommand(ping_default).addCommand(configFigma).addCommand(uploadFigma).addCommand(configWebFigma).addCommand(configAppFigma).addCommand(uploadWebFigmaCommand).addCommand(uploadAppFigmaCommand);
+program2.name("smartui").description("CLI to help you run your SmartUI tests on LambdaTest platform").version(`v${version}`).option("-c --config <filepath>", "Config file path").option("--markBaseline", "Mark this build baseline").option("--baselineBranch <string>", "Mark this build baseline").option("--baselineBuild <string>", "Mark this build baseline").option("--githubURL <string>", "GitHub URL including commitId").addCommand(exec_default2).addCommand(capture_default).addCommand(configWeb).addCommand(configStatic).addCommand(upload_default).addCommand(server_default2).addCommand(stopServer_default).addCommand(merge_default).addCommand(ping_default).addCommand(configFigma).addCommand(uploadFigma).addCommand(configWebFigma).addCommand(configAppFigma).addCommand(uploadWebFigmaCommand).addCommand(uploadAppFigmaCommand);
 var commander_default = program2;
 (function() {
   return __async(this, null, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.14",
+  "version": "4.1.16",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"