@cleartrip/frontguard 0.2.4 → 0.2.6

package/dist/cli.js

@@ -7,9 +7,10 @@ import { WriteStream } from 'tty';
 import path5, { sep, normalize, delimiter, resolve, dirname } from 'path';
 import fs from 'fs/promises';
 import { pathToFileURL, fileURLToPath } from 'url';
-import { execFileSync, spawn } from 'child_process';
+import { tmpdir } from 'os';
+import fs2, { existsSync, statSync, readFileSync } from 'fs';
+import { spawn, execFileSync } from 'child_process';
 import { createRequire } from 'module';
-import fs2 from 'fs';
 import { pipeline } from 'stream/promises';
 import { PassThrough } from 'stream';
 import fg from 'fast-glob';
@@ -2496,9 +2497,23 @@ async function initFrontGuard(cwd) {
     await fs.writeFile(tplPr, PR_TEMPLATE, "utf8");
   }
 }
-
-// src/ci/bitbucket-pr-snippet.ts
+var MAX_PNG_BYTES_FOR_EMBED = 22e4;
 function checksImageMarkdown() {
+  const embedPath = process.env.FRONTGUARD_EMBED_CHECKS_PNG_PATH?.trim();
+  if (embedPath) {
+    try {
+      if (!existsSync(embedPath)) return null;
+      const st = statSync(embedPath);
+      if (!st.isFile() || st.size > MAX_PNG_BYTES_FOR_EMBED) return null;
+      const buf = readFileSync(embedPath);
+      const b64 = buf.toString("base64");
+      const md = `![FrontGuard \u2014 checks summary](data:image/png;base64,${b64})`;
+      if (md.length > 45e4) return null;
+      return md;
+    } catch {
+      return null;
+    }
+  }
   const u4 = process.env.FRONTGUARD_CHECKS_IMAGE_URL?.trim();
   if (!u4) return null;
   return `![FrontGuard \u2014 checks summary](${u4})`;
@@ -2524,13 +2539,17 @@ function bitbucketDownloadsPageUrl() {
   if (ws && slug) return `https://bitbucket.org/${ws}/${slug}/downloads/`;
   return null;
 }
+var DETAILED_REPORT_LINE = "For detailed check analysis, please open the full interactive report:";
 function formatBitbucketPrSnippet(report) {
   const publicReport = process.env.FRONTGUARD_PUBLIC_REPORT_URL?.trim();
   const linkOnly = process.env.FRONTGUARD_BITBUCKET_COMMENT_LINK_ONLY === "1";
   const imgMd = checksImageMarkdown();
   if (linkOnly && publicReport) {
     const parts = [];
-    if (imgMd) parts.push(imgMd, "");
+    if (imgMd) {
+      parts.push(imgMd, "");
+      parts.push(DETAILED_REPORT_LINE);
+    }
     parts.push(publicReport.endsWith("\n") ? publicReport.slice(0, -1) : publicReport);
     return `${parts.join("\n")}
 `;
@@ -2559,15 +2578,13 @@ function formatBitbucketPrSnippet(report) {
     ""
   );
   if (publicReport) {
-    out.push("Full interactive report (open in browser):");
-    out.push(publicReport);
-    out.push("");
     if (imgMd) {
-      out.push(
-        "The image above is a quick checks overview. Use the link for file-level findings, hints, and suggested fixes."
-      );
-      out.push("");
+      out.push(DETAILED_REPORT_LINE);
+    } else {
+      out.push("Full interactive report (open in browser):");
     }
+    out.push(publicReport);
+    out.push("");
   } else if (downloadsName && downloadsPage) {
     out.push("HTML report is in Repository \u2192 Downloads. Open this page while logged in:");
     out.push(downloadsPage);
@@ -5530,6 +5547,30 @@ function applyAiAssistedEscalation(results, pr, config) {
     }
   }
 }
+var PLAYWRIGHT = "playwright@1.49.1";
+function runCmd(command, args) {
+  return new Promise((resolve, reject) => {
+    const p2 = spawn(command, args, { stdio: "inherit", env: process.env });
+    p2.on("error", reject);
+    p2.on("close", (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`${command} exited with code ${code}`));
+    });
+  });
+}
+async function runChecksHtmlToPng(htmlPath, pngPath) {
+  const fileUrl = pathToFileURL(htmlPath).href;
+  const npx = process.platform === "win32" ? "npx.cmd" : "npx";
+  await runCmd(npx, ["-y", PLAYWRIGHT, "install", "chromium"]);
+  await runCmd(npx, [
+    "-y",
+    PLAYWRIGHT,
+    "screenshot",
+    fileUrl,
+    pngPath,
+    "--viewport-size=920,1000"
+  ]);
+}
 
 // src/report/builder.ts
 var import_picocolors = __toESM(require_picocolors());
@@ -6913,26 +6954,53 @@ async function runFrontGuard(opts) {
     llmAppendix,
     cwd: opts.cwd,
     emitHtml: Boolean(opts.htmlOut),
-    emitChecksSnapshot: Boolean(opts.checksSnapshotOut)
+    emitChecksSnapshot: Boolean(opts.checksSnapshotOut || opts.checksPngOut)
   });
   if (opts.htmlOut && report.html) {
     await fs.writeFile(opts.htmlOut, report.html, "utf8");
   }
