@lambdatest/smartui-cli 3.0.3 → 3.0.5

package/dist/dom-serializer.js

@@ -332,32 +332,35 @@
       for (let video of dom.querySelectorAll('video')) {
         let videoId = video.getAttribute('data-smartui-element-id');
         let cloneEl = clone.querySelector(`[data-smartui-element-id="${videoId}"]`);
-        // if the video already has a poster image, no work for us to do
-        if (video.getAttribute('poster')) {
-          cloneEl.removeAttribute('src');
-          continue;
-        }
-        let canvas = document.createElement('canvas');
-        let width = canvas.width = video.videoWidth;
-        let height = canvas.height = video.videoHeight;
-        let dataUrl;
-        canvas.getContext('2d').drawImage(video, 0, 0, width, height);
-        try {
-          dataUrl = canvas.toDataURL();
-        } catch (e) {
-          warnings.add(`data-smartui-element-id="${videoId}" : ${e.toString()}`);
-        }
 
-        // if the canvas produces a blank image, skip
-        if (!dataUrl || dataUrl === 'data:,') continue;
+        // remove video sources
+        cloneEl.removeAttribute('src');
+        const sourceEls = cloneEl.querySelectorAll('source');
+        if (sourceEls.length) sourceEls.forEach((sourceEl) => sourceEl.remove());
+        
+        // if the video doesn't have a poster image
+        if (!video.getAttribute('poster')) {
+          let canvas = document.createElement('canvas');
+          let width = canvas.width = video.videoWidth;
+          let height = canvas.height = video.videoHeight;
+          let dataUrl;
+          canvas.getContext('2d').drawImage(video, 0, 0, width, height);
+          try {
+            dataUrl = canvas.toDataURL();
+          } catch (e) {
+            warnings.add(`data-smartui-element-id="${videoId}" : ${e.toString()}`);
+          }
 
-        // create a resource from the serialized data url
-        // let resource = resourceFromDataURL(videoId, dataUrl);
-        // resources.add(resource);
+          // if the canvas produces a blank image, skip
+          if (!dataUrl || dataUrl === 'data:,') continue;
 
-        // use a data attribute to avoid making a real request
-        cloneEl.removeAttribute('src');
-        cloneEl.setAttribute('poster', dataUrl);
+          // create a resource from the serialized data url
+          let resource = resourceFromDataURL(videoId, dataUrl);
+          resources.add(resource);
+
+          // set poster attribute to resource url to avoid making a real request
+          cloneEl.setAttribute('poster', resource.url);
+        }
       }
     }
 

package/dist/index.cjs

@@ -7,7 +7,7 @@ var listr2 = require('listr2');
 var chalk8 = require('chalk');
 var path2 = require('path');
 var fastify = require('fastify');
-var fs4 = require('fs');
+var fs5 = require('fs');
 var test = require('@playwright/test');
 var Ajv = require('ajv');
 var addErrors = require('ajv-errors');
@@ -23,7 +23,7 @@ var which__default = /*#__PURE__*/_interopDefault(which);
 var chalk8__default = /*#__PURE__*/_interopDefault(chalk8);
 var path2__default = /*#__PURE__*/_interopDefault(path2);
 var fastify__default = /*#__PURE__*/_interopDefault(fastify);
-var fs4__default = /*#__PURE__*/_interopDefault(fs4);
+var fs5__default = /*#__PURE__*/_interopDefault(fs5);
 var Ajv__default = /*#__PURE__*/_interopDefault(Ajv);
 var addErrors__default = /*#__PURE__*/_interopDefault(addErrors);
 var FormData__default = /*#__PURE__*/_interopDefault(FormData);
