@lambdatest/smartui-cli 4.1.45 → 4.1.47

package/dist/index.cjs

@@ -2681,7 +2681,9 @@ var env_default = () => {
     HTTPS_PROXY,
     SMARTUI_HTTP_PROXY,
     SMARTUI_HTTPS_PROXY,
-    GITHUB_ACTIONS,
+    GIT_URL,
+    BASIC_AUTH_USERNAME,
+    BASIC_AUTH_PASSWORD,
     FIGMA_TOKEN,
     LT_USERNAME,
     LT_ACCESS_KEY,
@@ -2708,7 +2710,9 @@ var env_default = () => {
     HTTPS_PROXY,
     SMARTUI_HTTP_PROXY,
     SMARTUI_HTTPS_PROXY,
-    GITHUB_ACTIONS,
+    GIT_URL,
+    BASIC_AUTH_USERNAME,
+    BASIC_AUTH_PASSWORD,
     FIGMA_TOKEN,
     LT_USERNAME,
     LT_ACCESS_KEY,
@@ -2725,7 +2729,8 @@ var env_default = () => {
     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,
-    DO_NOT_USE_USER_AGENT: DO_NOT_USE_USER_AGENT === "true"
+    DO_NOT_USE_USER_AGENT: DO_NOT_USE_USER_AGENT === "true",
+    CAPTURE_RENDERING_ERRORS: process.env.CAPTURE_RENDERING_ERRORS === "true"
   };
 };
 var logContext = {};
@@ -2820,7 +2825,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.45";
+var version = "4.1.47";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -3291,7 +3296,7 @@ var httpClient = class {
       data: requestData
     }, ctx.log);
   }
