@lambdatest/smartui-cli 4.1.42-beta.0 → 4.1.43

package/dist/index.cjs

@@ -112,7 +112,7 @@ var __async = (__this, __arguments, generator) => {
 
 // node_modules/.pnpm/find-free-port@2.0.0/node_modules/find-free-port/index.js
 var require_find_free_port = __commonJS({
-  "node_modules/.pnpm/find-free-port@2.0.0/node_modules/find-free-port/index.js"(exports, module) {
+  "node_modules/.pnpm/find-free-port@2.0.0/node_modules/find-free-port/index.js"(exports$1, module) {
     var net = __require("net");
     function findFreePort(beg, ...rest) {
       const p = rest.slice(0, rest.length - 1), cb = rest[rest.length - 1];
@@ -870,6 +870,14 @@ var ConfigSchema = {
         uniqueItems: "Invalid config; duplicates in requestHeaders"
       }
     },
+    dedicatedProxyURL: {
+      type: "string",
+      errorMessage: "Invalid config; dedicatedProxyURL must be a string"
+    },
+    geolocation: {
+      type: "string",
+      errorMessage: "Invalid config; geolocation must be a string like 'lat,lon'"
+    },
     allowDuplicateSnapshotNames: {
       type: "boolean",
       errorMessage: "Invalid config; allowDuplicateSnapshotNames must be true/false"
@@ -946,6 +954,9 @@ var WebStaticConfigSchema = {
       execute: {
         type: "object",
         properties: {
+          beforeNavigation: {
+            type: "string"
+          },
           afterNavigation: {
             type: "string"
           },
@@ -1878,7 +1889,7 @@ function startPollingForTunnel(ctx, build_id, baseline, projectToken, buildName)
 function stopTunnelHelper(ctx) {
   return __async(this, null, function* () {
     ctx.log.debug("stop-tunnel:: Stopping the tunnel now");
-    const tunnelRunningStatus = yield tunnelInstance.isRunning();
+    const tunnelRunningStatus = yield tunnelInstance == null ? void 0 : tunnelInstance.isRunning();
     ctx.log.debug("stop-tunnel:: Running status of tunnel before stopping ? " + tunnelRunningStatus);
     const status = yield tunnelInstance.stop();
     ctx.log.debug("stop-tunnel:: Tunnel is Stopped ? " + status);
@@ -2573,7 +2584,10 @@ var server_default = (ctx) => __async(void 0, null, function* () {
             lastExternalResponse = externalResponse;
             if (externalResponse.statusCode === 200) {
               replyCode = 200;
-              replyBody = externalResponse.data;
+              replyBody = {
+                data: externalResponse.data,
+                error: externalResponse.error.message
+              };
               return reply.code(replyCode).send(replyBody);
             } else if (externalResponse.statusCode === 202) {
               replyBody = externalResponse.data;
@@ -2585,22 +2599,15 @@ var server_default = (ctx) => __async(void 0, null, function* () {
             } else {
               ctx.log.debug(`Unexpected response from external API: ${JSON.stringify(externalResponse)}`);
               replyCode = 500;
-              replyBody = {
-                error: {
-                  message: `Unexpected response from external API: ${externalResponse.statusCode}`,
-                  externalApiStatus: externalResponse.statusCode
-                }
-              };
-              return reply.code(replyCode).send(replyBody);
+              return reply.code(replyCode).send(externalResponse);
             }
             ctx.log.debug(`timeoutDuration: ${timeoutDuration}`);
             ctx.log.debug(`Time passed: ${Date.now() - startTime}`);
             if (Date.now() - startTime > timeoutDuration) {
               replyCode = 202;
               replyBody = {
-                data: {
-                  message: "Request timed out-> Snapshot still processing"
-                }
+                error: "Request timed out, Snapshot still processing",
+                data: lastExternalResponse.data
               };
               return reply.code(replyCode).send(replyBody);
             }
@@ -2669,7 +2676,8 @@ var env_default = () => {
     SHOW_RENDER_ERRORS,
     SMARTUI_SSE_URL = "https://server-events.lambdatest.com",
     LT_SDK_SKIP_EXECUTION_LOGS,
-    MAX_CONCURRENT_PROCESSING
+    MAX_CONCURRENT_PROCESSING,
+    DO_NOT_USE_USER_AGENT
   } = process.env;
   return {
     PROJECT_TOKEN,
@@ -2696,7 +2704,8 @@ var env_default = () => {
     SHOW_RENDER_ERRORS: SHOW_RENDER_ERRORS === "true",
     SMARTUI_SSE_URL,
     LT_SDK_SKIP_EXECUTION_LOGS: LT_SDK_SKIP_EXECUTION_LOGS === "true",
-    MAX_CONCURRENT_PROCESSING: MAX_CONCURRENT_PROCESSING ? parseInt(MAX_CONCURRENT_PROCESSING, 10) : 0
+    MAX_CONCURRENT_PROCESSING: MAX_CONCURRENT_PROCESSING ? parseInt(MAX_CONCURRENT_PROCESSING, 10) : 0,
+    DO_NOT_USE_USER_AGENT: DO_NOT_USE_USER_AGENT === "true"
   };
 };
 var logContext = {};
@@ -2791,7 +2800,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.42-beta.0";
+var version = "4.1.43";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -2992,12 +3001,20 @@ var httpClient = class {
         }
       }, log2);
       if (response && response.projectToken) {
+        let orgId = 0;
+        let userId = 0;
         this.projectToken = response.projectToken;
         env.PROJECT_TOKEN = response.projectToken;
         if (response.message && response.message.includes("Project created successfully")) {
           result = 2;
         }
-        return result;
+        if (response.orgId) {
+          orgId = response.orgId;
+        }
+        if (response.userId) {
+          userId = response.userId;
+        }
+        return { authResult: result, orgId, userId };
       } else {
         throw new Error("Authentication failed, project token not received");
       }
@@ -3488,6 +3505,20 @@ var httpClient = class {
       }
     }, ctx.log);
   }
+  getGeolocationProxy(geoLocation, log2) {
+    return __async(this, null, function* () {
+      try {
+        const resp = yield this.request({
+          url: "/geolocation",
+          method: "GET",
+          params: { geoLocation }
+        }, log2);
+        return resp;
+      } catch (error) {
+        this.handleHttpError(error, log2);
+      }
+    });
+  }
   uploadPdf(ctx, form, buildName) {
     return __async(this, null, function* () {
       form.append("projectToken", this.projectToken);
@@ -3687,6 +3718,8 @@ var ctx_default = (options) => {
       ignoreHTTPSErrors: (_i = config.ignoreHTTPSErrors) != null ? _i : false,
       skipBuildCreation: (_j = config.skipBuildCreation) != null ? _j : false,
       tunnel: tunnelObj,
+      dedicatedProxyURL: config.dedicatedProxyURL || "",
+      geolocation: config.geolocation || "",
       userAgent: config.userAgent || "",
       requestHeaders: config.requestHeaders || {},
       allowDuplicateSnapshotNames,
@@ -4395,9 +4428,11 @@ function processSnapshot(snapshot, ctx) {
     };
     let contextOptions = {
       javaScriptEnabled: ctx.config.cliEnableJavaScript,
-      userAgent: constants_default.CHROME_USER_AGENT,
       ignoreHTTPSErrors: ctx.config.ignoreHTTPSErrors
     };
+    if (!ctx.env.DO_NOT_USE_USER_AGENT) {
+      contextOptions.userAgent = constants_default.CHROME_USER_AGENT;
+    }
     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 };
@@ -5542,7 +5577,7 @@ var startTunnel_default = (ctx) => {
 
 // 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").option("--fetch-results [filename]", "Fetch results and optionally specify an output file, e.g., <filename>.json").option("--buildName <string>", "Specify the build name").option("--scheduled <string>", "Specify the schedule ID").option("--userName <string>", "Specify the LT username").option("--accessKey <string>", "Specify the LT accesskey").option("--show-render-errors", "Show render errors from SmartUI build").action(function(execCommand, _, command11) {
+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").option("--buildName <string>", "Specify the build name").option("--scheduled <string>", "Specify the schedule ID").option("--show-render-errors", "Show render errors from SmartUI build").action(function(execCommand, _, command11) {
   return __async(this, null, function* () {
     var _a;
     const options = command11.optsWithGlobals();
@@ -5751,7 +5786,7 @@ var auth_default = (ctx) => {
     task: (ctx2, task) => __async(void 0, null, function* () {
       updateLogContext({ task: "auth" });
       try {
-        const authResult = yield ctx2.client.auth(ctx2.log, ctx2.env);
+        const { authResult, orgId, userId } = yield ctx2.client.auth(ctx2.log, ctx2.env);
         if (authResult === 2) {
           task.output = chalk__default.default.gray(`New project '${ctx2.env.PROJECT_NAME}' created successfully`);
         } else if (authResult === 0) {
@@ -5759,6 +5794,8 @@ var auth_default = (ctx) => {
         } else if (authResult === 1) {
           task.output = chalk__default.default.gray(`Using existing project '${ctx2.env.PROJECT_NAME}'`);
         }
+        ctx2.orgId = orgId;
+        ctx2.userId = userId;
         task.title = "Authenticated with SmartUI";
       } catch (error) {
         ctx2.log.debug(error);
@@ -5808,6 +5845,7 @@ function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, rend
   return __async(this, null, function* () {
     ctx.log.debug(`*** urlConfig  ${JSON.stringify(urlConfig)}`);
     let { name, url, waitForTimeout, execute, pageEvent, userAgent } = urlConfig;
+    let beforeNavigationScript = execute == null ? void 0 : execute.beforeNavigation;
     let afterNavigationScript = execute == null ? void 0 : execute.afterNavigation;
     let beforeSnapshotScript = execute == null ? void 0 : execute.beforeSnapshot;
     let waitUntilEvent = pageEvent || process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || "load";
@@ -5818,6 +5856,69 @@ function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, rend
     let contextOptions = {
       ignoreHTTPSErrors: ctx.config.ignoreHTTPSErrors
     };
+    try {
+      if (ctx.config.tunnel && ctx.config.tunnel.tunnelName) {
+        if (ctx.tunnelDetails && ctx.tunnelDetails.tunnelPort != -1 && ctx.tunnelDetails.tunnelHost) {
+          const tunnelServer = `http://${ctx.tunnelDetails.tunnelHost}:${ctx.tunnelDetails.tunnelPort}`;
+          ctx.log.info(`URL Capture :: Using tunnel address: ${tunnelServer}`);
+          contextOptions.proxy = { server: tunnelServer };
+        } else {
+          let tunnelResp = yield ctx.client.getTunnelDetails(ctx, ctx.log);
+          ctx.log.debug(`Tunnel Response: ${JSON.stringify(tunnelResp)}`);
+          if (tunnelResp && tunnelResp.data && tunnelResp.data.host && tunnelResp.data.port) {
+            ctx.tunnelDetails = {
+              tunnelHost: tunnelResp.data.host,
+              tunnelPort: tunnelResp.data.port,
+              tunnelName: tunnelResp.data.tunnel_name
+            };
+            const tunnelServer = `http://${ctx.tunnelDetails.tunnelHost}:${ctx.tunnelDetails.tunnelPort}`;
+            ctx.log.info(`URL Capture :: Using tunnel address: ${tunnelServer}`);
+            contextOptions.proxy = { server: tunnelServer };
+          } else if (tunnelResp && tunnelResp.error) {
+            if (tunnelResp.error.message) {
+              ctx.log.warn(`Error while fetching tunnel details: ${tunnelResp.error.message}`);
+            }
+          }
+        }
+      } else if (ctx.config.geolocation && ctx.config.geolocation !== "") {
+        if (ctx.geolocationData && ctx.geolocationData.proxy && ctx.geolocationData.username && ctx.geolocationData.password && ctx.geolocationData.geoCode === ctx.config.geolocation) {
+          ctx.log.info(`URL Capture :: Using cached geolocation proxy for ${ctx.config.geolocation}`);
+          contextOptions.proxy = {
+            server: ctx.geolocationData.proxy,
+            username: ctx.geolocationData.username,
+            password: ctx.geolocationData.password
+          };
+        } else {
+          const geoResp = yield ctx.client.getGeolocationProxy(ctx.config.geolocation, ctx.log);
+          ctx.log.debug(`Geolocation proxy response: ${JSON.stringify(geoResp)}`);
+          if (geoResp && geoResp.data && geoResp.data.proxy && geoResp.data.username && geoResp.data.password) {
+            ctx.log.info(`URL Capture :: Using geolocation proxy for ${ctx.config.geolocation}`);
+            ctx.geolocationData = {
+              proxy: geoResp.data.proxy,
+              username: geoResp.data.username,
+              password: geoResp.data.password,
+              geoCode: ctx.config.geolocation
+            };
+            contextOptions.proxy = {
+              server: geoResp.data.proxy,
+              username: geoResp.data.username,
+              password: geoResp.data.password
+            };
+          } else {
+            ctx.log.warn(`Geolocation proxy not available for '${ctx.config.geolocation}', falling back if dedicatedProxyURL present`);
+            if (ctx.config.dedicatedProxyURL && ctx.config.dedicatedProxyURL !== "") {
+              ctx.log.info(`URL Capture :: Using dedicated proxy: ${ctx.config.dedicatedProxyURL}`);
+              contextOptions.proxy = { server: ctx.config.dedicatedProxyURL };
+            }
+          }
+        }
+      } else if (ctx.config.dedicatedProxyURL && ctx.config.dedicatedProxyURL !== "") {
+        ctx.log.info(`URL Capture :: Using dedicated proxy: ${ctx.config.dedicatedProxyURL}`);
+        contextOptions.proxy = { server: ctx.config.dedicatedProxyURL };
+      }
+    } catch (e) {
+      ctx.log.debug(`Failed resolving tunnel/proxy details: ${e}`);
+    }
     let page;
     if (browserName == constants_default.CHROME)
       contextOptions.userAgent = constants_default.CHROME_USER_AGENT;
@@ -5839,6 +5940,15 @@ function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, rend
       const browser = browsers[browserName];
       context = yield browser == null ? void 0 : browser.newContext(contextOptions);
       page = yield context == null ? void 0 : context.newPage();
+      if (beforeNavigationScript && beforeNavigationScript !== "") {
+        const wrappedScript = new Function("page", `
+                return (async () => {
+                    ${beforeNavigationScript}
+                })();
+            `);
+        ctx.log.debug(`Executing before navigation script: ${wrappedScript}`);
+        yield wrappedScript(page);
+      }
       const headersObject = {};
       if (ctx.config.requestHeaders && Array.isArray(ctx.config.requestHeaders)) {
         ctx.config.requestHeaders.forEach((headerObj) => {
@@ -5854,6 +5964,11 @@ function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, rend
           });
         });
       }
+      if (ctx.config.basicAuthorization) {
+        ctx.log.debug(`Adding basic authorization to the headers for root url`);
+        let token = Buffer.from(`${ctx.config.basicAuthorization.username}:${ctx.config.basicAuthorization.password}`).toString("base64");
+        headersObject["Authorization"] = `Basic ${token}`;
+      }
       ctx.log.debug(`Combined headers: ${JSON.stringify(headersObject)}`);
       if (Object.keys(headersObject).length > 0) {
         yield page.setExtraHTTPHeaders(headersObject);
@@ -7221,7 +7336,7 @@ var uploadPdf_default = command10;
 
 // 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").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).addCommand(pingTest_default).addCommand(uploadPdf_default);
+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").option("--userName <string>", "Specify the LT username").option("--accessKey <string>", "Specify the LT accesskey").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).addCommand(pingTest_default).addCommand(uploadPdf_default);
 var commander_default = program2;
 (function() {
   return __async(this, null, function* () {

package/package.json

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