@lambdatest/smartui-cli 4.1.25 → 4.1.27

package/dist/index.cjs

@@ -1012,6 +1012,18 @@ var SnapshotSchema = {
         sessionId: {
           type: "string",
           errorMessage: "Invalid snapshot options; sessionId must be a string"
+        },
+        contextId: {
+          type: "string",
+          errorMessage: "Invalid snapshot options; contextId must be a string"
+        },
+        sync: {
+          type: "boolean",
+          errorMessage: "Invalid snapshot options; sync must be a boolean"
+        },
+        timeout: {
+          type: "number",
+          errorMessage: "Invalid snapshot options; timeout must be a number"
         }
       },
       additionalProperties: false
@@ -1674,8 +1686,39 @@ function stopTunnelHelper(ctx) {
     ctx.log.debug("Tunnel is Stopped ? " + status);
   });
 }
+function calculateVariantCount(config) {
+  let variantCount = 0;
+  if (config.web) {
+    const browsers = config.web.browsers || [];
+    const viewports = config.web.viewports || [];
+    variantCount += browsers.length * viewports.length;
+  }
+  if (config.mobile) {
+    const devices = config.mobile.devices || [];
+    variantCount += devices.length;
+  }
+  return variantCount;
+}
+function calculateVariantCountFromSnapshot(snapshot, globalConfig) {
+  var _a, _b;
+  let variantCount = 0;
+  if ((_a = snapshot.options) == null ? void 0 : _a.web) {
+    const browsers = snapshot.options.web.browsers || [];
+    const viewports = snapshot.options.web.viewports || [];
+    variantCount += browsers.length * viewports.length;
+  }
+  if ((_b = snapshot.options) == null ? void 0 : _b.mobile) {
+    const devices = snapshot.options.mobile.devices || [];
+    variantCount += devices.length;
+  }
+  if (variantCount === 0 && globalConfig) {
+    variantCount = calculateVariantCount(globalConfig);
+  }
+  return variantCount;
+}
 
 // src/lib/server.ts
