@lambdatest/smartui-cli 2.0.5 → 2.0.7

package/dist/index.cjs

@@ -69,7 +69,7 @@ var __async = (__this, __arguments, generator) => {
 var MIN_VIEWPORT_HEIGHT = 1080;
 var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function* () {
   let options = snapshot.options;
-  let warnings = [];
+  let optionWarnings = /* @__PURE__ */ new Set();
   let processedOptions = {};
   if (options && Object.keys(options).length !== 0) {
     ctx.log.debug(`Processing options: ${JSON.stringify(options)}`);
@@ -115,7 +115,7 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
         for (const selector of selectors) {
           let l = yield page.locator(selector).all();
           if (l.length === 0) {
-            warnings.push(`For snapshot ${snapshot.name}, no element found for selector ${selector}`);
+            optionWarnings.add(`For snapshot ${snapshot.name}, no element found for selector ${selector}`);
             continue;
           }
           locators.push(...l);
@@ -135,7 +135,6 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
       }
     }
   }
-  warnings.push(...snapshot.dom.warnings);
   return {
     processedSnapshot: {
       name: snapshot.name,
@@ -143,15 +142,19 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
       dom: Buffer.from(snapshot.dom.html).toString("base64"),
       options: processedOptions
     },
-    warnings
+    warnings: [...optionWarnings, ...snapshot.dom.warnings]
   };
 });
 var ajv = new Ajv__default.default({ allErrors: true });
 ajv.addFormat("web-url", {
   type: "string",
   validate: (url) => {
-    const urlPattern = new RegExp("^(https?:\\/\\/)?((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|((\\d{1,3}\\.){3}\\d{1,3}))(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*(\\?[;&a-z\\d%_.~+=-]*)?(\\#[-a-z\\d_]*)?$", "i");
-    return urlPattern.test(url.trim());
+    try {
+      new URL(url.trim());
+      return true;
+    } catch (error) {
+      return false;
+    }
   }
 });
 addErrors__default.default(ajv);
@@ -322,7 +325,7 @@ var SnapshotSchema = {
       additionalProperties: false
     }
   },
-  required: ["name", "url", "dom", "options"],
+  required: ["name", "url", "dom"],
   additionalProperties: false,
   errorMessage: "Invalid snapshot"
 };
@@ -354,7 +357,7 @@ var server_default = (ctx) => __async(void 0, null, function* () {
       return reply.code(500).send({ error: { message: error.message } });
     }
   }));
-  yield server.listen({ port: 8080 });
+  yield server.listen();
   let { port } = server.addresses()[0];
   process.env.SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
   return server;
@@ -365,42 +368,47 @@ var env_default = () => {
   const {
     PROJECT_TOKEN = "",
     SMARTUI_CLIENT_API_URL = "https://api.lambdatest.com/visualui/1.0",
-    SMARTUI_LOG_LEVEL,
-    SMARTUI_DEBUG
+    LT_SDK_LOG_LEVEL,
+    LT_SDK_DEBUG
   } = process.env;
   return {
     PROJECT_TOKEN,
     SMARTUI_CLIENT_API_URL,
-    SMARTUI_LOG_LEVEL,
-    SMARTUI_DEBUG
+    LT_SDK_LOG_LEVEL,
+    LT_SDK_DEBUG
   };
 };
-
-// src/lib/logger.ts
-var logContext = {};
+var logContext = { task: "smartui-cli" };
 function updateLogContext(newContext) {
   logContext = __spreadValues(__spreadValues({}, logContext), newContext);
 }
 var logLevel = () => {
   let env = env_default();
-  let debug = env.SMARTUI_DEBUG === "true" ? "debug" : void 0;
-  return debug || env.SMARTUI_LOG_LEVEL || "info";
+  let debug = env.LT_SDK_DEBUG === "true" ? "debug" : void 0;
+  return debug || env.LT_SDK_LOG_LEVEL || "info";
 };
 var logger = winston.createLogger({
   level: logLevel(),
   format: winston.format.combine(
     winston.format.timestamp(),
     winston.format.printf((info) => {
-      let contextString;
-      if (logContext && Object.keys(logContext).length) {
-        contextString = Object.values(logContext).join(" | ");
+      let contextString = Object.values(logContext).join(" | ");
+      let message = typeof info.message === "object" ? JSON.stringify(info.message) : info.message;
+      switch (info.level) {
+        case "debug":
+          message = chalk__default.default.blue(message);
+          break;
+        case "warn":
+          message = chalk__default.default.yellow(message);
+          break;
+        case "error":
+          message = chalk__default.default.red(message);
+          break;
       }
-      let message = `[${contextString}:${info.level}] `;
-      message += info.message === "object" ? JSON.stringify(info.message) : info.message;
-      return message;
+      return info.level === "info" ? message : `[${contextString}:${info.level}] ` + message;
     })
   ),
-  transports: [new winston.transports.File({ filename: "smartui.log" })]
+  transports: [new winston.transports.Console()]
 });
 var logger_default = logger;
 
@@ -416,9 +424,8 @@ var startServer_default = (ctx) => {
         task.output = chalk__default.default.gray(`listening on port ${(_a = ctx2.server.addresses()[0]) == null ? void 0 : _a.port}`);
         task.title = "SmartUI started";
       } catch (error) {
-        if (error.code === "EADDRINUSE") {
-          task.output = chalk__default.default.gray(`port 8080 is already in use`);
-        }
+        ctx2.log.debug(error);
+        task.output = chalk__default.default.gray(error.message);
         throw new Error("SmartUI server setup failed");
       }
     }),
