monocart-reporter 2.7.1 → 2.8.1

package/lib/plugins/audit/audit.js

@@ -72,9 +72,11 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
         return;
     }
 
+    const outputDir = await Util.resolveOutputDir(testInfo);
+
     options = {
         name: `Lighthouse Report - ${testInfo.title}`,
-        outputDir: Util.resolveOutputDir(testInfo, options),
+        outputDir,
         outputName: `audit-${Util.resolveTestIdWithRetry(testInfo)}`,
         ... options
     };

package/lib/plugins/coverage/coverage.js

@@ -5,9 +5,7 @@ const Util = require('../../utils/util.js');
 
 const attachCoverageReport = async (data, testInfo, options = {}) => {
 
-    const reporterOptions = Util.resolveReporterOptions(testInfo);
-
-    const outputDir = Util.resolveOutputDir(testInfo, options);
+    const outputDir = await Util.resolveOutputDir(testInfo);
     const folderName = `coverage-${Util.resolveTestIdWithRetry(testInfo)}`;
 
     // support multiple calls
@@ -21,7 +19,7 @@ const attachCoverageReport = async (data, testInfo, options = {}) => {
     }
 
     const coverageOptions = {
-        logging: reporterOptions.logging,
+        logging: Util.resolveLogging(testInfo, options),
         outputDir: htmlDir,
         name: `Coverage Report - ${testInfo.title}`,
         assetsPath: '../assets',

package/lib/plugins/network/network.js

@@ -129,10 +129,12 @@ const attachNetworkReport = async (har, testInfo, options = {}) => {
         return;
     }
 
+    const outputDir = await Util.resolveOutputDir(testInfo);
+
     options = {
         // default title
         name: `Network Report - ${testInfo.title}`,
-        outputDir: Util.resolveOutputDir(testInfo, options),
+        outputDir,
         outputName: `network-${Util.resolveTestIdWithRetry(testInfo)}`,
         inline: false,
         ... options

package/lib/utils/util.js

@@ -9,8 +9,6 @@ const Share = require('../platform/share.js');
 
 const getDefaultOptions = require('../default/options.js');
 
-const assetsName = 'assets';
-
 const Util = {
     ... Share,
 
@@ -78,15 +76,11 @@ const Util = {
         return parsed;
     },
 
-    resolveOutputDir: (testInfo, options) => {
-        if (options && options.outputDir) {
-            return options.outputDir;
-        }
-        const outputDir = testInfo.project.outputDir || testInfo.config.outputDir;
-        if (outputDir) {
-            return outputDir;
-        }
-        return path.resolve(testInfo.outputDir, '../');
+    resolveOutputDir: async (testInfo) => {
+        const reporterOptions = Util.resolveReporterOptions(testInfo);
+        const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
+        const outputDir = path.dirname(outputFile);
+        return outputDir;
     },
 
     resolveOutputFile: async (outputFile) => {
@@ -98,6 +92,12 @@ const Util = {
         if (!outputFile || typeof outputFile !== 'string') {
             outputFile = getDefaultOptions().outputFile;
         }
+
+        // end with html
+        if (!outputFile.endsWith('.html')) {
+            outputFile = path.join(outputFile, 'index.html');
+        }
+
         return path.resolve(outputFile);
     },
 
@@ -109,7 +109,11 @@ const Util = {
         return reporterOptions.logging;
     },
 
+    // eslint-disable-next-line complexity
     resolveReporterOptions: (testInfo) => {
+        if (Util.reporterOptions) {
+            return Util.reporterOptions;
+        }
         if (!testInfo) {
             return {};
         }
@@ -119,6 +123,7 @@ const Util = {
                 if (Array.isArray(item)) {
                     const [name, options] = item;
                     if (name && name.indexOf('monocart-reporter') !== -1) {
+                        Util.reporterOptions = options;
                         return options || {};
                     }
                 }
@@ -152,13 +157,6 @@ const Util = {
         });
     },
 
-    initAssetsDir: async (options) => {
-        const outputFile = await Util.resolveOutputFile(options.outputFile);
-        const outputDir = path.dirname(outputFile);
-        const assetsDir = path.resolve(outputDir, assetsName);
-        Util.initDir(assetsDir);
-    },
-
     getEOL: function(content) {
         if (!content) {
             return os.EOL;
@@ -276,7 +274,8 @@ const Util = {
         if (fs.existsSync(p)) {
             fs.rmSync(p, {
                 recursive: true,
-                force: true
+                force: true,
+                maxRetries: 10
             });
         }
     },

package/lib/visitor.js

@@ -527,6 +527,8 @@ class Visitor {
             }
 
             // before path change
+            // Attachments with a text/html content type can now be opened in a new tab in the HTML report.
+            // This is useful for including third-party reports or other HTML content in the Playwright test report and distributing it to your team.
             this.reportHandler(item, 'audit', title);
             this.reportHandler(item, 'coverage', title);
             this.reportHandler(item, 'network', title);
@@ -536,6 +538,7 @@ class Visitor {
 
             const o = this.options;
             // store relative path first
+            this.copyAttachmentsHandler(item);
             item.path = Util.relativePath(item.path, o.outputDir);
 
             // custom attachment path
@@ -558,6 +561,37 @@ class Visitor {
         }
     }
 
+    copyAttachmentsHandler(item) {
+
+        const { attachmentsDir } = this.options;
+        if (!attachmentsDir) {
+            return;
+        }
+
+        if (!fs.existsSync(attachmentsDir)) {
+            fs.mkdirSync(attachmentsDir, {
+                recursive: true
+            });
+        }
+
+        // custom report
+        if (item.report) {
+            return;
+        }
+
+        const oldPath = item.path;
+        const filename = Util.calculateSha1(oldPath);
+        const ext = path.extname(oldPath);
+        const newPath = path.resolve(attachmentsDir, `${filename}${ext}`);
+        fs.cpSync(oldPath, newPath, {
+            force: true,
+            recursive: true
+        });
+
+        item.path = newPath;
+
+    }
+
     getImageCategory(item) {
         if (item.contentType && item.contentType.startsWith('image/')) {
             if (item.name) {
@@ -702,7 +736,10 @@ class Visitor {
             return;
         }
 
-        const attachmentsPath = path.resolve(this.options.outputDir, caseId);
+        // testOutputDir is for test results not reporter
+        const { outputDir, testOutputDir } = this.options;
+
+        const attachmentsPath = path.resolve(testOutputDir || outputDir, caseId);
         if (!fs.existsSync(attachmentsPath)) {
             fs.mkdirSync(attachmentsPath, {
                 recursive: true

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-reporter",
-    "version": "2.7.1",
+    "version": "2.8.1",
     "description": "A playwright test reporter. Shows suites/cases/steps with tree style, markdown annotations, custom columns/formatters/data collection visitors, console logs, style tags, send email.",
     "main": "lib/index.js",
     "bin": {
@@ -46,27 +46,29 @@
         "koa": "^2.15.3",
         "koa-static-resolver": "^1.0.6",
         "lz-utils": "^2.1.0",
-        "monocart-coverage-reports": "^2.10.3",
+        "monocart-coverage-reports": "^2.10.9",
         "monocart-locator": "^1.0.2",
-        "nodemailer": "^6.9.14"
+        "nodemailer": "^6.9.15"
     },
     "devDependencies": {
         "@babel/code-frame": "^7.24.7",
-        "@playwright/test": "^1.46.1",
+        "@playwright/test": "^1.47.1",
         "ansi-to-html": "^0.7.2",
         "async-tick": "^1.0.0",
         "autolinker": "^4.0.0",
-        "axios": "^1.7.5",
+        "axios": "^1.7.7",
         "commander": "^12.1.0",
         "dotenv": "^16.4.5",
-        "eslint": "^9.9.1",
+        "eslint": "^9.10.0",
         "eslint-config-plus": "^2.0.2",
         "eslint-plugin-html": "^8.1.1",
-        "eslint-plugin-vue": "^9.27.0",
+        "eslint-plugin-vue": "^9.28.0",
         "file-saver": "^2.0.5",
+        "find-up": "^7.0.0",
         "github-markdown-css": "^5.6.1",
-        "marked": "^14.1.0",
-        "mermaid": "^11.0.2",
+        "glob": "^11.0.0",
+        "marked": "^14.1.2",
+        "mermaid": "^11.2.1",
         "mitt": "^3.0.1",
         "monocart-code-viewer": "^1.1.4",
         "monocart-formatter": "^3.0.0",
@@ -75,7 +77,8 @@
         "sanitize-filename": "^1.6.3",
         "stack-utils": "^2.0.6",
         "stylelint": "^16.9.0",
-        "stylelint-config-plus": "^1.1.2",
+        "stylelint-config-plus": "^1.1.3",
+        "supports-color": "^9.4.0",
         "turbogrid": "^3.2.0",
         "vine-ui": "^3.1.16",
         "ws": "^8.18.0"