monocart-reporter 1.7.0 → 1.7.2

package/README.md

@@ -119,13 +119,14 @@ Separated metadata file (Already included in the above HTML and compressed, it c
 
     traceViewerUrl: 'https://trace.playwright.dev/?trace={traceUrl}',
 
+    // logging levels: off, error, info, debug
+    logging: 'info',
+
     // global coverage settings for addCoverageReport API
     coverage: null,
     // coverage: {
     //     entryFilter: (entry) => true,
-    //     unpackSourceMap: true,
-    //     excludeDistFile: true,
-    //     sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
+    //     sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     // },
 
     // trend data handler
@@ -630,16 +631,13 @@ Attach a code coverage report with API `attachCoverageReport(data, testInfo, opt
 - `testInfo` see [TestInfo](https://playwright.dev/docs/api/class-testinfo)
 - `options` (Object)
     - `title` (String) report title.
-    - `toIstanbul` (Boolean) Whether to convert to Istanbul report from V8 list.
+    - `toIstanbul` (Boolean) Whether to convert to Istanbul report from V8 list. Defaults to `html-spa` report | (String) or using `html` report 
     - `entryFilter` (Function) A filter function to execute for each element in the V8 list.
-    - `unpackSourceMap` (Boolean) Whether to unpack all sources from the source map if a related source map file is found.
-    - `excludeDistFile` (Boolean) Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
     - `sourceFilter` (Function) A filter function to execute for each element in the sources which unpacked from the source map.
     - `watermarks` (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report) | (Array) V8 watermarks, Defaults to `[50, 80]`.
     - `lcov` (Boolean) Whether to create `lcov.info`. Istanbul only.
     - `sourcePath` (Function) source path handler, return a new source path. Istanbul only.
-    - `inline` (Boolean) Whether inline all scripts to the single HTML file.
-    - `debug` (Boolean) The temporary artifacts will not be removed.
+    - `inline` (Boolean) Whether inline all scripts to the single HTML file. V8 only.
 
  (see example: [report-coverage.spec.js](https://github.com/cenfun/monocart-reporter/blob/main/tests/report-coverage/report-coverage.spec.js))
 
@@ -705,7 +703,7 @@ test('Take V8 and Istanbul coverage report', async ({ page }) => {
     const coverageList = [... jsCoverage, ... cssCoverage];
 
     const v8 = await attachCoverageReport(coverageList, test.info(), {
-        excludeDistFile: false
+        
     });
     console.log(v8.summary);
 
@@ -745,9 +743,7 @@ module.exports = {
             // global coverage report options
             coverage: {
                 entryFilter: (entry) => true,
-                unpackSourceMap: true,
-                excludeDistFile: true,
-                sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
+                sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
             }
         }]
     ]

package/lib/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const fs = require('fs');
 const path = require('path');

package/lib/common.js

@@ -1,4 +1,3 @@
-const EC = require('eight-colors');
 const Util = require('./utils/util.js');
 const defaultSummary = require('./default/summary.js');
 const generatePieChart = require('./utils/pie.js');
@@ -205,12 +204,12 @@ const getTrends = async (input) => {
     }
     const data = await getTrendData(input);
     if (!data) {
-        EC.logRed('[MCR] failed to load trend data');
+        Util.logError('failed to load trend data');
         return [];
     }
 
     if (!isTrendData(data)) {
-        EC.logRed('[MCR] trend data requires properties: date, duration and summary');
+        Util.logError('trend data requires properties: date, duration and summary');
         return [];
     }
 

package/lib/default/options.js

@@ -11,13 +11,14 @@ module.exports = {
 
     traceViewerUrl: 'https://trace.playwright.dev/?trace={traceUrl}',
 
+    // logging levels: off, error, info, debug
+    logging: 'info',
+
     // global coverage settings for addCoverageReport API
     coverage: null,
     // coverage: {
     //     entryFilter: (entry) => true,
-    //     unpackSourceMap: true,
-    //     excludeDistFile: true,
-    //     sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
+    //     sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     // },
 
     state: null,

package/lib/generate-data.js

@@ -5,7 +5,6 @@ const { getTickInfo } = require('./utils/system.js');
 const Visitor = require('./visitor.js');
 const { calculateSummary } = require('./common.js');
 const { generateGlobalCoverageReport } = require('./plugins/coverage/coverage.js');
-const { generateGlobalNetworkReport } = require('./plugins/network/network.js');
 const version = require('../package.json').version;
 
 const getReportName = (options, config, metadata) => {
@@ -19,21 +18,17 @@ const getReportName = (options, config, metadata) => {
 const artifactsHandler = async (visitor, options) => {
     const artifacts = [].concat(visitor.artifacts);
     // global artifacts
-    const { coverage, network } = visitor.artifactDataMap;
+    const { coverage } = visitor.artifactDataMap;
     if (coverage) {
         const report = await generateGlobalCoverageReport(coverage, options);
         artifacts.push(report);
     }
-    if (network) {
-        const report = await generateGlobalNetworkReport(coverage, options);
-        artifacts.push(report);
-    }
     return artifacts;
 };
 
 const generateData = async (results) => {
 
-    console.log('[MCR] generating report data ...');
+    Util.logInfo('generating report data ...');
 
     const {
         config,

package/lib/generate-report.js

@@ -1,6 +1,5 @@
 const path = require('path');
 const EC = require('eight-colors');
-const CG = require('console-grid');
 const nodemailer = require('nodemailer');
 const Util = require('./utils/util.js');
 const emailPlugin = require('./plugins/email.js');
@@ -12,7 +11,7 @@ const generateJson = (outputDir, htmlFile, reportData) => {
     let jsonPath = path.resolve(outputDir, `${filename}.json`);
     Util.writeJSONSync(jsonPath, reportData);
     jsonPath = Util.relativePath(jsonPath);
-    console.log(`[MCR] json report: ${EC.cyan(jsonPath)}`);
+    Util.logInfo(`json report: ${EC.cyan(jsonPath)}`);
     return jsonPath;
 };
 
@@ -27,31 +26,30 @@ const generateHtml = async (outputDir, htmlFile, reportData, inline) => {
 
         outputDir,
         reportDataFile: 'report-data.js',
-        assetsName: 'assets',
         assetsRelative: ''
     };
 
     const htmlPath = await Util.saveHtmlReport(options);
-    console.log(`[MCR] html report: ${EC.cyan(htmlPath)}`);
+    Util.logInfo(`html report: ${EC.cyan(htmlPath)}`);
 
     const cmd = `npx monocart show-report ${htmlPath}`;
-    console.log(`[MCR] view report: ${EC.cyan(cmd)}`);
+    Util.logInfo(`view report: ${EC.cyan(cmd)}`);
 
     return htmlPath;
 };
 
 const sendEmail = (emailOptions) => {
     if (!emailOptions.transport || !emailOptions.message) {
-        EC.logRed('[MCR] invalid email options, transport and message are required (https://nodemailer.com/)');
+        Util.logError('invalid email options, transport and message are required (https://nodemailer.com/)');
         return;
     }
-    console.log('[MCR] sending email ...');
+    Util.logInfo('sending email ...');
     const transporter = nodemailer.createTransport(emailOptions.transport);
     return transporter.sendMail(emailOptions.message);
 };
 
 const showTestResults = (reportData) => {
-    console.log(`[MCR] test results: ${EC.cyan(reportData.name)}`);
+    Util.logInfo(`test results: ${EC.cyan(reportData.name)}`);
 
     const summary = reportData.summary;
 
@@ -127,7 +125,7 @@ const showTestResults = (reportData) => {
         value: Util.TF(reportData.duration)
     }]);
 
-    CG({
+    Util.logGrid({
         options: {
             headerVisible: false
         },
@@ -138,12 +136,13 @@ const showTestResults = (reportData) => {
         }],
         rows
     });
+
 };
 
 
 const generateReport = async (reportData, options) => {
 
-    console.log('[MCR] generating test report ...');
+    Util.logInfo('generating test report ...');
     showTestResults(reportData);
 
     const {
@@ -153,7 +152,7 @@ const generateReport = async (reportData, options) => {
     if (artifacts) {
         artifacts.forEach((report) => {
             const g = report.global ? `${EC.magenta('(global)')}` : '';
-            console.log(`[MCR] ${report.name}: ${EC.cyan(report.path)} ${report.title} ${g}`);
+            Util.logInfo(`${report.name}: ${EC.cyan(report.path)} ${report.title} ${g}`);
             // convert path to relative reporter
             report.path = Util.relativePath(report.path, outputDir);
         });

package/lib/index.d.ts

@@ -39,16 +39,11 @@ export type CoverageReportOptions = {
     outputName?: string,
 
     // Whether to convert to Istanbul report
-    toIstanbul?: boolean,
+    toIstanbul?: boolean | string,
 
     // A filter function to execute for each element in the V8 list.
     entryFilter?: (entry: any) => boolean,
 
-    // Whether to unpack all sources from the source map if a related source map file is found.
-    unpackSourceMap?: boolean,
-    // Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
-    excludeDistFile?: boolean,
-
     // A filter function to execute for each element in the sources which unpacked from the source map.
     sourceFilter?: (sourcePath: string) => boolean,
 
@@ -67,9 +62,7 @@ export type CoverageReportOptions = {
     },
 
     // Whether inline all scripts to the single HTML file.
-    inline?: boolean,
-
-    debug?: boolean
+    inline?: boolean
 };
 
 export function attachCoverageReport(

package/lib/index.js

@@ -11,6 +11,7 @@ const { addCoverageReport, attachCoverageReport } = require('./plugins/coverage/
 const { attachNetworkReport } = require('./plugins/network/network.js');
 
 const { createStateServer, useState } = require('./plugins/state/state.js');
+const Util = require('./utils/util.js');
 
 // custom reporter
 // https://playwright.dev/docs/test-reporters#custom-reporters
@@ -36,6 +37,8 @@ class Reporter {
             ... userOptions
         };
 
+        Util.initLoggingLevel(this.options.logging, 'reporter');
+
         this.system = getSystemInfo();
         this.system.timestampStart = timestampStart;
         this.system.ticks = [];
@@ -47,6 +50,9 @@ class Reporter {
         this.tickTime = this.options.tickTime || 1000;
         this.tickStart();
 
+        // clean assets dir
+        Util.initAssetsDir(this.options);
+
         const stateOptions = this.options.state;
         if (stateOptions) {
             this.stateServer = createStateServer(stateOptions);

package/lib/merge-data.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const path = require('path');
-const EC = require('eight-colors');
 const Util = require('./utils/util.js');
 const generateReport = require('./generate-report.js');
 const defaultOptions = require('./default/options.js');
@@ -16,7 +15,7 @@ const checkReportData = (item) => {
 
 const initDataList = (reportDataList) => {
     if (!Util.isList(reportDataList)) {
-        EC.logRed(`[MCR] invalid report data list: ${reportDataList}`);
+        Util.logError(`invalid report data list: ${reportDataList}`);
         return;
     }
 
@@ -28,16 +27,16 @@ const initDataList = (reportDataList) => {
             const data = Util.readJSONSync(item);
             if (!data) {
                 hasError = true;
-                EC.logRed(`[MCR] failed to read report data file: ${item}`);
+                Util.logError(`failed to read report data file: ${item}`);
                 continue;
             }
             list.push(data);
-            EC.logGreen(`[MCR] report data loaded: ${item}`);
+            Util.logInfo(`report data loaded: ${item}`);
             continue;
         }
 
         if (!checkReportData(item)) {
-            EC.logRed(`[MCR] unmatched report data format: ${item}`);
+            Util.logError(`unmatched report data format: ${item}`);
             return;
         }
         list.push(item);
@@ -164,7 +163,9 @@ const mergeDataList = async (dataList, options) => {
 
 module.exports = async (reportDataList, userOptions = {}) => {
 
-    console.log('[MCR] merging report data ...');
+    Util.initLoggingLevel(userOptions.logging, 'merge');
+
+    Util.logInfo('merging report data ...');
 
     const dataList = await initDataList(reportDataList);
     if (!dataList) {

package/lib/plugins/audit/audit.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const path = require('path');
-const EC = require('eight-colors');
 const Util = require('../../utils/util.js');
 
 const getStatus = (s) => {
@@ -65,8 +64,11 @@ const getSummaryReport = (lhr) => {
 
 const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
 
+    const reporterOptions = Util.resolveReporterOptions(testInfo);
+    Util.initLoggingLevel(reporterOptions.logging, 'audit');
+
     if (!runnerResult || !runnerResult.lhr || !runnerResult.report) {
-        EC.logRed('[MCR] invalid lighthouse runner result');
+        Util.logError('invalid lighthouse runner result');
         return;
     }
 

package/lib/plugins/comments.js

@@ -1,5 +1,4 @@
 const fs = require('fs');
-const EC = require('eight-colors');
 const { parse } = require('../runtime/monocart-vendor.js');
 const Util = require('../utils/util.js');
 
@@ -32,8 +31,8 @@ const getFileComments = (filePath, parserOptions = {}) => {
     try {
         ast = parse(source, parserOptions);
     } catch (e) {
-        EC.logRed(`[MCR] ${e.message}`);
-        EC.logRed(`[MCR] failed to collect comments from file: "${Util.relativePath(filePath)}" please try different parser options like: sourceType: "module", plugins: ["typescript"] and more https://babeljs.io/docs/babel-parser`);
+        Util.logError(e.message);
+        Util.logError(`failed to collect comments from the file: ${Util.relativePath(filePath)}`);
         return map;
     }
 