-  uploadScreenshot({ id: buildId, name: buildName, baseline }, ssPath, ssName, browserName, viewport, url = "", log2) {
+  uploadScreenshot({ id: buildId, name: buildName, baseline }, ssPath, ssName, browserName, viewport, url = "", log2, discoveryErrors, ctx) {
     browserName = browserName === constants_default.SAFARI ? constants_default.WEBKIT : browserName;
     const file = fs6__default.default.readFileSync(ssPath);
     const form = new FormData__default.default();
@@ -3303,6 +3308,9 @@ var httpClient = class {
     form.append("screenshotName", ssName);
     form.append("baseline", baseline.toString());
     form.append("pageUrl", url);
+    if ((ctx == null ? void 0 : ctx.env.CAPTURE_RENDERING_ERRORS) && discoveryErrors) {
+      form.append("discoveryErrors", JSON.stringify(discoveryErrors));
+    }
     return this.axiosInstance.request({
       url: `/screenshot`,
       method: "POST",
@@ -3361,6 +3369,19 @@ var httpClient = class {
       }
     }, ctx.log);
   }
+  getS3PreSignedURLForCaps(ctx, capsBuildId, capsProjectToken) {
+    return this.request({
+      url: `/loguploadurl`,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        projectToken: capsProjectToken !== "" ? capsProjectToken : this.projectToken
+      },
+      data: {
+        buildId: capsBuildId
+      }
+    }, ctx.log);
+  }
   getS3PresignedURLForSnapshotUpload(ctx, snapshotName, snapshotUuid) {
     return this.request({
       url: `/snapshotuploadurl`,
@@ -3419,7 +3440,7 @@ var httpClient = class {
     }, ctx.log);
   }
   uploadLogs(ctx, uploadURL) {
-    const fileStream = fs6__default.default.createReadStream(constants_default.LOG_FILE_PATH);
+    const logContent = fs6__default.default.readFileSync(constants_default.LOG_FILE_PATH);
     const { size } = fs6__default.default.statSync(constants_default.LOG_FILE_PATH);
     return this.request({
       url: uploadURL,
@@ -3428,7 +3449,7 @@ var httpClient = class {
         "Content-Type": "text/plain",
         "Content-Length": size
       },
-      data: fileStream,
+      data: logContent,
       maxBodyLength: Infinity,
       // prevent axios from limiting the body size
       maxContentLength: Infinity
@@ -3447,6 +3468,22 @@ var httpClient = class {
       }
     }, ctx.log);
   }
+  sendCliLogsToLSRSForCaps(ctx, capsBuildId, capsProjectToken) {
+    const logContent = fs6__default.default.readFileSync(constants_default.LOG_FILE_PATH, "utf-8");
+    return this.request({
+      url: `/upload/logs`,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        projectToken: capsProjectToken !== "" ? capsProjectToken : this.projectToken
+      },
+      data: {
+        buildId: capsBuildId,
+        logContent,
+        skipLogging: true
+      }
+    }, ctx.log);
+  }
   uploadSnapshotToS3(ctx, uploadURL, snapshot) {
     return this.request({
       url: uploadURL,
@@ -3692,6 +3729,12 @@ var ctx_default = (options) => {
       orientation: config.mobile.orientation || constants_default.MOBILE_ORIENTATION_PORTRAIT
     };
   }
+  if (env.BASIC_AUTH_USERNAME && env.BASIC_AUTH_PASSWORD) {
+    basicAuthObj = {
+      "username": env.BASIC_AUTH_USERNAME,
+      "password": env.BASIC_AUTH_PASSWORD
+    };
+  }
   if (config.basicAuthorization) {
     basicAuthObj = config.basicAuthorization;
   }
@@ -3788,7 +3831,7 @@ var ctx_default = (options) => {
       fetchResultsFileName: fetchResultsFileObj,
       baselineBranch: options.baselineBranch || "",
       baselineBuild: options.baselineBuild || "",
-      githubURL: options.githubURL || "",
+      githubURL: options.gitURL || options.githubURL || "",
       showRenderErrors: options.showRenderErrors ? true : false,
       userName: options.userName || "",
       accessKey: options.accessKey || ""
@@ -3860,6 +3903,9 @@ var git_default = (ctx) => {
   if (ctx.options.githubURL && ctx.options.githubURL.startsWith("https://")) {
     githubURL = ctx.options.githubURL;
   }
+  if (ctx.options.gitURL && ctx.options.gitURL.startsWith("https://")) {
+    githubURL = ctx.options.gitURL;
+  }
   if (ctx.env.SMARTUI_GIT_INFO_FILEPATH) {
     let gitInfo = JSON.parse(fs6__default.default.readFileSync(ctx.env.SMARTUI_GIT_INFO_FILEPATH, "utf-8"));
     if (ctx.options.markBaseline) {
@@ -3871,7 +3917,7 @@ var git_default = (ctx) => {
       commitId: gitInfo.commit_id.slice(0, 6) || "",
       commitMessage: gitInfo.commit_body || "",
       commitAuthor: gitInfo.commit_author || "",
-      githubURL: githubURL ? githubURL : ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}` : "",
+      githubURL: githubURL ? githubURL : ctx.env.GIT_URL ? ctx.env.GIT_URL : `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}`,
       baselineBranch: ctx.options.baselineBranch || ctx.env.BASELINE_BRANCH || ""
     };
   } else {
@@ -3891,7 +3937,7 @@ var git_default = (ctx) => {
       commitId: res[0] || "",
       commitMessage: res[2] || "",
       commitAuthor: res[7] || "",
-      githubURL: githubURL ? githubURL : ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : "",
+      githubURL: githubURL ? githubURL : ctx.env.GIT_URL ? ctx.env.GIT_URL : `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}`,
       baselineBranch: ctx.options.baselineBranch || ctx.env.BASELINE_BRANCH || ""
     };
   }
@@ -3906,6 +3952,9 @@ function setNonGitInfo(ctx) {
   if (ctx.options.githubURL && ctx.options.githubURL.startsWith("https://")) {
     githubURL = ctx.options.githubURL;
   }
+  if (ctx.options.gitURL && ctx.options.gitURL.startsWith("https://")) {
+    githubURL = ctx.options.gitURL;
+  }
   ctx.git = {
     branch,
     commitId: "-",
@@ -4166,6 +4215,7 @@ var finalizeBuild_default = (ctx) => {
         clearInterval(pingIntervalId);
         ctx2.log.debug("Ping polling stopped immediately from Finalize Build");
       }
+      let uploadedCliLogsBuildIds = /* @__PURE__ */ new Set();
       for (const [sessionId, capabilities] of ctx2.sessionCapabilitiesMap.entries()) {
         try {
           const buildId = (capabilities == null ? void 0 : capabilities.buildId) || "";
@@ -4188,6 +4238,18 @@ var finalizeBuild_default = (ctx) => {
           }
           ctx2.log.debug(`Capabilities for sessionId ${sessionId}: ${JSON.stringify(capabilities)}`);
           if (buildId && projectToken) {
+            if (ctx2.isSnapshotCaptured && !uploadedCliLogsBuildIds.has(buildId)) {
+              let uploadCLILogsToS3 = ctx2.config.useLambdaInternal || uploadDomToS3ViaEnv2;
+              if (!uploadCLILogsToS3) {
+                ctx2.log.debug(`Log file to be uploaded`);
+                let resp = yield ctx2.client.getS3PreSignedURLForCaps(ctx2, buildId, projectToken);
+                yield ctx2.client.uploadLogs(ctx2, resp.data.url);
+              } else {
+                ctx2.log.debug(`Log file to be uploaded via LSRS`);
+                ctx2.client.sendCliLogsToLSRSForCaps(ctx2, buildId, projectToken);
+              }
+              uploadedCliLogsBuildIds.add(buildId);
+            }
             yield ctx2.client.finalizeBuildForCapsWithToken(buildId, totalSnapshots, projectToken, ctx2.log);
             if (ctx2.autoTunnelStarted) {
               yield startPollingForTunnel(ctx2, buildId, false, projectToken, capabilities == null ? void 0 : capabilities.buildName);
@@ -5869,6 +5931,15 @@ function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, rend
     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";
+    let discoveryErrors = {
+      name: "",
+      url: "",
+      timestamp: "",
+      snapshotUUID: "",
+      browsers: {}
+    };
+    let globalViewport = "";
+    let globalBrowser = constants_default.CHROME;
     let pageOptions = { waitUntil: waitUntilEvent, timeout: ctx.config.waitForPageRender || constants_default.DEFAULT_PAGE_LOAD_TIMEOUT };
     ctx.log.debug(`url:  ${url}  pageOptions: ${JSON.stringify(pageOptions)}`);
     let ssId = name.toLowerCase().replace(/\s/g, "_");
@@ -5993,17 +6064,85 @@ function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, rend
       if (Object.keys(headersObject).length > 0) {
         yield page.setExtraHTTPHeaders(headersObject);
       }
+      if (ctx.env.CAPTURE_RENDERING_ERRORS) {
+        yield page.route("**/*", (route, request) => __async(this, null, function* () {
+          var _a;
+          const requestUrl = request.url();
+          const requestHostname = new URL(requestUrl).hostname;
+          let requestOptions = {
+            timeout: 3e4,
+            headers: __spreadValues(__spreadValues({}, yield request.allHeaders()), constants_default.REQUEST_HEADERS)
+          };
+          try {
+            let response, body;
+            response = yield page.request.fetch(request, requestOptions);
+            body = yield response.body();
+            let data = {
+              statusCode: `${response.status()}`,
+              url: requestUrl
+            };
+            if (response.status() >= 400 && response.status() < 600 && response.status() !== 0) {
+              if (!discoveryErrors.browsers[globalBrowser]) {
+                discoveryErrors.browsers[globalBrowser] = {};
+              }
+              if (discoveryErrors.browsers[globalBrowser] && !discoveryErrors.browsers[globalBrowser][globalViewport]) {
+                discoveryErrors.browsers[globalBrowser][globalViewport] = [];
+              }
+              if (discoveryErrors.browsers[globalBrowser]) {
+                (_a = discoveryErrors.browsers[globalBrowser][globalViewport]) == null ? void 0 : _a.push(data);
+              }
+              ctx.build.hasDiscoveryError = true;
+            }
+            route.fulfill({
+              status: response.status(),
+              headers: response.headers(),
+              body
+            });
+          } catch (error) {
+            ctx.log.debug(`Handling request ${requestUrl}
+ - aborted due to ${error.message}`);
+            route.abort();
+          }
+        }));
+      }
+      if (renderViewports && renderViewports.length > 0) {
+        const first = renderViewports[0];
+        globalViewport = first.viewportString;
+        globalBrowser = browserName;
+        if (globalViewport.toLowerCase().includes("iphone") || globalViewport.toLowerCase().includes("ipad")) {
+          globalBrowser = constants_default.WEBKIT;
+        }
+      }
+      if (browserName == constants_default.SAFARI || (globalViewport.toLowerCase().includes("iphone") || globalViewport.toLowerCase().includes("ipad"))) {
+        globalBrowser = constants_default.WEBKIT;
+      }
       yield page == null ? void 0 : page.goto(url.trim(), pageOptions);
       yield executeDocumentScripts(ctx, page, "afterNavigation", afterNavigationScript);
       for (let { viewport, viewportString, fullPage } of renderViewports) {
+        globalViewport = viewportString;
+        globalBrowser = browserName;
+        ctx.log.debug(`globalViewport : ${globalViewport}`);
+        if (browserName == constants_default.SAFARI || (globalViewport.toLowerCase().includes("iphone") || globalViewport.toLowerCase().includes("ipad"))) {
+          globalBrowser = constants_default.WEBKIT;
+        }
         let ssPath = `screenshots/${ssId}/${`${browserName}-${viewport.width}x${viewport.height}`}-${ssId}.png`;
         yield page == null ? void 0 : page.setViewportSize({ width: viewport.width, height: viewport.height || constants_default.MIN_VIEWPORT_HEIGHT });
         if (fullPage)
           yield page == null ? void 0 : page.evaluate(scrollToBottomAndBackToTop);
         yield page == null ? void 0 : page.waitForTimeout(waitForTimeout || 0);
         yield executeDocumentScripts(ctx, page, "beforeSnapshot", beforeSnapshotScript);
+        discoveryErrors.name = name;
+        discoveryErrors.url = url;
+        discoveryErrors.timestamp = (/* @__PURE__ */ new Date()).toISOString();
         yield page == null ? void 0 : page.screenshot({ path: ssPath, fullPage });
-        yield ctx.client.uploadScreenshot(ctx.build, ssPath, name, browserName, viewportString, url, ctx.log);
+        yield ctx.client.uploadScreenshot(ctx.build, ssPath, name, browserName, viewportString, url, ctx.log, discoveryErrors, ctx);
+        discoveryErrors = {
+          name: "",
+          url: "",
+          timestamp: "",
+          snapshotUUID: "",
+          browsers: {}
+        };
       }
     } catch (error) {
       throw new Error(`captureScreenshotsForConfig failed for browser ${browserName}; error: ${error}`);
@@ -6173,7 +6312,13 @@ function uploadScreenshots(ctx) {
                   viewport = `${width}x${height}`;
                 }
               }
-              yield ctx.client.uploadScreenshot(ctx.build, filePath, ssId, "default", viewport, "", ctx.log);
+              yield ctx.client.uploadScreenshot(ctx.build, filePath, ssId, "default", viewport, "", ctx.log, {
+                name: "",
+                url: "",
+                timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+                snapshotUUID: "",
+                browsers: {}
+              }, ctx);
               ctx.log.info(`${filePath} : uploaded successfully`);
               noOfScreenshots++;
             } else {
@@ -7356,7 +7501,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").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);
+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("--gitURL <string>", "Git 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.45",
+  "version": "4.1.47",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"