@lambdatest/smartui-cli 4.0.21 → 4.1.0

package/dist/index.cjs

@@ -7,7 +7,7 @@ var listr2 = require('listr2');
 var chalk = require('chalk');
 var path2 = require('path');
 var fastify = require('fastify');
-var fs5 = require('fs');
+var fs6 = require('fs');
 var Ajv = require('ajv');
 var addErrors = require('ajv-errors');
 var test = require('@playwright/test');
@@ -27,7 +27,7 @@ var which__default = /*#__PURE__*/_interopDefault(which);
 var chalk__default = /*#__PURE__*/_interopDefault(chalk);
 var path2__default = /*#__PURE__*/_interopDefault(path2);
 var fastify__default = /*#__PURE__*/_interopDefault(fastify);
-var fs5__default = /*#__PURE__*/_interopDefault(fs5);
+var fs6__default = /*#__PURE__*/_interopDefault(fs6);
 var Ajv__default = /*#__PURE__*/_interopDefault(Ajv);
 var addErrors__default = /*#__PURE__*/_interopDefault(addErrors);
 var FormData__default = /*#__PURE__*/_interopDefault(FormData);
@@ -419,6 +419,7 @@ var constants_default = {
     "Xperia 10 IV": { os: "android", viewport: { width: 412, height: 832 } },
     "Honeywell CT40": { os: "android", viewport: { width: 360, height: 512 } }
   },
