@lambdatest/smartui-cli 4.1.55-beta.0 → 4.1.56-beta.1

package/dist/index.cjs

@@ -18,10 +18,10 @@ var stringify = require('json-stringify-safe');
 var FormData = require('form-data');
 var axios = require('axios');
 var https = require('https');
+var uuid = require('uuid');
 var child_process = require('child_process');
 var spawn = require('cross-spawn');
 var NodeCache = require('node-cache');
-var uuid = require('uuid');
 var sharp = require('sharp');
 var http = require('http');
 
@@ -2432,16 +2432,28 @@ function findAvailablePort(server, startPort, log2) {
       return currentPort;
     } catch (error) {
       if (error.code === "EADDRINUSE") {
-        log2.debug(`Port ${currentPort} is in use, finding available port in range 49100-60000`);
-        const availablePorts = yield fp(constants_default.MIN_PORT_RANGE, constants_default.MAX_PORT_RANGE);
-        if (availablePorts.length > 0) {
-          const freePort = availablePorts[0];
-          yield server.listen({ port: freePort });
-          log2.debug(`Found and started server on port ${freePort}`);
-          return freePort;
-        } else {
-          throw new Error("No available ports found in range 49100-60000");
+        log2.debug(`Port ${currentPort} is in use, finding available port in range ${constants_default.MIN_PORT_RANGE}-${constants_default.MAX_PORT_RANGE}`);
+        const maxRetries = 3;
+        for (let attempt = 1; attempt <= maxRetries; attempt++) {
+          try {
+            const availablePorts = yield fp(constants_default.MIN_PORT_RANGE, constants_default.MAX_PORT_RANGE);
+            if (availablePorts.length > 0) {
+              const freePort = availablePorts[0];
+              yield server.listen({ port: freePort });
+              log2.debug(`Found and started server on port ${freePort}`);
+              return freePort;
+            } else {
+              throw new Error(`No available ports found in range ${constants_default.MIN_PORT_RANGE}-${constants_default.MAX_PORT_RANGE}`);
+            }
+          } catch (retryError) {
+            if (retryError.code === "EADDRINUSE" && attempt < maxRetries) {
+              log2.debug(`Port race condition on attempt ${attempt}, retrying...`);
+              continue;
+            }
+            throw retryError;
+          }
         }
+        throw new Error("Failed to find available port after max retries");
       } else {
         throw error;
       }
@@ -2700,6 +2712,52 @@ var server_default = (ctx) => __async(null, null, function* () {
       return reply.code(replyCode).send(replyBody);
     }
   }));
+  server.get("/smartui/results", opts, (request, reply) => __async(null, null, function* () {
+    var _a;
+    let replyCode;
+    let replyBody;
+    try {
+      const { sessionId } = request.query;
+      ctx.log.debug(`smartui results request: sessionId=${sessionId || "none"}`);
+      let resolvedBuildId = "";
+      let projectToken = "";
+      if (sessionId && ((_a = ctx.sessionCapabilitiesMap) == null ? void 0 : _a.has(sessionId))) {
+        const cachedCapabilities = ctx.sessionCapabilitiesMap.get(sessionId);
+        resolvedBuildId = (cachedCapabilities == null ? void 0 : cachedCapabilities.buildId) || "";
+        projectToken = (cachedCapabilities == null ? void 0 : cachedCapabilities.projectToken) || "";
+        ctx.log.debug(`Resolved from sessionCapabilitiesMap for sessionId ${sessionId}: buildId=${resolvedBuildId}, projectToken=${projectToken ? "present" : "missing"}`);
+      }
+      if ((!resolvedBuildId || resolvedBuildId.length <= 30) && ctx.build && ctx.build.id) {
+        resolvedBuildId = ctx.build.id;
+      }
+      if (!projectToken) {
+        projectToken = ctx.env.PROJECT_TOKEN || "";
+      }
+      ctx.log.debug(`smartui results params: sessionId=${sessionId || "none"}, buildId=${resolvedBuildId}, projectToken=${projectToken ? "present" : "missing"}`);
+      if (!resolvedBuildId) {
+        replyCode = 404;
+        replyBody = { error: { message: "Unable to determine buildId. Ensure a SmartUI build is active." } };
+        return reply.code(replyCode).send(replyBody);
+      }
+      const resp = yield ctx.client.getScreenshotData(
+        resolvedBuildId,
+        false,
+        ctx.log,
+        projectToken,
+        "",
+        sessionId || "",
+        "smartui-results"
+      );
+      replyCode = 200;
+      replyBody = resp;
+    } catch (error) {
+      const errMsg = (error == null ? void 0 : error.message) || (typeof error === "string" ? error : JSON.stringify(error));
+      ctx.log.debug(`smartui results failed; ${errMsg}`);
+      replyCode = 500;
+      replyBody = { error: { message: `smartui results failed; ${errMsg}` } };
+    }
+    return reply.code(replyCode).send(replyBody);
+  }));
   server.get("/build/info", opts, (request, reply) => __async(null, null, function* () {
     let replyCode;
     let replyBody;
@@ -2838,6 +2896,24 @@ var logger = winston.createLogger({
     })
   ]
 });
