@lambdatest/smartui-cli 4.1.15 → 4.1.17

package/dist/index.cjs

@@ -13,6 +13,7 @@ var addErrors = require('ajv-errors');
 var test = require('@playwright/test');
 var util = require('util');
 var winston = require('winston');
+var stringify = require('json-stringify-safe');
 var FormData = require('form-data');
 var axios = require('axios');
 var https = require('https');
@@ -31,6 +32,7 @@ var fastify__default = /*#__PURE__*/_interopDefault(fastify);
 var fs5__default = /*#__PURE__*/_interopDefault(fs5);
 var Ajv__default = /*#__PURE__*/_interopDefault(Ajv);
 var addErrors__default = /*#__PURE__*/_interopDefault(addErrors);
+var stringify__default = /*#__PURE__*/_interopDefault(stringify);
 var FormData__default = /*#__PURE__*/_interopDefault(FormData);
 var axios__default = /*#__PURE__*/_interopDefault(axios);
 var https__default = /*#__PURE__*/_interopDefault(https);
@@ -737,6 +739,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 +1669,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);
@@ -1777,7 +1794,7 @@ var logger = winston.createLogger({
     winston.format.timestamp(),
     winston.format.printf((info) => {
       let contextString = Object.values(logContext).join(" | ");
-      let message = typeof info.message === "object" ? JSON.stringify(info.message).trim() : info.message.trim();
+      let message = typeof info.message === "object" ? stringify__default.default(info.message) : info.message.trim();
       switch (info.level) {
         case "warn":
           message = chalk__default.default.yellow(message);
@@ -1856,7 +1873,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.15";
+var version = "4.1.17";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -1882,14 +1899,15 @@ var package_default = {
   author: "LambdaTest <keys@lambdatest.com>",
   license: "MIT",
   dependencies: {
+    "@lambdatest/node-tunnel": "^4.0.9",
     "@playwright/browser-chromium": "^1.47.2",
     "@playwright/browser-firefox": "^1.47.2",
     "@playwright/browser-webkit": "^1.47.2",
     "@playwright/test": "^1.47.2",
     "@types/cross-spawn": "^6.0.4",
+    "@types/json-stringify-safe": "^5.0.3",
     "@types/node": "^20.8.9",
     "@types/which": "^3.0.2",
-    "@lambdatest/node-tunnel": "^4.0.9",
     ajv: "^8.12.0",
     "ajv-errors": "^3.0.0",
     axios: "^1.6.0",
@@ -1898,6 +1916,7 @@ var package_default = {
     "cross-spawn": "^7.0.3",
     fastify: "^4.24.3",
     "form-data": "^4.0.0",
+    "json-stringify-safe": "^5.0.1",
     listr2: "^7.0.1",
     "node-cache": "^5.1.2",
     sharp: "^0.33.4",
@@ -2451,7 +2470,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 +2549,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 +2586,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 +2635,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 +2650,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 +2670,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 +2688,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);
@@ -2931,6 +2958,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;
@@ -3076,6 +3106,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 = {
@@ -3150,6 +3183,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 = {
@@ -5427,7 +5467,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.15",
+  "version": "4.1.17",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"
@@ -17,14 +17,15 @@
   "author": "LambdaTest <keys@lambdatest.com>",
   "license": "MIT",
   "dependencies": {
+    "@lambdatest/node-tunnel": "^4.0.9",
     "@playwright/browser-chromium": "^1.47.2",
     "@playwright/browser-firefox": "^1.47.2",
     "@playwright/browser-webkit": "^1.47.2",
     "@playwright/test": "^1.47.2",
     "@types/cross-spawn": "^6.0.4",
+    "@types/json-stringify-safe": "^5.0.3",
     "@types/node": "^20.8.9",
     "@types/which": "^3.0.2",
-    "@lambdatest/node-tunnel": "^4.0.9",
     "ajv": "^8.12.0",
     "ajv-errors": "^3.0.0",
     "axios": "^1.6.0",
@@ -33,6 +34,7 @@
     "cross-spawn": "^7.0.3",
     "fastify": "^4.24.3",
     "form-data": "^4.0.0",
+    "json-stringify-safe": "^5.0.1",
     "listr2": "^7.0.1",
     "node-cache": "^5.1.2",
     "sharp": "^0.33.4",