@arghajit/playwright-pulse-report 0.3.3 → 0.3.5

package/dist/types/index.d.ts

@@ -1,5 +1,4 @@
-import type { LucideIcon } from "lucide-react";
-export type TestStatus = "passed" | "failed" | "skipped" | "expected-failure" | "unexpected-success" | "explicitly-skipped";
+export type TestStatus = "passed" | "failed" | "skipped" | "expected-failure" | "unexpected-success" | "explicitly-skipped" | "flaky";
 export interface TestStep {
     id: string;
     title: string;
@@ -11,6 +10,7 @@ export interface TestStep {
     errorMessage?: string;
     stackTrace?: string;
     codeLocation?: string;
+    codeSnippet?: string;
     isHook?: boolean;
     hookType?: "before" | "after";
     steps?: TestStep[];
@@ -35,6 +35,8 @@ export interface TestResult {
     suiteName?: string;
     runId: string;
     browser: string;
+    outcome?: string;
+    final_status?: TestStatus;
     screenshots?: string[];
     videoPath?: string[];
     tracePath?: string;
@@ -58,6 +60,7 @@ export interface TestResult {
             column: number;
         };
     }[];
+    retryHistory?: TestResult[];
 }
 export interface TestRun {
     id: string;
@@ -66,26 +69,67 @@ export interface TestRun {
     passed: number;
     failed: number;
     skipped: number;
+    flaky?: number;
     duration: number;
-    environment?: EnvDetails;
+    environment?: EnvDetails | EnvDetails[];
 }
 export interface TrendDataPoint {
     date: string;
     passed: number;
     failed: number;
     skipped: number;
-}
-export interface SummaryMetric {
-    label: string;
-    value: string | number;
-    icon: LucideIcon;
-    color?: string;
+    flaky?: number;
 }
 export interface PlaywrightPulseReporterOptions {
+    /**
+     * The name of the output JSON file. Kindly do not change.
+     * @default "playwright-pulse-report.json"
+     */
     outputFile?: string;
+    /**
+     * The directory where the report files will be generated.
+     *
+     * Mostly useful while using sharding
+     *
+     * @default "pulse-report"
+     */
     outputDir?: string;
+    /**
+     * Whether to embed images directly as base64 strings in the report.
+     * @default false
+     */
     base64Images?: boolean;
+    /**
+     * Whether to reset the output directory before each run.
+     *
+     * Mostly useful while running multiple test suites in a single run with `&&` operator.
+     *
+     * example: `npx playwright test test1.spec.ts && npx playwright test test2.spec.ts`
+     *
+     * If `resetOnEachRun` is set to `false`, then the report of `test2.spec.ts` will be merged with `test1.spec.ts` report.
+     *
+     * @default true
+     */
     resetOnEachRun?: boolean;
+    /**
+     * A custom description to embed or display in the report.
+     *
+     * If not added, the component will not appear in the html reports
+     */
+    reportDescription?: string;
+    /**
+     * Path to a custom logo image file to use in the report, which will be displayed in the header of the html report's logo and favicon.
+     *
+     * If not added, the default logo will be used.
+     */
+    logo?: string;
+    /**
+     * The subdirectory within `outputDir` where individual run reports are stored.
+     * Only used when `resetOnEachRun` is `false`.
+     *
+     * @default "pulse-results"
+     */
+    individualReportsSubDir?: string;
 }
 export interface EnvDetails {
     host: string;

package/dist/utils/compression-utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Compression utilities for images
+ * Uses sharp for image compression (works cross-platform with no external dependencies)
+ */
+/**
+ * Compress an image file in-place
+ * @param filePath - Absolute path to the image file
+ * @param options - Compression options
+ */
+export declare function compressImage(filePath: string, options?: {
+    quality?: number;
+}): Promise<void>;
+/**
+ * Compress an attachment file (auto-detects type)
+ * Note: Only compresses images. Videos are already compressed by Playwright.
+ * @param filePath - Absolute path to the file
+ * @param contentType - MIME content type
+ */
+export declare function compressAttachment(filePath: string, contentType: string): Promise<void>;

package/dist/utils/compression-utils.js

@@ -0,0 +1,112 @@
+"use strict";
+// src/utils/compression-utils.ts
+/**
+ * Compression utilities for images
+ * Uses sharp for image compression (works cross-platform with no external dependencies)
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compressImage = compressImage;
+exports.compressAttachment = compressAttachment;
+const fs = __importStar(require("fs/promises"));
+const path = __importStar(require("path"));
+/**
+ * Compress an image file in-place
+ * @param filePath - Absolute path to the image file
+ * @param options - Compression options
+ */
+async function compressImage(filePath, options = {}) {
+    try {
+        const sharp = require('sharp');
+        const quality = options.quality || 75;
+        const ext = path.extname(filePath).toLowerCase();
+        // Read original file
+        const imageBuffer = await fs.readFile(filePath);
+        let compressedBuffer;
+        if (ext === '.png') {
+            // Compress PNG
+            compressedBuffer = await sharp(imageBuffer)
+                .png({ quality, compressionLevel: 9 })
+                .toBuffer();
+        }
+        else if (ext === '.jpg' || ext === '.jpeg') {
+            // Compress JPEG
+            compressedBuffer = await sharp(imageBuffer)
+                .jpeg({ quality, mozjpeg: true })
+                .toBuffer();
+        }
+        else if (ext === '.webp') {
+            // Compress WebP
+            compressedBuffer = await sharp(imageBuffer)
+                .webp({ quality })
+                .toBuffer();
+        }
+        else if (ext === '.gif') {
+            // Compress GIF
+            compressedBuffer = await sharp(imageBuffer)
+                .gif()
+                .toBuffer();
+        }
+        else if (ext === '.tiff' || ext === '.tif') {
+            // Compress TIFF
+            compressedBuffer = await sharp(imageBuffer)
+                .tiff({ quality, compression: 'lzw' })
+                .toBuffer();
+        }
+        else {
+            // Unsupported format, skip compression
+            return;
+        }
+        // Only overwrite if compression actually reduced size
+        if (compressedBuffer.length < imageBuffer.length) {
+            await fs.writeFile(filePath, compressedBuffer);
+        }
+    }
+    catch (error) {
+        // File remains unchanged
+    }
+}
+/**
+ * Compress an attachment file (auto-detects type)
+ * Note: Only compresses images. Videos are already compressed by Playwright.
+ * @param filePath - Absolute path to the file
+ * @param contentType - MIME content type
+ */
+async function compressAttachment(filePath, contentType) {
+    if (contentType.startsWith('image/')) {
+        await compressImage(filePath, { quality: 75 });
+    }
+    // Videos are skipped - already compressed by Playwright as WebM
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arghajit/playwright-pulse-report",
   "author": "Arghajit Singha",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "A Playwright reporter and dashboard for visualizing test results.",
   "homepage": "https://arghajit47.github.io/playwright-pulse/",
   "repository": {
@@ -23,7 +23,8 @@
     "email",
     "playwright-report",
     "pulse",
-    "ai-failure-analysis"
+    "ai-failure-analysis",
+    "pulse-report"
   ],
   "main": "dist/reporter/index.js",
   "types": "dist/reporter/index.d.ts",
@@ -34,12 +35,14 @@
   ],
   "license": "MIT",
   "bin": {
+    "logo": "scripts/terminal-logo.mjs",
     "generate-pulse-report": "scripts/generate-static-report.mjs",
     "generate-report": "scripts/generate-report.mjs",
-    "merge-pulse-report": "scripts/merge-pulse-report.js",
+    "merge-pulse-report": "scripts/merge-pulse-report.mjs",
     "send-email": "scripts/sendReport.mjs",
+    "generate-email-report": "scripts/generate-email-report.mjs",
     "generate-trend": "scripts/generate-trend.mjs",
-    "generate-email-report": "scripts/generate-email-report.mjs"
+    "pulse-logo": "scripts/terminal-logo.mjs"
   },
   "exports": {
     ".": {
@@ -53,7 +56,7 @@
     "prepublishOnly": "npm run build:reporter",
     "report:static": "node ./scripts/generate-static-report.mjs",
     "report:generate": "node ./scripts/generate-report.mjs",
-    "report:merge": "node ./scripts/merge-pulse-report.js",
+    "report:merge": "node ./scripts/merge-pulse-report.mjs",
     "report:email": "node ./scripts/sendReport.mjs",
     "report:minify": "node ./scripts/generate-email-report.mjs",
     "generate-trend": "node ./scripts/generate-trend.mjs"
@@ -65,12 +68,13 @@
     "d3": "^7.9.0",
     "date-fns": "^3.6.0",
     "dotenv": "^16.5.0",
-    "highcharts": "^12.2.0",
+    "highcharts": "^12.5.0",
     "jsdom": "^26.1.0",
-    "lucide-react": "^0.475.0",
     "node-fetch": "^3.3.2",
-    "nodemailer": "^7.0.3",
+    "nodemailer": "^7.0.12",
     "patch-package": "^8.0.0",
+    "readable-stream": "^4.7.0",
+    "sharp": "^0.34.5",
     "ua-parser-js": "^1.0.41",
     "zod": "^3.24.2"
   },
@@ -87,6 +91,11 @@
     "@playwright/test": ">=1.40.0"
   },
   "overrides": {
-    "glob": "^13.0.0"
+    "glob": "^13.0.6",
+    "minimatch": "^10.2.1",
+    "ajv": "^8.18.0",
+    "isarray": "^2.0.5",
+    "safe-buffer": "^5.2.1",
+    "string_decoder": "^1.3.0"
   }
 }

package/scripts/config-reader.mjs

@@ -22,159 +22,149 @@ async function findPlaywrightConfig() {
   return { path: null, exists: false };
 }
 
-async function extractOutputDirFromConfig(configPath) {
+async function extractReporterOptionsFromConfig(configPath) {
   let fileContent = "";
   try {
     fileContent = fs.readFileSync(configPath, "utf-8");
   } catch (e) {
-    // If we can't read the file, we can't parse or import it.
-    return null;
+    return {};
   }
 
+  const options = {};
+
   // 1. Strategy: Text Parsing (Safe & Fast)
-  // We try to read the file as text first. This finds the outputDir without
-  // triggering any Node.js warnings or errors.
   try {
-    // Regex matches: outputDir: "value" or outputDir: 'value'
-    const match = fileContent.match(/outputDir:\s*["']([^"']+)["']/);
+    // Find the Pulse/Dummy reporter block
+    // It usually looks like ["@arghajit/playwright-pulse-report", { ... }] or ["playwright-pulse-report", { ... }]
+    const reporterBlockRegex = /\[\s*["'](?:@arghajit\/)?(?:playwright-pulse-report|dummy)["']\s*,\s*(\{[\s\S]*?\})\s*,?\s*\]/g;
+    let match;
+    while ((match = reporterBlockRegex.exec(fileContent)) !== null) {
+      const block = match[1];
+      
+      const outputDirMatch = block.match(/outputDir:\s*["']([^"']+)["']/);
+      if (outputDirMatch && outputDirMatch[1]) options.outputDir = outputDirMatch[1];
+
+      const outputFileMatch = block.match(/outputFile:\s*["']([^"']+)["']/);
+      if (outputFileMatch && outputFileMatch[1]) options.outputFile = outputFileMatch[1];
+
+      const resetOnEachRunMatch = block.match(/resetOnEachRun:\s*(true|false)/);
+      if (resetOnEachRunMatch) options.resetOnEachRun = resetOnEachRunMatch[1] === "true";
+
+      const individualReportsSubDirMatch = block.match(/individualReportsSubDir:\s*["']([^"']+)["']/);
+      if (individualReportsSubDirMatch && individualReportsSubDirMatch[1]) options.individualReportsSubDir = individualReportsSubDirMatch[1];
+      
+      // If we found any Pulse-specific options, we're likely in the right block
+      if (Object.keys(options).length > 0) break;
+    }
 
-    if (match && match[1]) {
-      return path.resolve(process.cwd(), match[1]);
+    // Fallback for global outputDir if not found in reporter block
+    if (!options.outputDir) {
+      const globalOutputDirMatch = fileContent.match(/outputDir:\s*["']([^"']+)["']/);
+      if (globalOutputDirMatch && globalOutputDirMatch[1]) options.outputDir = globalOutputDirMatch[1];
     }
-  } catch (e) {
-    // Ignore text reading errors
-  }
+  } catch (e) { }
+
+  // 2. Safety Check and Dynamic Import
+  if (Object.keys(options).length < 3) {
+    // Check if we can safely import()
+    let canImport = true;
+    if (configPath.endsWith(".js")) {
+      let isModulePackage = false;
+      try {
+        const pkgPath = path.resolve(process.cwd(), "package.json");
+        if (fs.existsSync(pkgPath)) {
+          const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+          isModulePackage = pkg.type === "module";
+        }
+      } catch (e) {}
 
-  // 2. Safety Check: Detect ESM in CJS to Prevent Node Warnings
-  // The warning "To load an ES module..." happens when we try to import()
-  // a .js file containing ESM syntax (import/export) in a CJS package.
-  // We explicitly check for this and ABORT the import if found.
-  if (configPath.endsWith(".js")) {
-    let isModulePackage = false;
-    try {
-      const pkgPath = path.resolve(process.cwd(), "package.json");
-      if (fs.existsSync(pkgPath)) {
-        const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
-        isModulePackage = pkg.type === "module";
-      }
-    } catch (e) {}
-
-    if (!isModulePackage) {
-      // Heuristic: Check for ESM syntax (import/export at start of lines)
-      const hasEsmSyntax =
-        /^\s*import\s+/m.test(fileContent) ||
-        /^\s*export\s+/m.test(fileContent);
-
-      if (hasEsmSyntax) {
-        // We found ESM syntax in a .js file within a CJS project.
-        // Attempting to import this WILL trigger the Node.js warning.
-        // Since regex failed to find outputDir, and we can't import safely, we abort now.
-        return null;
+      if (!isModulePackage) {
+        const hasEsmSyntax = /^\s*import\s+/m.test(fileContent) || /^\s*export\s+/m.test(fileContent);
+        if (hasEsmSyntax) canImport = false;
       }
     }
-  }
 
-  // 3. Strategy: Dynamic Import
-  // If we passed the safety check, we try to import the config.
-  try {
-    let config;
-    const configDir = dirname(configPath);
-    const originalDirname = global.__dirname;
-    const originalFilename = global.__filename;
-
-    try {
-      global.__dirname = configDir;
-      global.__filename = configPath;
+    if (canImport) {
+      try {
+        let config;
+        const configDir = dirname(configPath);
+        const originalDirname = global.__dirname;
+        const originalFilename = global.__filename;
 
-      if (configPath.endsWith(".ts")) {
         try {
-          const { register } = await import("node:module");
-          const { pathToFileURL } = await import("node:url");
-          register("ts-node/esm", pathToFileURL("./"));
-          config = await import(pathToFileURL(configPath).href);
-        } catch (tsError) {
-          const tsNode = await import("ts-node");
-          tsNode.register({
-            transpileOnly: true,
-            compilerOptions: { module: "commonjs" },
-          });
-          config = require(configPath);
-        }
-      } else {
-        // Try dynamic import for JS/MJS
-        config = await import(pathToFileURL(configPath).href);
-      }
-
-      // Handle Default Export
-      if (config && config.default) {
-        config = config.default;
-      }
+          global.__dirname = configDir;
+          global.__filename = configPath;
+
+          if (configPath.endsWith(".ts")) {
+            try {
+              const { register } = await import("node:module");
+              const { pathToFileURL } = await import("node:url");
+              register("ts-node/esm", pathToFileURL("./"));
+              config = await import(pathToFileURL(configPath).href);
+            } catch (tsError) {
+              const tsNode = await import("ts-node");
+              tsNode.register({ transpileOnly: true, compilerOptions: { module: "commonjs" } });
+              config = require(configPath);
+            }
+          } else {
+            config = await import(pathToFileURL(configPath).href);
+          }
 
-      if (config) {
-        // Check for Reporter Config
-        if (config.reporter) {
-          const reporters = Array.isArray(config.reporter)
-            ? config.reporter
-            : [config.reporter];
-
-          for (const reporter of reporters) {
-            const reporterName = Array.isArray(reporter)
-              ? reporter[0]
-              : reporter;
-            const reporterOptions = Array.isArray(reporter)
-              ? reporter[1]
-              : null;
-
-            if (
-              typeof reporterName === "string" &&
-              (reporterName.includes("playwright-pulse-report") ||
-                reporterName.includes("@arghajit/playwright-pulse-report") ||
-                reporterName.includes("@arghajit/dummy"))
-            ) {
-              if (reporterOptions && reporterOptions.outputDir) {
-                return path.resolve(process.cwd(), reporterOptions.outputDir);
+          if (config && config.default) config = config.default;
+
+          if (config) {
+            if (config.reporter) {
+              const reporters = Array.isArray(config.reporter) ? config.reporter : [config.reporter];
+              for (const reporter of reporters) {
+                const reporterName = Array.isArray(reporter) ? reporter[0] : reporter;
+                const reporterOptions = Array.isArray(reporter) ? reporter[1] : null;
+
+                if (typeof reporterName === "string" && 
+                   (reporterName.includes("playwright-pulse-report") || 
+                    reporterName.includes("@arghajit/playwright-pulse-report") ||
+                    reporterName.includes("@arghajit/dummy"))) {
+                  if (reporterOptions) {
+                    if (reporterOptions.outputDir) options.outputDir = reporterOptions.outputDir;
+                    if (reporterOptions.outputFile) options.outputFile = reporterOptions.outputFile;
+                    if (reporterOptions.resetOnEachRun !== undefined) options.resetOnEachRun = reporterOptions.resetOnEachRun;
+                    if (reporterOptions.individualReportsSubDir) options.individualReportsSubDir = reporterOptions.individualReportsSubDir;
+                  }
+                }
               }
             }
+            if (config.outputDir && !options.outputDir) options.outputDir = config.outputDir;
           }
+        } finally {
+          global.__dirname = originalDirname;
+          global.__filename = originalFilename;
         }
-
-        // Check for Global outputDir
-        if (config.outputDir) {
-          return path.resolve(process.cwd(), config.outputDir);
-        }
-      }
-    } finally {
-      // Clean up globals
-      global.__dirname = originalDirname;
-      global.__filename = originalFilename;
+      } catch (error) {}
     }
-  } catch (error) {
-    // SILENT CATCH: Do NOT log anything here.
-    return null;
   }
 
-  return null;
+  return options;
 }
 
-export async function getOutputDir(customOutputDirFromArgs = null) {
-  if (customOutputDirFromArgs) {
-    console.log(`Using custom outputDir from CLI: ${customOutputDirFromArgs}`);
-    return path.resolve(process.cwd(), customOutputDirFromArgs);
-  }
-
+export async function getReporterConfig(customOutputDirFromArgs = null) {
   const { path: configPath, exists } = await findPlaywrightConfig();
-  console.log(
-    `Config file search result: ${exists ? configPath : "not found"}`
-  );
+  let options = {};
 
   if (exists) {
-    const outputDirFromConfig = await extractOutputDirFromConfig(configPath);
-    if (outputDirFromConfig) {
-      console.log(`Using outputDir from config: ${outputDirFromConfig}`);
-      return outputDirFromConfig;
-    }
+    options = await extractReporterOptionsFromConfig(configPath);
   }
 
-  console.log(`Using default outputDir: ${DEFAULT_OUTPUT_DIR}`);
-  return path.resolve(process.cwd(), DEFAULT_OUTPUT_DIR);
+  const outputDir = customOutputDirFromArgs 
+    ? path.resolve(process.cwd(), customOutputDirFromArgs)
+    : path.resolve(process.cwd(), options.outputDir || DEFAULT_OUTPUT_DIR);
+
+  const outputFile = options.outputFile || "playwright-pulse-report.json";
+  const resetOnEachRun = options.resetOnEachRun !== undefined ? options.resetOnEachRun : true;
+  const individualReportsSubDir = options.individualReportsSubDir || "pulse-results";
+
+  return { outputDir, outputFile, resetOnEachRun, individualReportsSubDir };
+}
+
+export async function getOutputDir(customOutputDirFromArgs = null) {
+  const config = await getReporterConfig(customOutputDirFromArgs);
+  return config.outputDir;
 }