@@ -435,7 +442,7 @@ var auth_default = (ctx) => {
         task.output = chalk__default.default.gray(`using project token '******#${ctx2.env.PROJECT_TOKEN.split("#").pop()}'`);
         task.title = "Authenticated with SmartUI";
       } catch (error) {
-        ctx2.log.debug(error.message);
+        ctx2.log.debug(error);
         task.output = chalk__default.default.gray(error.message);
         throw new Error("Authentication failed");
       }
@@ -504,30 +511,59 @@ function createWebStaticConfig(filepath) {
 }
 
 // package.json
-var version = "2.0.5";
-var HTTP_SCHEME = "https:";
-var HTTP_SCHEME_PREFIX = "https://";
-var WWW = "www.";
+var version = "2.0.7";
+var package_default = {
+  name: "@lambdatest/smartui-cli",
+  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"
+  },
+  bin: {
+    smartui: "./dist/index.cjs"
+  },
+  type: "module",
+  keywords: [
+    "lambdatest",
+    "smartui",
+    "cli"
+  ],
+  author: "LambdaTest <keys@lambdatest.com>",
+  license: "MIT",
+  dependencies: {
+    "@playwright/browser-chromium": "^1.40.1",
+    "@playwright/browser-firefox": "^1.40.1",
+    "@playwright/browser-webkit": "^1.40.1",
+    "@playwright/test": "^1.40.1",
+    "@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",
+    tsup: "^7.2.0",
+    which: "^4.0.0",
+    winston: "^3.10.0"
+  },
+  devDependencies: {
+    typescript: "^5.3.2"
+  }
+};
 function delDir(dir) {
   if (fs__default.default.existsSync(dir)) {
     fs__default.default.rmSync(dir, { recursive: true });
   }
 }
-function ensureHttps(urlString) {
-  try {
-    if (urlString && urlString.startsWith(WWW)) {
-      urlString = HTTP_SCHEME_PREFIX + urlString;
-    }
-    let url = new URL(urlString);
-    if (url.protocol !== HTTP_SCHEME) {
-      url.protocol = HTTP_SCHEME;
-    }
-    return url.toString();
-  } catch (error) {
-    console.error("Invalid URL: " + urlString, error);
-    return null;
-  }
-}
 function scrollToBottomAndBackToTop({
   frequency = 100,
   timing = 8,
@@ -575,11 +611,18 @@ var httpClient = class {
         return resp.data;
       }).catch((error) => {
         if (error.response) {
+          log.debug(`http response: ${JSON.stringify({
+            status: error.response.status,
+            headers: error.response.headers,
+            body: error.response.data
+          })}`);
           throw new Error(JSON.stringify(error.response.data));
         }
         if (error.request) {
+          log.debug(`http request failed: ${error.toJSON()}`);
           throw new Error(error.toJSON().message);
         }
+        log.debug(`http request failed: ${error.message}`);
         throw new Error(error.message);
       });
     });
@@ -664,6 +707,17 @@ var httpClient = class {
       throw new Error(error.message);
     });
   }
