@lambdatest/smartui-cli 4.1.33 → 4.1.35

package/dist/index.cjs

@@ -61,6 +61,7 @@ var sharp__default = /*#__PURE__*/_interopDefault(sharp);
 var http__namespace = /*#__PURE__*/_interopNamespace(http);
 
 var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __propIsEnum = Object.prototype.propertyIsEnumerable;
@@ -83,6 +84,9 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
     return require.apply(this, arguments);
   throw Error('Dynamic require of "' + x + '" is not supported');
 });
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -104,6 +108,73 @@ 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) {
+    var net = __require("net");
+    function findFreePort(beg, ...rest) {
+      const p = rest.slice(0, rest.length - 1), cb = rest[rest.length - 1];
+      let [end, ip, cnt] = Array.from(p);
+      if (!ip && end && !/^\d+$/.test(end)) {
+        ip = end;
+        end = 65534;
+      } else {
+        if (end == null) {
+          end = 65534;
+        }
+      }
+      if (cnt == null) {
+        cnt = 1;
+      }
+      const retcb = cb;
+      const res = [];
+      const probe = function(ip2, port, cb2) {
+        const s = net.createConnection({ port, host: ip2 });
+        s.on("connect", function() {
+          s.end();
+          cb2(null, port + 1);
+        });
+        s.on("error", (err) => {
+          cb2(port);
+        });
+      };
+      var onprobe = function(port, nextPort) {
+        if (port) {
+          res.push(port);
+          if (res.length >= cnt) {
+            retcb(null, ...res);
+          } else {
+            setImmediate(() => probe(ip, port + 1, onprobe));
+          }
+        } else {
+          if (nextPort >= end) {
+            retcb(new Error("No available ports"));
+          } else {
+            setImmediate(() => probe(ip, nextPort, onprobe));
+          }
+        }
+      };
+      return probe(ip, beg, onprobe);
+    }
+    function findFreePortPmfy(beg, ...rest) {
+      const last = rest[rest.length - 1];
+      if (typeof last === "function") {
+        findFreePort(beg, ...rest);
+      } else {
+        return new Promise((resolve, reject) => {
+          findFreePort(beg, ...rest, (err, ...ports) => {
+            if (err)
+              reject(err);
+            else
+              resolve(ports);
+          });
+        });
+      }
+    }
+    module.exports = findFreePortPmfy;
+  }
+});
+
 // src/lib/constants.ts
 var constants_default = {
   // default configs
@@ -152,6 +223,8 @@ var constants_default = {
   EDGE: "edge",
   EDGE_CHANNEL: "msedge",
   WEBKIT: "webkit",
+  MIN_PORT_RANGE: 49100,
+  MAX_PORT_RANGE: 6e4,
   // discovery browser launch arguments
   LAUNCH_ARGS: [
     // disable the translate popup and optimization downloads
@@ -785,6 +858,10 @@ var ConfigSchema = {
       type: "boolean",
       errorMessage: "Invalid config; useLambdaInternal must be true/false"
     },
+    useRemoteDiscovery: {
+      type: "boolean",
+      errorMessage: "Invalid config; useRemoteDiscovery must be true/false"
+    },
     useExtendedViewport: {
       type: "boolean",
       errorMessage: "Invalid config; useExtendedViewport must be true/false"
@@ -1089,6 +1166,14 @@ var SnapshotSchema = {
           minimum: 0,
           maximum: 100,
           errorMessage: "Invalid snapshot options; rejectionThreshold must be a number between 0 and 100"
+        },
+        customCookies: {
+          type: "array",
+          items: {
+            type: "object",
+            minProperties: 1
+          },
+          errorMessage: "Invalid snapshot options; customCookies must be an array of objects with string properties"
         }
       },
       additionalProperties: false
@@ -1810,10 +1895,11 @@ function startPdfPolling(ctx) {
   const maxAttempts = 60;
   console.log(chalk__default.default.yellow("Waiting for results..."));
   const interval = setInterval(() => __async(this, null, function* () {
+    var _a;
     attempts++;
     try {
       const response = yield ctx.client.fetchPdfResults(ctx);
-      if (response.screenshots) {
+      if (response.screenshots && ((_a = response.build) == null ? void 0 : _a.build_status) === constants_default.BUILD_COMPLETE) {
         clearInterval(interval);
         const pdfGroups = groupScreenshotsByPdf(response.screenshots);
         const pdfsWithMismatches = countPdfsWithMismatches(pdfGroups);
@@ -1971,7 +2057,32 @@ function validateCoordinates(coordString, pageHeight, pageWidth, snapshotName) {
 }
 
 // src/lib/server.ts
+var fp = require_find_free_port();
 var uploadDomToS3ViaEnv = process.env.USE_LAMBDA_INTERNAL || false;
+function findAvailablePort(server, startPort, log2) {
+  return __async(this, null, function* () {
+    let currentPort = startPort;
+    try {
+      yield server.listen({ port: currentPort });
+      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");
+        }
+      } else {
+        throw error;
+      }
+    }
+  });
+}
 var server_default = (ctx) => __async(void 0, null, function* () {
   const server = fastify__default.default({
     logger: {
@@ -2221,10 +2332,18 @@ var server_default = (ctx) => __async(void 0, null, function* () {
       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}`;
-  process.env.CYPRESS_SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
+  if (ctx.sourceCommand && ctx.sourceCommand === "exec-start") {
+    yield server.listen({ port: ctx.options.port });
+    let { port } = server.addresses()[0];
+    process.env.SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
+    process.env.CYPRESS_SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
+    ctx.log.debug(`Server started successfully on port ${port}`);
+  } else {
+    const actualPort = yield findAvailablePort(server, ctx.options.port, ctx.log);
+    process.env.SMARTUI_SERVER_ADDRESS = `http://localhost:${actualPort}`;
+    process.env.CYPRESS_SMARTUI_SERVER_ADDRESS = `http://localhost:${actualPort}`;
+    ctx.log.debug(`Server started successfully on port ${actualPort}`);
+  }
   return server;
 });
 
@@ -2369,7 +2488,7 @@ var authExec_default = (ctx) => {
 };
 
 // package.json
-var version = "4.1.33";
+var version = "4.1.35";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -2425,6 +2544,7 @@ var package_default = {
     "simple-swizzle": "0.2.2"
   },
   devDependencies: {
+    "find-free-port": "^2.0.0",
     typescript: "^5.3.2"
   }
 };
@@ -3041,6 +3161,9 @@ var httpClient = class {
       if (ctx.build.name !== void 0 && ctx.build.name !== "") {
         form.append("buildName", buildName);
       }
+      if (ctx.options.markBaseline) {
+        form.append("markBaseline", ctx.options.markBaseline.toString());
+      }
       try {
         const response = yield this.axiosInstance.request({
           url: ctx.env.SMARTUI_UPLOAD_URL + "/pdf/upload",
@@ -3110,6 +3233,7 @@ var ctx_default = (options) => {
   let buildNameObj;
   let allowDuplicateSnapshotNames = false;
   let useLambdaInternal = false;
+  let useRemoteDiscovery = false;
   let useExtendedViewport = false;
   let loadDomContent = false;
   try {
@@ -3184,6 +3308,9 @@ var ctx_default = (options) => {
   if (config.useLambdaInternal) {
     useLambdaInternal = true;
   }
+  if (config.useRemoteDiscovery) {
+    useRemoteDiscovery = true;
+  }
   if (config.useExtendedViewport) {
     useExtendedViewport = true;
   }
@@ -3219,6 +3346,7 @@ var ctx_default = (options) => {
       requestHeaders: config.requestHeaders || {},
       allowDuplicateSnapshotNames,
       useLambdaInternal,
+      useRemoteDiscovery,
       useExtendedViewport,
       loadDomContent,
       approvalThreshold: config.approvalThreshold,
@@ -3268,6 +3396,7 @@ var ctx_default = (options) => {
     isSnapshotCaptured: false,
     sessionCapabilitiesMap: /* @__PURE__ */ new Map(),
     buildToSnapshotCountMap: /* @__PURE__ */ new Map(),
+    sessionIdToSnapshotNameMap: /* @__PURE__ */ new Map(),
     fetchResultsForBuild: new Array(),
     orgId: 0,
     userId: 0,
@@ -3425,7 +3554,7 @@ var createBuildExec_default = (ctx) => {
           }
           task.output = chalk__default.default.gray(`build id: ${resp.data.buildId}`);
           task.title = "SmartUI build created";
-          if (ctx2.env.USE_REMOTE_DISCOVERY) {
+          if (ctx2.env.USE_REMOTE_DISCOVERY || ctx2.config.useRemoteDiscovery) {
             task.output += chalk__default.default.gray(`
  Using remote discovery for this build`);
           }
@@ -3887,6 +4016,39 @@ function processSnapshot(snapshot, ctx) {
         ctx.log.debug("No valid cookies to add");
       }
     }
+    let options = snapshot.options;
+    if ((options == null ? void 0 : options.customCookies) && Array.isArray(options.customCookies) && options.customCookies.length > 0) {
+      ctx.log.debug(`Setting ${options.customCookies.length} custom cookies`);
+      const validCustomCookies = options.customCookies.filter((cookie) => {
+        if (!cookie.name || !cookie.value || !cookie.domain) {
+          ctx.log.debug(`Skipping invalid custom cookie: missing required fields (name, value, or domain)`);
+          return false;
+        }
+        if (cookie.sameSite && !["Strict", "Lax", "None"].includes(cookie.sameSite)) {
+          ctx.log.debug(`Skipping invalid custom cookie: invalid sameSite value '${cookie.sameSite}'`);
+          return false;
+        }
+        return true;
+      }).map((cookie) => ({
+        name: cookie.name,
+        value: cookie.value,
+        domain: cookie.domain,
+        path: cookie.path || "/",
+        httpOnly: cookie.httpOnly || false,
+        secure: cookie.secure || false,
+        sameSite: cookie.sameSite || "Lax"
+      }));
+      if (validCustomCookies.length > 0) {
+        try {
+          yield context.addCookies(validCustomCookies);
+          ctx.log.debug(`Successfully added ${validCustomCookies.length} custom cookies`);
+        } catch (error) {
+          ctx.log.debug(`Failed to add custom cookies: ${error}`);
+        }
+      } else {
+        ctx.log.debug("No valid custom cookies to add");
+      }
+    }
     const page = yield context.newPage();
     let cache = {};
     if (snapshot.dom.resources.length) {
@@ -4042,7 +4204,6 @@ function processSnapshot(snapshot, ctx) {
         route.abort();
       }
     }));
-    let options = snapshot.options;
     let optionWarnings = /* @__PURE__ */ new Set();
     let selectors = [];
     let ignoreOrSelectDOM;
@@ -4118,13 +4279,13 @@ function processSnapshot(snapshot, ctx) {
         for (const [key, value] of Object.entries(options[ignoreOrSelectDOM])) {
           switch (key) {
             case "id":
-              selectors.push(...value.map((e) => "#" + e));
+              selectors.push(...value.map((e) => e.startsWith("#") ? e : "#" + e));
               break;
             case "class":
-              selectors.push(...value.map((e) => "." + e));
+              selectors.push(...value.map((e) => e.startsWith(".") ? e : "." + e));
               break;
             case "xpath":
-              selectors.push(...value.map((e) => "xpath=" + e));
+              selectors.push(...value.map((e) => e.startsWith("xpath=") ? e : "xpath=" + e));
               break;
             case "cssSelector":
               selectors.push(...value);
@@ -4182,6 +4343,9 @@ function processSnapshot(snapshot, ctx) {
           yield new Promise((r) => setTimeout(r, 1250));
           if (ctx.config.waitForTimeout)
             yield page.waitForTimeout(ctx.config.waitForTimeout);
+          yield page.waitForLoadState("networkidle", { timeout: 1e4 }).catch(() => {
+            ctx.log.debug("networkidle event failed to fire within 10s");
+          });
           navigated = true;
           ctx.log.debug(`Navigated to ${snapshot.url}`);
         } catch (error) {
@@ -4239,14 +4403,7 @@ function processSnapshot(snapshot, ctx) {
           }
         }
       }
-      if (processedOptions.element) {
-        let l = yield page.locator(processedOptions.element).all();
-        if (l.length === 0) {
-          throw new Error(`for snapshot ${snapshot.name} viewport ${viewportString}, no element found for selector ${processedOptions.element}`);
-        } else if (l.length > 1) {
-          throw new Error(`for snapshot ${snapshot.name} viewport ${viewportString}, multiple elements found for selector ${processedOptions.element}`);
-        }
-      } else if (selectors.length) {
+      if (selectors.length) {
         let height = 0;
         height = yield page.evaluate(() => {
           const DEFAULT_HEIGHT = 16384;
@@ -4271,7 +4428,6 @@ function processSnapshot(snapshot, ctx) {
           return Math.max(...measurements);
         });
         ctx.log.debug(`Calculated content height: ${height}`);
-        let locators = [];
         if (!Array.isArray(processedOptions[ignoreOrSelectBoxes][viewportString]))
           processedOptions[ignoreOrSelectBoxes][viewportString] = [];
         for (const selector of selectors) {
@@ -4294,44 +4450,75 @@ function processSnapshot(snapshot, ctx) {
             if (renderViewports.length > 1) {
               optionWarnings.add(`for snapshot ${snapshot.name} viewport ${viewportString}, coordinates may not be accurate for multiple viewports`);
             }
-            const coordinateElement = __spreadValues({
+            __spreadValues({
               type: "coordinates"
             }, validation.coords);
-            locators.push(coordinateElement);
-            continue;
-          }
-          let l = yield page.locator(selector).all();
-          if (l.length === 0) {
-            optionWarnings.add(`for snapshot ${snapshot.name} viewport ${viewportString}, no element found for selector ${selector}`);
             continue;
-          }
-          locators.push(...l);
-        }
-        for (const locator of locators) {
-          if (locator && typeof locator === "object" && locator.hasOwnProperty("type") && locator.type === "coordinates") {
-            const coordLocator = locator;
-            const { top, bottom, left, right } = coordLocator;
-            processedOptions[ignoreOrSelectBoxes][viewportString].push({
-              left,
-              top,
-              right,
-              bottom
-            });
-            continue;
-          }
-          let bb = yield locator.boundingBox();
-          if (bb) {
-            const top = bb.y;
-            const bottom = bb.y + bb.height;
-            if (top <= height && bottom <= height) {
-              processedOptions[ignoreOrSelectBoxes][viewportString].push({
-                left: bb.x,
-                top,
-                right: bb.x + bb.width,
-                bottom
-              });
+          } else {
+            const isXPath = selector.startsWith("xpath=");
+            const selectorValue = isXPath ? selector.substring(6) : selector;
+            const boxes = yield page.evaluate(({ selectorValue: selectorValue2, isXPath: isXPath2 }) => {
+              try {
+                const DEFAULT_HEIGHT = 16384;
+                const DEFAULT_WIDTH = 7680;
+                const body = document.body;
+                const html = document.documentElement;
+                let pageHeight;
+                let pageWidth;
+                if (!body || !html) {
+                  pageHeight = DEFAULT_HEIGHT;
+                  pageWidth = DEFAULT_WIDTH;
+                } else {
+                  const measurements = [
+                    (body == null ? void 0 : body.scrollHeight) || 0,
+                    (body == null ? void 0 : body.offsetHeight) || 0,
+                    (html == null ? void 0 : html.clientHeight) || 0,
+                    (html == null ? void 0 : html.scrollHeight) || 0,
+                    (html == null ? void 0 : html.offsetHeight) || 0
+                  ];
+                  const allMeasurementsInvalid = measurements.every((measurement) => !measurement);
+                  if (allMeasurementsInvalid) {
+                    pageHeight = DEFAULT_HEIGHT;
+                  } else {
+                    pageHeight = Math.max(...measurements);
+                  }
+                  const measurementsWidth = [
+                    (body == null ? void 0 : body.scrollWidth) || 0,
+                    (body == null ? void 0 : body.offsetWidth) || 0,
+                    (html == null ? void 0 : html.clientWidth) || 0,
+                    (html == null ? void 0 : html.scrollWidth) || 0,
+                    (html == null ? void 0 : html.offsetWidth) || 0
+                  ];
+                  const allMeasurementsInvalidWidth = measurementsWidth.every((measurement) => !measurement);
+                  if (allMeasurementsInvalidWidth) {
+                    pageWidth = DEFAULT_WIDTH;
+                  } else {
+                    pageWidth = Math.max(...measurementsWidth);
+                  }
+                }
+                let elements = [];
+                if (isXPath2) {
+                  const xpathResult = document.evaluate(
+                    selectorValue2,
+                    document,
+                    null,
+                    XPathResult.ORDERED_NODE_SNAPSHOT_TYPE,
+                    null
+                  );
+                  for (let i = 0; i < xpathResult.snapshotLength; i++) {
+                    elements.push(xpathResult.snapshotItem(i));
+                  }
+                } else {
+                  elements = Array.from(document.querySelectorAll(selectorValue2));
+                }
+                return elements;
+              } catch (error) {
+              }
+            }, { selectorValue, isXPath });
+            if (boxes && boxes.length >= 1) {
+              processedOptions[ignoreOrSelectBoxes][viewportString].push(...boxes);
             } else {
-              ctx.log.debug(`Bounding box for selector skipped due to exceeding height: ${JSON.stringify({ top, bottom, height })}`);
+              optionWarnings.add(`for snapshot ${snapshot.name} viewport ${viewportString}, no element found for selector ${selector}`);
             }
           }
         }
@@ -4616,8 +4803,24 @@ var Queue = class {
             this.ctx.log.info(`Processing Snapshot: ${snapshot == null ? void 0 : snapshot.name}`);
           }
           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 'allowDuplicateSnapshotNames' or 'delayedUpload' configuration as true in your config file.`);
+            if (this.ctx.sessionIdToSnapshotNameMap && snapshot.options && snapshot.options.sessionId) {
+              if (this.ctx.sessionIdToSnapshotNameMap.has(snapshot.options.sessionId)) {
+                console.log(`snapshot.options.sessionId`, snapshot.options.sessionId, `this.ctx.sessionIdToSnapshotNameMap`, JSON.stringify([...this.ctx.sessionIdToSnapshotNameMap]));
+                const existingNames = this.ctx.sessionIdToSnapshotNameMap.get(snapshot.options.sessionId) || [];
+                if (existingNames.includes(snapshot.name)) {
+                  drop = true;
+                  this.ctx.log.info(`Skipping123 duplicate SmartUI snapshot '${snapshot.name}'. To capture duplicate screenshots, please set the 'allowDuplicateSnapshotNames' or 'delayedUpload' configuration as true in your config file.`);
+                } else {
+                  existingNames.push(snapshot.name);
+                  this.ctx.sessionIdToSnapshotNameMap.set(snapshot.options.sessionId, existingNames);
+                }
+              } else {
+                this.ctx.sessionIdToSnapshotNameMap.set(snapshot.options.sessionId, [snapshot.name]);
+              }
+            } else {
+              drop = true;
+              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);
@@ -4644,7 +4847,7 @@ var Queue = class {
               }
             }
             let processedSnapshot, warnings, discoveryErrors;
-            if (this.ctx.env.USE_REMOTE_DISCOVERY) {
+            if (this.ctx.env.USE_REMOTE_DISCOVERY || this.ctx.config.useRemoteDiscovery) {
               this.ctx.log.debug(`Using remote discovery`);
               let result = yield prepareSnapshot(snapshot, this.ctx);
               processedSnapshot = result.processedSnapshot;
@@ -6441,7 +6644,7 @@ function uploadPdfs(ctx, pdfPath) {
 
 // src/commander/uploadPdf.ts
 var command10 = new commander.Command();
-command10.name("upload-pdf").description("Upload PDFs for visual comparison").argument("<directory>", "Path of the directory containing PDFs").option("--fetch-results [filename]", "Fetch results and optionally specify an output file, e.g., <filename>.json").option("--buildName <string>", "Specify the build name").action(function(directory, _, command11) {
+command10.name("upload-pdf").description("Upload PDFs for visual comparison").argument("<directory>", "Path of the directory containing PDFs").option("--fetch-results [filename]", "Fetch results and optionally specify an output file, e.g., <filename>.json").option("--buildName <string>", "Specify the build name").option("--markBaseline", "Mark this build baseline").action(function(directory, _, command11) {
   return __async(this, null, function* () {
     const options = command11.optsWithGlobals();
     if (options.buildName === "") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.33",
+  "version": "4.1.35",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"
@@ -47,6 +47,7 @@
     "simple-swizzle": "0.2.2"
   },
   "devDependencies": {
+    "find-free-port": "^2.0.0",
     "typescript": "^5.3.2"
   },
   "scripts": {