@lambdatest/smartui-cli 4.1.4-beta.0 → 4.1.5

package/dist/index.cjs

@@ -629,6 +629,14 @@ var ConfigSchema = {
     skipBuildCreation: {
       type: "boolean",
       errorMessage: "Invalid config; skipBuildCreation must be true/false"
+    },
+    tunnel: {
+      type: "boolean",
+      errorMessage: "Invalid config; tunnel must be true/false"
+    },
+    tunnelName: {
+      type: "string",
+      errorMessage: "Invalid config; tunnelName must be string"
     }
   },
   anyOf: [
@@ -1517,7 +1525,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.4-beta.0";
+var version = "4.1.5";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -1642,7 +1650,11 @@ var httpClient = class {
             headers: resp.headers,
             body: resp.data
           })}`);
-          return resp.data;
+          if (resp.data !== "") {
+            return resp.data;
+          } else {
+            return resp;
+          }
         } else {
           log2.debug(`empty response: ${JSON.stringify(resp)}`);
           return {};
@@ -1696,7 +1708,8 @@ var httpClient = class {
         git,
         config,
         buildName,
-        isStartExec
+        isStartExec,
+        packageVersion: package_default.version
       }
     }, log2);
   }
@@ -1708,6 +1721,15 @@ var httpClient = class {
       headers: { projectToken }
     }, log2);
   }
+  getTunnelDetails(tunnelName, log2) {
+    return this.request({
+      url: "/tunnel",
+      method: "POST",
+      data: {
+        tunnelName
+      }
+    }, log2);
+  }
   ping(buildId, log2) {
     return this.request({
       url: "/build/ping",
@@ -1998,7 +2020,7 @@ var httpClient = class {
   }
 };
 var ctx_default = (options) => {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
   let env = env_default();
   let webConfig;
   let mobileConfig;
@@ -2083,7 +2105,9 @@ var ctx_default = (options) => {
       delayedUpload: (_g = config.delayedUpload) != null ? _g : false,
       useGlobalCache: (_h = config.useGlobalCache) != null ? _h : false,
       ignoreHTTPSErrors: (_i = config.ignoreHTTPSErrors) != null ? _i : false,
-      skipBuildCreation: (_j = config.skipBuildCreation) != null ? _j : false
+      skipBuildCreation: (_j = config.skipBuildCreation) != null ? _j : false,
+      tunnel: (_k = config.tunnel) != null ? _k : false,
+      tunnelName: config.tunnelName || ""
     },
     uploadFilePath: "",
     webStaticConfig: [],
@@ -2101,6 +2125,11 @@ var ctx_default = (options) => {
       url: ""
     },
     args: {},
+    tunnelDetails: {
+      tunnelPort: -1,
+      tunnelHost: "",
+      tunnelName: ""
+    },
     options: {
       parallel: parallelObj,
       force: options.force ? true : false,
@@ -2210,12 +2239,37 @@ var createBuildExec_default = (ctx) => {
             baseline: resp.data.baseline,
             useKafkaFlow: resp.data.useKafkaFlow || false
           };
+          if (ctx2.build.id === "") {
+            ctx2.log.debug("Build creation failed: Build ID is empty");
+            task.output = chalk__default.default.red("Build creation failed: Build ID is empty");
+            throw new Error("SmartUI build creation failed");
+          }
           task.output = chalk__default.default.gray(`build id: ${resp.data.buildId}`);
           task.title = "SmartUI build created";
         } else {
           task.output = chalk__default.default.gray(`Empty PROJECT_TOKEN and PROJECT_NAME. Skipping Creation of Build!`);
           task.title = "Skipped SmartUI build creation";
         }
+        if (ctx2.config.tunnel) {
+          let tunnelResp = yield ctx2.client.getTunnelDetails(ctx2.config.tunnelName, ctx2.log);
+          ctx2.log.debug(`Tunnel Response: ${JSON.stringify(tunnelResp)}`);
+          if (tunnelResp && tunnelResp.data && tunnelResp.data.host && tunnelResp.data.port && tunnelResp.data.tunnel_name) {
+            ctx2.tunnelDetails = {
+              tunnelHost: tunnelResp.data.host,
+              tunnelPort: tunnelResp.data.port,
+              tunnelName: tunnelResp.data.tunnel_name
+            };
+            ctx2.log.debug(`Tunnel Details: ${JSON.stringify(ctx2.tunnelDetails)}`);
+          } else if (tunnelResp && tunnelResp.error) {
+            if (tunnelResp.error.message) {
+              if (tunnelResp.error.code && tunnelResp.error.code === 400) {
+                ctx2.log.warn(tunnelResp.error.message);
+              } else {
+                ctx2.log.warn(`Error while fetch tunnel details; Either tunnel is not running or tunnel parameters are different`);
+              }
+            }
+          }
+        }
       } catch (error) {
         ctx2.log.debug(error);
         task.output = chalk__default.default.gray(error.message);
@@ -2320,6 +2374,9 @@ var finalizeBuild_default = (ctx) => {
         if (ctx2.build.id) {
           yield ctx2.client.finalizeBuild(ctx2.build.id, ctx2.totalSnapshots, ctx2.log);
         }
+        if (ctx2.build.hasDiscoveryError) {
+          ctx2.log.warn(`We found some network errors while capturing DOM snapshots. These network errors may cause visual differences in your screenshots. Please go to ${ctx2.build.url} for more details`);
+        }
       } catch (error) {
         ctx2.log.debug(error);
         task.output = chalk__default.default.gray(error.message);
@@ -2395,11 +2452,10 @@ function processSnapshot(snapshot, ctx) {
       url: "",
       timestamp: "",
       snapshotUUID: "",
-      browsers: {
-        chrome: {}
-      }
+      browsers: {}
     };
     let globalViewport = "";
+    let globalBrowser = constants_default.CHROME;
     let launchOptions = {
       headless: isHeadless,
       args: constants_default.LAUNCH_ARGS
@@ -2526,13 +2582,15 @@ function processSnapshot(snapshot, ctx) {
             url: requestUrl,
             resourceType: request.resourceType()
           };
-          if (!discoveryErrors.browsers.chrome) {
-            discoveryErrors.browsers.chrome = {};
+          if (!discoveryErrors.browsers[globalBrowser]) {
+            discoveryErrors.browsers[globalBrowser] = {};
           }
-          if (!discoveryErrors.browsers.chrome[globalViewport]) {
-            discoveryErrors.browsers.chrome[globalViewport] = [];
+          if (discoveryErrors.browsers[globalBrowser] && !discoveryErrors.browsers[globalBrowser][globalViewport]) {
+            discoveryErrors.browsers[globalBrowser][globalViewport] = [];
+          }
+          if (discoveryErrors.browsers[globalBrowser]) {
+            (_a2 = discoveryErrors.browsers[globalBrowser][globalViewport]) == null ? void 0 : _a2.push(data);
           }
-          (_a2 = discoveryErrors.browsers.chrome[globalViewport]) == null ? void 0 : _a2.push(data);
         } else {
           ctx.log.debug(`Handling request ${requestUrl}
  - content-type ${response.headers()["content-type"]}`);
@@ -2653,6 +2711,13 @@ function processSnapshot(snapshot, ctx) {
         processedOptions.ignoreType = options.ignoreType;
       }
     }
+    if (ctx.config.tunnel) {
+      if (ctx.tunnelDetails && ctx.tunnelDetails.tunnelPort != -1 && ctx.tunnelDetails.tunnelHost != "") {
+        const tunnelAddress = `http://${ctx.tunnelDetails.tunnelHost}:${ctx.tunnelDetails.tunnelPort}`;
+        processedOptions.tunnelAddress = tunnelAddress;
+        ctx.log.debug(`Tunnel address added to processedOptions: ${tunnelAddress}`);
+      }
+    }
     let navigated = false;
     let previousDeviceType = null;
     let renderViewports;