+function removeFileTransport() {
+  logger.transports.forEach((transport) => {
+    if (transport instanceof winston.transports.File) {
+      logger.remove(transport);
+    }
+  });
+}
+function reconfigureLogFile(newFilePath) {
+  logger.transports.forEach((transport) => {
+    if (transport instanceof winston.transports.File) {
+      logger.remove(transport);
+    }
+  });
+  logger.add(new winston.transports.File({
+    level: "debug",
+    filename: newFilePath
+  }));
+}
 var logger_default = logger;
 
 // src/tasks/startServer.ts
@@ -2895,7 +2971,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.55-beta.0";
+var version = "4.1.56-beta.1";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -3185,12 +3261,19 @@ var httpClient = class {
       }
     }, log2);
   }
-  getScreenshotData(buildId, baseline, log2, projectToken, buildName) {
+  getScreenshotData(buildId, baseline, log2, projectToken, buildName, sessionId, type) {
     log2.debug(`Fetching screenshot data for buildId: ${buildId}  having  buildName: ${buildName} with baseline: ${baseline}`);
+    const params = { buildId, baseline, buildName };
+    if (sessionId) {
+      params.sessionId = sessionId;
+    }
+    if (type) {
+      params.type = type;
+    }
     return this.request({
       url: "/screenshot",
       method: "GET",
-      params: { buildId, baseline, buildName },
+      params,
       headers: { projectToken }
     }, log2);
   }
@@ -3509,8 +3592,13 @@ var httpClient = class {
     }, ctx.log);
   }
   uploadLogs(ctx, uploadURL) {
-    const fileStream = fs6__default.default.createReadStream(constants_default.LOG_FILE_PATH);
-    const { size } = fs6__default.default.statSync(constants_default.LOG_FILE_PATH);
+    if (!ctx.logFilePath) {
+      ctx.log.debug("Log file disabled, skipping log upload");
+      return Promise.resolve();
+    }
+    const logPath = ctx.logFilePath;
+    const fileStream = fs6__default.default.createReadStream(logPath);
+    const { size } = fs6__default.default.statSync(logPath);
     return this.request({
       url: uploadURL,
       method: "PUT",
@@ -3526,8 +3614,13 @@ var httpClient = class {
     }, ctx.log);
   }
   uploadLogsForCaps(ctx, uploadURL) {
-    const logContent = fs6__default.default.readFileSync(constants_default.LOG_FILE_PATH);
-    const { size } = fs6__default.default.statSync(constants_default.LOG_FILE_PATH);
+    if (!ctx.logFilePath) {
+      ctx.log.debug("Log file disabled, skipping log upload");
+      return Promise.resolve();
+    }
+    const logPath = ctx.logFilePath;
+    const logContent = fs6__default.default.readFileSync(logPath);
+    const { size } = fs6__default.default.statSync(logPath);
     return this.request({
       url: uploadURL,
       method: "PUT",
@@ -3543,7 +3636,12 @@ var httpClient = class {
     }, ctx.log);
   }
   sendCliLogsToLSRS(ctx) {
-    const logContent = fs6__default.default.readFileSync(constants_default.LOG_FILE_PATH, "utf-8");
+    if (!ctx.logFilePath) {
+      ctx.log.debug("Log file disabled, skipping log upload");
+      return Promise.resolve();
+    }
+    const logPath = ctx.logFilePath;
+    const logContent = fs6__default.default.readFileSync(logPath, "utf-8");
     return this.request({
       url: `/upload/logs`,
       method: "POST",
@@ -3555,7 +3653,12 @@ var httpClient = class {
     }, ctx.log);
   }
   sendCliLogsToLSRSForCaps(ctx, capsBuildId, capsProjectToken) {
-    const logContent = fs6__default.default.readFileSync(constants_default.LOG_FILE_PATH, "utf-8");
+    if (!ctx.logFilePath) {
+      ctx.log.debug("Log file disabled, skipping log upload");
+      return Promise.resolve();
+    }
+    const logPath = ctx.logFilePath;
+    const logContent = fs6__default.default.readFileSync(logPath, "utf-8");
     return this.request({
       url: `/upload/logs`,
       method: "POST",
@@ -3851,6 +3954,26 @@ var ctx_default = (options) => {
   if (config.waitForPageRender && config.waitForPageRender < 3e4) {
     config.waitForPageRender = 3e4;
   }
+  let disableLogFile = options.disableLogFile ? true : false;
+  if (disableLogFile) {
+    removeFileTransport();
+    logger_default.debug("File logging disabled via --disableLogFile flag");
+  }
+  let logFileUUID;
+  let logFilePath = disableLogFile ? void 0 : constants_default.LOG_FILE_PATH;
+  if (!disableLogFile && options.createUniqueLogFile) {
+    logFileUUID = uuid.v4();
+    logFilePath = `.smartui-${logFileUUID}.log`;
+    reconfigureLogFile(logFilePath);
+    try {
+      if (fs6__default.default.existsSync(logFilePath)) {
+        fs6__default.default.unlinkSync(logFilePath);
+      }
+    } catch (error) {
+      logger_default.debug(`Could not delete existing unique log file: ${error.message}`);
+    }
+    logger_default.debug(`Using unique log file: ${logFilePath} (UUID: ${logFileUUID})`);
+  }
   return {
     env,
     log: logger_default,
@@ -3947,7 +4070,9 @@ var ctx_default = (options) => {
     mergeBuildSourceId: "",
     mergeBuildTargetId: "",
     mergeByBranch: false,
-    mergeByBuild: false
+    mergeByBuild: false,
+    logFileUUID,
+    logFilePath
   };
 };
 
@@ -4565,6 +4690,10 @@ function prepareSnapshot(snapshot, ctx) {
     processedOptions.selectors = selectors;
     processedOptions.ignoreDOM = options == null ? void 0 : options.ignoreDOM;
     processedOptions.selectDOM = options == null ? void 0 : options.selectDOM;
+    if ((options == null ? void 0 : options.customCookies) && Array.isArray(options.customCookies) && options.customCookies.length > 0) {
+      ctx.log.debug(`Setting ${options.customCookies.length} custom cookies`);
+      processedOptions.customCookies = options.customCookies;
+    }
     ctx.log.debug(`Processed options: ${JSON.stringify(processedOptions)}`);
     let renderViewports;
     if (snapshot.options && snapshot.options.web || snapshot.options && snapshot.options.mobile) {
@@ -7638,7 +7767,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("--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);
+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").option("--createUniqueLogFile", "Create a unique log file for each CLI execution to avoid file lock issues in parallel runs").option("--disableLogFile", "Disable writing logs to a file").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.55-beta.0",
+  "version": "4.1.56-beta.1",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"