monocart-reporter 1.7.12 → 2.0.0

package/lib/platform/share.js

@@ -19,11 +19,6 @@ const Util = {
             name: 'network',
             contentType: 'text/html',
             reportFile: 'network-report.json'
-        },
-        // artifact will be removed finally
-        artifact: {
-            name: 'artifact',
-            contentType: 'application/json'
         }
     },
 

package/lib/plugins/audit/audit.js

@@ -73,7 +73,7 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
     }
 
     options = {
-        title: `Lighthouse Report - ${testInfo.title}`,
+        name: `Lighthouse Report - ${testInfo.title}`,
         outputDir: Util.resolveOutputDir(testInfo, options),
         outputName: `audit-${Util.resolveTestIdWithRetry(testInfo)}`,
         ... options
@@ -89,7 +89,7 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
 
     // `.lhr` is the Lighthouse Result as a JS object
     const report = {
-        title: options.title,
+        name: options.name,
         ... getSummaryReport(runnerResult.lhr)
     };
 

package/lib/plugins/coverage/coverage.js

@@ -1,302 +1,116 @@
 const fs = require('fs');
 const path = require('path');
-
+const CoverageReport = require('monocart-coverage-reports');
 const Util = require('../../utils/util.js');
-const {
-    initIstanbulData, mergeIstanbulCoverage, saveIstanbulReport
-} = require('./istanbul/istanbul.js');
-const {
-    initV8ListAndSourcemap, mergeV8Coverage, saveV8Report
-} = require('./v8/v8.js');
-
-const { convertV8List } = require('./converter/converter.js');
-
-const artifactsDirName = '.artifacts';
-
-const defaultOptions = {
-
-    // Defaults to test title
-    // title
-    // outputDir
-    // outputName
-
-    // (Boolean) Whether to convert to Istanbul report from V8 list. Defaults to `html-spa` report | (String) or using `html` report
-    toIstanbul: false,
 
-    // (Function) A filter function to execute for each element in the V8 list.
-    entryFilter: null,
+const attachCoverageReport = async (data, testInfo, options = {}) => {
 
-    // (Function) A filter function to execute for each element in the sources which unpacked from the source map.
-    sourceFilter: null,
+    const reporterOptions = Util.resolveReporterOptions(testInfo);
 
-    // Istanbul Only
+    const outputDir = Util.resolveOutputDir(testInfo, options);
+    const folderName = `coverage-${Util.resolveTestIdWithRetry(testInfo)}`;
 
-    // source path handler
-    sourcePath: null,
-
-    // (usually not used) source finder for Istanbul HTML report
-    sourceFinder: null,
-
-    // (Boolean) Whether to create `lcov.info`
-    lcov: false,
-
-    // (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report)
-    // watermarks: {},
-    // (Array) V8 watermarks, Defaults to `[50, 80]`
-    // watermarks: [50, 80],
-
-    // (Boolean) Whether inline all scripts to the single HTML file. V8 only.
-    inline: false
-
-};
-
-// ========================================================================================================
-
-const generateV8ListReport = async (v8list, coverageData, fileSources, options) => {
-    const { toIstanbul, lcov } = options;
-    const istanbulReport = toIstanbul || lcov;
-    const v8Report = !toIstanbul;
-
-    let report;
-    if (istanbulReport) {
-        report = await saveIstanbulReport(coverageData, fileSources, options);
-    }
-    if (v8Report) {
-        report = await saveV8Report(v8list, options);
+    // support multiple calls
+    let outputName = folderName;
+    let htmlDir = path.resolve(outputDir, outputName);
+    let i = 0;
+    while (fs.existsSync(htmlDir)) {
+        i += 1;
+        outputName = `${folderName}-${i}`;
+        htmlDir = path.resolve(outputDir, outputName);
     }
 
-    return report;
-};
-
-// ========================================================================================================
+    const coverageOptions = {
+        logging: reporterOptions.logging,
+        outputDir: htmlDir,
+        name: `Coverage Report - ${testInfo.title}`,
+        assetsPath: '../assets',
+        ... options
+    };
 
-const saveReportAttachment = (testInfo, report, htmlDir) => {
+    const coverageReport = new CoverageReport(coverageOptions);
+    await coverageReport.add(data);
+    const coverageResults = await coverageReport.generate();
 
+    // save report json
     const definition = Util.attachments.coverage;
-    // save report
     const reportPath = path.resolve(htmlDir, definition.reportFile);
-    Util.writeJSONSync(reportPath, report);
+    Util.writeJSONSync(reportPath, coverageResults);
 
+    // save attachments html link
     testInfo.attachments.push({
         name: definition.name,
         contentType: definition.contentType,
-        path: path.resolve(htmlDir, 'index.html')
+        path: coverageResults.reportPath
     });
-};
-
-// ========================================================================================================
-
-const generateIstanbulReport = (istanbulData, testInfo, options) => {
 
-    const { coverageData, fileSources } = initIstanbulData(istanbulData, options);
-    const report = saveIstanbulReport(coverageData, fileSources, options);
-
-    saveReportAttachment(testInfo, report, options.htmlDir);
-
-    return report;
+    return coverageResults;
 };
 
-
 // ========================================================================================================
 
-const generateV8Coverage = async (v8list, testInfo, options) => {
-
-    // init v8list and unpack sourcemap
-    const inlineSourceMap = true;
-    v8list = await initV8ListAndSourcemap(v8list, options, inlineSourceMap);
-
-    const { coverageData, fileSources } = await convertV8List(v8list, options);
-
-    const report = await generateV8ListReport(v8list, coverageData, fileSources, options);
+const getGlobalCoverageOptions = async (reporterOptions) => {
 
-    saveReportAttachment(testInfo, report, options.htmlDir);
+    const reporterOutputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
+    const outputDir = path.dirname(reporterOutputFile);
+    const htmlDir = path.resolve(outputDir, 'coverage');
 
-    return report;
-};
-
-const attachCoverageReport = (data, testInfo, options = {}) => {
-
-    const logging = Util.resolveLogging(testInfo, options);
-    Util.initLoggingLevel(logging, 'coverage-attach');
-
-    if (!data) {
-        Util.logError(`invalid coverage data: ${testInfo.title}`);
-        return;
-    }
-
-    options = {
-        ... defaultOptions,
-        // default title
-        title: `Coverage Report - ${testInfo.title}`,
-        outputDir: Util.resolveOutputDir(testInfo, options),
-        outputName: `coverage-${Util.resolveTestIdWithRetry(testInfo)}`,
-        ... options
+    const coverageOptions = {
+        logging: reporterOptions.logging,
+        outputDir: htmlDir,
+        name: `Coverage Report - ${reporterOptions.name}`,
+        assetsPath: '../assets',
+        // merge all global coverage options
+        ... reporterOptions.coverage
     };
 
-    // support multiple calls
-    let htmlDir = path.resolve(options.outputDir, options.outputName);
-    let i = 1;
-    while (fs.existsSync(htmlDir)) {
-        const outputName = `${options.outputName}-${i}`;
-        htmlDir = path.resolve(options.outputDir, outputName);
-        i += 1;
-    }
-
-    Util.initDir(htmlDir);
-    options.htmlDir = htmlDir;
-
-    const dataType = Array.isArray(data) ? 'v8' : 'istanbul';
-    // console.log('data type', dataType);
-
-    if (dataType === 'v8') {
-        return generateV8Coverage(data, testInfo, options);
-    }
-
-    return generateIstanbulReport(data, testInfo, options);
+    return coverageOptions;
 };
 
-// ========================================================================================================
-
 //  add coverage report to global, v8list only
-const addCoverageReport = async (data, testInfo, options = {}) => {
-
-    const logging = Util.resolveLogging(testInfo, options);
-    Util.initLoggingLevel(logging, 'coverage-add');
-
-    if (!data) {
-        Util.logError(`invalid coverage data: ${testInfo.title}`);
-        return;
-    }
-
-    // global outputDir
-    const outputDir = await Util.resolveGlobalOutputDir(testInfo, options);
-
-    const coverageOptions = Util.resolveCoverageOptions(testInfo, options);
-
-    options = {
-        ... defaultOptions,
-        // use reporter dir as output dir, NOT test output dir
-        outputDir,
-        outputName: 'coverage',
-        ... coverageOptions
-    };
-
-    const reportDir = path.resolve(options.outputDir, options.outputName);
-    // do NOT empty dir, there are previous artifacts generated
-
-    // artifactsDir for temp artifact files
-    const artifactsDir = path.resolve(reportDir, artifactsDirName);
-    options.artifactsDir = artifactsDir;
-
-    const filename = `coverage-${Util.resolveTestIdWithRetry(testInfo)}.json`;
-    const jsonPath = path.resolve(artifactsDir, filename);
-
-    const report = {
-        title: testInfo.title
-    };
-
-    if (Array.isArray(data)) {
-        // init v8list and unpack sourcemap
-        const inlineSourceMap = false;
-        report.data = await initV8ListAndSourcemap(data, options, inlineSourceMap);
-    } else {
-        // istanbul
-        report.data = data;
-    }
+const addCoverageReport = async (data, testInfo) => {
 
-    const artifactContent = JSON.stringify({
-        type: 'coverage',
-        data: report
-    });
-
-    await Util.writeFile(jsonPath, artifactContent);
+    const reporterOptions = Util.resolveReporterOptions(testInfo);
+    const coverageOptions = await getGlobalCoverageOptions(reporterOptions);
 
-    const definition = Util.attachments.artifact;
-    testInfo.attachments.push({
-        name: definition.name,
-        contentType: definition.contentType,
-        path: jsonPath
-    });
+    const coverageReport = new CoverageReport(coverageOptions);
+    const results = await coverageReport.add(data);
 
-    return report;
+    return results;
 };
 
-// ========================================================================================================
-
-const getGlobalCoverageData = async (dataList, options) => {
+const generateGlobalCoverageReport = async (reporterOptions) => {
 
-    // get first and check v8list or istanbul data
-    const firstData = dataList[0].data;
-    const dataType = Array.isArray(firstData) ? 'v8' : 'istanbul';
-    // console.log('data type', dataType);
+    const coverageOptions = await getGlobalCoverageOptions(reporterOptions);
 
-    // v8list
-    if (dataType === 'v8') {
-        // merge v8list first
-        const v8list = await mergeV8Coverage(dataList, options);
-        // console.log('after merge', v8list.map((it) => it.url));
-
-        const { coverageData, fileSources } = await convertV8List(v8list, options);
-        return generateV8ListReport(v8list, coverageData, fileSources, options);
+    const coverageReport = new CoverageReport(coverageOptions);
 
+    // check if has cache
+    if (!coverageReport.hasCache()) {
+        return;
     }
 
-    // istanbul data
-    const istanbulData = mergeIstanbulCoverage(dataList, options);
-    const { coverageData, fileSources } = initIstanbulData(istanbulData, options);
-    return saveIstanbulReport(coverageData, fileSources, options);
-
-};
-
-// global coverage report, run different process with addCoverageReport
-const addGlobalCoverageReport = async (dataList, coverageOptions) => {
-
-    Util.logInfo('generating global coverage report ...');
-
-    const options = {
-        ... defaultOptions,
-        ... coverageOptions
-    };
-
-    const reportDir = path.resolve(options.outputDir, options.outputName);
-
-    // empty dir except artifacts dir
-    if (fs.existsSync(reportDir)) {
-        fs.readdirSync(reportDir).forEach((itemName) => {
-            if (itemName === artifactsDirName) {
-                return;
-            }
-            Util.rmSync(path.resolve(reportDir, itemName));
-        });
+    const coverageResults = await coverageReport.generate();
+    if (!coverageResults) {
+        return;
     }
 
-    options.htmlDir = reportDir;
+    // coverageResults: type, reportPath, name, watermarks, summary, files
 
-    // artifactsDir for temp artifact files
-    const artifactsDir = path.resolve(reportDir, artifactsDirName);
-    options.artifactsDir = artifactsDir;
+    // showing list props: global, name, path, title
 
-    const report = await getGlobalCoverageData(dataList, options);
-    // console.log(report);
-
-    // =============================================================
-    // remove artifacts dir after report generated
-    if (Util.loggingType !== 'debug') {
-        Util.rmSync(artifactsDir);
-    }
-    // =============================================================
+    // console.log('global coverage report', report);
 
     return {
         global: true,
-        name: 'coverage',
-        path: report.htmlPath,
-        summary: report.summary,
-        title: options.title
+        type: 'coverage',
+        name: coverageResults.name,
+        path: coverageResults.reportPath
     };
 };
 
 module.exports = {
     addCoverageReport,
-    addGlobalCoverageReport,
-    attachCoverageReport
+    attachCoverageReport,
+    generateGlobalCoverageReport
 };

package/lib/plugins/network/network.js

@@ -96,21 +96,25 @@ const getNetworkSummary = (log) => {
 
 const saveNetworkHtmlReport = async (reportData, _options) => {
 
-    const {
-        htmlDir, outputDir, inline
-    } = _options;
+    const { htmlDir, inline } = _options;
+
+    // deps
+    const jsFiles = ['monocart-code-viewer', 'monocart-formatter', 'turbogrid'].map((it) => {
+        return path.resolve(`node_modules/${it}/dist/${it}.js`);
+    });
+
+    jsFiles.push(path.resolve(__dirname, '../../packages/monocart-common.js'));
+    jsFiles.push(path.resolve(__dirname, '../../packages/monocart-network.js'));
 
     const options = {
         inline,
         reportData,
-        jsFiles: ['monocart-code-viewer.js', 'monocart-formatter.js', 'monocart-common.js', 'monocart-network.js'],
-        htmlDir,
+        jsFiles,
+        assetsPath: '../assets',
+        outputDir: htmlDir,
         htmlFile: 'index.html',
 
-        outputDir,
-        reportDataFile: 'network-data.js',
-        assetsName: 'assets',
-        assetsRelative: '../'
+        reportDataFile: 'network-data.js'
     };
 
     const htmlPath = await Util.saveHtmlReport(options);
@@ -131,7 +135,7 @@ const attachNetworkReport = async (har, testInfo, options = {}) => {
 
     options = {
         // default title
-        title: `Network Report - ${testInfo.title}`,
+        name: `Network Report - ${testInfo.title}`,
         outputDir: Util.resolveOutputDir(testInfo, options),
         outputName: `network-${Util.resolveTestIdWithRetry(testInfo)}`,
         inline: false,
@@ -150,7 +154,7 @@ const attachNetworkReport = async (har, testInfo, options = {}) => {
 
     // save har
     const reportData = {
-        title: options.title,
+        name: options.name,
         summary,
         ... harData
     };
@@ -158,14 +162,14 @@ const attachNetworkReport = async (har, testInfo, options = {}) => {
     const htmlPath = await saveNetworkHtmlReport(reportData, options);
 
     const report = {
-        title: options.title,
+        name: options.name,
         ... harData.log,
         htmlPath,
         summary
     };
     delete report.entries;
 
-    // save report
+    // save report json
     const definition = Util.attachments.network;
     const reportPath = path.resolve(htmlDir, definition.reportFile);
     Util.writeJSONSync(reportPath, report);

package/lib/plugins/state/client.js

@@ -1,4 +1,4 @@
-const { WebSocket } = require('../../runtime/monocart-vendor.js');
+const { WebSocket } = require('../../packages/monocart-vendor.js');
 const Util = require('../../utils/util.js');
 
 const getServerUrl = (options = {}) => {

package/lib/plugins/state/state.js

@@ -1,5 +1,5 @@
 const EC = require('eight-colors');
-const { WebSocketServer } = require('../../runtime/monocart-vendor.js');
+const { WebSocketServer } = require('../../packages/monocart-vendor.js');
 const Util = require('../../utils/util.js');
 const { getServerUrl, Client } = require('./client.js');
 

package/lib/utils/parse-source.js

@@ -1,5 +1,5 @@
 const Util = require('./util.js');
-const { parse } = require('../runtime/monocart-vendor.js');
+const { parse } = require('../packages/monocart-vendor.js');
 
 const parseSource = (data) => {
     const {

package/lib/utils/util.js

@@ -8,6 +8,8 @@ const CG = require('console-grid');
 const Share = require('../platform/share.js');
 const { deflateSync } = require('lz-utils');
 
+const defaultOptions = require('../default/options.js');
+
 const assetsName = 'assets';
 
 const Util = {
@@ -79,24 +81,16 @@ const Util = {
         return path.resolve(testInfo.outputDir, '../');
     },
 
-    resolveGlobalOutputDir: async (testInfo, options) => {
-        if (options && options.outputDir) {
-            return options.outputDir;
-        }
-        const reporterOptions = Util.resolveReporterOptions(testInfo);
-        const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
-        const outputDir = path.dirname(outputFile);
-        return outputDir;
-    },
-
     resolveOutputFile: async (outputFile) => {
+        // function to string first
         if (typeof outputFile === 'function') {
             outputFile = await outputFile();
         }
-        if (typeof outputFile === 'string' && outputFile) {
-            return outputFile;
+        // then check string
+        if (!outputFile || typeof outputFile !== 'string') {
+            outputFile = defaultOptions.outputFile;
         }
-        return './test-results/report.html';
+        return path.resolve(outputFile);
     },
 
     resolveLogging: (testInfo, options) => {
@@ -107,14 +101,6 @@ const Util = {
         return reporterOptions.logging;
     },
 
-    resolveCoverageOptions: (testInfo, options) => {
-        const reporterOptions = Util.resolveReporterOptions(testInfo);
-        return {
-            ... reporterOptions.coverage,
-            ... options
-        };
-    },
-
     resolveReporterOptions: (testInfo) => {
         if (!testInfo) {
             return {};
@@ -171,12 +157,11 @@ const Util = {
             inline,
             reportData,
             jsFiles,
-            htmlDir,
+            assetsPath,
+            outputDir,
             htmlFile,
 
-            outputDir,
-            reportDataFile,
-            assetsRelative
+            reportDataFile
         } = options;
 
         //  report data
@@ -186,10 +171,9 @@ const Util = {
         // js libs
         const jsList = [];
         for (const jsFile of jsFiles) {
-            const jsPath = path.resolve(__dirname, `../runtime/${jsFile}`);
-            const jsStr = await Util.readFile(jsPath);
+            const jsStr = await Util.readFile(jsFile);
             jsList.push({
-                file: jsFile,
+                filename: path.basename(jsFile),
                 str: jsStr
             });
         }
@@ -206,10 +190,13 @@ const Util = {
             ].join(EOL);
         } else {
 
-            await Util.writeFile(path.resolve(htmlDir, reportDataFile), reportDataStr);
+            await Util.writeFile(path.resolve(outputDir, reportDataFile), reportDataStr);
+
+            const assetsDir = path.resolve(outputDir, assetsPath);
+            const relAssetsDir = Util.relativePath(assetsDir, outputDir);
 
             for (const item of jsList) {
-                const filePath = path.resolve(outputDir, assetsName, item.file);
+                const filePath = path.resolve(assetsDir, item.filename);
                 if (!fs.existsSync(filePath)) {
                     await Util.writeFile(filePath, item.str);
                 }
@@ -217,12 +204,12 @@ const Util = {
 
             htmlStr = [
                 `<script src="${reportDataFile}"></script>`,
-                ... jsList.map((it) => `<script src="${assetsRelative}${assetsName}/${it.file}"></script>`)
+                ... jsList.map((it) => `<script src="${relAssetsDir}/${it.filename}"></script>`)
             ].join(EOL);
         }
 
         // html
-        const htmlPath = path.resolve(htmlDir, htmlFile);
+        const htmlPath = path.resolve(outputDir, htmlFile);
         const template = Util.getTemplate(path.resolve(__dirname, '../default/template.html'));
         const html = Util.replace(template, {
             title: reportData.title,
@@ -319,7 +306,7 @@ const Util = {
     readFile: async (filePath) => {
         if (fs.existsSync(filePath)) {
             const buf = await readFile(filePath).catch((e) => {
-                console.log(e);
+                Util.logError(`read file: ${filePath} ${e.message || e}`);
             });
             if (Buffer.isBuffer(buf)) {
                 return buf.toString('utf8');
@@ -350,7 +337,7 @@ const Util = {
             }
         }
         await writeFile(filePath, content).catch((e) => {
-            console.log(e);
+            Util.logError(`write file: ${filePath} ${e.message || e}`);
         });
     },
 
@@ -433,14 +420,14 @@ const Util = {
         if (Util.loggingLevel < Util.loggingLevels.error) {
             return;
         }
-        EC.logRed(`[MCR] ${message}`);
+        EC.logRed(`[MR] ${message}`);
     },
 
     logInfo: (message) => {
         if (Util.loggingLevel < Util.loggingLevels.info) {
             return;
         }
-        console.log(`[MCR] ${message}`);
+        console.log(`[MR] ${message}`);
     },
 
     // grid is info level
@@ -455,7 +442,7 @@ const Util = {
         if (Util.loggingLevel < Util.loggingLevels.debug) {
             return;
         }
-        console.log(`[MCR] ${message}`);
+        console.log(`[MR] ${message}`);
     },
 
     // time is debug level
@@ -465,7 +452,7 @@ const Util = {
         }
         const duration = Date.now() - time_start;
         const durationH = Util.TSF(duration);
-        const ls = [`[MCR] ${message}`, ' ('];
+        const ls = [`[MR] ${message}`, ' ('];
         if (duration <= 100) {
             ls.push(EC.green(durationH));
         } else if (duration < 500) {