@lambdatest/smartui-cli 4.0.22 → 4.1.1

package/dist/index.cjs

@@ -638,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"],
@@ -1270,6 +1281,7 @@ var server_default = (ctx) => __async(void 0, null, function* () {
         throw new Error(validateSnapshot.errors[0].message);
       ctx.testType = testType;
       (_a = ctx.snapshotQueue) == null ? void 0 : _a.enqueue(snapshot);
+      ctx.isSnapshotCaptured = true;
       replyCode = 200;
       replyBody = { data: { message: "success", warnings: [] } };
     } catch (error) {
@@ -1389,6 +1401,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;
     })
@@ -1451,7 +1466,7 @@ var auth_default = (ctx) => {
 };
 
 // package.json
-var version = "4.0.22";
+var version = "4.1.1";
 var package_default = {
   name: "@lambdatest/smartui-cli",
   version,
@@ -1906,7 +1921,8 @@ var ctx_default = (options) => {
     },
     cliVersion: version,
     totalSnapshots: -1,
-    isStartExec: false
+    isStartExec: false,
+    isSnapshotCaptured: false
   };
 };
 function executeCommand(command7) {
@@ -2109,8 +2125,11 @@ var finalizeBuild_default = (ctx) => {
         ctx2.log.debug(`Closed browser`);
         yield (_b = ctx2.server) == null ? void 0 : _b.close();
         ctx2.log.debug(`Closed server`);
-        let resp = yield ctx2.client.getS3PreSignedURL(ctx2);
-        yield ctx2.client.uploadLogs(ctx2, resp.data.url);
+        if (ctx2.isSnapshotCaptured) {
+          ctx2.log.debug(`Log file to be uploaded`);
+          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) {
@@ -2910,8 +2929,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;
@@ -2930,12 +2953,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);
       }
@@ -3012,7 +3037,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;
@@ -3207,6 +3232,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",
@@ -3244,20 +3286,32 @@ 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());
+    ctx.isSnapshotCaptured = true;
     if (!fs6__default.default.existsSync(file)) {
       ctx.log.error(`Web Static Config file ${file} not found.`);
       return;
     }
     try {
       ctx.webStaticConfig = JSON.parse(fs6__default.default.readFileSync(file, "utf8"));
-      if (!validateWebStaticConfig(ctx.webStaticConfig))
-        throw new Error(validateWebStaticConfig.errors[0].message);
+      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;
@@ -3331,6 +3385,7 @@ command3.name("upload").description("Upload screenshots from given directory").a
       process.exit(1);
     }
     let ctx = ctx_default(command7.optsWithGlobals());
+    ctx.isSnapshotCaptured = true;
     if (!fs6__default.default.existsSync(directory)) {
       console.log(`Error: The provided directory ${directory} not found.`);
       return;
@@ -3529,6 +3584,7 @@ uploadFigma.name("upload-figma").description("Capture screenshots of static site
   return __async(this, null, function* () {
     var _a, _b;
     let ctx = ctx_default(command7.optsWithGlobals());
+    ctx.isSnapshotCaptured = true;
     if (!fs6__default.default.existsSync(file)) {
       console.log(`Error: Figma Config file ${file} not found.`);
       return;

package/package.json

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