@reportforge/playwright-pdf 0.5.0 → 0.6.0

package/dist/index.js

@@ -10332,6 +10332,113 @@ var DEFAULT_OPTIONS = {
   flakinessTopN: 5
 };
 
+// src/templates/sections.ts
+init_cjs_shims();
+var SECTION_KEYS = [
+  // block toggles
+  "coverPage",
+  "analysisOneliner",
+  "releaseGate",
+  "summary",
+  "charts",
+  "trend",
+  "requirementsMatrix",
+  "ciEnvironment",
+  "suiteBreakdown",
+  "failureDeepDive",
+  "failureAnalysis",
+  "slowTests",
+  "defectLog",
+  // display modifiers
+  "passRate",
+  "fullEnvironment",
+  "retries",
+  "fullFailures",
+  "stackTraces"
+];
+var SECTION_DEFAULTS = {
+  minimal: {
+    coverPage: false,
+    analysisOneliner: false,
+    releaseGate: true,
+    summary: true,
+    charts: false,
+    trend: false,
+    requirementsMatrix: false,
+    ciEnvironment: true,
+    suiteBreakdown: true,
+    failureDeepDive: true,
+    failureAnalysis: false,
+    slowTests: false,
+    defectLog: false,
+    passRate: true,
+    fullEnvironment: false,
+    retries: true,
+    fullFailures: true,
+    stackTraces: true
+  },
+  detailed: {
+    coverPage: false,
+    analysisOneliner: false,
+    releaseGate: true,
+    summary: true,
+    charts: true,
+    trend: true,
+    requirementsMatrix: true,
+    ciEnvironment: true,
+    suiteBreakdown: true,
+    failureDeepDive: true,
+    failureAnalysis: true,
+    slowTests: true,
+    defectLog: true,
+    passRate: true,
+    fullEnvironment: true,
+    retries: true,
+    fullFailures: true,
+    stackTraces: true
+  },
+  executive: {
+    coverPage: true,
+    analysisOneliner: true,
+    releaseGate: true,
+    summary: true,
+    charts: true,
+    trend: true,
+    requirementsMatrix: false,
+    ciEnvironment: true,
+    suiteBreakdown: false,
+    failureDeepDive: true,
+    failureAnalysis: false,
+    slowTests: true,
+    defectLog: false,
+    passRate: true,
+    fullEnvironment: false,
+    retries: false,
+    fullFailures: false,
+    stackTraces: false
+  }
+};
+var SECTION_KEY_SET = new Set(SECTION_KEYS);
+function resolveSections(template, userSections) {
+  const base = SECTION_DEFAULTS[template];
+  if (!userSections) return { ...base };
+  const flat = {};
+  for (const [k, v] of Object.entries(userSections)) {
+    if (v !== void 0 && SECTION_KEY_SET.has(k)) flat[k] = v;
+  }
+  const perTemplateRaw = userSections[template] ?? {};
+  const perTemplate = {};
+  for (const [k, v] of Object.entries(perTemplateRaw)) {
+    if (v !== void 0) perTemplate[k] = v;
+  }
+  const result = { ...base, ...flat, ...perTemplate };
+  if (!result.charts) result.trend = false;
+  return result;
+}
+function allSectionsOn() {
+  return Object.fromEntries(SECTION_KEYS.map((k) => [k, true]));
+}
+
 // src/config/schema.ts
 var hexColor = external_exports.string().regex(
   /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/,
@@ -10364,6 +10471,15 @@ var failureAnalysisConfigSchema = external_exports.object({
   collectUnclassified: external_exports.boolean().default(true),
   autoUpdateModel: external_exports.boolean().default(true)
 }).default({});
+var sectionFlagsShape = Object.fromEntries(
+  SECTION_KEYS.map((k) => [k, external_exports.boolean().optional()])
+);
+var sectionFlagsSchema = external_exports.object(sectionFlagsShape).strict();
+var sectionsSchema = sectionFlagsSchema.extend({
+  minimal: sectionFlagsSchema.optional(),
+  detailed: sectionFlagsSchema.optional(),
+  executive: sectionFlagsSchema.optional()
+}).strict();
 var ReporterOptionsSchema = external_exports.object({
   outputFile: external_exports.string().optional().default(DEFAULT_OPTIONS.outputFile),
   template: external_exports.union([
@@ -10401,7 +10517,8 @@ var ReporterOptionsSchema = external_exports.object({
     ).min(1, "templatePath array must not be empty")
   ]).optional().transform(
     (v) => v === void 0 ? void 0 : Array.isArray(v) ? v : [v]
-  )
+  ),
+  sections: sectionsSchema.optional()
 });
 function parseOptions(raw) {
   const result = ReporterOptionsSchema.safeParse(raw ?? {});
@@ -10993,11 +11110,33 @@ var STRENGTH = {
   strongMinMargin: 0.25
 };
 var STRENGTH_LEVELS = ["weak", "moderate", "strong"];
-var FLAKY_MARGIN = 999;
+var OVERRIDE_MARGIN = 999;
 
 // src/analysis/FailureClusterer.ts
 var MAX_TESTS_PER_CLUSTER = 20;
 var MAX_MESSAGE_CHARS = 200;
+function errorHeader(message) {
+  const beforeCallLog = message.split(/\n\s*Call log:/i)[0];
+  return beforeCallLog.split("\n").filter((line) => !/^\s*[-+]?\s*(?:Expected|Received)\b/i.test(line)).join("\n");
+}
+function isAssertionTimeout(message) {
+  return /Expect "[^"]+" with timeout/.test(message) && /resolved to [1-9]\d* element/.test(message);
+}
+function isNetwork(message) {
+  return /net::ERR_(CONNECTION|NAME_NOT_RESOLVED|INTERNET_DISCONNECTED|SSL|TIMED_OUT|ADDRESS|NETWORK_CHANGED|EMPTY_RESPONSE)|\bECONN(?:REFUSED|RESET)\b|\bENOTFOUND\b|\bEAI_AGAIN\b|getaddrinfo|socket hang up|fetch failed/.test(errorHeader(message));
+}
+function isNavigation(message) {
+  return /net::ERR_(?:ABORTED|TOO_MANY_REDIRECTS)|navigation interrupted|interrupted by (?:a|another) navigation|because of a navigation|no history entry|page crashed|Execution context was destroyed|frame was detached/.test(errorHeader(message));
+}
+function isLocatorNotFound(message) {
+  return /strict mode violation|resolved to 0 element|element not found|not attached to the DOM|No node found for selector|no element matches|Unable to find an element/i.test(errorHeader(message));
+}
+var MESSAGE_RULES = [
+  [isAssertionTimeout, "assertion"],
+  [isNavigation, "navigation"],
+  [isNetwork, "network"],
+  [isLocatorNotFound, "locator-not-found"]
+];
 function strengthOf(margin) {
   if (margin >= STRENGTH.strongMinMargin) return "strong";
   if (margin >= STRENGTH.moderateMinMargin) return "moderate";
@@ -11020,11 +11159,15 @@ function representativeMessage(message) {
   return firstLine.length > MAX_MESSAGE_CHARS ? `${firstLine.slice(0, MAX_MESSAGE_CHARS)}\u2026` : firstLine;
 }
 function classifyOne(f, model) {
+  const frame = topFrame(f.error.stack);
   if (f.retryHistory.some((r) => r.status === "passed")) {
-    return { category: "flaky-by-retry", margin: FLAKY_MARGIN, failure: f, frame: topFrame(f.error.stack) };
+    return { category: "flaky-by-retry", margin: OVERRIDE_MARGIN, failure: f, frame };
+  }
+  for (const [match, category] of MESSAGE_RULES) {
+    if (match(f.error.message)) return { category, margin: OVERRIDE_MARGIN, failure: f, frame };
   }
   const { label, margin } = classify(model, classifyInput(f));
-  return { category: label, margin, failure: f, frame: topFrame(f.error.stack) };
+  return { category: label, margin, failure: f, frame };
 }
 function classifyAll(failures, model) {
   return failures.map((f) => classifyOne(f, model));
@@ -11884,11 +12027,26 @@ function formatDuration(ms) {
 }
 
 // src/templates/engine.ts
+function jsonForInlineScript(value) {
+  return JSON.stringify(value).replace(/<\//g, "<\\/");
+}
+function deriveOptions(s) {
+  return {
+    showCharts: s.charts,
+    showTrend: s.trend,
+    showStackTraces: s.stackTraces,
+    showFullEnvironment: s.fullEnvironment,
+    showPassRate: s.passRate,
+    showRetries: s.retries,
+    showFullFailures: s.fullFailures
+  };
+}
 var TemplateEngine = class {
   constructor() {
     this.chartjsInline = "";
     this.fontsBundleCss = "";
     this.customTemplateCache = /* @__PURE__ */ new Map();
+    this.styleCache = /* @__PURE__ */ new Map();
     this.handlebars = import_handlebars.default.create();
     this.templatesDir = import_path3.default.resolve(__dirname, "templates");
     if (!import_fs4.default.existsSync(this.templatesDir)) {
@@ -11908,14 +12066,14 @@ var TemplateEngine = class {
   setChartjsBundle(inline) {
     this.chartjsInline = inline;
   }
-  render(data, template) {
+  render(data, template, userSections) {
     const layoutPath = import_path3.default.join(this.templatesDir, "layouts", `${template}.hbs`);
     if (!import_fs4.default.existsSync(layoutPath)) {
       throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
     }
     const layoutSource = import_fs4.default.readFileSync(layoutPath, "utf8");
     const compiledLayout = this.handlebars.compile(layoutSource);
-    const ctx = this.buildContext(data, template);
+    const ctx = this.buildContext(data, template, userSections);
     return compiledLayout(ctx);
   }
   renderFromPath(data, filePath) {
@@ -11930,17 +12088,11 @@ var TemplateEngine = class {
     return compiledFn(this.buildCustomContext(data));
   }
   buildCustomContext(data) {
+    const sections = allSectionsOn();
     return {
       ...data,
-      options: {
-        showCharts: true,
-        showTrend: true,
-        showStackTraces: true,
-        showFullEnvironment: true,
-        showPassRate: true,
-        showRetries: true,
-        showFullFailures: true
-      },
+      options: deriveOptions(sections),
+      sections,
       tagGroups: this.buildTagGroups(data),
       slowTests: this.buildSlowTests(data),
       baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
@@ -11948,47 +12100,20 @@ var TemplateEngine = class {
       chartjsScript: this.buildChartjsScript()
     };
   }
-  buildContext(data, template) {
+  buildContext(data, template, userSections) {
     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,
-        showRetries: true,
-        showFullFailures: true
-      },
-      detailed: {
-        showCharts: true,
-        showTrend: true,
-        showStackTraces: true,
-        showFullEnvironment: true,
-        showPassRate: true,
-        showRetries: true,
-        showFullFailures: true
-      },
-      executive: {
-        showCharts: true,
-        showTrend: true,
-        showStackTraces: false,
-        showFullEnvironment: false,
-        showPassRate: true,
-        showRetries: false,
-        showFullFailures: false
-      }
-    };
-    const chartjsScript = this.buildChartjsScript();
+    const sections = resolveSections(template, userSections);
+    const options = deriveOptions(sections);
     return {
       ...data,
-      options: optionsMap[template],
+      options,
+      sections,
       tagGroups: this.buildTagGroups(data),
       slowTests: this.buildSlowTests(data),
       baseCSS,
       templateCSS,
-      chartjsScript
+      chartjsScript: this.buildChartjsScript()
     };
   }
   buildChartjsScript() {
@@ -12036,9 +12161,12 @@ var TemplateEngine = class {
     return tests.sort((a, b) => b.durationMs - a.durationMs).slice(0, 10);
   }
   readStyle(filename) {
+    const cached = this.styleCache.get(filename);
+    if (cached !== void 0) return cached;
     const stylePath = import_path3.default.join(this.templatesDir, "styles", filename);
-    if (!import_fs4.default.existsSync(stylePath)) return "";
-    return import_fs4.default.readFileSync(stylePath, "utf8");
+    const css = import_fs4.default.existsSync(stylePath) ? import_fs4.default.readFileSync(stylePath, "utf8") : "";
+    this.styleCache.set(filename, css);
+    return css;
   }
   registerPartials() {
     const partialsDir = import_path3.default.join(this.templatesDir, "partials");
@@ -12099,7 +12227,7 @@ var TemplateEngine = class {
         if (!Array.isArray(arr)) return "";
         const values = arr.map((item) => {
           const v = item[key];
-          return typeof v === "string" ? JSON.stringify(v) : String(v ?? 0);
+          return typeof v === "string" ? jsonForInlineScript(v) : String(v ?? 0);
         });
         return new import_handlebars.default.SafeString(values.join(","));
       }
@@ -12110,7 +12238,7 @@ var TemplateEngine = class {
     this.handlebars.registerHelper("absFixed", (n) => Math.abs(n).toFixed(0));
     this.handlebars.registerHelper(
       "safeJsonData",
-      (value) => new import_handlebars.default.SafeString(JSON.stringify(value).replace(/<\//g, "<\\/"))
+      (value) => new import_handlebars.default.SafeString(jsonForInlineScript(value))
     );
     this.handlebars.registerHelper(
       "reverse",
@@ -12593,6 +12721,12 @@ var PdfGenerator = class {
       `Compression: level=${compression.effective} jpeg-q=${compression.quality} max-w=${compression.maxWidth}px inline-failures\u2264${compression.maxInlineFailures}`
     );
     const outputPaths = [];
+    if (options.sections !== void 0) {
+      const hasCustom = sources.some((s) => s.kind !== "builtin");
+      if (hasCustom) {
+        logger.warn('[reportforge] "sections" applies to built-in templates only; it is ignored for custom templatePath templates.');
+      }
+    }
     const { page } = await this.browserManager.launch(options.puppeteerExecutablePath);
     try {
       for (const source of sources) {
@@ -12700,13 +12834,13 @@ var PdfGenerator = class {
     }
     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 html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, options.sections) : 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 = source.kind === "builtin" ? source.id !== "minimal" : true;
+      const showCharts = source.kind === "builtin" ? resolveSections(source.id, options.sections).charts : true;
       await this.chartRenderer.waitForCharts(page, showCharts);
       logger.info(`Generating PDF \u2192 ${import_path8.default.relative(process.cwd(), outputPath)}`);
       await page.pdf({
@@ -13097,7 +13231,7 @@ var PdfReporter = class {
     this.dataCollector = new DataCollector();
     this.pdfGenerator = new PdfGenerator();
     this.options = parseOptions(rawOptions);
-    const version = true ? "0.5.0" : "0.x";
+    const version = true ? "0.6.0" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,