-  if (opts.checksSnapshotOut && report.checksSnapshotHtml) {
-    const snapPath = path5.isAbsolute(opts.checksSnapshotOut) ? opts.checksSnapshotOut : path5.join(opts.cwd, opts.checksSnapshotOut);
-    await fs.writeFile(snapPath, report.checksSnapshotHtml, "utf8");
-    const fileUrl = pathToFileURL(snapPath).href;
-    g.stderr.write(
-      `
-FrontGuard: wrote checks snapshot HTML to ${snapPath} (screenshot this file for PR comments).
-  Example: npx playwright screenshot "${fileUrl}" frontguard-checks.png
-  Host the PNG at an HTTPS URL, then set FRONTGUARD_CHECKS_IMAGE_URL before generating the PR comment.
+  let embedPngPath = null;
+  let tmpDir = null;
+  let htmlForPng;
+  if ((opts.checksSnapshotOut || opts.checksPngOut) && report.checksSnapshotHtml) {
+    if (opts.checksSnapshotOut) {
+      const snapPath = path5.isAbsolute(opts.checksSnapshotOut) ? opts.checksSnapshotOut : path5.join(opts.cwd, opts.checksSnapshotOut);
+      await fs.writeFile(snapPath, report.checksSnapshotHtml, "utf8");
+      htmlForPng = snapPath;
+      g.stderr.write(`
+FrontGuard: wrote checks snapshot HTML to ${snapPath}
+`);
+    }
+    if (opts.checksPngOut) {
+      if (!htmlForPng) {
+        tmpDir = await fs.mkdtemp(path5.join(tmpdir(), "fg-checks-"));
+        htmlForPng = path5.join(tmpDir, "checks.html");
+        await fs.writeFile(htmlForPng, report.checksSnapshotHtml, "utf8");
+      }
+      const pngAbs = path5.isAbsolute(opts.checksPngOut) ? opts.checksPngOut : path5.join(opts.cwd, opts.checksPngOut);
+      await runChecksHtmlToPng(htmlForPng, pngAbs);
+      embedPngPath = pngAbs;
+      g.stderr.write(`FrontGuard: wrote checks PNG to ${pngAbs} (Playwright via npx).
+
+`);
+      if (tmpDir) {
+        await fs.rm(tmpDir, { recursive: true, force: true });
+        tmpDir = null;
+      }
+    } else if (opts.checksSnapshotOut && htmlForPng) {
+      g.stderr.write(
+        `  Tip: add --checksPngOut checks.png to render this HTML to PNG with Playwright (npx).
 
 `
-    );
+      );
+    }
   }
   if (opts.prCommentOut) {
+    if (embedPngPath) {
+      g.env.FRONTGUARD_EMBED_CHECKS_PNG_PATH = embedPngPath;
+    }
     const snippet = formatBitbucketPrSnippet(report);
+    delete g.env.FRONTGUARD_EMBED_CHECKS_PNG_PATH;
     const abs = path5.isAbsolute(opts.prCommentOut) ? opts.prCommentOut : path5.join(opts.cwd, opts.prCommentOut);
     await fs.writeFile(abs, snippet, "utf8");
     g.stderr.write(
@@ -6940,7 +7008,7 @@ FrontGuard: wrote checks snapshot HTML to ${snapPath} (screenshot this file for
 FrontGuard: wrote Bitbucket PR comment text to ${abs} (${snippet.length} bytes).
   Use ONLY this file in your POST \u2026/pullrequests/{id}/comments payload (content.raw).
   Do not post frontguard-report.md or captured stdout \u2014 that is the long markdown log.
-  Optional: set FRONTGUARD_CHECKS_IMAGE_URL so the comment includes a checks summary image.
+  With --checksPngOut, the PNG is inlined (small files only) or set FRONTGUARD_CHECKS_IMAGE_URL.
 
 `
     );
@@ -6995,7 +7063,11 @@ var run = defineCommand({
     },
     checksSnapshotOut: {
       type: "string",
-      description: "Write HTML with only the Checks table (screenshot \u2192 PNG \u2192 FRONTGUARD_CHECKS_IMAGE_URL in PR comment)"
+      description: "Write HTML with only the Checks table (for screenshots / PR comments)"
+    },
+    checksPngOut: {
+      type: "string",
+      description: "Write PNG of the checks table via Playwright (npx). Pair with --checksSnapshotOut or use alone"
     },
     prCommentOut: {
       type: "string",
@@ -7010,6 +7082,7 @@ var run = defineCommand({
       append: typeof args.append === "string" ? args.append : null,
       htmlOut: typeof args.htmlOut === "string" ? args.htmlOut : null,
       checksSnapshotOut: typeof args.checksSnapshotOut === "string" ? args.checksSnapshotOut : null,
+      checksPngOut: typeof args.checksPngOut === "string" ? args.checksPngOut : null,
       prCommentOut: typeof args.prCommentOut === "string" ? args.prCommentOut : null
     });
   }