+  FIGMA_API: "https://api.figma.com/v1/",
   DEFAULT_FIGMA_CONFIG: {
     "depth": 2,
     "figma_config": [
@@ -637,6 +638,17 @@ var WebStaticConfigSchema = {
         minimum: 0,
         maximum: 3e4,
         errorMessage: "waitForTimeout must be > 0 and <= 30000"
+      },
+      execute: {
+        type: "object",
+        properties: {
+          afterNavigation: {
+            type: "string"
+          },
+          beforeSnapshot: {
+            type: "string"
+          }
+        }
       }
     },
     required: ["name", "url"],
@@ -966,8 +978,8 @@ var validateWebFigmaConfig = ajv.compile(FigmaWebConfigSchema);
 util.promisify(setTimeout);
 var isPollingActive = false;
 function delDir(dir) {
-  if (fs5__default.default.existsSync(dir)) {
-    fs5__default.default.rmSync(dir, { recursive: true });
+  if (fs6__default.default.existsSync(dir)) {
+    fs6__default.default.rmSync(dir, { recursive: true });
   }
 }
 function scrollToBottomAndBackToTop({
@@ -1167,7 +1179,7 @@ function startPolling(ctx) {
           clearInterval(intervalId);
           isPollingActive = false;
         }
-        fs5__default.default.writeFileSync(ctx.options.fetchResultsFileName, JSON.stringify(resp, null, 2));
+        fs6__default.default.writeFileSync(ctx.options.fetchResultsFileName, JSON.stringify(resp, null, 2));
         ctx.log.debug(`Updated results in ${ctx.options.fetchResultsFileName}`);
         if (resp.build.build_status_ind === constants_default.BUILD_COMPLETE || resp.build.build_status_ind === constants_default.BUILD_ERROR) {
           clearInterval(intervalId);
@@ -1252,7 +1264,7 @@ var server_default = (ctx) => __async(void 0, null, function* () {
     bodyLimit: 3e7
   });
   const opts = {};
-  const SMARTUI_DOM = fs5.readFileSync(path2__default.default.resolve(__dirname, "dom-serializer.js"), "utf-8");
+  const SMARTUI_DOM = fs6.readFileSync(path2__default.default.resolve(__dirname, "dom-serializer.js"), "utf-8");
   server.get("/healthcheck", opts, (_, reply) => {
     reply.code(200).send({ cliVersion: ctx.cliVersion });
   });
@@ -1388,6 +1400,9 @@ var logger = winston.createLogger({
         case "warn":
           message = chalk__default.default.yellow(message);
           break;
+        case "error":
+          message = chalk__default.default.red(message);
+          break;
       }
       return info.level === "info" ? message : `[${contextString}:${info.level}] ` + message;
     })
@@ -1450,10 +1465,57 @@ var auth_default = (ctx) => {
 };
 
 // package.json
-var version = "4.0.21";
+var version = "4.1.0";
 var package_default = {
   name: "@lambdatest/smartui-cli",
-  version};
+  version,
+  description: "A command line interface (CLI) to run SmartUI tests on LambdaTest",
+  files: [
+    "dist/**/*"
+  ],
+  scripts: {
+    build: "tsup",
+    release: "pnpm run build && pnpm publish --access public --no-git-checks",
+    "local-build": "pnpm run build && pnpm pack"
+  },
+  bin: {
+    smartui: "./dist/index.cjs"
+  },
+  type: "module",
+  keywords: [
+    "lambdatest",
+    "smartui",
+    "cli"
+  ],
+  author: "LambdaTest <keys@lambdatest.com>",
+  license: "MIT",
+  dependencies: {
+    "@playwright/browser-chromium": "^1.47.2",
+    "@playwright/browser-firefox": "^1.47.2",
+    "@playwright/browser-webkit": "^1.47.2",
+    "@playwright/test": "^1.47.2",
+    "@types/cross-spawn": "^6.0.4",
+    "@types/node": "^20.8.9",
+    "@types/which": "^3.0.2",
+    ajv: "^8.12.0",
+    "ajv-errors": "^3.0.0",
+    axios: "^1.6.0",
+    chalk: "^4.1.2",
+    commander: "^11.1.0",
+    "cross-spawn": "^7.0.3",
+    fastify: "^4.24.3",
+    "form-data": "^4.0.0",
+    listr2: "^7.0.1",
+    sharp: "^0.33.4",
+    tsup: "^7.2.0",
+    uuid: "^11.0.3",
+    which: "^4.0.0",
+    winston: "^3.10.0"
+  },
+  devDependencies: {
+    typescript: "^5.3.2"
+  }
+};
 var httpClient = class {
   constructor({ SMARTUI_CLIENT_API_URL, PROJECT_TOKEN, PROJECT_NAME, LT_USERNAME, LT_ACCESS_KEY, SMARTUI_API_PROXY, SMARTUI_API_SKIP_CERTIFICATES }) {
     this.projectToken = PROJECT_TOKEN || "";
@@ -1491,7 +1553,7 @@ var httpClient = class {
   request(config, log2) {
     return __async(this, null, function* () {
       log2.debug(`http request: ${config.method} ${config.url}`);
-      if (config && config.data) {
+      if (config && config.data && !config.data.name) {
         log2.debug(config.data);
       }
       return this.axiosInstance.request(config).then((resp) => {
@@ -1613,7 +1675,7 @@ var httpClient = class {
   }
   uploadScreenshot({ id: buildId, name: buildName, baseline }, ssPath, ssName, browserName, viewport, log2) {
     browserName = browserName === constants_default.SAFARI ? constants_default.WEBKIT : browserName;
-    const file = fs5__default.default.readFileSync(ssPath);
+    const file = fs6__default.default.readFileSync(ssPath);
     const form = new FormData__default.default();
     form.append("screenshot", file, { filename: `${ssName}.png`, contentType: "image/png" });
     form.append("browser", browserName);
@@ -1692,8 +1754,8 @@ var httpClient = class {
     }, ctx.log);
   }
   uploadLogs(ctx, uploadURL) {
-    const fileStream = fs5__default.default.createReadStream(constants_default.LOG_FILE_PATH);
-    const { size } = fs5__default.default.statSync(constants_default.LOG_FILE_PATH);
+    const fileStream = fs6__default.default.createReadStream(constants_default.LOG_FILE_PATH);
+    const { size } = fs6__default.default.statSync(constants_default.LOG_FILE_PATH);
     return this.request({
       url: uploadURL,
       method: "PUT",
@@ -1761,7 +1823,7 @@ var ctx_default = (options) => {
   let buildNameObj;
   try {
     if (options.config) {
-      config = JSON.parse(fs5__default.default.readFileSync(options.config, "utf-8"));
+      config = JSON.parse(fs6__default.default.readFileSync(options.config, "utf-8"));
       if ((_a = config.web) == null ? void 0 : _a.resolutions) {
         config.web.viewports = config.web.resolutions;
         delete config.web.resolutions;
@@ -1883,7 +1945,7 @@ function isGitRepo() {
 }
 var git_default = (ctx) => {
   if (ctx.env.SMARTUI_GIT_INFO_FILEPATH) {
-    let gitInfo = JSON.parse(fs5__default.default.readFileSync(ctx.env.SMARTUI_GIT_INFO_FILEPATH, "utf-8"));
+    let gitInfo = JSON.parse(fs6__default.default.readFileSync(ctx.env.SMARTUI_GIT_INFO_FILEPATH, "utf-8"));
     return {
       branch: ctx.env.CURRENT_BRANCH || gitInfo.branch || "",
       commitId: gitInfo.commit_id.slice(0, 6) || "",
@@ -2063,6 +2125,8 @@ var finalizeBuild_default = (ctx) => {
         ctx2.log.debug(`Closed server`);
         let resp = yield ctx2.client.getS3PreSignedURL(ctx2);
         yield ctx2.client.uploadLogs(ctx2, resp.data.url);
+        fs6__default.default.unlinkSync(constants_default.LOG_FILE_PATH);
+        ctx2.log.debug(`Log file deleted: ${constants_default.LOG_FILE_PATH}`);
       } catch (error) {
         ctx2.log.debug(error);
       }
@@ -2746,13 +2810,13 @@ function createConfig(filepath) {
     console.log("Error: Config file must have .json extension");
     return;
   }
-  if (fs5__default.default.existsSync(filepath)) {
+  if (fs6__default.default.existsSync(filepath)) {
     console.log(`Error: SmartUI Config already exists: ${filepath}`);
     console.log(`To create a new file, please specify the file name like: 'smartui config:create .smartui-config.json'`);
     return;
   }
-  fs5__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
-  fs5__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_CONFIG, null, 2) + "\n");
+  fs6__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
+  fs6__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_CONFIG, null, 2) + "\n");
   console.log(`Created SmartUI Config: ${filepath}`);
 }
 function createWebStaticConfig(filepath) {
@@ -2762,13 +2826,13 @@ function createWebStaticConfig(filepath) {
     console.log("Error: Config file must have .json extension");
     return;
   }
-  if (fs5__default.default.existsSync(filepath)) {
+  if (fs6__default.default.existsSync(filepath)) {
     console.log(`Error: web-static config already exists: ${filepath}`);
     console.log(`To create a new file, please specify the file name like: 'smartui config:create-web-static links.json'`);
     return;
   }
-  fs5__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
-  fs5__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_WEB_STATIC_CONFIG, null, 2) + "\n");
+  fs6__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
+  fs6__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_WEB_STATIC_CONFIG, null, 2) + "\n");
   console.log(`Created web-static config: ${filepath}`);
 }
 function createFigmaConfig(filepath) {
@@ -2778,13 +2842,13 @@ function createFigmaConfig(filepath) {
     console.log("Error: designs config file must have .json extension");
     return;
   }
-  if (fs5__default.default.existsSync(filepath)) {
+  if (fs6__default.default.existsSync(filepath)) {
     console.log(`Error: designs config already exists: ${filepath}`);
     console.log(`To create a new file, please specify the file name like: 'smartui config:figma-config designs.json'`);
     return;
   }
-  fs5__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
-  fs5__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_FIGMA_CONFIG, null, 2) + "\n");
+  fs6__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
+  fs6__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_FIGMA_CONFIG, null, 2) + "\n");
   console.log(`Created designs config: ${filepath}`);
 }
 function createWebFigmaConfig(filepath) {
@@ -2794,13 +2858,13 @@ function createWebFigmaConfig(filepath) {
     console.log("Error: figma config file must have .json extension");
     return;
   }
-  if (fs5__default.default.existsSync(filepath)) {
+  if (fs6__default.default.existsSync(filepath)) {
     console.log(`Error: figma config already exists: ${filepath}`);
     console.log(`To create a new file, please specify the file name like: 'smartui config:create-figma-web <fileName>.json'`);
     return;
   }
-  fs5__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
-  fs5__default.default.writeFileSync(filepath, JSON.stringify(constants_default.WEB_FIGMA_CONFIG, null, 2) + "\n");
+  fs6__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
+  fs6__default.default.writeFileSync(filepath, JSON.stringify(constants_default.WEB_FIGMA_CONFIG, null, 2) + "\n");
   console.log(`Created figma web config: ${filepath}`);
 }
 function verifyFigmaWebConfig(ctx) {
@@ -2860,8 +2924,12 @@ configWebFigma.name("config:create-figma-web").description("Create figma config
     createWebFigmaConfig(filepath);
   });
 });
-function captureScreenshotsForConfig(_0, _1, _2, _3, _4) {
-  return __async(this, arguments, function* (ctx, browsers, { name, url, waitForTimeout }, browserName, renderViewports) {
+function captureScreenshotsForConfig(ctx, browsers, urlConfig, browserName, renderViewports) {
+  return __async(this, null, function* () {
+    ctx.log.debug(`*** urlConfig  ${JSON.stringify(urlConfig)}`);
+    let { name, url, waitForTimeout, execute } = urlConfig;
+    let afterNavigationScript = execute == null ? void 0 : execute.afterNavigation;
+    let beforeSnapshotScript = execute == null ? void 0 : execute.beforeSnapshot;
     let pageOptions = { waitUntil: process.env.SMARTUI_PAGE_WAIT_UNTIL_EVENT || "load", timeout: ctx.config.waitForPageRender || constants_default.DEFAULT_PAGE_LOAD_TIMEOUT };
     let ssId = name.toLowerCase().replace(/\s/g, "_");
     let context;
@@ -2880,12 +2948,14 @@ function captureScreenshotsForConfig(_0, _1, _2, _3, _4) {
       context = yield browser == null ? void 0 : browser.newContext(contextOptions);
       page = yield context == null ? void 0 : context.newPage();
       yield page == null ? void 0 : page.goto(url.trim(), pageOptions);
+      yield executeDocumentScripts(ctx, page, "afterNavigation", afterNavigationScript);
       for (let { viewport, viewportString, fullPage } of renderViewports) {
         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);
         yield page == null ? void 0 : page.screenshot({ path: ssPath, fullPage });
         yield ctx.client.uploadScreenshot(ctx.build, ssPath, name, browserName, viewportString, ctx.log);
       }
@@ -2962,7 +3032,7 @@ function captureScreenshots(ctx) {
         ctx.task.output = output;
         capturedScreenshots++;
       } catch (error) {
-        ctx.log.debug(`screenshot capture failed for ${JSON.stringify(staticConfig)}; error: ${error}`);
+        ctx.log.debug(`captureScreenshots failed for ${JSON.stringify(staticConfig)}; error: ${error}`);
         output += `${chalk__default.default.gray(staticConfig.name)} ${chalk__default.default.red("\u2717")}
 `;
         ctx.task.output = output;
@@ -2974,7 +3044,7 @@ function captureScreenshots(ctx) {
   });
 }
 function getImageDimensions(filePath) {
-  const buffer = fs5__default.default.readFileSync(filePath);
+  const buffer = fs6__default.default.readFileSync(filePath);
   let width, height;
   if (buffer.toString("hex", 0, 2) === "ffd8") {
     let offset = 2;
@@ -2999,7 +3069,7 @@ function getImageDimensions(filePath) {
 function isAllowedImage(filePath) {
   return __async(this, null, function* () {
     try {
-      const fileBuffer = fs5__default.default.readFileSync(filePath);
+      const fileBuffer = fs6__default.default.readFileSync(filePath);
       const isMagicValid = constants_default.MAGIC_NUMBERS.some((magic) => fileBuffer.slice(0, magic.magic.length).equals(magic.magic));
       const metadata = yield sharp__default.default(filePath).metadata();
       if (metadata.format === constants_default.FILE_EXTENSION_GIFS) {
@@ -3023,10 +3093,10 @@ function uploadScreenshots(ctx) {
     let noOfScreenshots = 0;
     function processDirectory(directory, relativePath = "") {
       return __async(this, null, function* () {
-        const files = fs5__default.default.readdirSync(directory);
+        const files = fs6__default.default.readdirSync(directory);
         for (let file of files) {
           const filePath = path2__default.default.join(directory, file);
-          const stat = fs5__default.default.statSync(filePath);
+          const stat = fs6__default.default.statSync(filePath);
           const relativeFilePath = path2__default.default.join(relativePath, file);
           if (stat.isDirectory() && ctx.options.ignorePattern.includes(relativeFilePath)) {
             ctx.log.info(`Ignoring Directory ${relativeFilePath}`);
@@ -3157,6 +3227,23 @@ function processChunk(ctx, urlConfig) {
     return { capturedScreenshots, finalOutput };
   });
 }
+function executeDocumentScripts(ctx, page, actionType, script) {
+  return __async(this, null, function* () {
+    try {
+      if (!page) {
+        throw new Error("Page instance not available");
+      }
+      if (script !== "") {
+        yield page.evaluate((script2) => {
+          new Function(script2)();
+        }, script);
+      }
+    } catch (error) {
+      ctx.log.error(`Error executing script for action ${actionType}: `, error);
+      throw error;
+    }
+  });
+}
 var captureScreenshots_default = (ctx) => {
   return {
     title: "Capturing screenshots",
@@ -3194,20 +3281,31 @@ var captureScreenshots_default = (ctx) => {
 var command2 = new commander.Command();
 command2.name("capture").description("Capture screenshots of static sites").argument("<file>", "Web static config file").option("-C, --parallel [number]", "Specify the number of instances per browser", parseInt).option("-F, --force", "forcefully apply the specified parallel instances per browser").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(file, _, command7) {
   return __async(this, null, function* () {
+    var _a, _b;
     const options = command7.optsWithGlobals();
     if (options.buildName === "") {
       console.log(`Error: The '--buildName' option cannot be an empty string.`);
       process.exit(1);
     }
     let ctx = ctx_default(command7.optsWithGlobals());
-    if (!fs5__default.default.existsSync(file)) {
+    if (!fs6__default.default.existsSync(file)) {
       ctx.log.error(`Web Static Config file ${file} not found.`);
       return;
     }
     try {
-      ctx.webStaticConfig = JSON.parse(fs5__default.default.readFileSync(file, "utf8"));
-      if (!validateWebStaticConfig(ctx.webStaticConfig))
-        throw new Error(validateWebStaticConfig.errors[0].message);
+      ctx.webStaticConfig = JSON.parse(fs6__default.default.readFileSync(file, "utf8"));
+      if (!validateWebStaticConfig(ctx.webStaticConfig)) {
+        ctx.log.debug(JSON.stringify(validateWebStaticConfig.errors, null, 2));
+        (_a = validateWebStaticConfig.errors) == null ? void 0 : _a.forEach((error) => {
+          if (error.keyword === "additionalProperties") {
+            ctx.log.warn(`Additional property "${error.params.additionalProperty}" is not allowed.`);
+          } else {
+            const validationError = error.message;
+            throw new Error(validationError || "Invalid Web Static config found in file : " + file);
+          }
+        });
+        throw new Error((_b = validateWebStaticConfig.errors[0]) == null ? void 0 : _b.message);
+      }
       if (ctx.webStaticConfig && ctx.webStaticConfig.length === 0) {
         ctx.log.error(`No URLs found in the specified config file -> ${file}`);
         return;
@@ -3281,7 +3379,7 @@ command3.name("upload").description("Upload screenshots from given directory").a
       process.exit(1);
     }
     let ctx = ctx_default(command7.optsWithGlobals());
-    if (!fs5__default.default.existsSync(directory)) {
+    if (!fs6__default.default.existsSync(directory)) {
       console.log(`Error: The provided directory ${directory} not found.`);
       return;
     }
@@ -3479,12 +3577,12 @@ uploadFigma.name("upload-figma").description("Capture screenshots of static site
   return __async(this, null, function* () {
     var _a, _b;
     let ctx = ctx_default(command7.optsWithGlobals());
-    if (!fs5__default.default.existsSync(file)) {
+    if (!fs6__default.default.existsSync(file)) {
       console.log(`Error: Figma Config file ${file} not found.`);
       return;
     }
     try {
-      ctx.figmaDesignConfig = JSON.parse(fs5__default.default.readFileSync(file, "utf8"));
+      ctx.figmaDesignConfig = JSON.parse(fs6__default.default.readFileSync(file, "utf8"));
       if (!validateFigmaDesignConfig(ctx.figmaDesignConfig)) {
         const validationError = (_b = (_a = validateFigmaDesignConfig.errors) == null ? void 0 : _a[0]) == null ? void 0 : _b.message;
         throw new Error(validationError || "Invalid figma design Config");
@@ -3520,12 +3618,12 @@ uploadWebFigmaCommand.name("upload-figma-web").description("Capture screenshots
   return __async(this, null, function* () {
     var _a;
     let ctx = ctx_default(command7.optsWithGlobals());
-    if (!fs5__default.default.existsSync(file)) {
+    if (!fs6__default.default.existsSync(file)) {
       console.log(`Error: figma-web config file ${file} not found.`);
       return;
     }
     try {
-      ctx.config = JSON.parse(fs5__default.default.readFileSync(file, "utf8"));
+      ctx.config = JSON.parse(fs6__default.default.readFileSync(file, "utf8"));
       ctx.log.info(JSON.stringify(ctx.config));
       if (!validateWebFigmaConfig(ctx.config)) {
         ctx.log.debug(JSON.stringify(validateWebFigmaConfig.errors, null, 2));

package/package.json

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