monocart-reporter 2.5.2 → 2.6.0

package/lib/platform/share.js

@@ -18,6 +18,10 @@ const Util = {
             name: 'network',
             contentType: 'text/html',
             reportFile: 'network-report.json'
+        },
+        metadata: {
+            name: 'metadata',
+            contentType: 'application/json'
         }
     },
 

package/lib/plugins/metadata/metadata.js

@@ -0,0 +1,25 @@
+const Util = require('../../utils/util.js');
+
+const setMetadata = (data, testInfo) => {
+    if (!data || typeof data !== 'object' || !testInfo) {
+        return;
+    }
+
+    const definition = Util.attachments.metadata;
+
+    // console.log(definition);
+    const attachment = {
+        name: definition.name,
+        contentType: definition.contentType,
+        body: Buffer.from(Util.jsonString(data))
+    };
+    // console.log(attachment);
+
+    testInfo.attachments.push(attachment);
+
+};
+
+
+module.exports = {
+    setMetadata
+};

package/lib/visitor.js

@@ -8,18 +8,6 @@ const Util = require('./utils/util.js');
 const commentsPlugin = require('./plugins/comments.js');
 const getDefaultColumns = require('./default/columns.js');
 
-// retired, just warning for old babel parser
-let collectWarning = '"collect.comments()" has been deprecated (replaced with new option "customFieldsInComments: true/false" in version 2.2.0), please remove the code related to "collect.comments()" in custom "visitor".';
-const collect = new Proxy({}, {
-    get: function(obj, prop) {
-        if (collectWarning) {
-            Util.logError(collectWarning);
-            collectWarning = null;
-        }
-        return () => {};
-    }
-});
-
 class Visitor {
     constructor(root, options) {
         this.root = root;
@@ -125,13 +113,13 @@ class Visitor {
 
         // for all data
         if (this.customCommonVisitor) {
-            await this.customCommonVisitor.call(this, data, metadata, collect);
+            await this.customCommonVisitor.call(this, data, metadata);
         }
 
         // for single column data (high priority)
         if (this.customVisitors) {
             for (const item of this.customVisitors) {
-                const res = await item.visitor.call(this, data, metadata, collect);
+                const res = await item.visitor.call(this, data, metadata);
                 if (typeof res !== 'undefined') {
                     data[item.id] = res;
                 }
@@ -518,6 +506,11 @@ class Visitor {
 
         attachments.forEach((item, i) => {
 
+            // metadata with body
+            if (this.testMetadataHandler(item, caseItem)) {
+                return;
+            }
+
             if (item.body) {
                 if (!item.path) {
                     this.saveAttachmentBodyHandler(item, i, caseId);
@@ -536,7 +529,7 @@ class Visitor {
             this.reportHandler(item, 'network', title);
 
             // content: text
-            this.contentHandler(item);
+            this.testContentHandler(item);
 
             const o = this.options;
             // store relative path first
@@ -595,7 +588,39 @@ class Visitor {
 
     }
 
-    contentHandler(item) {
+    testMetadataHandler(item, caseItem) {
+        const definition = Util.attachments.metadata;
+        if (item.name !== definition.name || item.contentType !== definition.contentType) {
+            return;
+        }
+
+        // console.log(item);
+        // name, path(undefined), contentType, body, retry
+
+        let content = item.body;
+        if (Buffer.isBuffer(content)) {
+            content = content.toString('utf8');
+        }
+        if (!content) {
+            return;
+        }
+
+        let metadata;
+        try {
+            metadata = JSON.parse(content);
+        } catch (e) {
+            // invalid json format
+        }
+
+        if (!metadata) {
+            return;
+        }
+
+        Object.assign(caseItem, metadata);
+        return true;
+    }
+
+    testContentHandler(item) {
         if (item.content) {
             return;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-reporter",
-    "version": "2.5.2",
+    "version": "2.6.0",
     "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": {
@@ -20,6 +20,7 @@
     "scripts": {
         "link": "node ./scripts/link.js",
         "test": "npm run link && npx playwright test -c tests",
+        "test-data": "npm run link && npx playwright test tests/data -c tests",
         "test-page": "npm run link && npx playwright test tests/home-page -c tests",
         "test-coverage": "npm run link && npx playwright test tests/report-coverage -c tests",
         "test-network": "npm run link && npx playwright test tests/report-network -c tests",
@@ -47,20 +48,20 @@
         "koa": "^2.15.3",
         "koa-static-resolver": "^1.0.6",
         "lz-utils": "^2.0.2",
-        "monocart-coverage-reports": "^2.8.5",
+        "monocart-coverage-reports": "^2.9.0",
         "monocart-formatter": "^3.0.0",
-        "monocart-locator": "^1.0.0",
+        "monocart-locator": "^1.0.2",
         "nodemailer": "^6.9.14",
         "turbogrid": "^3.2.0"
     },
     "devDependencies": {
-        "@playwright/test": "^1.44.1",
+        "@playwright/test": "^1.45.1",
         "axios": "^1.7.2",
         "dotenv": "^16.4.5",
-        "eslint": "^9.5.0",
+        "eslint": "^9.6.0",
         "eslint-config-plus": "^2.0.2",
         "eslint-plugin-html": "^8.1.1",
-        "eslint-plugin-vue": "^9.26.0",
+        "eslint-plugin-vue": "^9.27.0",
         "mermaid": "^10.9.1",
         "open": "8.4.2",
         "stylelint": "^16.6.1",