@arghajit/dummy 0.1.0-beta-19 → 0.1.0-beta-21

package/README.md

@@ -161,8 +161,8 @@ npx generate-report
 1. Configure `.env`:
 
    ```bash
-   SENDER_EMAIL_1=recipient1@example.com
-   SENDER_EMAIL_2=recipient2@example.com
+   RECIPIENT_EMAIL_1=recipient1@example.com
+   RECIPIENT_EMAIL_2=recipient2@example.com
    # ... up to 5 recipients
    ```
 
@@ -277,7 +277,7 @@ npm install @arghajit/playwright-pulse-report@latest
 
 ---
 
-<img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//pulse-logo.png" alt="pulse dashboard" title="pulse dashboard" height="50px" width="80px" align="left" padding="10px"/>
+<img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//pulse-logo.png" alt="pulse dashboard" title="pulse dashboard" height="35px" width="60px" align="left" padding="5px"/>
 <h2>Pulse Dashboard</h2>
 
 **Real-time Playwright Test Monitoring & Analysis**  
@@ -300,13 +300,13 @@ npm run pulse-dashboard
 
 *(Run from project root containing `pulse-report/` directory)*  
 
-**NPM Package**: [pulse-dashboard on npm](https://www.npmjs.com/package/pulse-dashboard)  
+**NPM Package**: [pulse-dashboard](https://www.npmjs.com/package/pulse-dashboard)  
 
 **Tech Stack**: Next.js, TypeScript, Tailwind CSS, Playwright  
 
-*Part of the Playwright Pulse Report ecosystem*  
+*Part of the Playwright Pulse Report ecosystem*
 
---- 
+---
 
 ## 📬 Support
 

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

@@ -11,6 +11,7 @@ export declare class PlaywrightPulseReporter implements Reporter {
     private baseOutputFile;
     private isSharded;
     private shardIndex;
+    private resetOnEachRun;
     constructor(options?: PlaywrightPulseReporterOptions);
     printsToStdio(): boolean;
     onBegin(config: FullConfig, suite: Suite): void;

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

@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaywrightPulseReporter = void 0;
 const fs = __importStar(require("fs/promises"));
 const path = __importStar(require("path"));
+const fsSync = __importStar(require("fs"));
 const crypto_1 = require("crypto");
 const ua_parser_js_1 = require("ua-parser-js");
 const os = __importStar(require("os"));
@@ -62,7 +63,7 @@ const TEMP_SHARD_FILE_PREFIX = ".pulse-shard-results-";
 const ATTACHMENTS_SUBDIR = "attachments";
 class PlaywrightPulseReporter {
     constructor(options = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         this.results = [];
         this.baseOutputFile = "playwright-pulse-report.json";
         this.isSharded = false;
@@ -71,6 +72,7 @@ class PlaywrightPulseReporter {
         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.attachmentsDir = path.join(this.outputDir, ATTACHMENTS_SUBDIR);
+        this.resetOnEachRun = (_c = options.resetOnEachRun) !== null && _c !== void 0 ? _c : false;
     }
     printsToStdio() {
         return this.shardIndex === undefined || this.shardIndex === 0;
@@ -253,37 +255,47 @@ class PlaywrightPulseReporter {
             codeSnippet: codeSnippet,
             tags: test.tags.map((tag) => tag.startsWith("@") ? tag.substring(1) : tag),
             screenshots: [],
-            videoPath: [], // MODIFIED: Initialized as an array
+            videoPath: [],
             tracePath: undefined,
-            attachments: [], // NEW: Initialized
+            attachments: [],
             stdout: stdoutMessages.length > 0 ? stdoutMessages : undefined,
             stderr: stderrMessages.length > 0 ? stderrMessages : undefined,
             ...testSpecificData,
         };
-        // --- NEW SELF-CONTAINED ATTACHMENT PROCESSING LOGIC ---
-        for (const attachment of result.attachments) {
+        // --- CORRECTED ATTACHMENT PROCESSING LOGIC ---
+        for (const [index, attachment] of result.attachments.entries()) {
             if (!attachment.path)
                 continue;
             try {
-                const attachmentFileName = path.basename(attachment.path);
-                const relativeDestPath = path.join(ATTACHMENTS_SUBDIR, attachmentFileName);
+                // Create a sanitized, unique folder name for this specific test
+                const testSubfolder = test.id.replace(/[^a-zA-Z0-9_-]/g, "_");
+                // Sanitize the original attachment name to create a safe filename
+                const safeAttachmentName = path
+                    .basename(attachment.path)
+                    .replace(/[^a-zA-Z0-9_.-]/g, "_");
+                // Create a unique filename to prevent collisions, especially in retries
+                const uniqueFileName = `${index}-${Date.now()}-${safeAttachmentName}`;
+                // This is the relative path that will be stored in the JSON report
+                const relativeDestPath = path.join(ATTACHMENTS_SUBDIR, testSubfolder, uniqueFileName);
+                // This is the absolute path used for the actual file system operation
                 const absoluteDestPath = path.join(this.outputDir, relativeDestPath);
+                // Ensure the unique, test-specific attachment directory exists
                 await this._ensureDirExists(path.dirname(absoluteDestPath));
                 await fs.copyFile(attachment.path, absoluteDestPath);
+                // Categorize the attachment based on its content type
                 if (attachment.contentType.startsWith("image/")) {
                     (_j = pulseResult.screenshots) === null || _j === void 0 ? void 0 : _j.push(relativeDestPath);
                 }
                 else if (attachment.contentType.startsWith("video/")) {
-                    (_k = pulseResult.videoPath) === null || _k === void 0 ? void 0 : _k.push(relativeDestPath); // MODIFIED: Push to videoPath array
+                    (_k = pulseResult.videoPath) === null || _k === void 0 ? void 0 : _k.push(relativeDestPath);
                 }
                 else if (attachment.name === "trace") {
                     pulseResult.tracePath = relativeDestPath;
                 }
                 else {
-                    // NEW: Handle all other file types
                     (_l = pulseResult.attachments) === null || _l === void 0 ? void 0 : _l.push({
-                        name: attachment.name,
-                        path: relativeDestPath,
+                        name: attachment.name, // The original, human-readable name
+                        path: relativeDestPath, // The safe, relative path for linking
                         contentType: attachment.contentType,
                     });
                 }
@@ -459,29 +471,118 @@ class PlaywrightPulseReporter {
             console.error("PlaywrightPulseReporter: CRITICAL - finalReport object was not generated. Cannot create summary.");
             return;
         }
-        const finalOutputPath = path.join(this.outputDir, this.baseOutputFile);
-        try {
-            await this._ensureDirExists(this.outputDir);
-            await fs.writeFile(finalOutputPath, JSON.stringify(finalReport, (key, value) => {
-                if (value instanceof Date)
-                    return value.toISOString();
-                if (typeof value === "bigint")
-                    return value.toString();
-                return value;
-            }, 2));
-            if (this.printsToStdio()) {
-                console.log(`PlaywrightPulseReporter: JSON report written to ${finalOutputPath}`);
+        if (this.resetOnEachRun == true) {
+            const finalOutputPath = path.join(this.outputDir, this.baseOutputFile);
+            try {
+                await this._ensureDirExists(this.outputDir);
+                await fs.writeFile(finalOutputPath, JSON.stringify(finalReport, (key, value) => {
+                    if (value instanceof Date)
+                        return value.toISOString();
+                    if (typeof value === "bigint")
+                        return value.toString();
+                    return value;
+                }, 2));
+                if (this.printsToStdio()) {
+                    console.log(`PlaywrightPulseReporter: JSON report written to ${finalOutputPath}`);
+                }
+            }
+            catch (error) {
+                console.error(`Pulse Reporter: Failed to write final JSON report to ${finalOutputPath}. Error: ${error.message}`);
+            }
+            finally {
+                if (this.isSharded) {
+                    await this._cleanupTemporaryFiles();
+                }
             }
         }
-        catch (error) {
-            console.error(`Pulse Reporter: Failed to write final JSON report to ${finalOutputPath}. Error: ${error.message}`);
-        }
-        finally {
-            if (this.isSharded) {
-                await this._cleanupTemporaryFiles();
+        else {
+            console.warn("PlaywrightPulseReporter: resetOnEachRun is set to false. The finalReport will display all the results present in '/pulse-results'.");
+            const finalOutputPath = path.join(`${this.outputDir}/pulse-results`, `playwright-pulse-report-${Date.now()}.json`);
+            try {
+                await this._ensureDirExists(this.outputDir);
+                await fs.writeFile(finalOutputPath, JSON.stringify(finalReport, (key, value) => {
+                    if (value instanceof Date)
+                        return value.toISOString();
+                    if (typeof value === "bigint")
+                        return value.toString();
+                    return value;
+                }, 2));
+                if (this.printsToStdio()) {
+                    console.log(`PlaywrightPulseReporter: JSON report written to ${finalOutputPath}`);
+                }
+            }
+            catch (error) {
+                console.error(`Pulse Reporter: Failed to write final JSON report to ${finalOutputPath}. Error: ${error.message}`);
+            }
+            finally {
+                if (this.isSharded) {
+                    await this._cleanupTemporaryFiles();
+                }
             }
         }
     }
 }
 exports.PlaywrightPulseReporter = PlaywrightPulseReporter;
+function falseResetOnEachRun() {
+    const REPORT_DIR = "./pulse-report"; // Or change this to your reports directory
+    const OUTPUT_FILE = "playwright-pulse-report.json";
+    function getReportFiles(dir) {
+        return fsSync
+            .readdirSync(dir)
+            .filter((file) => file.startsWith("playwright-pulse-report-") && file.endsWith(".json"));
+    }
+    function mergeReports(files) {
+        var _a;
+        let combinedRun = {
+            totalTests: 0,
+            passed: 0,
+            failed: 0,
+            skipped: 0,
+            duration: 0,
+            environment: {},
+        };
+        let combinedResults = [];
+        let latestTimestamp = "";
+        let latestGeneratedAt = "";
+        for (const file of files) {
+            const filePath = path.join(`${REPORT_DIR}/pulse-results`, file);
+            const json = JSON.parse(fsSync.readFileSync(filePath, "utf-8"));
+            const run = json.run || {};
+            combinedRun.totalTests += run.totalTests || 0;
+            combinedRun.passed += run.passed || 0;
+            combinedRun.failed += run.failed || 0;
+            combinedRun.skipped += run.skipped || 0;
+            combinedRun.duration += run.duration || 0;
+            combinedRun.environment = run.environment || {};
+            if (json.results) {
+                combinedResults.push(...json.results);
+            }
+            if (run.timestamp > latestTimestamp)
+                latestTimestamp = run.timestamp;
+            if (((_a = json.metadata) === null || _a === void 0 ? void 0 : _a.generatedAt) > latestGeneratedAt)
+                latestGeneratedAt = json.metadata.generatedAt;
+        }
+        const finalJson = {
+            run: {
+                id: `merged-${Date.now()}`,
+                timestamp: latestTimestamp,
+                ...combinedRun,
+            },
+            results: combinedResults,
+            metadata: {
+                generatedAt: latestGeneratedAt,
+            },
+        };
+        return finalJson;
+    }
+    // Main execution
+    const reportFiles = getReportFiles(REPORT_DIR);
+    if (reportFiles.length === 0) {
+        console.log("No matching JSON report files found.");
+        process.exit(1);
+    }
+    const merged = mergeReports(reportFiles);
+    fsSync.writeFileSync(path.join(REPORT_DIR, OUTPUT_FILE), JSON.stringify(merged, null, 2));
+    console.log(`✅ Merged report saved as ${OUTPUT_FILE}`);
+}
 exports.default = PlaywrightPulseReporter;

package/dist/types/index.d.ts

@@ -72,6 +72,7 @@ export interface PlaywrightPulseReporterOptions {
     outputFile?: string;
     outputDir?: string;
     base64Images?: boolean;
+    resetOnEachRun?: boolean;
 }
 export interface EnvDetails {
     host: string;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@arghajit/dummy",
   "author": "Arghajit Singha",
-  "version": "0.1.0-beta-19",
+  "version": "0.1.0-beta-21",
   "description": "A Playwright reporter and dashboard for visualizing test results.",
+  "homepage": "https://playwright-pulse-report.netlify.app/",
   "keywords": [
     "playwright",
     "reporter",
@@ -15,7 +16,9 @@
     "report",
     "email-report",
     "send-report",
-    "email"
+    "email",
+    "playwright-report",
+    "pulse"
   ],
   "main": "dist/reporter/index.js",
   "types": "dist/reporter/index.d.ts",

package/scripts/generate-report.mjs

@@ -1409,6 +1409,11 @@ function generateHTML(reportData, trendData = null) {
         </div>
         <div class="test-case-content" style="display: none;">
           <p><strong>Full Path:</strong> ${sanitizeHTML(test.name)}</p>
+          <p><strong>Test run Worker ID:</strong> ${sanitizeHTML(
+            test.workerId
+          )} [<strong>Total No. of Workers:</strong> ${sanitizeHTML(
+          test.totalWorkers
+        )}]</p>
           ${
             test.errorMessage
               ? `<div class="test-error-summary">${formatPlaywrightError(
@@ -1441,15 +1446,15 @@ function generateHTML(reportData, trendData = null) {
           ${
             test.stdout && test.stdout.length > 0
               ? `<div class="console-output-section"><h4>Console Output (stdout)</h4><pre class="console-log stdout-log" style="background-color: #2d2d2d; color: wheat; padding: 1.25em; border-radius: 0.85em; line-height: 1.2;">${formatPlaywrightError(
-                  test.stdout.join("\n")
+                  test.stdout.map((line) => sanitizeHTML(line)).join("\n")
                 )}</pre></div>`
               : ""
           }
           ${
             test.stderr && test.stderr.length > 0
-              ? `<div class="console-output-section"><h4>Console Output (stderr)</h4><pre class="console-log stderr-log" style="background-color: #2d2d2d; color: indianred; padding: 1.25em; border-radius: 0.85em; line-height: 1.2;">${test.stderr
-                  .map((line) => sanitizeHTML(line))
-                  .join("\n")}</pre></div>`
+              ? `<div class="console-output-section"><h4>Console Output (stderr)</h4><pre class="console-log stderr-log" style="background-color: #2d2d2d; color: indianred; padding: 1.25em; border-radius: 0.85em; line-height: 1.2;">${formatPlaywrightError(
+                  test.stderr.map((line) => sanitizeHTML(line)).join("\n")
+                )}</pre></div>`
               : ""
           }
           ${
@@ -1480,11 +1485,7 @@ function generateHTML(reportData, trendData = null) {
           }
           ${
             test.videoPath && test.videoPath.length > 0
-              ? `
-            <div class="attachments-section">
-                <h4>Videos</h4>
-                <div class="attachments-grid">
-                ${test.videoPath
+              ? `<div class="attachments-section"><h4>Videos</h4><div class="attachments-grid">${test.videoPath
                   .map((videoUrl, index) => {
                     const fileExtension = String(videoUrl)
                       .split(".")
@@ -1498,8 +1499,7 @@ function generateHTML(reportData, trendData = null) {
                         mov: "video/quicktime",
                         avi: "video/x-msvideo",
                       }[fileExtension] || "video/mp4";
-                    return `
-                        <div class="attachment-item video-item">
+                    return `<div class="attachment-item video-item">
                             <video controls width="100%" height="auto" title="Video ${
                               index + 1
                             }">
@@ -1517,10 +1517,7 @@ function generateHTML(reportData, trendData = null) {
                             </div>
                         </div>`;
                   })
-                  .join("")}
-                </div>
-            </div>
-            `
+                  .join("")}</div></div>`
               : ""
           }
           ${
@@ -1592,8 +1589,8 @@ function generateHTML(reportData, trendData = null) {
           }
           ${
             test.codeSnippet
-              ? `<div class="code-section"><h4>Code Snippet</h4><pre><code>${sanitizeHTML(
-                  test.codeSnippet
+              ? `<div class="code-section"><h4>Code Snippet</h4><pre><code>${formatPlaywrightError(
+                  sanitizeHTML(test.codeSnippet)
                 )}</code></pre></div>`
               : ""
           }

package/scripts/generate-static-report.mjs

@@ -1377,6 +1377,11 @@ function generateHTML(reportData, trendData = null) {
                         <p><strong>Full Path:</strong> ${sanitizeHTML(
                           test.name
                         )}</p>
+                        <p><strong>Test run Worker ID:</strong> ${sanitizeHTML(
+                          test.workerId
+                        )} [<strong>Total No. of Workers:</strong> ${sanitizeHTML(
+          test.totalWorkers
+        )}]</p>
                         ${
                           test.errorMessage
                             ? `<div class="test-error-summary">${formatPlaywrightError(
@@ -1535,6 +1540,14 @@ function generateHTML(reportData, trendData = null) {
                             })
                             .join("")}</div></div>`;
                         })()}
+                        
+                        ${
+                          test.codeSnippet
+                            ? `<div class="code-section"><h4>Code Snippet</h4><pre><code>${sanitizeHTML(
+                                test.codeSnippet
+                              )}</code></pre></div>`
+                            : ""
+                        }
                     </div>
                 </div>`;
       })

package/scripts/generate-trend.mjs

@@ -1,6 +1,6 @@
+#!/usr/bin/env node
 import * as fs from "fs/promises";
 import path from "path";
-// XLSX is NO LONGER NEEDED here
 
 // Use dynamic import for chalk as it's ESM only for prettier console logs
 let chalk;

package/scripts/sendReport.mjs

@@ -265,11 +265,11 @@ const sendEmail = async (credentials) => {
     const mailOptions = {
       from: credentials.username,
       to: [
-        process.env.SENDER_EMAIL_1 || "",
-        process.env.SENDER_EMAIL_2 || "",
-        process.env.SENDER_EMAIL_3 || "",
-        process.env.SENDER_EMAIL_4 || "",
-        process.env.SENDER_EMAIL_5 || "",
+        process.env.RECIPIENT_EMAIL_1 || "",
+        process.env.RECIPIENT_EMAIL_2 || "",
+        process.env.RECIPIENT_EMAIL_3 || "",
+        process.env.RECIPIENT_EMAIL_4 || "",
+        process.env.RECIPIENT_EMAIL_5 || "",
       ].filter((email) => email), // Filter out empty strings
       subject: "Pulse Report " + new Date().toLocaleString(),
       html: htmlContent,