@arghajit/playwright-pulse-report 0.2.2 → 0.2.4

package/README.md

@@ -7,53 +7,7 @@ _The ultimate Playwright reporter — Interactive dashboard with historical tren
 
 ## ![Features](https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images/features.svg)
 
-## 📸 Screenshots
-
-### 🖥️ Desktop View
-
-<div align="center" style="display: flex; gap: 20px; justify-content: center; flex-wrap: wrap;">
-  <a href="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//playwright-pulse-static-report-desktop.html.png" target="_blank"> <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//playwright-pulse-static-report-desktop.html.png" alt="Dashboard Overview" width="300"/>
-   <p align="center"><strong>Dashboard Overview</strong></p>
-  </a>
-  <a href="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Test-run-desktop.png" target="_blank"> <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Test-run-desktop.png" alt="Test Details" width="300"/>
-   <p align="center"><strong>Test Details</strong>
-   </p>
-  </a>
-  <a href="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Test-error-desktop.png" target="_blank"> <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Test-run-desktop.png" alt="Test Failure Details" width="300"/>
-   <p align="center"><strong>Test Failure Details</strong>
-   </p>
-  </a>
-  <a href="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Test-trends-desktop.png" target="_blank"> <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Test-trends-desktop.png" alt="Filter View" width="300"/>
-  <p align="center"><strong>Test Trends</strong></p>
-  </a>
-</div>
-
-### 📱 Mobile View
-
-<div align="center" style="display: flex; gap: 20px; justify-content: center; flex-wrap: wrap;">
-
-  <a href="https://postimg.cc/CzJBLR5N" target="_blank">
-    <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//playwright-pulse-static-report-Dashboard.html.png" alt="Mobile Dashboard Overview" width="300"/>
-    <p align="center"><strong>Dashboard Overview</strong></p>
-  </a>
-
-  <a href="https://postimg.cc/G8YTczT8" target="_blank">
-    <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//playwright-pulse-static-report_Test-results.html.png" alt="Test Details" width="300"/>
-    <p align="center"><strong>Test Details</strong></p>
-  </a>
-
-  <a href="https://postimg.cc/G8YTczT8" target="_blank">
-    <img src="https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//playwright-pulse-static-report-Trends.html.png" alt="Test Trends" width="300"/>
-    <p align="center"><strong>Test Trends</strong></p>
-  </a>
-
-</div>
-
-### Email Report Example
-
-[![Email Report Template](https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Email-report-mobile-template.jpeg)](https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//Email-report-mobile-template.jpeg)
-
-[![Email Report](https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//pulse-email-summary.html.png)](https://ocpaxmghzmfbuhxzxzae.supabase.co/storage/v1/object/public/images//pulse-email-summary.html.png)
+## **Documentation**: [Pulse Report](https://playwright-pulse-report.netlify.app/)
 
 ## Available Scripts
 
@@ -91,10 +45,6 @@ Run with `npm run <command>`
 
 ```bash
 npm install @arghajit/playwright-pulse-report@latest --save-dev
-# or
-yarn add @arghajit/playwright-pulse-report@latest --dev
-# or
-pnpm add @arghajit/playwright-pulse-report@latest --save-dev
 ```
 
 ### 2. Configure Playwright
@@ -161,8 +111,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
    ```
 
@@ -300,7 +250,7 @@ npm run pulse-dashboard
 
 *(Run from project root containing `pulse-report/` directory)*  
 
-**NPM Package**: [pulse-dashboard](https://www.npmjs.com/package/pulse-dashboard)  
+**NPM Package**: [playwright-pulse-report](https://www.npmjs.com/package/@arghajit/playwright-pulse-report) 
 
 **Tech Stack**: Next.js, TypeScript, Tailwind CSS, Playwright  
 
@@ -308,6 +258,52 @@ npm run pulse-dashboard
 
 ---
 
+## ⚙️ Advanced Configuration
+
+### Handling Sequential Test Runs
+
+By default, the reporter will overwrite the `playwright-pulse-report.json` file on each new test run. This is usually what we want. However, if we run tests sequentially in the same job, like this:
+
+```bash
+npx playwright test test1.spec.ts && npx playwright test test2.spec.ts
+```
+
+By default, In this above scenario, the report from test1 will be lost. To solve this, you can use the resetOnEachRun option.
+
+```bash
+// playwright.config.ts
+import { defineConfig } from "@playwright/test";
+import * as path from "path";
+
+// Define where the final report JSON and HTML should go
+const PULSE_REPORT_DIR = path.resolve(__dirname, "pulse-report"); // Example: a directory in your project root
+
+export default defineConfig({
+  reporter: [
+    ["list"],
+    [
+      "@arghajit/playwright-pulse-report",
+      {
+        outputDir: PULSE_REPORT_DIR,
+        // Add this option
+        resetOnEachRun: false, // Default is true
+      },
+    ],
+  ],
+  // ...
+});
+```
+
+**How it works when resetOnEachRun: false:**
+
+- On the first run, it saves report-1.json to a pulse-report/pulse-results directory and creates the main playwright-pulse-report.json from it.
+- On the second run, it saves report-2.json to the same directory.
+- It then automatically reads both report-1.json and report-2.json, merges them, and updates the main playwright-pulse-report.json with the combined results.
+
+***This ensures your final report is always a complete summary of all sequential test runs.***
+
+---
+
 ## 📬 Support
 
 For issues or feature requests, please [Contact Me](mailto:arghajitsingha47@gmail.com).

package/dist/reporter/attachment-utils.js

@@ -45,11 +45,10 @@ const ATTACHMENTS_SUBDIR = "attachments"; // Consistent subdirectory name
  * @param config The reporter configuration options.
  */
 function attachFiles(testId, pwResult, pulseResult, config) {
-    const baseReportDir = config.outputDir || "pulse-report"; // Base output directory
-    // Ensure attachments are relative to the main outputDir
-    const attachmentsBaseDir = path.resolve(baseReportDir, ATTACHMENTS_SUBDIR); // Absolute path for FS operations
-    const attachmentsSubFolder = testId.replace(/[^a-zA-Z0-9_-]/g, "_"); // Sanitize testId for folder name
-    const testAttachmentsDir = path.join(attachmentsBaseDir, attachmentsSubFolder); // e.g., pulse-report/attachments/test_id_abc
+    const baseReportDir = config.outputDir || "pulse-report";
+    const attachmentsBaseDir = path.resolve(baseReportDir, ATTACHMENTS_SUBDIR);
+    const attachmentsSubFolder = testId.replace(/[^a-zA-Z0-9_-]/g, "_");
+    const testAttachmentsDir = path.join(attachmentsBaseDir, attachmentsSubFolder);
     try {
         if (!fs.existsSync(testAttachmentsDir)) {
             fs.mkdirSync(testAttachmentsDir, { recursive: true });
@@ -57,53 +56,49 @@ function attachFiles(testId, pwResult, pulseResult, config) {
     }
     catch (error) {
         console.error(`Pulse Reporter: Failed to create attachments directory: ${testAttachmentsDir}`, error);
-        return; // Stop processing if directory creation fails
+        return;
     }
     if (!pwResult.attachments)
         return;
-    const { base64Images } = config; // Get base64 embedding option
-    pulseResult.screenshots = []; // Initialize screenshots array
+    const { base64Images } = config;
+    // --- MODIFICATION: Initialize all attachment arrays to prevent errors ---
+    pulseResult.screenshots = [];
+    pulseResult.videoPath = [];
+    pulseResult.attachments = [];
     pwResult.attachments.forEach((attachment) => {
         const { contentType, name, path: attachmentPath, body } = attachment;
-        // Skip attachments without path or body
         if (!attachmentPath && !body) {
             console.warn(`Pulse Reporter: Attachment "${name}" for test ${testId} has no path or body. Skipping.`);
             return;
         }
-        // Determine filename
-        const safeName = name.replace(/[^a-zA-Z0-9_.-]/g, "_"); // Sanitize original name
+        const safeName = name.replace(/[^a-zA-Z0-9_.-]/g, "_");
         const extension = attachmentPath
             ? path.extname(attachmentPath)
             : `.${getFileExtension(contentType)}`;
         const baseFilename = attachmentPath
             ? path.basename(attachmentPath, extension)
             : safeName;
-        // Ensure unique filename within the test's attachment folder
         const fileName = `${baseFilename}_${Date.now()}${extension}`;
-        // Relative path for storing in JSON (relative to baseReportDir)
         const relativePath = path.join(ATTACHMENTS_SUBDIR, attachmentsSubFolder, fileName);
-        // Full path for file system operations
         const fullPath = path.join(testAttachmentsDir, fileName);
         if (contentType === null || contentType === void 0 ? void 0 : contentType.startsWith("image/")) {
-            // Handle all image types consistently
             handleImage(attachmentPath, body, base64Images, fullPath, relativePath, pulseResult, name);
         }
         else if (name === "video" || (contentType === null || contentType === void 0 ? void 0 : contentType.startsWith("video/"))) {
-            handleAttachment(attachmentPath, body, fullPath, relativePath, "videoPath", pulseResult);
+            handleAttachment(attachmentPath, body, fullPath, relativePath, "videoPath", pulseResult, attachment);
         }
         else if (name === "trace" || contentType === "application/zip") {
-            // Trace files are zips
-            handleAttachment(attachmentPath, body, fullPath, relativePath, "tracePath", pulseResult);
+            handleAttachment(attachmentPath, body, fullPath, relativePath, "tracePath", pulseResult, attachment);
         }
         else {
-            // Handle other generic attachments if needed (e.g., log files)
-            // console.log(`Pulse Reporter: Processing generic attachment "${name}" (Type: ${contentType}) for test ${testId}`);
-            // handleAttachment(attachmentPath, body, fullPath, relativePath, 'otherAttachments', pulseResult); // Example for storing other types
+            // --- MODIFICATION: Enabled handling for all other file types ---
+            handleAttachment(attachmentPath, body, fullPath, relativePath, "attachments", pulseResult, attachment);
         }
     });
 }
 /**
  * Handles image attachments, either embedding as base64 or copying the file.
+ * (This function is unchanged)
  */
 function handleImage(attachmentPath, body, base64Embed, fullPath, relativePath, pulseResult, attachmentName) {
     let screenshotData = undefined;
@@ -123,14 +118,10 @@ function handleImage(attachmentPath, body, base64Embed, fullPath, relativePath,
         }
     }
     else if (body) {
-        // Always embed if only body is available
         screenshotData = `data:image/${getFileExtension(attachmentName)};base64,${body.toString("base64")}`;
         if (!base64Embed) {
-            // Optionally save the buffer to a file even if embedding is off,
-            // but the primary representation will be base64.
             try {
                 fs.writeFileSync(fullPath, body);
-                // console.log(`Pulse Reporter: Saved screenshot buffer to ${fullPath}`);
             }
             catch (error) {
                 console.error(`Pulse Reporter: Failed to save screenshot buffer: ${fullPath}. Error: ${error.message}`);
@@ -147,21 +138,36 @@ function handleImage(attachmentPath, body, base64Embed, fullPath, relativePath,
 /**
  * Handles non-image attachments by copying the file or writing the buffer.
  */
-function handleAttachment(attachmentPath, body, fullPath, relativePath, resultKey, // Add more keys if needed
-pulseResult) {
+function handleAttachment(attachmentPath, body, fullPath, relativePath, resultKey, // MODIFIED: Added 'attachments'
+pulseResult, originalAttachment // MODIFIED: Pass original attachment
+) {
+    var _a, _b;
     try {
         if (attachmentPath) {
             fs.copyFileSync(attachmentPath, fullPath);
-            pulseResult[resultKey] = relativePath;
         }
         else if (body) {
             fs.writeFileSync(fullPath, body);
-            pulseResult[resultKey] = relativePath; // Store relative path even if from buffer
+        }
+        // --- MODIFICATION: Logic to handle different properties correctly ---
+        switch (resultKey) {
+            case "videoPath":
+                (_a = pulseResult.videoPath) === null || _a === void 0 ? void 0 : _a.push(relativePath);
+                break;
+            case "tracePath":
+                pulseResult.tracePath = relativePath;
+                break;
+            case "attachments":
+                (_b = pulseResult.attachments) === null || _b === void 0 ? void 0 : _b.push({
+                    name: originalAttachment.name,
+                    path: relativePath,
+                    contentType: originalAttachment.contentType,
+                });
+                break;
         }
     }
     catch (error) {
         console.error(`Pulse Reporter: Failed to copy/write attachment to ${fullPath}. Error: ${error.message}`);
-        // Don't set the path in pulseResult if saving failed
     }
 }
 /**
@@ -172,8 +178,7 @@ pulseResult) {
 function getFileExtension(contentType) {
     var _a;
     if (!contentType)
-        return "bin"; // Default binary extension
-    // More robust mapping
+        return "bin";
     const extensions = {
         "image/png": "png",
         "image/jpeg": "jpg",
@@ -182,9 +187,12 @@ function getFileExtension(contentType) {
         "image/svg+xml": "svg",
         "video/webm": "webm",
         "video/mp4": "mp4",
-        "application/zip": "zip", // For traces
+        "application/zip": "zip",
         "text/plain": "txt",
         "application/json": "json",
+        "text/html": "html",
+        "application/pdf": "pdf",
+        "text/csv": "csv",
     };
     return (extensions[contentType.toLowerCase()] ||
         ((_a = contentType.split("/")[1]) === null || _a === void 0 ? void 0 : _a.split("+")[0]) ||

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;
@@ -18,6 +19,7 @@ export declare class PlaywrightPulseReporter implements Reporter {
     private getBrowserDetails;
     private processStep;
     onTestEnd(test: TestCase, result: PwTestResult): Promise<void>;
+    private _getFinalizedResults;
     onError(error: any): void;
     private _getEnvDetails;
     private _writeShardResults;
@@ -25,5 +27,6 @@ export declare class PlaywrightPulseReporter implements Reporter {
     private _cleanupTemporaryFiles;
     private _ensureDirExists;
     onEnd(result: FullResult): Promise<void>;
+    private _mergeAllRunReports;
 }
 export default PlaywrightPulseReporter;