@arghajit/dummy 0.3.37 → 0.3.39

package/dist/lib/report-types.d.ts

@@ -4,5 +4,7 @@ export interface PlaywrightPulseReport {
     results: TestResult[];
     metadata: {
         generatedAt: string;
+        reportDescription?: string;
+        logo?: string;
     };
 }

package/dist/reporter/playwright-pulse-reporter.d.ts

@@ -10,6 +10,7 @@ export declare class PlaywrightPulseReporter implements Reporter {
     private outputDir;
     private attachmentsDir;
     private baseOutputFile;
+    private individualReportsSubDir;
     private isSharded;
     private shardIndex;
     private resetOnEachRun;
@@ -46,6 +47,5 @@ export declare class PlaywrightPulseReporter implements Reporter {
     private _cleanupStaleRunReports;
     private _ensureDirExists;
     onEnd(result: FullResult): Promise<void>;
-    private _mergeAllRunReports;
 }
 export default PlaywrightPulseReporter;

package/dist/reporter/playwright-pulse-reporter.js

@@ -64,20 +64,21 @@ const convertStatus = (status, testCase) => {
 };
 const TEMP_SHARD_FILE_PREFIX = ".pulse-shard-results-";
 const ATTACHMENTS_SUBDIR = "attachments";
-const INDIVIDUAL_REPORTS_SUBDIR = "pulse-results";
 class PlaywrightPulseReporter {
     constructor(options = {}) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         this.results = [];
         this._pendingTestEnds = [];
         this.baseOutputFile = "playwright-pulse-report.json";
+        this.individualReportsSubDir = "pulse-results";
         this.isSharded = false;
         this.shardIndex = undefined;
         this.options = options;
         this.baseOutputFile = (_a = options.outputFile) !== null && _a !== void 0 ? _a : this.baseOutputFile;
         this.outputDir = (_b = options.outputDir) !== null && _b !== void 0 ? _b : "pulse-report";
+        this.individualReportsSubDir = (_c = options.individualReportsSubDir) !== null && _c !== void 0 ? _c : "pulse-results";
         this.attachmentsDir = path.join(this.outputDir, ATTACHMENTS_SUBDIR);
-        this.resetOnEachRun = (_c = options.resetOnEachRun) !== null && _c !== void 0 ? _c : true;
+        this.resetOnEachRun = (_d = options.resetOnEachRun) !== null && _d !== void 0 ? _d : true;
     }
     printsToStdio() {
         return this.shardIndex === undefined || this.shardIndex === 0;
@@ -488,7 +489,11 @@ class PlaywrightPulseReporter {
         return {
             run: finalRunData,
             results: properlyTypedResults,
-            metadata: { generatedAt: new Date().toISOString() },
+            metadata: {
+                generatedAt: new Date().toISOString(),
+                reportDescription: this.options.reportDescription,
+                logo: this.options.logo,
+            },
         };
     }
     async _cleanupTemporaryFiles() {
@@ -520,7 +525,7 @@ class PlaywrightPulseReporter {
      * Cleaning up at `onBegin` time guarantees each run starts with a fresh slate.
      */
     async _cleanupStaleRunReports() {
-        const pulseResultsDir = path.join(this.outputDir, INDIVIDUAL_REPORTS_SUBDIR);
+        const pulseResultsDir = path.join(this.outputDir, this.individualReportsSubDir);
         try {
             const files = await fs.readdir(pulseResultsDir);
             const staleFiles = files.filter((f) => f.startsWith("playwright-pulse-report-") && f.endsWith(".json"));
@@ -588,7 +593,11 @@ class PlaywrightPulseReporter {
                 run: runData,
                 // Use the de-duplicated results
                 results: finalResults,
-                metadata: { generatedAt: new Date().toISOString() },
+                metadata: {
+                    generatedAt: new Date().toISOString(),
+                    reportDescription: this.options.reportDescription,
+                    logo: this.options.logo,
+                },
             };
         }
         if (!finalReport) {
@@ -617,7 +626,7 @@ class PlaywrightPulseReporter {
         }
         else {
             // Logic for appending/merging reports
-            const pulseResultsDir = path.join(this.outputDir, INDIVIDUAL_REPORTS_SUBDIR);
+            const pulseResultsDir = path.join(this.outputDir, this.individualReportsSubDir);
             const individualReportPath = path.join(pulseResultsDir, `playwright-pulse-report-${Date.now()}.json`);
             try {
                 await this._ensureDirExists(pulseResultsDir);
@@ -625,111 +634,19 @@ class PlaywrightPulseReporter {
                 if (this.printsToStdio()) {
                     console.log(`PlaywrightPulseReporter: Individual run report for merging written to ${individualReportPath}`);
                 }
-                await this._mergeAllRunReports();
+                // DEFERRED MERGING: 
+                // We do not call _mergeAllRunReports() here anymore when resetOnEachRun is false.
+                // The individual JSON files in pulse-results/ will be collected and merged
+                // into the main JSON when the user next runs one of the report generator commands.
             }
             catch (error) {
-                console.error(`Pulse Reporter: Failed to write or merge report. Error: ${error.message}`);
+                console.error(`Pulse Reporter: Failed to write report. Error: ${error.message}`);
             }
         }
         if (this.isSharded) {
             await this._cleanupTemporaryFiles();
         }
     }
-    async _mergeAllRunReports() {
-        const pulseResultsDir = path.join(this.outputDir, INDIVIDUAL_REPORTS_SUBDIR);
-        const finalOutputPath = path.join(this.outputDir, this.baseOutputFile);
-        let reportFiles;
-        try {
-            const allFiles = await fs.readdir(pulseResultsDir);
-            reportFiles = allFiles.filter((file) => file.startsWith("playwright-pulse-report-") && file.endsWith(".json"));
-        }
-        catch (error) {
-            if (error.code === "ENOENT") {
-                if (this.printsToStdio()) {
-                    console.log(`Pulse Reporter: No individual reports directory found at ${pulseResultsDir}. Skipping merge.`);
-                }
-                return;
-            }
-            console.error(`Pulse Reporter: Error reading report directory ${pulseResultsDir}:`, error);
-            return;
-        }
-        if (reportFiles.length === 0) {
-            if (this.printsToStdio()) {
-                console.log("Pulse Reporter: No matching JSON report files found to merge.");
-            }
-            return;
-        }
-        const allResultsFromAllFiles = [];
-        let latestTimestamp = new Date(0);
-        let lastRunEnvironment = undefined;
-        let totalDuration = 0;
-        for (const file of reportFiles) {
-            const filePath = path.join(pulseResultsDir, file);
-            try {
-                const content = await fs.readFile(filePath, "utf-8");
-                const json = JSON.parse(content);
-                if (json.run) {
-                    const runTimestamp = new Date(json.run.timestamp);
-                    if (runTimestamp > latestTimestamp) {
-                        latestTimestamp = runTimestamp;
-                        lastRunEnvironment = json.run.environment || undefined;
-                    }
-                }
-                if (json.results) {
-                    allResultsFromAllFiles.push(...json.results);
-                }
-            }
-            catch (err) {
-                console.warn(`Pulse Reporter: Could not parse report file ${filePath}. Skipping. Error: ${err.message}`);
-            }
-        }
-        // De-duplicate the results from ALL merged files using the helper function
-        const finalMergedResults = this._getFinalizedResults(allResultsFromAllFiles);
-        // Sum the duration from the final, de-duplicated list of tests
-        totalDuration = finalMergedResults.reduce((acc, r) => acc + (r.duration || 0), 0);
-        const combinedRun = {
-            id: `merged-${Date.now()}`,
-            timestamp: latestTimestamp,
-            environment: lastRunEnvironment,
-            // Recalculate counts based on the truly final, de-duplicated list
-            totalTests: finalMergedResults.length,
-            passed: finalMergedResults.filter((r) => (r.final_status || r.status) === "passed").length,
-            failed: finalMergedResults.filter((r) => (r.final_status || r.status) === "failed").length,
-            skipped: finalMergedResults.filter((r) => (r.final_status || r.status) === "skipped").length,
-            flaky: finalMergedResults.filter((r) => (r.final_status || r.status) === "flaky").length,
-            duration: totalDuration,
-        };
-        const finalReport = {
-            run: combinedRun,
-            results: finalMergedResults, // Use the de-duplicated list
-            metadata: {
-                generatedAt: new Date().toISOString(),
-            },
-        };
-        try {
-            await fs.writeFile(finalOutputPath, JSON.stringify(finalReport, (key, value) => {
-                if (value instanceof Date)
-                    return value.toISOString();
-                return value;
-            }, 2));
-            if (this.printsToStdio()) {
-                console.log(`PlaywrightPulseReporter: ✅ Merged report with ${finalMergedResults.length} total results saved to ${finalOutputPath}`);
-            }
-            // Clean up the pulse-results directory after a successful merge
-            try {
-                await fs.rm(pulseResultsDir, { recursive: true, force: true });
-                if (this.printsToStdio()) {
-                    console.log(`PlaywrightPulseReporter: Cleaned up individual reports directory at ${pulseResultsDir}`);
-                }
-            }
-            catch (cleanupErr) {
-                console.warn(`Pulse Reporter: Could not clean up individual reports directory. Error: ${cleanupErr.message}`);
-            }
-        }
-        catch (err) {
-            console.error(`Pulse Reporter: Failed to write final merged report to ${finalOutputPath}. Error: ${err.message}`);
-        }
-    }
 }
 exports.PlaywrightPulseReporter = PlaywrightPulseReporter;
 exports.default = PlaywrightPulseReporter;

package/dist/types/index.d.ts

@@ -81,10 +81,55 @@ export interface TrendDataPoint {
     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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arghajit/dummy",
   "author": "Arghajit Singha",
-  "version": "0.3.37",
+  "version": "0.3.39",
   "description": "A Playwright reporter and dashboard for visualizing test results.",
   "homepage": "https://arghajit47.github.io/playwright-pulse/",
   "repository": {
@@ -40,8 +40,8 @@
     "generate-report": "scripts/generate-report.mjs",
     "merge-pulse-report": "scripts/merge-pulse-report.js",
     "send-email": "scripts/sendReport.mjs",
-    "generate-trend": "scripts/generate-trend.mjs",
     "generate-email-report": "scripts/generate-email-report.mjs",
+    "generate-trend": "scripts/generate-trend.mjs",
     "pulse-logo": "scripts/terminal-logo.mjs"
   },
   "exports": {

package/scripts/config-reader.mjs

@@ -22,159 +22,131 @@ 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*["']([^"']+)["']/);
-
-    if (match && match[1]) {
-      return path.resolve(process.cwd(), match[1]);
-    }
-  } catch (e) {
-    // Ignore text reading errors
-  }
+    const outputDirMatch = fileContent.match(/outputDir:\s*["']([^"']+)["']/);
+    if (outputDirMatch && outputDirMatch[1]) options.outputDir = outputDirMatch[1];
+
+    const outputFileMatch = fileContent.match(/outputFile:\s*["']([^"']+)["']/);
+    if (outputFileMatch && outputFileMatch[1]) options.outputFile = outputFileMatch[1];
+
+    const resetOnEachRunMatch = fileContent.match(/resetOnEachRun:\s*(true|false)/);
+    if (resetOnEachRunMatch) options.resetOnEachRun = resetOnEachRunMatch[1] === "true";
+
+    const individualReportsSubDirMatch = fileContent.match(/individualReportsSubDir:\s*["']([^"']+)["']/);
+    if (individualReportsSubDirMatch && individualReportsSubDirMatch[1]) options.individualReportsSubDir = individualReportsSubDirMatch[1];
+  } 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"))) {
+                  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;
 }