@reportforge/playwright-pdf 0.0.1 → 0.2.0

package/dist/index.js

@@ -10328,7 +10328,8 @@ var DEFAULT_OPTIONS = {
   compressionLevel: "auto",
   maxFileSizeMb: 8,
   historySize: 10,
-  showTrend: true
+  showTrend: true,
+  flakinessTopN: 5
 };
 
 // src/config/schema.ts
@@ -10341,10 +10342,17 @@ var channelConfigSchema = external_exports.object({
   on: external_exports.enum(["always", "failure", "success"]).default("always"),
   enabled: external_exports.boolean().default(false)
 });
+var emailChannelConfigSchema = external_exports.object({
+  to: external_exports.array(external_exports.string().email('Each "to" entry must be a valid email')).min(1, '"to" must have at least one address'),
+  on: external_exports.enum(["always", "failure", "success"]).default("always"),
+  enabled: external_exports.boolean().default(false),
+  attachPdf: external_exports.boolean().default(false)
+});
 var notifyConfigSchema = external_exports.object({
   slack: channelConfigSchema.optional(),
   teams: channelConfigSchema.optional(),
-  discord: channelConfigSchema.optional()
+  discord: channelConfigSchema.optional(),
+  email: emailChannelConfigSchema.optional()
 }).optional();
 var ReporterOptionsSchema = external_exports.object({
   outputFile: external_exports.string().optional().default(DEFAULT_OPTIONS.outputFile),
@@ -10373,7 +10381,16 @@ var ReporterOptionsSchema = external_exports.object({
   notify: notifyConfigSchema,
   historyFile: external_exports.string().optional(),
   historySize: external_exports.number().int().min(2).optional().default(DEFAULT_OPTIONS.historySize),
-  showTrend: external_exports.boolean().optional().default(DEFAULT_OPTIONS.showTrend)
+  showTrend: external_exports.boolean().optional().default(DEFAULT_OPTIONS.showTrend),
+  flakinessTopN: external_exports.number().int().min(0, "flakinessTopN must be 0 or greater").optional().default(DEFAULT_OPTIONS.flakinessTopN),
+  templatePath: external_exports.union([
+    external_exports.string().regex(/\.hbs$/, "templatePath must end with .hbs").refine((v) => v.slice(0, -4).trim().length > 0, "templatePath basename must not be empty"),
+    external_exports.array(
+      external_exports.string().regex(/\.hbs$/, "Each templatePath entry must end with .hbs").refine((v) => v.slice(0, -4).trim().length > 0, "Each templatePath basename must not be empty")
+    ).min(1, "templatePath array must not be empty")
+  ]).optional().transform(
+    (v) => v === void 0 ? void 0 : Array.isArray(v) ? v : [v]
+  )
 });
 function parseOptions(raw) {
   const result = ReporterOptionsSchema.safeParse(raw ?? {});
@@ -11461,6 +11478,7 @@ var TemplateEngine = class {
   constructor() {
     this.chartjsInline = "";
     this.fontsBundleCss = "";
+    this.customTemplateCache = /* @__PURE__ */ new Map();
     this.handlebars = import_handlebars.default.create();
     this.templatesDir = import_path3.default.resolve(__dirname, "templates");
     if (!import_fs4.default.existsSync(this.templatesDir)) {
@@ -11490,12 +11508,43 @@ var TemplateEngine = class {
     const ctx = this.buildContext(data, template);
     return compiledLayout(ctx);
   }
+  renderFromPath(data, filePath) {
+    if (!this.customTemplateCache.has(filePath)) {
+      if (!import_fs4.default.existsSync(filePath)) {
+        throw new Error(`[reportforge] Custom template not found: ${filePath}`);
+      }
+      const source = import_fs4.default.readFileSync(filePath, "utf8");
+      this.customTemplateCache.set(filePath, this.handlebars.compile(source));
+    }
+    const compiledFn = this.customTemplateCache.get(filePath);
+    return compiledFn(this.buildCustomContext(data));
+  }
+  buildCustomContext(data) {
+    return {
+      ...data,
+      options: {
+        showCharts: true,
+        showTrend: true,
+        showStackTraces: true,
+        showFullEnvironment: true,
+        showPassRate: true,
+        showRetries: true,
+        showFullFailures: true
+      },
+      tagGroups: this.buildTagGroups(data),
+      slowTests: this.buildSlowTests(data),
+      baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
+      templateCSS: "",
+      chartjsScript: this.buildChartjsScript()
+    };
+  }
   buildContext(data, template) {
     const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
     const templateCSS = this.readStyle(`${template}.css`);
     const optionsMap = {
       minimal: {
         showCharts: false,
+        showTrend: false,
         showStackTraces: true,
         showFullEnvironment: false,
         showPassRate: true,
@@ -11504,6 +11553,7 @@ var TemplateEngine = class {
       },
       detailed: {
         showCharts: true,
+        showTrend: true,
         showStackTraces: true,
         showFullEnvironment: true,
         showPassRate: true,
@@ -11512,6 +11562,7 @@ var TemplateEngine = class {
       },
       executive: {
         showCharts: true,
+        showTrend: true,
         showStackTraces: false,
         showFullEnvironment: false,
         showPassRate: true,
@@ -11519,7 +11570,7 @@ var TemplateEngine = class {
         showFullFailures: false
       }
     };
-    const chartjsScript = this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
+    const chartjsScript = this.buildChartjsScript();
     return {
       ...data,
       options: optionsMap[template],
@@ -11530,6 +11581,9 @@ var TemplateEngine = class {
       chartjsScript
     };
   }
+  buildChartjsScript() {
+    return this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
+  }
   buildTagGroups(data) {
     const tagMap = /* @__PURE__ */ new Map();
     for (const project of data.projects) {
@@ -11910,10 +11964,10 @@ var FilenameResolver = class {
     import_fs9.default.mkdirSync(import_path6.default.dirname(absolute), { recursive: true });
     return absolute;
   }
-  injectTemplateSuffix(outputPath, templateId) {
+  injectTemplateSuffix(outputPath, suffix) {
     const ext = import_path6.default.extname(outputPath);
     const base = outputPath.slice(0, outputPath.length - ext.length);
-    return `${base}-${templateId}${ext}`;
+    return `${base}-${suffix}${ext}`;
   }
   formatDate(d) {
     const yyyy = d.getFullYear();
@@ -12033,9 +12087,15 @@ var PdfGenerator = class {
     }
   }
   async generateAll(data, options, _licenseInfo) {
-    const rawTemplates = Array.isArray(options.template) ? options.template : [options.template];
-    const templates = [...new Set(rawTemplates)];
-    const isMulti = templates.length > 1;
+    const sources = this.resolveTemplateSources(options);
+    const isMulti = sources.length > 1;
+    for (const source of sources) {
+      if (source.kind === "custom" && !import_fs11.default.existsSync(source.absolutePath)) {
+        throw new Error(
+          `[reportforge] Custom template not found: ${source.absolutePath}`
+        );
+      }
+    }
     if (options.logo) {
       const logoBase64 = await this.screenshotEmbedder.embedLogoFile(options.logo);
       data.meta.branding.logoBase64 = logoBase64;
@@ -12052,11 +12112,13 @@ var PdfGenerator = class {
     const outputPaths = [];
     const { page } = await this.browserManager.launch(options.puppeteerExecutablePath);
     try {
-      for (const templateId of templates) {
-        const outputPath = isMulti ? this.filenameResolver.injectTemplateSuffix(baseOutputPath, templateId) : baseOutputPath;
+      for (const source of sources) {
+        const suffix = source.kind === "builtin" ? source.id : source.label;
+        const outputPath = isMulti ? this.filenameResolver.injectTemplateSuffix(baseOutputPath, suffix) : baseOutputPath;
+        const templateId = source.kind === "builtin" ? source.id : "detailed";
         const templateData = { ...data, meta: { ...data.meta, template: templateId } };
         const templateOptions = { ...options, template: templateId };
-        await this.renderPdf(templateData, templateOptions, compression, outputPath, page);
+        await this.renderPdf(templateData, templateOptions, source, compression, outputPath, page);
         const capBytes = (options.maxFileSizeMb ?? 0) * 1024 * 1024;
         if (capBytes > 0) {
           const sizeBytes = (await import_fs11.default.promises.stat(outputPath)).size;
@@ -12065,7 +12127,7 @@ var PdfGenerator = class {
             logger.warn(
               `PDF size ${fmtMb(sizeBytes)} exceeds cap ${fmtMb(capBytes)} \u2014 re-rendering (jpeg-q=${tighter.quality}, max-w=${tighter.maxWidth}px, inline-failures\u2264${tighter.maxInlineFailures}).`
             );
-            await this.renderPdf(templateData, templateOptions, tighter, outputPath, page);
+            await this.renderPdf(templateData, templateOptions, source, tighter, outputPath, page);
             const finalSize = (await import_fs11.default.promises.stat(outputPath)).size;
             if (finalSize > capBytes) {
               logger.warn(
@@ -12088,6 +12150,17 @@ var PdfGenerator = class {
     }
     return outputPaths;
   }
+  resolveTemplateSources(options) {
+    if (options.templatePath && options.templatePath.length > 0) {
+      return [...new Set(options.templatePath)].map((p) => ({
+        kind: "custom",
+        absolutePath: import_path8.default.isAbsolute(p) ? p : import_path8.default.resolve(process.cwd(), p),
+        label: import_path8.default.basename(p, ".hbs")
+      }));
+    }
+    const rawIds = Array.isArray(options.template) ? options.template : [options.template];
+    return [...new Set(rawIds)].map((id) => ({ kind: "builtin", id }));
+  }
   resolveSettings(options, data) {
     return resolveCompression({
       level: options.compressionLevel ?? "auto",
@@ -12122,7 +12195,7 @@ var PdfGenerator = class {
    * Separated from generateAll() so the size-cap retune can reuse it with
    * stricter settings without reshaping the rest of the flow.
    */
-  async renderPdf(data, options, compression, outputPath, page) {
+  async renderPdf(data, options, source, compression, outputPath, page) {
     const paginated = await this.failurePaginator.paginate(
       data.failures,
       compression.maxInlineFailures,
@@ -12142,15 +12215,15 @@ var PdfGenerator = class {
         maxWidth: compression.maxWidth
       });
     }
-    const templateId = options.template;
-    logger.info(`Rendering template: ${templateId}`);
-    const html = this.templateEngine.render(renderData, templateId);
+    const templateLabel = source.kind === "builtin" ? source.id : source.label;
+    logger.info(`Rendering template: ${templateLabel}`);
+    const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id) : this.templateEngine.renderFromPath(renderData, source.absolutePath);
     const tempHtmlPath = await this.htmlWriter.write(html);
     const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
     try {
       logger.info(`Navigating to temp HTML (${Math.round(html.length / 1024)} KB)...`);
       await page.goto(fileUrl, { waitUntil: "domcontentloaded", timeout: 6e4 });
-      const showCharts = templateId !== "minimal";
+      const showCharts = source.kind === "builtin" ? source.id !== "minimal" : true;
       await this.chartRenderer.waitForCharts(page, showCharts);
       logger.info(`Generating PDF \u2192 ${import_path8.default.relative(process.cwd(), outputPath)}`);
       await page.pdf({
@@ -12169,7 +12242,7 @@ function fmtMb(bytes) {
 }
 
 // src/reporter.ts
-var import_path11 = __toESM(require("path"));
+var import_path12 = __toESM(require("path"));
 var import_crypto7 = __toESM(require("crypto"));
 var import_os6 = __toESM(require("os"));
 
@@ -12211,6 +12284,42 @@ var HistoryManager = class {
   }
 };
 
+// src/history/FlakinessAnalyser.ts
+init_cjs_shims();
+function computeTopN(entries, topN) {
+  if (topN === 0) return [];
+  const qualifying = entries.filter((e) => Array.isArray(e.flakyTests));
+  if (qualifying.length === 0) return [];
+  const map = /* @__PURE__ */ new Map();
+  qualifying.forEach((entry, idx) => {
+    const seen = /* @__PURE__ */ new Set();
+    for (const t of entry.flakyTests) {
+      if (seen.has(t.id)) continue;
+      seen.add(t.id);
+      if (!map.has(t.id)) map.set(t.id, { title: t.title, hits: /* @__PURE__ */ new Set() });
+      map.get(t.id).hits.add(idx);
+    }
+  });
+  const totalRuns = qualifying.length;
+  const rows = [...map.entries()].map(([, { title, hits }]) => {
+    const flakeCount = hits.size;
+    const sparkline = qualifying.slice().reverse().map((_, reversedIdx) => {
+      const originalIdx = qualifying.length - 1 - reversedIdx;
+      return hits.has(originalIdx);
+    });
+    return {
+      title,
+      flakeRate: Math.round(flakeCount / totalRuns * 100),
+      flakeCount,
+      totalRuns,
+      sparkline
+    };
+  });
+  return rows.sort(
+    (a, b) => b.flakeRate - a.flakeRate || b.flakeCount - a.flakeCount || a.title.localeCompare(b.title)
+  ).slice(0, topN);
+}
+
 // src/notify/index.ts
 init_cjs_shims();
 
@@ -12327,6 +12436,115 @@ ${name}`,
   };
 }
 
+// src/notify/EmailSender.ts
+init_cjs_shims();
+var import_promises = require("fs/promises");
+var import_path11 = require("path");
+
+// src/notify/formatters/email.ts
+init_cjs_shims();
+function buildEmailContent(stats, pdfPaths, reportTitle) {
+  const label = statusLabel(stats.verdict);
+  const subject = `[ReportForge] ${label} \u2014 ${stats.passRate}% passed`;
+  const name = reportName(pdfPaths, reportTitle);
+  const html = `<!DOCTYPE html>
+<html lang="en">
+<head><meta charset="utf-8"><title>${escHtml(subject)}</title></head>
+<body style="font-family:sans-serif;max-width:600px;margin:auto;padding:24px;color:#1a1a1a">
+  <h2 style="margin:0 0 8px">${escHtml(label)}</h2>
+  <p style="margin:0 0 16px;color:#555">${escHtml(name)}</p>
+  <table style="border-collapse:collapse;width:100%">
+    <tr style="background:#f5f5f5">
+      <th style="text-align:left;padding:8px 12px;font-weight:600">Metric</th>
+      <th style="text-align:right;padding:8px 12px;font-weight:600">Value</th>
+    </tr>
+    <tr>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5">Total</td>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5;text-align:right">${stats.total}</td>
+    </tr>
+    <tr style="background:#f9f9f9">
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5">Passed</td>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5;text-align:right;color:#1a7f3c">${stats.passed}</td>
+    </tr>
+    <tr>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5">Failed</td>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5;text-align:right;color:${stats.failed > 0 ? "#b91c1c" : "#1a1a1a"}">${stats.failed}</td>
+    </tr>
+    <tr style="background:#f9f9f9">
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5">Flaky</td>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5;text-align:right">${stats.flaky}</td>
+    </tr>
+    <tr>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5">Pass Rate</td>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5;text-align:right">${stats.passRate}%</td>
+    </tr>
+    <tr style="background:#f9f9f9">
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5">Duration</td>
+      <td style="padding:8px 12px;border-top:1px solid #e5e5e5;text-align:right">${escHtml(countsLine(stats).split(" \xB7 ").pop() ?? "")}</td>
+    </tr>
+  </table>
+  <p style="margin:24px 0 0;color:#888;font-size:12px">Sent by ReportForge \xB7 <a href="https://reportforge.org" style="color:#888">reportforge.org</a></p>
+</body>
+</html>`;
+  return { subject, html };
+}
+function escHtml(str) {
+  return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+
+// src/notify/EmailSender.ts
+var RESEND_ENDPOINT = "https://api.resend.com/emails";
+var DEFAULT_FROM = "ReportForge <noreply@reportforge.org>";
+var EmailSender = class {
+  async send(reportData, config, pdfPaths) {
+    const apiKey = process.env["RESEND_API_KEY"];
+    if (!apiKey) {
+      logger.warn("[notify] email: RESEND_API_KEY not set \u2014 skipping");
+      return "skipped";
+    }
+    const from = process.env["RESEND_FROM"] ?? DEFAULT_FROM;
+    const { subject, html } = buildEmailContent(
+      reportData.stats,
+      pdfPaths,
+      reportData.meta.title ?? ""
+    );
+    const body = { from, to: config.to, subject, html };
+    if (config.attachPdf && pdfPaths.length > 0) {
+      const pdfPath = pdfPaths[0];
+      try {
+        const content = await (0, import_promises.readFile)(pdfPath);
+        body["attachments"] = [{ filename: (0, import_path11.basename)(pdfPath), content: content.toString("base64") }];
+      } catch (err) {
+        logger.warn(`[notify] email: could not read PDF for attachment: ${err instanceof Error ? err.message : String(err)}`);
+      }
+    }
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), 15e3);
+    try {
+      const res = await fetch(RESEND_ENDPOINT, {
+        method: "POST",
+        headers: {
+          "Authorization": `Bearer ${apiKey}`,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(body),
+        signal: controller.signal
+      });
+      if (!res.ok) {
+        const detail = await res.json().catch(() => ({}));
+        throw new Error(`HTTP ${res.status}: ${detail.message ?? "unknown"}`);
+      }
+      logger.info("[notify] email: sent");
+      return "sent";
+    } catch (err) {
+      logger.warn(`[notify] email: ${err instanceof Error ? err.message : String(err)}`);
+      return "failed";
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
+};
+
 // src/notify/NotificationSender.ts
 function shouldNotify(channel, stats) {
   if (!channel.enabled) return false;
@@ -12355,6 +12573,18 @@ var NotificationSender = class {
         return this.post(name, channel.url, payload, result);
       })
     );
+    if (notifyConfig.email) {
+      if (!shouldNotify(notifyConfig.email, reportData.stats)) {
+        result.skipped.push("email");
+      } else {
+        const outcome = await new EmailSender().send(reportData, notifyConfig.email, pdfPaths);
+        if (outcome === "sent") result.sent.push("email");
+        else if (outcome === "failed") result.failed.push("email");
+        else result.skipped.push("email");
+      }
+    } else {
+      result.skipped.push("email");
+    }
     return result;
   }
   async post(name, url, payload, result) {
@@ -12386,7 +12616,7 @@ var PdfReporter = class {
     this.dataCollector = new DataCollector();
     this.pdfGenerator = new PdfGenerator();
     this.options = parseOptions(rawOptions);
-    const version = true ? "0.0.1" : "0.x";
+    const version = true ? "0.2.0" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,
@@ -12442,6 +12672,7 @@ var PdfReporter = class {
     const historyPath = resolveHistoryPath(this.options, this.cwd);
     const hm = new HistoryManager(historyPath);
     const suffix = Math.random().toString(36).padEnd(8, "0").slice(2, 6);
+    const flakyTests = collectFlakyTests(collected.projects);
     const entry = {
       runId: `${(/* @__PURE__ */ new Date()).toISOString()}-${suffix}`,
       timestamp: Date.now(),
@@ -12451,9 +12682,13 @@ var PdfReporter = class {
       failed: collected.stats.failed,
       flaky: collected.stats.flaky,
       duration: collected.stats.duration,
-      verdict: deriveVerdict(collected.stats)
+      verdict: deriveVerdict(collected.stats),
+      flakyTests
     };
     const entries = hm.append(entry, this.options.historySize);
+    this._populateHistoryCharts(entries, collected);
+  }
+  _populateHistoryCharts(entries, collected) {
     if (entries.length >= 2) {
       collected.charts.trend = {
         entries: entries.map((e) => ({
@@ -12467,11 +12702,17 @@ var PdfReporter = class {
         delta: entries[0].passRate - entries[1].passRate
       };
     }
+    if (this.options.flakinessTopN > 0) {
+      const table = computeTopN(entries, this.options.flakinessTopN);
+      if (table.length > 0) {
+        collected.charts.flakinessTable = table;
+      }
+    }
   }
   _buildReportData(collected, licenseInfo) {
     const { projects, stats, failures, environment, charts } = collected;
     const projectName = this.options.projectName ?? this.resolveProjectName();
-    const firstTemplate = Array.isArray(this.options.template) ? this.options.template[0] : this.options.template;
+    const firstTemplate = this.options.templatePath?.length ? "detailed" : Array.isArray(this.options.template) ? this.options.template[0] : this.options.template;
     return {
       meta: {
         title: this.options.reportTitle,
@@ -12507,7 +12748,7 @@ var PdfReporter = class {
   }
   resolveProjectName() {
     try {
-      const pkgPath = import_path11.default.resolve(process.cwd(), "package.json");
+      const pkgPath = import_path12.default.resolve(process.cwd(), "package.json");
       const pkg = require(pkgPath);
       return pkg.name ?? "Playwright Tests";
     } catch {
@@ -12529,6 +12770,15 @@ var PdfReporter = class {
         logger.warn(`open: true \u2014 could not open ${pdfPath}: ${err.message}`);
       });
       child.unref();
+      if (platform === "win32") {
+        child.on("close", (code) => {
+          if (code !== 0 && code !== null) {
+            logger.warn(
+              `open: true \u2014 shell-open exited with code ${code}. No PDF viewer may be registered for .pdf files on this machine. File is at: ${pdfPath}`
+            );
+          }
+        });
+      }
     } catch (err) {
       logger.warn(`open: true \u2014 unexpected error: ${err.message}`);
     }
@@ -12548,10 +12798,28 @@ function deriveVerdict(stats) {
 }
 function resolveHistoryPath(options, cwd) {
   if (options.historyFile) {
-    return import_path11.default.isAbsolute(options.historyFile) ? options.historyFile : import_path11.default.resolve(cwd, options.historyFile);
+    return import_path12.default.isAbsolute(options.historyFile) ? options.historyFile : import_path12.default.resolve(cwd, options.historyFile);
   }
   const projectKey = import_crypto7.default.createHash("sha256").update(cwd + (options.outputFile ?? "")).digest("hex").slice(0, 8);
-  return import_path11.default.join(import_os6.default.homedir(), ".reportforge", projectKey, "history.json");
+  return import_path12.default.join(import_os6.default.homedir(), ".reportforge", projectKey, "history.json");
+}
+function flattenSuiteNodes(suites) {
+  return suites.flatMap((s) => [s, ...flattenSuiteNodes(s.suites)]);
+}
+function collectFlakyTests(projects) {
+  const seen = /* @__PURE__ */ new Set();
+  const result = [];
+  for (const project of projects) {
+    for (const suite of flattenSuiteNodes(project.suites)) {
+      for (const test of suite.tests) {
+        if (test.status === "flaky" && !seen.has(test.id)) {
+          seen.add(test.id);
+          result.push({ id: test.id, title: test.fullTitle });
+        }
+      }
+    }
+  }
+  return result;
 }
 
 // src/index.ts