@@ -2670,6 +2735,11 @@ function processSnapshot(snapshot, ctx) {
       ctx.log.debug(`Page resized to ${viewport.width}x${viewport.height || MIN_VIEWPORT_HEIGHT}`);
       globalViewport = viewportString;
       ctx.log.debug(`globalViewport : ${globalViewport}`);
+      if (globalViewport.toLowerCase().includes("iphone") || globalViewport.toLowerCase().includes("ipad")) {
+        globalBrowser = constants_default.WEBKIT;
+      } else {
+        globalBrowser = constants_default.CHROME;
+      }
       if (!navigated) {
         try {
           discoveryErrors.url = snapshot.url;
@@ -2682,7 +2752,19 @@ function processSnapshot(snapshot, ctx) {
           ctx.log.debug(`Navigated to ${snapshot.url}`);
         } catch (error) {
           ctx.log.debug(`Navigation to discovery page failed; ${error}`);
-          throw new Error(error.message);
+          if (error && error.name && error.name === "TimeoutError") {
+            ctx.log.debug(`Payload uploaded tough navigation to discovery page failed; ${error}`);
+            return {
+              processedSnapshot: {
+                name: snapshot.name,
+                url: snapshot.url,
+                dom: Buffer.from(snapshot.dom.html).toString("base64"),
+                resources: cache,
+                options: processedOptions
+              },
+              warnings: [...optionWarnings, ...snapshot.dom.warnings]
+            };
+          }
         }
       }
       if (ctx.config.cliEnableJavaScript && fullPage)
@@ -2756,7 +2838,21 @@ function processSnapshot(snapshot, ctx) {
       }
       ctx.log.debug(`Processed options: ${JSON.stringify(processedOptions)}`);
     }
-    discoveryErrors.timestamp = (/* @__PURE__ */ new Date()).toISOString();
+    let hasBrowserErrors = false;
+    for (let browser in discoveryErrors.browsers) {
+      if (discoveryErrors.browsers[browser]) {
+        for (let viewport in discoveryErrors.browsers[browser]) {
+          if (discoveryErrors.browsers[browser][viewport].length > 0) {
+            hasBrowserErrors = true;
+            ctx.build.hasDiscoveryError = true;
+            break;
+          }
+        }
+      }
+    }
+    if (hasBrowserErrors) {
+      discoveryErrors.timestamp = (/* @__PURE__ */ new Date()).toISOString();
+    }
     return {
       processedSnapshot: {
         name: snapshot.name,
@@ -3063,8 +3159,24 @@ var Queue = class {
                 const snapshotUuid = uuid.v4();
                 const presignedResponse = yield this.ctx.client.getS3PresignedURLForSnapshotUpload(this.ctx, processedSnapshot.name, snapshotUuid);
                 const uploadUrl = presignedResponse.data.url;
-                yield this.ctx.client.uploadSnapshotToS3(this.ctx, uploadUrl, processedSnapshot);
-                yield this.ctx.client.processSnapshot(this.ctx, processedSnapshot, snapshotUuid, discoveryErrors);
+                let snapshotUploadResponse = yield this.ctx.client.uploadSnapshotToS3(this.ctx, uploadUrl, processedSnapshot);
+                if (!snapshotUploadResponse || Object.keys(snapshotUploadResponse).length === 0) {
+                  this.ctx.log.debug(`snapshot failed; Unable to upload dom to S3`);
+                  this.processedSnapshots.push({ name: snapshot == null ? void 0 : snapshot.name, error: `snapshot failed; Unable to upload dom to S3` });
+                  if (this.ctx.browser) {
+                    for (let context of this.ctx.browser.contexts()) {
+                      for (let page of context.pages()) {
+                        yield page.close();
+                        this.ctx.log.debug(`Closed browser page for snapshot ${snapshot.name}`);
+                      }
+                      yield context.close();
+                      this.ctx.log.debug(`Closed browser context for snapshot ${snapshot.name}`);
+                    }
+                  }
+                  this.processNext();
+                } else {
+                  yield this.ctx.client.processSnapshot(this.ctx, processedSnapshot, snapshotUuid, discoveryErrors);
+                }
               } else {
                 yield this.ctx.client.uploadSnapshot(this.ctx, processedSnapshot, discoveryErrors);
               }

package/package.json

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