@arghajit/playwright-pulse-report 0.1.2 → 0.1.3

package/README.md

@@ -6,13 +6,20 @@ This project provides both a custom Playwright reporter and a Next.js web dashbo
 ## Screenshots
 
 ### Desktop View [Click on Images to View full Image]
-<a href="https://postimg.cc/180cym6c" target="_blank"><img src="https://i.postimg.cc/180cym6c/Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html.png" alt="Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html"/></a><br/><br/>
-<a href="https://postimg.cc/V5TFRHmM" target="_blank"><img src="https://i.postimg.cc/V5TFRHmM/Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html-1.png" alt="Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html-1"/></a><br/><br/>
-<a href="https://postimg.cc/XXTwFGkk" target="_blank"><img src="https://i.postimg.cc/XXTwFGkk/Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html-2.png" alt="Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html-2"/></a><br/><br/>
+
+[![Screenshot 1](https://i.postimg.cc/180cym6c/Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html.png)](https://postimg.cc/180cym6c)
+
+[![Screenshot 2](https://i.postimg.cc/V5TFRHmM/Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html-1.png)](https://postimg.cc/V5TFRHmM)
+
+[![Screenshot 3](https://i.postimg.cc/XXTwFGkk/Users-arghajitsingha-Downloads-pulse-report-1-playwright-pulse-static-report-html-2.png)](https://postimg.cc/XXTwFGkk)
+
 
 ### Mobile View [Click on Images to View full Image]
-<a href="https://postimg.cc/CzJBLR5N" target="_blank"><img src="https://i.postimg.cc/CzJBLR5N/127-0-0-1-5500-pulse-report-output-playwright-pulse-static-report-html-i-Phone-14-Pro-Max.png" alt="127-0-0-1-5500-pulse-report-output-playwright-pulse-static-report-html-i-Phone-14-Pro-Max"/></a><br/><br/>
-<a href="https://postimg.cc/G8YTczT8" target="_blank"><img src="https://i.postimg.cc/G8YTczT8/127-0-0-1-5500-pulse-report-output-playwright-pulse-static-report-html-i-Phone-14-Pro-Max-1.png" alt="127-0-0-1-5500-pulse-report-output-playwright-pulse-static-report-html-i-Phone-14-Pro-Max-1"/></a><br/><br/>
+
+[![iPhone Preview 1](https://i.postimg.cc/CzJBLR5N/127-0-0-1-5500-pulse-report-output-playwright-pulse-static-report-html-i-Phone-14-Pro-Max.png)](https://postimg.cc/CzJBLR5N)
+
+[![iPhone Preview 2](https://i.postimg.cc/G8YTczT8/127-0-0-1-5500-pulse-report-output-playwright-pulse-static-report-html-i-Phone-14-Pro-Max-1.png)](https://postimg.cc/G8YTczT8)
+
 
 ## How it Works
 
@@ -289,7 +296,24 @@ To work on the reporter or the dashboard itself:
 *   merge-report is a custom Node.js script that combines all JSON files into one.
 *   generate-report can build a static HTML dashboard if needed.
 
+## Email Report:
+
+- To use the Emailable report option, user should use .env file by installing "dotenv" package into their repository:
+
+✅  Create a .env file in the root of your project:
+```bash
+SENDER_EMAIL_1=recipient1@example.com
+SENDER_EMAIL_2=recipient2@example.com
+SENDER_EMAIL_3=recipient3@example.com
+SENDER_EMAIL_4=recipient4@example.com
+SENDER_EMAIL_5=recipient5@example.com
+```
+Pulse Report by default supports 5 mail recipients, and by running the command `npx send-email` user can send an overall test report with the actual test report html file attached to it. The Final email report will look something like below screenshot:
+
+[![Screenshot-2025-05-09-at-2-31-15-AM.png](https://i.postimg.cc/X7W1VWqr/Screenshot-2025-05-09-at-2-31-15-AM.png)](https://postimg.cc/DmCPgtqh)
+
 ## Fixes:
 
 ### -   "0.1.1" : Added Sharding Support
 ### -  "0.1.2" : Fixed browser filter and Added Browser Tag in Test Suite Card
+### -  "0.1.3" : Added Emailable report option

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

@@ -142,23 +142,27 @@ class PlaywrightPulseReporter {
             codeLocation = `${path.relative(this.config.rootDir, step.location.file)}:${step.location.line}:${step.location.column}`;
         }
         return {
-            id: `${testId}_step_${startTime.toISOString()}-${duration}-${(0, crypto_1.randomUUID)()}`,
-            title: step.title,
-            status: stepStatus,
-            duration: duration,
-            startTime: startTime,
-            endTime: endTime,
-            browser: browserName,
-            errorMessage: errorMessage,
-            stackTrace: ((_d = step.error) === null || _d === void 0 ? void 0 : _d.stack) || undefined,
-            codeLocation: codeLocation || undefined,
-            isHook: step.category === "hook",
-            hookType: step.category === "hook"
-                ? step.title.toLowerCase().includes("before")
-                    ? "before"
-                    : "after"
-                : undefined,
-            steps: [], // Will be populated recursively
+          id: `${testId}_step_${startTime.toISOString()}-${duration}-${(0,
+          crypto_1.randomUUID)()}--581d5ad8-ce75-4ca5-94a6-ed29c466c815`,
+          title: step.title,
+          status: stepStatus,
+          duration: duration,
+          startTime: startTime,
+          endTime: endTime,
+          browser: browserName,
+          errorMessage: errorMessage,
+          stackTrace:
+            ((_d = step.error) === null || _d === void 0 ? void 0 : _d.stack) ||
+            undefined,
+          codeLocation: codeLocation || undefined,
+          isHook: step.category === "hook",
+          hookType:
+            step.category === "hook"
+              ? step.title.toLowerCase().includes("before")
+                ? "before"
+                : "after"
+              : undefined,
+          steps: [], // Will be populated recursively
         };
     }
     async onTestEnd(test, result) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arghajit/playwright-pulse-report",
   "author": "Arghajit Singha",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A Playwright reporter and dashboard for visualizing test results.",
   "keywords": [
     "playwright",
@@ -11,7 +11,10 @@
     "reporting",
     "nextjs",
     "playwright-pulse",
-    "report"
+    "report",
+    "email-report",
+    "send-report",
+    "email"
   ],
   "main": "dist/reporter/index.js",
   "types": "dist/reporter/index.d.ts",
@@ -22,7 +25,8 @@
   "license": "MIT",
   "bin": {
     "generate-pulse-report": "./scripts/generate-static-report.mjs",
-    "merge-pulse-report": "./scripts/merge-pulse-report.js"
+    "merge-pulse-report": "./scripts/merge-pulse-report.js",
+    "send-email": "./scripts/sendReport.js"
   },
   "exports": {
     ".": {
@@ -41,7 +45,9 @@
     "lint": "next lint",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build:reporter",
-    "report:static": "node ./scripts/generate-static-report.mjs"
+    "report:static": "node ./scripts/generate-static-report.mjs",
+    "report:merge": "node ./scripts/merge-pulse-report.js",
+    "report:email": "node ./scripts/sendReport.js"
   },
   "dependencies": {
     "@genkit-ai/googleai": "^1.6.2",
@@ -86,7 +92,10 @@
     "recharts": "^2.15.1",
     "tailwind-merge": "^3.0.1",
     "tailwindcss-animate": "^1.0.7",
-    "zod": "^3.24.2"
+    "zod": "^3.24.2",
+    "archiver": "^7.0.1",
+    "dotenv": "^16.5.0",
+    "nodemailer": "^7.0.3"
   },
   "devDependencies": {
     "@types/node": "^20",

package/scripts/sendReport.js

@@ -0,0 +1,335 @@
+#!/usr/bin/env node
+const nodemailer = require("nodemailer");
+const path = require("path");
+const archiver = require("archiver");
+const fileSystem = require("fs");
+const reportDir = "./pulse-report";
+
+require("dotenv").config();
+
+let fetch;
+import("node-fetch")
+  .then((module) => {
+    fetch = module.default;
+  })
+  .catch((err) => {
+    console.error("Failed to import node-fetch:", err);
+    process.exit(1);
+  });
+
+let projectName;
+
+function getUUID() {
+  const reportPath = path.join(
+    process.cwd(),
+    `${reportDir}/playwright-pulse-report.json`
+  );
+  console.log("Report path:", reportPath);
+
+  if (!fileSystem.existsSync(reportPath)) {
+    throw new Error("Pulse report file not found.");
+  }
+
+  const content = JSON.parse(fileSystem.readFileSync(reportPath, "utf-8"));
+  const idString = content.run.id;
+  const parts = idString.split("-");
+  const uuid = parts.slice(-5).join("-");
+  return uuid;
+}
+
+function formatDuration(ms) {
+  const seconds = (ms / 1000).toFixed(2);
+  if (ms < 1000) return `${ms}ms`;
+  if (ms < 60000) return `${seconds}s`;
+  if (ms < 3600000) return `${(ms / 60000).toFixed(1)}min`;
+  return `${(ms / 3600000).toFixed(1)}h`;
+}
+const formatStartTime = (isoString) => {
+  const date = new Date(isoString);
+  return date.toLocaleString(); // Default locale
+};
+
+// Generate test-data from allure report
+const getPulseReportSummary = () => {
+  const reportPath = path.join(
+    process.cwd(),
+    `${reportDir}/playwright-pulse-report.json`
+  );
+
+  if (!fileSystem.existsSync(reportPath)) {
+    throw new Error("Pulse report file not found.");
+  }
+
+  const content = JSON.parse(fileSystem.readFileSync(reportPath, "utf-8"));
+  const run = content.run;
+
+  const total = run.totalTests || 0;
+  const passed = run.passed || 0;
+  const failed = run.failed || 0;
+  const skipped = run.skipped || 0;
+  const duration = (run.duration || 0) / 1000; // Convert ms to seconds
+
+  const readableStartTime = new Date(run.timestamp).toLocaleString();
+
+  return {
+    total,
+    passed,
+    failed,
+    skipped,
+    passedPercentage: total ? ((passed / total) * 100).toFixed(2) : "0.00",
+    failedPercentage: total ? ((failed / total) * 100).toFixed(2) : "0.00",
+    skippedPercentage: total ? ((skipped / total) * 100).toFixed(2) : "0.00",
+    startTime: readableStartTime,
+    duration: formatDuration(duration),
+  };
+};
+
+// sleep function for javascript file
+const delay = (time) => new Promise((resolve) => setTimeout(resolve, time));
+// Function to zip the folder asynchronously using async/await
+const zipFolder = async (folderPath, zipPath) => {
+  return new Promise((resolve, reject) => {
+    const output = fileSystem.createWriteStream(zipPath); // Must use require("fs") directly here
+    const archive = archiver("zip", { zlib: { level: 9 } });
+
+    output.on("close", () => {
+      console.log(`${archive.pointer()} total bytes`);
+      console.log("Folder has been zipped successfully.");
+      resolve(); // Resolve the promise after zipping is complete
+    });
+
+    archive.on("error", (err) => {
+      reject(err); // Reject the promise in case of an error
+    });
+
+    archive.pipe(output);
+    archive.directory(folderPath, false); // Zip the folder without the parent folder
+    archive.finalize(); // Finalize the archive
+  });
+};
+
+// Function to convert JSON data to HTML table format
+const generateHtmlTable = (data) => {
+  projectName = "Pulse Emailable Report";
+  const stats = data;
+  const total = stats.passed + stats.failed + stats.skipped;
+  const passedTests = stats.passed;
+  const passedPercentage = stats.passedPercentage;
+  const failedTests = stats.failed;
+  const failedPercentage = stats.failedPercentage;
+  const skippedTests = stats.skipped;
+  const skippedPercentage = stats.skippedPercentage;
+  const startTime = stats.startTime;
+  const durationSeconds = stats.duration;
+
+  return `
+  <!DOCTYPE html>
+  <html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Test Stats Report</title>
+    <style>
+      table {
+        width: 100%;
+        border-collapse: collapse;
+      }
+      table, th, td {
+        border: 1px solid black;
+      }
+      th, td {
+        padding: 8px;
+        text-align: left;
+      }
+      th {
+        background-color: #f2f2f2;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>${projectName} Statistics</h1>
+    <table>
+      <thead>
+        <tr>
+          <th>Metric</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>Test Start Time</td>
+          <td>${startTime}</td>
+        </tr>
+        <tr>
+          <td>Test Run Duration (Seconds)</td>
+          <td>${durationSeconds}</td>
+        </tr>
+        <tr>
+          <td>Total Tests Count</td>
+          <td>${total}</td>
+        </tr>
+        <tr>
+          <td>Tests Passed</td>
+          <td>${passedTests} (${passedPercentage}%)</td>
+        </tr>
+        <tr>
+          <td>Skipped Tests</td>
+          <td>${skippedTests} (${skippedPercentage}%)</td>
+        </tr>
+        <tr>
+          <td>Test Failed</td>
+          <td>${failedTests} (${failedPercentage}%)</td>
+        </tr>
+      </tbody>
+    </table>
+    <p>With regards,</p>
+    <p>Networks QA Team</p>
+  </body>
+  </html>
+  `;
+};
+
+// Async function to send an email
+const sendEmail = async (credentials) => {
+  try {
+    console.log("Starting the sendEmail function...");
+
+    // Configure nodemailer transporter
+    const secureTransporter = nodemailer.createTransport({
+      host: "smtp.gmail.com",
+      port: 465,
+      secure: true, // Use SSL/TLS
+      auth: {
+        user: credentials.username,
+        pass: credentials.password, // Ensure you use app password or secured token
+      },
+    });
+    // Generate HTML content for email
+    const reportData = getPulseReportSummary();
+    const htmlContent = generateHtmlTable(reportData);
+
+    // Configure mail options
+    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 || "",
+      ],
+      subject: "Pulse Report " + new Date().toLocaleString(),
+      html: htmlContent,
+      attachments: [
+        {
+          filename: `report.html`,
+          path: `${reportDir}/playwright-pulse-static-report.html`, // Attach the zipped folder
+        },
+      ],
+    };
+
+    // Send email
+    const info = await secureTransporter.sendMail(mailOptions);
+    console.log("Email sent: ", info.response);
+  } catch (error) {
+    console.error("Error sending email: ", error);
+  }
+};
+
+async function fetchCredentials(retries = 6) {
+  const timeout = 10000; // 10 seconds timeout
+  const key = getUUID();
+  // Validate API key exists before making any requests
+  if (!key) {
+    console.error(
+      "🔴 Critical: API key not provided - please set EMAIL_KEY in your environment variables"
+    );
+    console.warn("🟠 Falling back to default credentials (if any)");
+    return null; // Return null instead of throwing
+  }
+
+  for (let attempt = 1; attempt <= retries; attempt++) {
+    try {
+      console.log(`🟡 Attempt ${attempt} of ${retries}`);
+
+      // Create a timeout promise
+      const timeoutPromise = new Promise((_, reject) => {
+        setTimeout(() => {
+          reject(new Error(`Request timed out after ${timeout}ms`));
+        }, timeout);
+      });
+
+      // Create the fetch promise
+      const fetchPromise = fetch(
+        "https://test-dashboard-66zd.onrender.com/api/getcredentials",
+        {
+          method: "GET",
+          headers: {
+            "x-api-key": `${key}`,
+          },
+        }
+      );
+
+      // Race between fetch and timeout
+      const response = await Promise.race([fetchPromise, timeoutPromise]);
+
+      if (!response.ok) {
+        // Handle specific HTTP errors with console messages only
+        if (response.status === 401) {
+          console.error("🔴 Invalid API key - authentication failed");
+        } else if (response.status === 404) {
+          console.error("🔴 Endpoint not found - check the API URL");
+        } else {
+          console.error(`🔴 Fetch failed with status: ${response.status}`);
+        }
+        continue; // Skip to next attempt instead of throwing
+      }
+
+      const data = await response.json();
+
+      // Validate the response structure
+      if (!data.username || !data.password) {
+        console.error("🔴 Invalid credentials format received from API");
+        continue;
+      }
+
+      console.log("🟢 Fetched credentials successfully");
+      return data;
+    } catch (err) {
+      console.error(`🔴 Attempt ${attempt} failed: ${err.message}`);
+
+      if (attempt === retries) {
+        console.error(
+          `🔴 All ${retries} attempts failed. Last error: ${err.message}`
+        );
+        console.warn(
+          "🟠 Proceeding without credentials - email sending will be skipped"
+        );
+        return null;
+      }
+
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+    }
+  }
+}
+
+// Main function to zip the folder and send the email
+const main = async () => {
+  await import("node-fetch").then((module) => {
+    fetch = module.default;
+  });
+  const credentials = await fetchCredentials();
+  if (!credentials) {
+    console.warn("Skipping email sending due to missing credentials");
+    // Continue with pipeline without failing
+    return;
+  }
+  await delay(10000);
+  try {
+    await sendEmail(credentials);
+  } catch (error) {
+    console.error("Error in main function: ", error);
+  }
+};
+
+main();