@@ -304,8 +304,8 @@ var constants_default = {
 
 // src/lib/utils.ts
 function delDir(dir) {
-  if (fs4__default.default.existsSync(dir)) {
-    fs4__default.default.rmSync(dir, { recursive: true });
+  if (fs5__default.default.existsSync(dir)) {
+    fs5__default.default.rmSync(dir, { recursive: true });
   }
 }
 function scrollToBottomAndBackToTop({
@@ -424,8 +424,13 @@ var REQUEST_TIMEOUT = 1e4;
 var MIN_VIEWPORT_HEIGHT = 1080;
 var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function* () {
   ctx.log.debug(`Processing snapshot ${snapshot.name}`);
-  if (!ctx.browser)
-    ctx.browser = yield test.chromium.launch({ headless: true });
+  if (!ctx.browser) {
+    let launchOptions = { headless: true };
+    if (ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY)
+      launchOptions.proxy = { server: ctx.env.HTTP_PROXY || ctx.env.HTTPS_PROXY };
+    ctx.browser = yield test.chromium.launch(launchOptions);
+    ctx.log.debug(`Chromium launched with options ${JSON.stringify(launchOptions)}`);
+  }
   const context = yield ctx.browser.newContext({ userAgent: constants_default.CHROME_USER_AGENT });
   const page = yield context.newPage();
   let cache = {};
@@ -433,6 +438,9 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
     const requestUrl = request.url();
     const requestHostname = new URL(requestUrl).hostname;
     try {
+      if (/\.(mp3|mp4|wav|ogg|webm)$/i.test(request.url())) {
+        throw new Error("resource type mp3/mp4/wav/ogg/webm");
+      }
       ctx.config.allowedHostnames.push(new URL(snapshot.url).hostname);
       if (ctx.config.enableJavaScript)
         ALLOWED_RESOURCES.push("script");
@@ -539,14 +547,21 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
     yield page.setViewportSize({ width: viewport.width, height: viewport.height || MIN_VIEWPORT_HEIGHT });
     ctx.log.debug(`Page resized to ${viewport.width}x${viewport.height || MIN_VIEWPORT_HEIGHT}`);
     if (!navigated) {
-      yield page.goto(snapshot.url);
+      yield page.goto(snapshot.url, { waitUntil: "domcontentloaded" });
+      yield new Promise((r) => setTimeout(r, 1250));
+      if (ctx.config.waitForTimeout)
+        yield page.waitForTimeout(ctx.config.waitForTimeout);
       navigated = true;
       ctx.log.debug(`Navigated to ${snapshot.url}`);
     }
     if (fullPage)
       yield page.evaluate(scrollToBottomAndBackToTop);
-    yield page.waitForLoadState("networkidle");
-    ctx.log.debug("Network idle 500ms");
+    try {
+      yield page.waitForLoadState("networkidle", { timeout: 5e3 });
+      ctx.log.debug("Network idle 500ms");
+    } catch (error) {
+      ctx.log.debug(`Network idle failed due to ${error}`);
+    }
     if (processedOptions.element) {
       let l = yield page.locator(processedOptions.element).all();
       if (l.length === 0) {
@@ -580,6 +595,14 @@ var processSnapshot_default = (snapshot, ctx) => __async(void 0, null, function*
   }
   yield page.close();
   yield context.close();
+  if (snapshot.dom.resources.length) {
+    for (let resource of snapshot.dom.resources) {
+      cache[resource.url] = {
+        body: resource.content,
+        type: resource.mimetype
+      };
+    }
+  }
   return {
     processedSnapshot: {
       name: snapshot.name,
@@ -862,7 +885,7 @@ var validateSnapshot = ajv.compile(SnapshotSchema);
 var server_default = (ctx) => __async(void 0, null, function* () {
   const server = fastify__default.default({ logger: false, bodyLimit: 1e7 });
   const opts = {};
-  const SMARTUI_DOM = fs4.readFileSync(path2__default.default.resolve(__dirname, "dom-serializer.js"), "utf-8");
+  const SMARTUI_DOM = fs5.readFileSync(path2__default.default.resolve(__dirname, "dom-serializer.js"), "utf-8");
   server.get("/healthcheck", opts, (_, reply) => {
     reply.code(200).send({ cliVersion: ctx.cliVersion });
   });
@@ -882,7 +905,7 @@ var server_default = (ctx) => __async(void 0, null, function* () {
       return reply.code(500).send({ error: { message: error.message } });
     }
   }));
-  yield server.listen();
+  yield server.listen({ port: 49152 });
   let { port } = server.addresses()[0];
   process.env.SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
   process.env.CYPRESS_SMARTUI_SERVER_ADDRESS = `http://localhost:${port}`;
@@ -896,6 +919,9 @@ var env_default = () => {
     SMARTUI_CLIENT_API_URL = "https://api.lambdatest.com/visualui/1.0",
     LT_SDK_LOG_LEVEL,
     LT_SDK_DEBUG,
+    SMARTUI_GIT_INFO_FILEPATH,
+    HTTP_PROXY,
+    HTTPS_PROXY,
     GITHUB_ACTIONS
   } = process.env;
   return {
@@ -903,6 +929,9 @@ var env_default = () => {
     SMARTUI_CLIENT_API_URL,
     LT_SDK_LOG_LEVEL,
     LT_SDK_DEBUG,
+    SMARTUI_GIT_INFO_FILEPATH,
+    HTTP_PROXY,
+    HTTPS_PROXY,
     GITHUB_ACTIONS
   };
 };
@@ -936,7 +965,7 @@ var logger = winston.createLogger({
       return info.level === "info" ? message : `[${contextString}:${info.level}] ` + message;
     })
   ),
-  transports: [new winston.transports.Console()]
+  transports: [new winston.transports.Console(), new winston.transports.File({ filename: ".smartui.log" })]
 });
 var logger_default = logger;
 
@@ -980,7 +1009,7 @@ var auth_default = (ctx) => {
 };
 
 // package.json
-var version = "3.0.3";
+var version = "3.0.5";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -1053,7 +1082,7 @@ var httpClient = class {
             headers: error.response.headers,
             body: error.response.data
           })}`);
-          throw new Error((_a = error.response.data.error) == null ? void 0 : _a.message);
+          throw new Error(((_a = error.response.data.error) == null ? void 0 : _a.message) || error.response.data.message);
         }
         if (error.request) {
           log.debug(`http request failed: ${error.toJSON()}`);
@@ -1106,7 +1135,7 @@ var httpClient = class {
   }
   uploadScreenshot({ id: buildId, name: buildName, baseline }, ssPath, ssName, browserName, viewport, log) {
     browserName = browserName === constants_default.SAFARI ? constants_default.WEBKIT : browserName;
-    const file = fs4__default.default.readFileSync(ssPath);
+    const file = fs5__default.default.readFileSync(ssPath);
     const form = new FormData__default.default();
     form.append("screenshot", file, { filename: `${ssName}.png`, contentType: "image/png" });
     form.append("browser", browserName);
@@ -1152,7 +1181,7 @@ var ctx_default = (options) => {
   let config = constants_default.DEFAULT_CONFIG;
   try {
     if (options.config) {
-      config = JSON.parse(fs4__default.default.readFileSync(options.config, "utf-8"));
+      config = JSON.parse(fs5__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;
@@ -1232,26 +1261,37 @@ function isGitRepo() {
   }
 }
 var git_default = (ctx) => {
-  const splitCharacter = "<##>";
-  const prettyFormat = ["%h", "%H", "%s", "%f", "%b", "%at", "%ct", "%an", "%ae", "%cn", "%ce", "%N", ""];
-  const command3 = 'git log -1 --pretty=format:"' + prettyFormat.join(splitCharacter) + '" && git rev-parse --abbrev-ref HEAD && git tag --contains HEAD';
-  let res = executeCommand(command3).split(splitCharacter);
-  var branchAndTags = res[res.length - 1].split("\n").filter((n) => n);
-  var branch = branchAndTags[0];
-  branchAndTags.slice(1);
-  return {
-    branch,
-    commitId: res[0] || "",
-    commitMessage: res[2] || "",
-    commitAuthor: res[7] || "",
-    githubURL: ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : ""
-  };
+  if (ctx.env.SMARTUI_GIT_INFO_FILEPATH) {
+    let gitInfo = JSON.parse(fs5__default.default.readFileSync(ctx.env.SMARTUI_GIT_INFO_FILEPATH, "utf-8"));
+    return {
+      branch: gitInfo.branch || "",
+      commitId: gitInfo.commit_id.slice(0, 6) || "",
+      commitMessage: gitInfo.commit_body || "",
+      commitAuthor: gitInfo.commit_author || "",
+      githubURL: ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}` : ""
+    };
+  } else {
+    const splitCharacter = "<##>";
+    const prettyFormat = ["%h", "%H", "%s", "%f", "%b", "%at", "%ct", "%an", "%ae", "%cn", "%ce", "%N", ""];
+    const command3 = 'git log -1 --pretty=format:"' + prettyFormat.join(splitCharacter) + '" && git rev-parse --abbrev-ref HEAD && git tag --contains HEAD';
+    let res = executeCommand(command3).split(splitCharacter);
+    var branchAndTags = res[res.length - 1].split("\n").filter((n) => n);
+    var branch = branchAndTags[0];
+    branchAndTags.slice(1);
+    return {
+      branch: branch || "",
+      commitId: res[0] || "",
+      commitMessage: res[2] || "",
+      commitAuthor: res[7] || "",
+      githubURL: ctx.env.GITHUB_ACTIONS ? `${constants_default.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : ""
+    };
+  }
 };
 var getGitInfo_default = (ctx) => {
   return {
     title: `Fetching git repo details`,
     skip: (ctx2) => {
-      return !isGitRepo() ? "[SKIPPED] Fetching git repo details; not a git repo" : "";
+      return !isGitRepo() && !ctx2.env.SMARTUI_GIT_INFO_FILEPATH ? "[SKIPPED] Fetching git repo details; not a git repo" : "";
     },
     task: (ctx2, task) => __async(void 0, null, function* () {
       try {
@@ -1397,13 +1437,13 @@ function createConfig(filepath) {
     console.log("Error: Config file must have .json extension");
     return;
   }
-  if (fs4__default.default.existsSync(filepath)) {
+  if (fs5__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;
   }
-  fs4__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
-  fs4__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_CONFIG, null, 2) + "\n");
+  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");
   console.log(`Created SmartUI Config: ${filepath}`);
 }
 function createWebStaticConfig(filepath) {
@@ -1413,13 +1453,13 @@ function createWebStaticConfig(filepath) {
     console.log("Error: Config file must have .json extension");
     return;
   }
-  if (fs4__default.default.existsSync(filepath)) {
+  if (fs5__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;
   }
-  fs4__default.default.mkdirSync(path2__default.default.dirname(filepath), { recursive: true });
-  fs4__default.default.writeFileSync(filepath, JSON.stringify(constants_default.DEFAULT_WEB_STATIC_CONFIG, null, 2) + "\n");
+  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");
   console.log(`Created web-static config: ${filepath}`);
 }
 
@@ -1577,12 +1617,12 @@ var command2 = new commander.Command();
 command2.name("capture").description("Capture screenshots of static sites").argument("<file>", "Web static config file").option("--parallel", "Capture parallely on all browsers").action(function(file, _, command3) {
   return __async(this, null, function* () {
     let ctx = ctx_default(command3.optsWithGlobals());
-    if (!fs4__default.default.existsSync(file)) {
+    if (!fs5__default.default.existsSync(file)) {
       console.log(`Error: Web Static Config file ${file} not found.`);
       return;
     }
     try {
-      ctx.webStaticConfig = JSON.parse(fs4__default.default.readFileSync(file, "utf8"));
+      ctx.webStaticConfig = JSON.parse(fs5__default.default.readFileSync(file, "utf8"));
       if (!validateWebStaticConfig(ctx.webStaticConfig))
         throw new Error(validateWebStaticConfig.errors[0].message);
     } catch (error) {

package/package.json

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