+  checkUpdate(log) {
+    return this.request({
+      url: `/packageinfo`,
+      method: "GET",
+      headers: { "Content-Type": "application/json" },
+      params: {
+        packageName: package_default.name,
+        packageVersion: package_default.version
+      }
+    }, log);
+  }
 };
 var ctx_default = (options) => {
   let env = env_default();
@@ -762,6 +816,7 @@ var getGitInfo_default = (ctx) => {
         task.output = chalk__default.default.gray(`branch: ${ctx2.git.branch}, commit: ${ctx2.git.commitId}, author: ${ctx2.git.commitAuthor}`);
         task.title = "Fetched git information";
       } catch (error) {
+        ctx2.log.debug(error);
         task.output = chalk__default.default.gray(`${error.message}`);
         throw new Error("Error fetching git repo details");
       }
@@ -786,6 +841,7 @@ var createBuild_default = (ctx) => {
         task.output = chalk__default.default.gray(`build id: ${resp.data.buildId}`);
         task.title = "SmartUI build created";
       } catch (error) {
+        ctx2.log.debug(error);
         task.output = chalk__default.default.gray(JSON.parse(error.message).message);
         throw new Error("SmartUI build creation failed");
       }
@@ -839,9 +895,9 @@ var finalizeBuild_default = (ctx) => {
         task.output = chalk__default.default.gray(`build url: ${ctx2.build.url}`);
         task.title = "Finalized build";
       } catch (error) {
-        ctx2.log.debug(error.message);
+        ctx2.log.debug(error);
         task.output = chalk__default.default.gray(error.message);
-        throw new Error("Finalize build error");
+        throw new Error("Finalize build failed");
       }
     }),
     rendererOptions: { persistentOutput: true }
@@ -855,7 +911,7 @@ command.name("exec").description("Run test commands around SmartUI").argument("<
     var _a, _b;
     let ctx = ctx_default(command3.optsWithGlobals());
     if (!which__default.default.sync(execCommand[0], { nothrow: true })) {
-      console.log(`Error: Command not found "${execCommand[0]}"`);
+      ctx.log.error(`Error: Command not found "${execCommand[0]}"`);
       return;
     }
     ctx.args.execCommand = execCommand;
@@ -883,7 +939,7 @@ command.name("exec").description("Run test commands around SmartUI").argument("<
     try {
       yield tasks.run(ctx);
     } catch (error) {
-      console.log("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
+      ctx.log.info("\nRefer docs: https://www.lambdatest.com/support/docs/smart-visual-regression-testing/");
     } finally {
       yield (_a = ctx.server) == null ? void 0 : _a.close();
       yield (_b = ctx.browser) == null ? void 0 : _b.close();
@@ -944,11 +1000,7 @@ function captureScreenshots(ctx, screenshots) {
           let screenshot = screenshots[j];
           let screenshotId = screenshot.name.toLowerCase().replace(/\s/g, "-");
           const page = yield context.newPage();
-          if (screenshot.url) {
-            screenshot.url = screenshot.url.trim();
-            screenshot.url = ensureHttps(screenshot.url);
-          }
-          yield page.goto(screenshot.url, pageOptions);
+          yield page.goto(screenshot.url.trim(), pageOptions);
           for (let k = 0; k < totalViewports; k++) {
             let { width, height } = ctx.webConfig.viewports[k];
             let ssName = `${browserName}-${width}x${height}-${screenshotId}.png`;
@@ -1044,6 +1096,26 @@ var capture_default = command2;
 var program = new commander.Command();
 program.name("smartui").description("CLI to help you run your SmartUI tests on LambdaTest platform").version(`v${version}`).option("-c --config <filepath>", "Config file path").addCommand(exec_default2).addCommand(capture_default).addCommand(configWeb).addCommand(configStatic);
 var commander_default = program;
-
-// src/index.ts
-commander_default.parse();
+(function() {
+  return __async(this, null, function* () {
+    let client = new httpClient(env_default());
+    let log = logger_default;
+    try {
+      log.info(`
+LambdaTest SmartUI CLI v${package_default.version}`);
+      let { data: { latestVersion, deprecated } } = yield client.checkUpdate(log);
+      if (deprecated)
+        log.warn(`This version is deprecated. A new version ${latestVersion} is available!
+`);
+      else if (package_default.version !== latestVersion)
+        log.info(chalk__default.default.gray(`A new version ${latestVersion} is available!
+`));
+      else
+        log.info(chalk__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
+    } catch (error) {
+      log.debug(error);
+      log.info(chalk__default.default.gray("https://www.npmjs.com/package/@lambdatest/smartui-cli\n"));
+    }
+    commander_default.parse();
+  });
+})();

package/package.json

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