@arghajit/playwright-pulse-report 0.2.1 → 0.2.3

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

@@ -1,5 +1,4 @@
 "use strict";
-// input_file_0.ts
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -38,7 +37,8 @@ exports.PlaywrightPulseReporter = void 0;
 const fs = __importStar(require("fs/promises"));
 const path = __importStar(require("path"));
 const crypto_1 = require("crypto");
-const attachment_utils_1 = require("./attachment-utils"); // Use relative path
+const ua_parser_js_1 = require("ua-parser-js");
+const os = __importStar(require("os"));
 const convertStatus = (status, testCase) => {
     if ((testCase === null || testCase === void 0 ? void 0 : testCase.expectedStatus) === "failed") {
         return "failed";
@@ -105,9 +105,59 @@ class PlaywrightPulseReporter {
             .catch((err) => console.error("Pulse Reporter: Error during initialization:", err));
     }
     onTestBegin(test) {
-        // console.log(`Starting test: ${test.title}`);
+        console.log(`Starting test: ${test.title}`);
     }
-    async processStep(step, testId, browserName, testCase) {
+    getBrowserDetails(test) {
+        var _a, _b, _c, _d;
+        const project = (_a = test.parent) === null || _a === void 0 ? void 0 : _a.project();
+        const projectConfig = project === null || project === void 0 ? void 0 : project.use;
+        const userAgent = projectConfig === null || projectConfig === void 0 ? void 0 : projectConfig.userAgent;
+        const configuredBrowserType = (_b = projectConfig === null || projectConfig === void 0 ? void 0 : projectConfig.browserName) === null || _b === void 0 ? void 0 : _b.toLowerCase();
+        const parser = new ua_parser_js_1.UAParser(userAgent);
+        const result = parser.getResult();
+        let browserName = result.browser.name;
+        const browserVersion = result.browser.version
+            ? ` v${result.browser.version.split(".")[0]}`
+            : "";
+        const osName = result.os.name ? ` on ${result.os.name}` : "";
+        const osVersion = result.os.version
+            ? ` ${result.os.version.split(".")[0]}`
+            : "";
+        const deviceType = result.device.type;
+        let finalString;
+        if (browserName === undefined) {
+            browserName = configuredBrowserType;
+            finalString = `${browserName}`;
+        }
+        else {
+            if (deviceType === "mobile" || deviceType === "tablet") {
+                if ((_c = result.os.name) === null || _c === void 0 ? void 0 : _c.toLowerCase().includes("android")) {
+                    if (browserName.toLowerCase().includes("chrome"))
+                        browserName = "Chrome Mobile";
+                    else if (browserName.toLowerCase().includes("firefox"))
+                        browserName = "Firefox Mobile";
+                    else if (result.engine.name === "Blink" && !result.browser.name)
+                        browserName = "Android WebView";
+                    else if (browserName &&
+                        !browserName.toLowerCase().includes("mobile")) {
+                        // Keep it as is
+                    }
+                    else {
+                        browserName = "Android Browser";
+                    }
+                }
+                else if ((_d = result.os.name) === null || _d === void 0 ? void 0 : _d.toLowerCase().includes("ios")) {
+                    browserName = "Mobile Safari";
+                }
+            }
+            else if (browserName === "Electron") {
+                browserName = "Electron App";
+            }
+            finalString = `${browserName}${browserVersion}${osName}${osVersion}`;
+        }
+        return finalString.trim();
+    }
+    async processStep(step, testId, browserDetails, testCase) {
         var _a, _b, _c, _d;
         let stepStatus = "passed";
         let errorMessage = ((_a = step.error) === null || _a === void 0 ? void 0 : _a.message) || undefined;
@@ -124,15 +174,14 @@ class PlaywrightPulseReporter {
         if (step.location) {
             codeLocation = `${path.relative(this.config.rootDir, step.location.file)}:${step.location.line}:${step.location.column}`;
         }
-        let stepTitle = step.title;
         return {
             id: `${testId}_step_${startTime.toISOString()}-${duration}-${(0, crypto_1.randomUUID)()}`,
-            title: stepTitle,
+            title: step.title,
             status: stepStatus,
             duration: duration,
             startTime: startTime,
             endTime: endTime,
-            browser: browserName,
+            browser: browserDetails,
             errorMessage: errorMessage,
             stackTrace: ((_d = step.error) === null || _d === void 0 ? void 0 : _d.stack) || undefined,
             codeLocation: codeLocation || undefined,
@@ -146,21 +195,16 @@ class PlaywrightPulseReporter {
         };
     }
     async onTestEnd(test, result) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         const project = (_a = test.parent) === null || _a === void 0 ? void 0 : _a.project();
-        const browserName = ((_b = project === null || project === void 0 ? void 0 : project.use) === null || _b === void 0 ? void 0 : _b.defaultBrowserType) || (project === null || project === void 0 ? void 0 : project.name) || "unknown";
+        const browserDetails = this.getBrowserDetails(test);
         const testStatus = convertStatus(result.status, test);
         const startTime = new Date(result.startTime);
         const endTime = new Date(startTime.getTime() + result.duration);
-        const testIdForFiles = test.id ||
-            `${test
-                .titlePath()
-                .join("_")
-                .replace(/[^a-zA-Z0-9]/g, "_")}_${startTime.getTime()}`;
         const processAllSteps = async (steps) => {
             let processed = [];
             for (const step of steps) {
-                const processedStep = await this.processStep(step, testIdForFiles, browserName, test);
+                const processedStep = await this.processStep(step, test.id, browserDetails, test);
                 processed.push(processedStep);
                 if (step.steps && step.steps.length > 0) {
                     processedStep.steps = await processAllSteps(step.steps);
@@ -170,7 +214,7 @@ class PlaywrightPulseReporter {
         };
         let codeSnippet = undefined;
         try {
-            if (((_c = test.location) === null || _c === void 0 ? void 0 : _c.file) && ((_d = test.location) === null || _d === void 0 ? void 0 : _d.line) && ((_e = test.location) === null || _e === void 0 ? void 0 : _e.column)) {
+            if (((_b = test.location) === null || _b === void 0 ? void 0 : _b.file) && ((_c = test.location) === null || _c === void 0 ? void 0 : _c.line) && ((_d = test.location) === null || _d === void 0 ? void 0 : _d.column)) {
                 const relativePath = path.relative(this.config.rootDir, test.location.file);
                 codeSnippet = `Test defined at: ${relativePath}:${test.location.line}:${test.location.column}`;
             }
@@ -178,48 +222,87 @@ class PlaywrightPulseReporter {
         catch (e) {
             console.warn(`Pulse Reporter: Could not extract code snippet for ${test.title}`, e);
         }
-        const stdoutMessages = [];
-        if (result.stdout && result.stdout.length > 0) {
-            result.stdout.forEach((item) => {
-                stdoutMessages.push(typeof item === "string" ? item : item.toString());
-            });
-        }
-        const stderrMessages = [];
-        if (result.stderr && result.stderr.length > 0) {
-            result.stderr.forEach((item) => {
-                stderrMessages.push(typeof item === "string" ? item : item.toString());
-            });
-        }
-        const uniqueTestId = test.id;
+        const stdoutMessages = result.stdout.map((item) => typeof item === "string" ? item : item.toString());
+        const stderrMessages = result.stderr.map((item) => typeof item === "string" ? item : item.toString());
+        const maxWorkers = this.config.workers;
+        let mappedWorkerId = result.workerIndex === -1
+            ? -1
+            : (result.workerIndex % (maxWorkers > 0 ? maxWorkers : 1)) + 1;
+        const testSpecificData = {
+            workerId: mappedWorkerId,
+            totalWorkers: maxWorkers,
+            configFile: this.config.configFile,
+            metadata: this.config.metadata
+                ? JSON.stringify(this.config.metadata)
+                : undefined,
+        };
         const pulseResult = {
-            id: uniqueTestId,
+            id: test.id,
             runId: "TBD",
             name: test.titlePath().join(" > "),
-            suiteName: (project === null || project === void 0 ? void 0 : project.name) || ((_f = this.config.projects[0]) === null || _f === void 0 ? void 0 : _f.name) || "Default Suite",
+            suiteName: (project === null || project === void 0 ? void 0 : project.name) || ((_e = this.config.projects[0]) === null || _e === void 0 ? void 0 : _e.name) || "Default Suite",
             status: testStatus,
             duration: result.duration,
             startTime: startTime,
             endTime: endTime,
-            browser: browserName,
+            browser: browserDetails,
             retries: result.retry,
-            steps: ((_g = result.steps) === null || _g === void 0 ? void 0 : _g.length) ? await processAllSteps(result.steps) : [],
-            errorMessage: (_h = result.error) === null || _h === void 0 ? void 0 : _h.message,
-            stackTrace: (_j = result.error) === null || _j === void 0 ? void 0 : _j.stack,
+            steps: ((_f = result.steps) === null || _f === void 0 ? void 0 : _f.length) ? await processAllSteps(result.steps) : [],
+            errorMessage: (_g = result.error) === null || _g === void 0 ? void 0 : _g.message,
+            stackTrace: (_h = result.error) === null || _h === void 0 ? void 0 : _h.stack,
             codeSnippet: codeSnippet,
             tags: test.tags.map((tag) => tag.startsWith("@") ? tag.substring(1) : tag),
             screenshots: [],
-            videoPath: undefined,
+            videoPath: [],
             tracePath: undefined,
+            attachments: [],
             stdout: stdoutMessages.length > 0 ? stdoutMessages : undefined,
             stderr: stderrMessages.length > 0 ? stderrMessages : undefined,
+            ...testSpecificData,
         };
-        try {
-            (0, attachment_utils_1.attachFiles)(testIdForFiles, result, pulseResult, this.options);
-        }
-        catch (attachError) {
-            console.error(`Pulse Reporter: Error processing attachments for test ${pulseResult.name} (ID: ${testIdForFiles}): ${attachError.message}`);
+        // --- CORRECTED ATTACHMENT PROCESSING LOGIC ---
+        for (const [index, attachment] of result.attachments.entries()) {
+            if (!attachment.path)
+                continue;
+            try {
+                // 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);
+                }
+                else if (attachment.name === "trace") {
+                    pulseResult.tracePath = relativeDestPath;
+                }
+                else {
+                    (_l = pulseResult.attachments) === null || _l === void 0 ? void 0 : _l.push({
+                        name: attachment.name, // The original, human-readable name
+                        path: relativeDestPath, // The safe, relative path for linking
+                        contentType: attachment.contentType,
+                    });
+                }
+            }
+            catch (err) {
+                console.error(`Pulse Reporter: Failed to process attachment "${attachment.name}" for test ${pulseResult.name}. Error: ${err.message}`);
+            }
         }
-        const existingTestIndex = this.results.findIndex((r) => r.id === uniqueTestId);
+        const existingTestIndex = this.results.findIndex((r) => r.id === test.id);
         if (existingTestIndex !== -1) {
             if (pulseResult.retries >= this.results[existingTestIndex].retries) {
                 this.results[existingTestIndex] = pulseResult;
@@ -236,6 +319,20 @@ class PlaywrightPulseReporter {
             console.error(error.stack);
         }
     }
+    _getEnvDetails() {
+        return {
+            host: os.hostname(),
+            os: `${os.platform()} ${os.release()}`,
+            cpu: {
+                model: os.cpus()[0] ? os.cpus()[0].model : "N/A",
+                cores: os.cpus().length,
+            },
+            memory: `${(os.totalmem() / 1024 ** 3).toFixed(2)}GB`,
+            node: process.version,
+            v8: process.versions.v8,
+            cwd: process.cwd(),
+        };
+    }
     async _writeShardResults() {
         if (this.shardIndex === undefined) {
             return;
@@ -322,14 +419,14 @@ class PlaywrightPulseReporter {
         }
     }
     async onEnd(result) {
-        var _a, _b, _c;
         if (this.shardIndex !== undefined) {
             await this._writeShardResults();
             return;
         }
         const runEndTime = Date.now();
         const duration = runEndTime - this.runStartTime;
-        const runId = `run-${this.runStartTime}-${(0, crypto_1.randomUUID)()}`;
+        const runId = `run-${this.runStartTime}-581d5ad8-ce75-4ca5-94a6-ed29c466c815`;
+        const environmentDetails = this._getEnvDetails();
         const runData = {
             id: runId,
             timestamp: new Date(this.runStartTime),
@@ -338,10 +435,14 @@ class PlaywrightPulseReporter {
             failed: 0,
             skipped: 0,
             duration,
+            environment: environmentDetails,
         };
-        let finalReport = undefined; // Initialize as undefined
+        let finalReport = undefined;
         if (this.isSharded) {
             finalReport = await this._mergeShardResults(runData);
+            if (finalReport && finalReport.run && !finalReport.run.environment) {
+                finalReport.run.environment = environmentDetails;
+            }
         }
         else {
             this.results.forEach((r) => (r.runId = runId));
@@ -366,66 +467,8 @@ class PlaywrightPulseReporter {
         }
         if (!finalReport) {
             console.error("PlaywrightPulseReporter: CRITICAL - finalReport object was not generated. Cannot create summary.");
-            const errorSummary = `
-PlaywrightPulseReporter: Run Finished
------------------------------------------
-  Overall Status: ERROR (Report data missing)
-  Total Tests:    N/A
-  Passed:         N/A
-  Failed:         N/A
-  Skipped:        N/A
-  Duration:       N/A
------------------------------------------`;
-            if (this.printsToStdio()) {
-                console.log(errorSummary);
-            }
-            const errorReport = {
-                run: {
-                    id: runId,
-                    timestamp: new Date(this.runStartTime),
-                    totalTests: 0,
-                    passed: 0,
-                    failed: 0,
-                    skipped: 0,
-                    duration: duration,
-                },
-                results: [],
-                metadata: {
-                    generatedAt: new Date().toISOString(),
-                },
-            };
-            const finalOutputPathOnError = path.join(this.outputDir, this.baseOutputFile);
-            try {
-                await this._ensureDirExists(this.outputDir);
-                await fs.writeFile(finalOutputPathOnError, JSON.stringify(errorReport, null, 2));
-                console.warn(`PlaywrightPulseReporter: Wrote an error report to ${finalOutputPathOnError} as finalReport was missing.`);
-            }
-            catch (writeError) {
-                console.error(`PlaywrightPulseReporter: Failed to write error report: ${writeError.message}`);
-            }
             return;
         }
-        const reportRunData = finalReport.run;
-        const finalRunStatus = ((_a = reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.failed) !== null && _a !== void 0 ? _a : 0) > 0
-            ? "failed"
-            : ((_b = reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.totalTests) !== null && _b !== void 0 ? _b : 0) === 0 && result.status !== "passed"
-                ? result.status === "interrupted"
-                    ? "interrupted"
-                    : "no tests or error"
-                : "passed";
-        const summary = `
-PlaywrightPulseReporter: Run Finished
------------------------------------------
-  Overall Status: ${finalRunStatus.toUpperCase()}
-  Total Tests:    ${(reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.totalTests) || 0}
-  Passed:         ${reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.passed}
-  Failed:         ${reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.failed}
-  Skipped:        ${reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.skipped}
-  Duration:       ${(((_c = reportRunData === null || reportRunData === void 0 ? void 0 : reportRunData.duration) !== null && _c !== void 0 ? _c : 0) / 1000).toFixed(2)}s 
------------------------------------------`;
-        if (this.printsToStdio()) {
-            console.log(summary);
-        }
         const finalOutputPath = path.join(this.outputDir, this.baseOutputFile);
         try {
             await this._ensureDirExists(this.outputDir);

package/dist/types/index.d.ts

@@ -32,10 +32,19 @@ export interface TestResult {
     runId: string;
     browser: string;
     screenshots?: string[];
-    videoPath?: string;
+    videoPath?: string[];
     tracePath?: string;
+    attachments?: {
+        name: string;
+        path: string;
+        contentType: string;
+    }[];
     stdout?: string[];
     stderr?: string[];
+    workerId?: number;
+    totalWorkers?: number;
+    configFile?: string;
+    metadata?: string;
 }
 export interface TestRun {
     id: string;
@@ -45,6 +54,7 @@ export interface TestRun {
     failed: number;
     skipped: number;
     duration: number;
+    environment?: EnvDetails;
 }
 export interface TrendDataPoint {
     date: string;
@@ -63,3 +73,15 @@ export interface PlaywrightPulseReporterOptions {
     outputDir?: string;
     base64Images?: boolean;
 }
+export interface EnvDetails {
+    host: string;
+    os: string;
+    cpu: {
+        model: string;
+        cores: number;
+    };
+    memory: string;
+    node: string;
+    v8: string;
+    cwd: string;
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@arghajit/playwright-pulse-report",
   "author": "Arghajit Singha",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "A Playwright reporter and dashboard for visualizing test results.",
+  "homepage": "https://playwright-pulse-report.netlify.app/",
   "keywords": [
     "playwright",
     "reporter",
@@ -11,10 +12,13 @@
     "reporting",
     "nextjs",
     "playwright-pulse",
+    "playwright-pulse-report",
     "report",
     "email-report",
     "send-report",
-    "email"
+    "email",
+    "playwright-report",
+    "pulse"
   ],
   "main": "dist/reporter/index.js",
   "types": "dist/reporter/index.d.ts",
@@ -26,9 +30,11 @@
   "license": "MIT",
   "bin": {
     "generate-pulse-report": "./scripts/generate-static-report.mjs",
+    "generate-report": "./scripts/generate-report.mjs",
     "merge-pulse-report": "./scripts/merge-pulse-report.js",
-    "send-email": "./scripts/sendReport.js",
-    "generate-trend": "./scripts/generate-trend.mjs"
+    "send-email": "./scripts/sendReport.mjs",
+    "generate-trend": "./scripts/generate-trend.mjs",
+    "generate-email-report": "./scripts/generate-email-report.mjs"
   },
   "exports": {
     ".": {
@@ -37,78 +43,37 @@
     }
   },
   "scripts": {
-    "dev": "next dev --turbopack -p 9002",
-    "genkit:dev": "genkit start -- tsx src/ai/dev.ts",
-    "genkit:watch": "genkit start -- tsx --watch src/ai/dev.ts",
     "build:reporter": "tsc -p tsconfig.reporter.json",
-    "build:next": "next build",
-    "build": "npm run build:reporter && npm run build:next",
-    "start": "next start",
-    "lint": "next lint",
     "typecheck": "tsc --noEmit",
     "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:email": "node ./scripts/sendReport.js"
+    "report:email": "node ./scripts/sendReport.mjs",
+    "report:minify": "node ./scripts/generate-email-report.mjs",
+    "generate-trend": "node ./scripts/generate-trend.mjs"
   },
   "dependencies": {
-    "@genkit-ai/googleai": "^1.6.2",
-    "@genkit-ai/next": "^1.6.2",
-    "@hookform/resolvers": "^4.1.3",
-    "@radix-ui/react-accordion": "^1.2.3",
-    "@radix-ui/react-alert-dialog": "^1.1.6",
-    "@radix-ui/react-avatar": "^1.1.3",
-    "@radix-ui/react-checkbox": "^1.1.4",
-    "@radix-ui/react-dialog": "^1.1.6",
-    "@radix-ui/react-dropdown-menu": "^2.1.6",
-    "@radix-ui/react-label": "^2.1.2",
-    "@radix-ui/react-menubar": "^1.1.6",
-    "@radix-ui/react-popover": "^1.1.6",
-    "@radix-ui/react-progress": "^1.1.2",
-    "@radix-ui/react-radio-group": "^1.2.3",
-    "@radix-ui/react-scroll-area": "^1.2.3",
-    "@radix-ui/react-select": "^2.1.6",
-    "@radix-ui/react-separator": "^1.1.2",
-    "@radix-ui/react-slider": "^1.2.3",
-    "@radix-ui/react-slot": "^1.1.2",
-    "@radix-ui/react-switch": "^1.1.3",
-    "@radix-ui/react-tabs": "^1.1.3",
-    "@radix-ui/react-toast": "^1.2.6",
-    "@radix-ui/react-tooltip": "^1.1.8",
-    "@tanstack-query-firebase/react": "^1.0.5",
-    "@tanstack/react-query": "^5.66.0",
     "archiver": "^7.0.1",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
     "d3": "^7.9.0",
     "date-fns": "^3.6.0",
     "dotenv": "^16.5.0",
-    "firebase": "^11.3.0",
-    "genkit": "^1.6.2",
     "highcharts": "^12.2.0",
     "jsdom": "^26.1.0",
     "lucide-react": "^0.475.0",
-    "next": "15.2.3",
+    "node-fetch": "^3.3.2",
     "nodemailer": "^7.0.3",
     "patch-package": "^8.0.0",
-    "react": "^18.3.1",
-    "react-day-picker": "^8.10.1",
-    "react-dom": "^18.3.1",
-    "react-hook-form": "^7.54.2",
     "recharts": "^2.15.1",
-    "tailwind-merge": "^3.0.1",
-    "tailwindcss-animate": "^1.0.7",
+    "ua-parser-js": "^2.0.3",
     "zod": "^3.24.2"
   },
   "devDependencies": {
     "@types/node": "^20",
-    "@types/react": "^18",
-    "@types/react-dom": "^18",
+    "@types/ua-parser-js": "^0.7.39",
     "eslint": "9.25.1",
-    "eslint-config-next": "15.3.1",
-    "genkit-cli": "^1.6.1",
-    "postcss": "^8",
-    "tailwindcss": "^3.4.1",
     "typescript": "^5"
   },
   "engines": {