package/lib/plugins/coverage/converter/collect-source-maps.js

@@ -0,0 +1,194 @@
+const fs = require('fs');
+const EC = require('eight-colors');
+const { fileURLToPath } = require('url');
+const Concurrency = require('../../../platform/concurrency.js');
+const { convertSourceMap, axios } = require('../../../runtime/monocart-coverage.js');
+
+const Util = require('../../../utils/util.js');
+
+const request = async (options) => {
+    if (typeof options === 'string') {
+        options = {
+            url: options
+        };
+    }
+    let err;
+    const res = await axios(options).catch((e) => {
+        err = e;
+    });
+    return [err, res];
+};
+
+const loadSourceMap = async (url = '') => {
+
+    if (url.startsWith('file://')) {
+        const p = fileURLToPath(url);
+        const json = Util.readJSONSync(p);
+        if (!json) {
+            Util.logDebug(EC.red(`failed to load sourcemap ${p}`));
+            return;
+        }
+        return json;
+    }
+
+    const [err, res] = await request({
+        url
+    });
+
+    if (err) {
+        Util.logDebug(EC.red(`${err.message} ${url}`));
+        return;
+    }
+
+    return res.data;
+};
+
+const getSourceMapUrl = (content, url) => {
+
+    const m = content.match(convertSourceMap.mapFileCommentRegex);
+    if (!m) {
+        return;
+    }
+
+    const comment = m.pop();
+    const r = convertSourceMap.mapFileCommentRegex.exec(comment);
+    // for some odd reason //# .. captures in 1 and /* .. */ in 2
+    const filename = r[1] || r[2];
+
+    let mapUrl;
+
+    try {
+        mapUrl = new URL(filename, url);
+    } catch (e) {
+        Util.logDebug(EC.red(`${e.message} ${filename} ${url}`));
+    }
+    if (mapUrl) {
+        return mapUrl.toString();
+    }
+};
+
+const resolveSourceMap = (data) => {
+    if (data) {
+        const {
+            sources, sourcesContent, mappings
+        } = data;
+        if (!sources || !sourcesContent || !mappings) {
+            return;
+        }
+        return data;
+    }
+};
+
+const collectInlineSourceMaps = async (v8list) => {
+    let count = 0;
+    const concurrency = new Concurrency();
+    for (const item of v8list) {
+
+        const { type, source } = item;
+
+        // only for js
+        if (type === 'js') {
+            const converter = convertSourceMap.fromSource(source);
+            if (converter) {
+                item.sourceMap = resolveSourceMap(converter.sourcemap);
+                count += 1;
+                // source map comments is inline source map, remove it because it is big
+                item.source = convertSourceMap.removeComments(source);
+
+                continue;
+            }
+            const sourceMapUrl = getSourceMapUrl(source, item.url);
+            if (sourceMapUrl) {
+                // console.log('========================', sourceMapUrl);
+                item.sourceMapUrl = sourceMapUrl;
+                concurrency.addItem(item);
+            }
+        }
+    }
+    await concurrency.start(async (item) => {
+        const data = await loadSourceMap(item.sourceMapUrl);
+        if (data) {
+            item.sourceMap = resolveSourceMap(data);
+            count += 1;
+            // source map comments is a link, no need remove
+        }
+    });
+
+    return count;
+};
+
+const collectFileSourceMaps = async (v8list, options) => {
+    let count = 0;
+    const concurrency = new Concurrency();
+    for (const item of v8list) {
+
+        const {
+            type, url, source, id
+        } = item;
+
+        // remove source just keep functions to reduce artifacts size
+        delete item.source;
+
+        const sourcePath = Util.resolveArtifactSourcePath(options.artifactsDir, id);
+        if (fs.existsSync(sourcePath)) {
+            continue;
+        }
+
+        const sourceData = {
+            url,
+            id,
+            source: convertSourceMap.removeComments(source)
+        };
+
+        // only for js
+        if (type === 'js') {
+            const converter = convertSourceMap.fromSource(source);
+            if (converter) {
+                sourceData.sourceMap = resolveSourceMap(converter.sourcemap);
+                count += 1;
+                await saveSourceFile(sourcePath, sourceData);
+                continue;
+            }
+            const sourceMapUrl = getSourceMapUrl(source, item.url);
+            if (sourceMapUrl) {
+                concurrency.addItem({
+                    sourceMapUrl,
+                    sourcePath,
+                    sourceData
+                });
+                continue;
+            }
+        }
+
+        await saveSourceFile(sourcePath, sourceData);
+
+    }
+
+    await concurrency.start(async (item) => {
+        const sourceData = item.sourceData;
+        const data = await loadSourceMap(item.sourceMapUrl);
+        if (data) {
+            sourceData.sourceMap = resolveSourceMap(data);
+            count += 1;
+        }
+        await saveSourceFile(item.sourcePath, sourceData);
+    });
+
+    return count;
+};
+
+const saveSourceFile = async (filePath, data) => {
+    await Util.writeFile(filePath, JSON.stringify(data));
+};
+
+const collectSourceMaps = (v8list, options, inlineSourceMap) => {
+
+    if (inlineSourceMap) {
+        return collectInlineSourceMaps(v8list);
+    }
+
+    return collectFileSourceMaps(v8list, options);
+
+};
+
+module.exports = collectSourceMaps;