+var uploadDomToS3ViaEnv = process.env.USE_LAMBDA_INTERNAL || false;
 var server_default = (ctx) => __async(void 0, null, function* () {
   const server = fastify__default.default({
     logger: {
@@ -1695,7 +1738,7 @@ var server_default = (ctx) => __async(void 0, null, function* () {
     reply.code(200).send({ data: { dom: SMARTUI_DOM } });
   });
   server.post("/snapshot", opts, (request, reply) => __async(void 0, null, function* () {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     let replyCode;
     let replyBody;
     try {
@@ -1704,8 +1747,9 @@ var server_default = (ctx) => __async(void 0, null, function* () {
         throw new Error(validateSnapshot.errors[0].message);
       const sessionId = (_a = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _a.sessionId;
       let capsBuildId = "";
+      const contextId = (_b = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _b.contextId;
       if (sessionId) {
-        if ((_b = ctx.sessionCapabilitiesMap) == null ? void 0 : _b.has(sessionId)) {
+        if ((_c = ctx.sessionCapabilitiesMap) == null ? void 0 : _c.has(sessionId)) {
           const cachedCapabilities = ctx.sessionCapabilitiesMap.get(sessionId);
           capsBuildId = (cachedCapabilities == null ? void 0 : cachedCapabilities.buildId) || "";
         } else {
@@ -1728,7 +1772,19 @@ var server_default = (ctx) => __async(void 0, null, function* () {
         }
       }
       ctx.testType = testType;
-      (_c = ctx.snapshotQueue) == null ? void 0 : _c.enqueue(snapshot);
+      if (contextId && !ctx.contextToSnapshotMap) {
+        ctx.contextToSnapshotMap = /* @__PURE__ */ new Map();
+        ctx.log.debug(`Initialized empty context mapping map for contextId: ${contextId}`);
+      }
+      if (contextId && ctx.contextToSnapshotMap) {
+        ctx.contextToSnapshotMap.set(contextId, 0);
+        ctx.log.debug(`Marking contextId as captured and added to queue: ${contextId}`);
+      }
+      if (contextId) {
+        (_d = ctx.snapshotQueue) == null ? void 0 : _d.enqueueFront(snapshot);
+      } else {
+        (_e = ctx.snapshotQueue) == null ? void 0 : _e.enqueue(snapshot);
+      }
       ctx.isSnapshotCaptured = true;
       replyCode = 200;
       replyBody = { data: { message: "success", warnings: [] } };
@@ -1740,7 +1796,7 @@ var server_default = (ctx) => __async(void 0, null, function* () {
     return reply.code(replyCode).send(replyBody);
   }));
   server.post("/stop", opts, (_, reply) => __async(void 0, null, function* () {
-    var _a, _b;
+    var _a, _b, _c;
     let replyCode;
     let replyBody;
     try {
@@ -1762,8 +1818,14 @@ var server_default = (ctx) => __async(void 0, null, function* () {
       if (ctx.server) {
         ctx.server.close();
       }
-      let resp = yield ctx.client.getS3PreSignedURL(ctx);
-      yield ctx.client.uploadLogs(ctx, resp.data.url);
+      let uploadCLILogsToS3 = ((_c = ctx == null ? void 0 : ctx.config) == null ? void 0 : _c.useLambdaInternal) || uploadDomToS3ViaEnv;
+      if (!uploadCLILogsToS3) {
+        ctx.log.debug(`Log file to be uploaded`);
+        let resp = yield ctx.client.getS3PreSignedURL(ctx);
+        yield ctx.client.uploadLogs(ctx, resp.data.url);
+      } else {
+        ctx.log.debug(`Skipping upload of CLI logs as useLambdaInternal is set`);
+      }
       if (pingIntervalId !== null) {
         clearInterval(pingIntervalId);
         ctx.log.debug("Ping polling stopped immediately.");
@@ -1781,6 +1843,93 @@ var server_default = (ctx) => __async(void 0, null, function* () {
   server.get("/ping", opts, (_, reply) => {
     reply.code(200).send({ status: "Server is running", version: ctx.cliVersion });
   });
+  server.get("/snapshot/status", opts, (request, reply) => __async(void 0, null, function* () {
+    var _a;
+    let replyCode;
+    let replyBody;
+    try {
+      ctx.log.debug(`request.query : ${JSON.stringify(request.query)}`);
+      const { contextId, pollTimeout, snapshotName } = request.query;
+      if (!contextId || !snapshotName) {
+        throw new Error("contextId and snapshotName are required parameters");
+      }
+      const timeoutDuration = pollTimeout * 1e3 || 3e4;
+      if ((_a = ctx.contextToSnapshotMap) == null ? void 0 : _a.has(contextId)) {
+        let contextStatus = ctx.contextToSnapshotMap.get(contextId);
+        while (contextStatus == 0) {
+          yield new Promise((resolve) => setTimeout(resolve, 5e3));
+          contextStatus = ctx.contextToSnapshotMap.get(contextId);
+        }
+        if (contextStatus == 2) {
+          throw new Error("Snapshot Failed");
+        }
+        ctx.log.debug("Snapshot uploaded successfully");
+        let lastExternalResponse = null;
+        const startTime = Date.now();
+        while (true) {
+          try {
+            const externalResponse = yield ctx.client.getSnapshotStatus(
+              snapshotName,
+              contextId,
+              ctx
+            );
+            lastExternalResponse = externalResponse;
+            if (externalResponse.statusCode === 200) {
+              replyCode = 200;
+              replyBody = externalResponse.data;
+              return reply.code(replyCode).send(replyBody);
+            } else if (externalResponse.statusCode === 202) {
+              replyBody = externalResponse.data;
+              ctx.log.debug(`External API attempt: Still processing, Pending Screenshots ${externalResponse.snapshotCount}`);
+              yield new Promise((resolve) => setTimeout(resolve, 5e3));
+            } else if (externalResponse.statusCode === 404) {
+              ctx.log.debug(`Snapshot still processing, not uploaded`);
+              yield new Promise((resolve) => setTimeout(resolve, 5e3));
+            } 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);
+            }
+            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"
+                }
+              };
+              return reply.code(replyCode).send(replyBody);
+            }
+          } catch (externalApiError) {
+            ctx.log.debug(`External API call failed: ${externalApiError.message}`);
+            replyCode = 500;
+            replyBody = {
+              error: {
+                message: `External API call failed: ${externalApiError.message}`
+              }
+            };
+            return reply.code(replyCode).send(replyBody);
+          }
+        }
+      } else {
+        replyCode = 404;
+        replyBody = { error: { message: `No snapshot found for contextId: ${contextId}` } };
+        return reply.code(replyCode).send(replyBody);
+      }
+    } catch (error) {
+      ctx.log.debug(`snapshot status failed; ${error}`);
+      replyCode = 500;
+      replyBody = { error: { message: error.message } };
+      return reply.code(replyCode).send(replyBody);
+    }
+  }));
   yield server.listen({ port: ctx.options.port });
   let { port } = server.addresses()[0];
   process.env.SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
@@ -1927,7 +2076,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.25";
+var version = "4.1.27";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -2268,7 +2417,7 @@ var httpClient = class {
       }
     }, ctx.log);
   }
-  processSnapshot(ctx, snapshot, snapshotUuid, discoveryErrors) {
+  processSnapshot(ctx, snapshot, snapshotUuid, discoveryErrors, variantCount, sync = false) {
     return this.request({
       url: `/build/${ctx.build.id}/snapshot`,
       method: "POST",
@@ -2277,12 +2426,14 @@ var httpClient = class {
         name: snapshot.name,
         url: snapshot.url,
         snapshotUuid,
+        variantCount,
         test: {
           type: ctx.testType,
           source: "cli"
         },
         doRemoteDiscovery: snapshot.options.doRemoteDiscovery,
-        discoveryErrors
+        discoveryErrors,
+        sync
       }
     }, ctx.log);
   }
@@ -2546,6 +2697,15 @@ var httpClient = class {
       data: requestData
     }, ctx.log);
   }
+  getSnapshotStatus(snapshotName, snapshotUuid, ctx) {
+    return this.request({
+      url: `/snapshot/status?buildId=${ctx.build.id}&snapshotName=${snapshotName}&snapshotUUID=${snapshotUuid}`,
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json"
+      }
+    }, ctx.log);
+  }
 };
 var ctx_default = (options) => {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
@@ -2633,6 +2793,9 @@ var ctx_default = (options) => {
   if (config.useLambdaInternal) {
     useLambdaInternal = true;
   }
+  if (config.waitForPageRender && config.waitForPageRender < 3e4) {
+    config.waitForPageRender = 3e4;
+  }
   return {
     env,
     log: logger_default,
@@ -2978,7 +3141,7 @@ ${snapshot.warnings.length ? chalk__default.default.gray(`[warning] ${snapshot.w
     rendererOptions: { persistentOutput: true }
   };
 };
-var uploadDomToS3ViaEnv = process.env.USE_LAMBDA_INTERNAL || false;
+var uploadDomToS3ViaEnv2 = process.env.USE_LAMBDA_INTERNAL || false;
 var finalizeBuild_default = (ctx) => {
   return {
     title: `Finalizing build`,
@@ -3043,7 +3206,7 @@ var finalizeBuild_default = (ctx) => {
         yield (_b = ctx2.server) == null ? void 0 : _b.close();
         ctx2.log.debug(`Closed server`);
         if (ctx2.isSnapshotCaptured) {
-          let uploadCLILogsToS3 = ctx2.config.useLambdaInternal || uploadDomToS3ViaEnv;
+          let uploadCLILogsToS3 = ctx2.config.useLambdaInternal || uploadDomToS3ViaEnv2;
           if (!uploadCLILogsToS3) {
             ctx2.log.debug(`Log file to be uploaded`);
             let resp = yield ctx2.client.getS3PreSignedURL(ctx2);
@@ -3715,7 +3878,7 @@ function processSnapshot(snapshot, ctx) {
     };
   });
 }
-var uploadDomToS3ViaEnv2 = process.env.USE_LAMBDA_INTERNAL || false;
+var uploadDomToS3ViaEnv3 = process.env.USE_LAMBDA_INTERNAL || false;
 var Queue = class {
   constructor(ctx) {
     this.snapshots = [];
@@ -3735,6 +3898,15 @@ var Queue = class {
       }
     }
   }
+  enqueueFront(item) {
+    this.snapshots.unshift(item);
+    if (!this.ctx.config.delayedUpload) {
+      if (!this.processing) {
+        this.processing = true;
+        this.processNext();
+      }
+    }
+  }
   startProcessingfunc() {
     if (!this.processing) {
       this.processing = true;
@@ -3928,7 +4100,7 @@ var Queue = class {
   }
   processNext() {
     return __async(this, null, function* () {
-      var _a, _b, _c, _d;
+      var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
       if (!this.isEmpty()) {
         let snapshot;
         if (this.ctx.config.delayedUpload) {
@@ -3944,7 +4116,7 @@ var Queue = class {
           }
           if (!this.ctx.config.delayedUpload && snapshot && snapshot.name && this.snapshotNames.includes(snapshot.name) && !this.ctx.config.allowDuplicateSnapshotNames) {
             drop = true;
-            this.ctx.log.info(`Skipping duplicate SmartUI snapshot '${snapshot.name}'. To capture duplicate screenshots, please set the 'delayedUpload' configuration as true in your config file.`);
+            this.ctx.log.info(`Skipping duplicate SmartUI snapshot '${snapshot.name}'. To capture duplicate screenshots, please set the 'allowDuplicateSnapshotNames' or 'delayedUpload' configuration as true in your config file.`);
           }
           if (this.ctx.config.delayedUpload && snapshot && snapshot.name && this.snapshotNames.includes(snapshot.name)) {
             drop = this.filterExistingVariants(snapshot, this.ctx.config);
@@ -3984,9 +4156,10 @@ var Queue = class {
               discoveryErrors = result.discoveryErrors;
             }
             if (useCapsBuildId) {
+              this.ctx.log.info(`Using cached buildId: ${capsBuildId}`);
               if (useKafkaFlowCaps) {
                 const snapshotUuid = uuid.v4();
-                let uploadDomToS3 = this.ctx.config.useLambdaInternal || uploadDomToS3ViaEnv2;
+                let uploadDomToS3 = this.ctx.config.useLambdaInternal || uploadDomToS3ViaEnv3;
                 if (!uploadDomToS3) {
                   this.ctx.log.debug(`Uploading dom to S3 for snapshot using presigned URL for CAPS`);
                   const presignedResponse = yield this.ctx.client.getS3PresignedURLForSnapshotUploadCaps(this.ctx, processedSnapshot.name, snapshotUuid, capsBuildId, capsProjectToken);
@@ -4028,9 +4201,12 @@ var Queue = class {
                 }
               }
               if (this.ctx.build && this.ctx.build.useKafkaFlow) {
-                const snapshotUuid = uuid.v4();
+                let snapshotUuid = uuid.v4();
                 let snapshotUploadResponse;
-                let uploadDomToS3 = this.ctx.config.useLambdaInternal || uploadDomToS3ViaEnv2;
+                if (((_e = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _e.contextId) && ((_f = this.ctx.contextToSnapshotMap) == null ? void 0 : _f.has(snapshot.options.contextId))) {
+                  snapshotUuid = snapshot.options.contextId;
+                }
+                let uploadDomToS3 = this.ctx.config.useLambdaInternal || uploadDomToS3ViaEnv3;
                 if (!uploadDomToS3) {
                   this.ctx.log.debug(`Uploading dom to S3 for snapshot using presigned URL`);
                   const presignedResponse = yield this.ctx.client.getS3PresignedURLForSnapshotUpload(this.ctx, processedSnapshot.name, snapshotUuid);
@@ -4053,11 +4229,19 @@ var Queue = class {
                       this.ctx.log.debug(`Closed browser context for snapshot ${snapshot.name}`);
                     }
                   }
+                  if ((_g = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _g.contextId) {
+                    (_i = this.ctx.contextToSnapshotMap) == null ? void 0 : _i.set((_h = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _h.contextId, 2);
+                  }
                   this.processNext();
                 } else {
-                  yield this.ctx.client.processSnapshot(this.ctx, processedSnapshot, snapshotUuid, discoveryErrors);
+                  yield this.ctx.client.processSnapshot(this.ctx, processedSnapshot, snapshotUuid, discoveryErrors, calculateVariantCountFromSnapshot(processedSnapshot, this.ctx.config), (_j = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _j.sync);
+                  if (((_k = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _k.contextId) && ((_l = this.ctx.contextToSnapshotMap) == null ? void 0 : _l.has(snapshot.options.contextId))) {
+                    this.ctx.contextToSnapshotMap.set(snapshot.options.contextId, 1);
+                  }
+                  this.ctx.log.debug(`ContextId: ${(_m = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _m.contextId} status set to uploaded`);
                 }
               } else {
+                this.ctx.log.info(`Uploading snapshot to S3`);
                 yield this.ctx.client.uploadSnapshot(this.ctx, processedSnapshot, discoveryErrors);
               }
               this.ctx.totalSnapshots++;
@@ -4067,6 +4251,9 @@ var Queue = class {
         } catch (error) {
           this.ctx.log.debug(`snapshot failed; ${error}`);
           this.processedSnapshots.push({ name: snapshot == null ? void 0 : snapshot.name, error: error.message });
+          if (((_n = snapshot == null ? void 0 : snapshot.options) == null ? void 0 : _n.contextId) && this.ctx.contextToSnapshotMap) {
+            this.ctx.contextToSnapshotMap.set(snapshot.options.contextId, 2);
+          }
         }
         if (this.ctx.browser) {
           for (let context of this.ctx.browser.contexts()) {

package/package.json

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