monocart-coverage-reports 2.9.3 → 2.10.1

package/README.md

@@ -107,6 +107,7 @@ For more information, see [Command Line](#command-line)
     - Features: 
         - A Brand-New V8 Coverage Report User Interface
         - Support for Native Byte Statistics
+        - Support processing big data with high performance
         - Coverage for Any Runtime Code
         - CSS Coverage Support
         - Better Support for Sourcemap Conversion
@@ -115,7 +116,10 @@ For more information, see [Command Line](#command-line)
 ![](./assets/v8.gif)
 
 - `v8-json`
-    - [V8 coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
+    - Save `CoverageResults` to a json file (defaults to [`coverage-report.json`](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)).
+    - Shows native V8 code coverage with VSCode extension [monocart-coverage-vscode](https://github.com/cenfun/monocart-coverage-vscode)
+
+![](./assets/mcv.gif)
 
 > Istanbul build-in reports (both V8 and Istanbul data):
 
@@ -158,6 +162,7 @@ cat path-to/coverage-summary.md >> $GITHUB_STEP_SUMMARY
 ![](./assets/markdown-summary.png)
 
 - `markdown-details` Save coverage details to a markdown file (defaults to `coverage-details.md`).
+    - Preview in [runs](https://github.com/cenfun/monocart-coverage-reports/actions/workflows/ci.yml)
 
 - `raw` only keep all original data, which can be used for other reports input with `inputDir`. see [Merge Coverage Reports](#merge-coverage-reports)
 

package/README.zh-Hans.md

@@ -107,6 +107,7 @@ mcr node my-app.js -r v8,console-details
     - 推荐使用: 
         - 全新的原生V8覆盖率报告界面，更好的用户体验
         - 支持原生的Bytes覆盖率指标
+        - 支持高性能处理大数据
         - 支持任何运行时代码的覆盖率（压缩后的）
         - 支持CSS代码覆盖率（用于分析CSS的冗余代码）
         - 对Sourcemap转换有更好的支持
@@ -115,7 +116,8 @@ mcr node my-app.js -r v8,console-details
 ![](./assets/v8.gif)
 
 - `v8-json`
-    - [V8 coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
+    - 保存 `CoverageResults` 到一个json文件
+    - 预览 [coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
 
 > 内置Istanbul报告 (V8和Istanbul格式数据都支持):
 
@@ -158,6 +160,7 @@ cat path-to/coverage-summary.md >> $GITHUB_STEP_SUMMARY
 ![](./assets/markdown-summary.png)
 
 - `markdown-details` 保存覆盖率详情到markdown文件 (默认是 `coverage-details.md`)
+    - 预览运行结果 [runs](https://github.com/cenfun/monocart-coverage-reports/actions/workflows/ci.yml)
 
 - `raw` 只是保存原始覆盖率数据, 用于使用`inputDir`参数来导入多个原始数据进行合并报告。参见 [合并覆盖率报告](#merge-coverage-reports)
 

package/lib/assets.js

@@ -0,0 +1,98 @@
+const fs = require('fs');
+const path = require('path');
+const { deflateSync } = require('lz-utils');
+const Util = require('./utils/util.js');
+const assetsMap = require('./packages/monocart-coverage-assets.js');
+
+const Assets = {
+
+    getFileContent: (id) => {
+        const content = assetsMap[id];
+        if (!content) {
+            Util.logError(`Not found module: ${id}`);
+            return '';
+        }
+        return content;
+    },
+
+    saveHtmlReport: async (options) => {
+
+        const {
+            inline,
+            reportData,
+            jsFiles,
+            assetsPath,
+            outputDir,
+            htmlFile,
+
+            saveReportPath,
+
+            reportDataFile
+        } = options;
+
+        // save path
+        const htmlPath = path.resolve(outputDir, htmlFile);
+        const reportPath = Util.relativePath(htmlPath);
+        if (saveReportPath) {
+            reportData[saveReportPath] = reportPath;
+        }
+
+        //  report data
+        const reportDataCompressed = deflateSync(JSON.stringify(reportData));
+        const reportDataStr = `window.reportData = '${reportDataCompressed}';`;
+
+        // js libs
+        const jsList = [];
+
+        // deps
+        jsFiles.forEach((id) => {
+            jsList.push({
+                filename: `${id}.js`,
+                str: Assets.getFileContent(id)
+            });
+        });
+
+        // html content
+        let htmlStr = '';
+        const EOL = Util.getEOL();
+        if (inline) {
+            htmlStr = [
+                '<script>',
+                reportDataStr,
+                ... jsList.map((it) => it.str),
+                '</script>'
+            ].join(EOL);
+        } else {
+
+            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(assetsDir, item.filename);
+                if (!fs.existsSync(filePath)) {
+                    await Util.writeFile(filePath, item.str);
+                }
+            }
+
+            htmlStr = [
+                `<script src="${reportDataFile}"></script>`,
+                ... jsList.map((it) => `<script src="${relAssetsDir}/${it.filename}"></script>`)
+            ].join(EOL);
+        }
+
+        // html
+        const template = Assets.getFileContent('template');
+        const html = Util.replace(template, {
+            title: reportData.title,
+            content: htmlStr
+        });
+
+        await Util.writeFile(htmlPath, html);
+
+        return reportPath;
+    }
+};
+
+module.exports = Assets;

package/lib/converter/converter.js

@@ -19,7 +19,7 @@ const {
 const { getSourceType, initSourceMapSourcesPath } = require('../utils/source-path.js');
 
 const { decode } = require('@jridgewell/sourcemap-codec');
-const { minimatch } = require('minimatch');
+const { minimatch } = require('../packages/monocart-coverage-vendor.js');
 
 const InfoBranch = require('./info-branch.js');
 const InfoFunction = require('./info-function.js');
@@ -66,8 +66,8 @@ const applyBytesToLines = (bytes, locator, lineMap) => {
             start, end, count, ignored
         } = range;
 
-        // no need handle ignored and uncovered byte
-        if (count === 0 && ignored) {
+        // no need handle ignored byte
+        if (ignored) {
             return;
         }
 
@@ -141,9 +141,8 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
             return;
         }
 
-        lineItem.coveredCount = 1;
-        lineItem.uncoveredEntire = null;
-        lineItem.uncoveredPieces = [];
+        Util.initLineCoverage(lineItem);
+
         lineMap.set(line, lineItem);
     });
 
@@ -282,8 +281,8 @@ const collectFileCoverage = (v8Data, state, options) => {
 
     // ==========================================
 
-    data.functions = functions.map((info) => {
-        return info.getRange();
+    data.functions = functions.map((info, i) => {
+        return info.getRange(i);
     });
     sortRanges(data.functions);
 
@@ -507,6 +506,11 @@ const handleGeneratedBytesCoverage = (state) => {
     if (js) {
         coverageList.forEach((block) => {
             block.ranges.forEach((range) => {
+
+                const { fixedStart, fixedEnd } = Util.fixSourceRange(state.locator, range.startOffset, range.endOffset);
+                range.startOffset = fixedStart;
+                range.endOffset = fixedEnd;
+
                 addJsBytesCoverage(state, range);
             });
         });
@@ -555,7 +559,9 @@ const handleOriginalFunctionsCoverage = (state, originalStateMap) => {
             start, end, bodyStart, bodyEnd
         } = it;
 
-        const result = findOriginalRange(start, end, state, originalStateMap);
+        const result = findOriginalRange(start, end, state, originalStateMap, {
+            checkName: true
+        });
         if (result.error) {
             logMappingErrors('function', result);
             return;
@@ -571,6 +577,10 @@ const handleOriginalFunctionsCoverage = (state, originalStateMap) => {
             bodyEnd: result.end
         };
 
+        if (result.name) {
+            originalFunction.functionName = result.name;
+        }
+
         // body start and end
         updateFunctionBodyRange(start, end, bodyStart, bodyEnd, originalFunction);
 
@@ -792,6 +802,7 @@ const handleOriginalEmptyBytesCoverage = (state, originalStateMap) => {
     });
 };
 
+
 const handleAllOriginalBytesCoverage = (state, originalStateMap) => {
 
     const { js, coverageList } = state;
@@ -814,7 +825,9 @@ const handleAllOriginalBytesCoverage = (state, originalStateMap) => {
                 startOffset, endOffset, count
             } = range;
 
-            const result = findOriginalRange(startOffset, endOffset, state, originalStateMap);
+            const result = findOriginalRange(startOffset, endOffset, state, originalStateMap, {
+                fixOriginalRange: true
+            });
             if (result.error) {
                 logMappingErrors('byte', result);
                 return;
@@ -863,7 +876,7 @@ const decodeSourceMappings = (state, originalDecodedMap) => {
             // const SOURCE_LINE = 2;
             // const SOURCE_COLUMN = 3;
             // const NAMES_INDEX = 4;
-            const [generatedColumn, sourceIndex, originalLine, originalColumn] = segment;
+            const [generatedColumn, sourceIndex, originalLine, originalColumn, nameIndex] = segment;
             // the segment length could be 1, 4 or 5
 
             if (typeof sourceIndex === 'undefined') {
@@ -883,7 +896,8 @@ const decodeSourceMappings = (state, originalDecodedMap) => {
 
                 sourceIndex,
                 originalLine,
-                originalColumn
+                originalColumn,
+                nameIndex
             };
 
             allDecodedMappings.push(info);
@@ -1102,6 +1116,8 @@ const unpackSourceMap = (state, options) => {
     const fileUrls = {};
     initSourceMapSourcesPath(fileUrls, sourceMap, sourcePath, options);
     state.fileUrls = fileUrls;
+    // for function names
+    state.sourceMapNames = sourceMap.names || [];
 
     // ===============================================
     // decode mappings for each original file
@@ -1496,6 +1512,14 @@ const generateV8DataList = (stateList, options) => {
         coverageData[sourcePath] = istanbulData;
     });
 
+    // sort v8DataList (files)
+    v8DataList.sort((a, b) => {
+        if (a.sourcePath > b.sourcePath) {
+            return 1;
+        }
+        return -1;
+    });
+
     return {
         v8DataList,
         fileSources,

package/lib/converter/find-original-range.js

@@ -1,4 +1,4 @@
-const diffSequence = require('diff-sequences').default;
+const { diffSequence } = require('../packages/monocart-coverage-vendor.js');
 const Util = require('../utils/util.js');
 const EC = Util.EC;
 
@@ -534,8 +534,13 @@ const getGeneratedText = (m1, m2, state, offset) => {
 };
 
 // ========================================================================================================
+const getFunctionName = (mp, state, options) => {
+    if (options.checkName && typeof mp.nameIndex !== 'undefined') {
+        return state.sourceMapNames[mp.nameIndex];
+    }
+};
 
-const getFixedOriginalStart = (start, mappings, state, cache) => {
+const getFixedOriginalStart = (start, mappings, state, cache, options) => {
 
     const [m1, m2] = mappings;
     const { originalState, crossStart } = cache;
@@ -543,7 +548,8 @@ const getFixedOriginalStart = (start, mappings, state, cache) => {
     // cross file from start of line
     if (crossStart) {
         return {
-            originalStart: m2.originalOffset
+            originalStart: m2.originalOffset,
+            originalName: getFunctionName(m2, state, options)
         };
     }
 
@@ -574,7 +580,8 @@ const getFixedOriginalStart = (start, mappings, state, cache) => {
     // }
 
     return {
-        originalStart: originalOffset + originalPos
+        originalStart: originalOffset + originalPos,
+        originalName: getFunctionName(m1, state, options)
     };
 };
 
@@ -635,17 +642,18 @@ const getFixedOriginalEnd = (end, mappings, state, cache) => {
 
 // ========================================================================================================
 
-const getOriginalStartPosition = (cache, state) => {
+const getOriginalStartPosition = (cache, state, options) => {
 
     const { start, startMappings } = cache;
 
     if (Array.isArray(startMappings)) {
-        return getFixedOriginalStart(start, startMappings, state, cache);
+        return getFixedOriginalStart(start, startMappings, state, cache, options);
     }
 
     // Exact match
     return {
-        originalStart: startMappings.originalOffset
+        originalStart: startMappings.originalOffset,
+        originalName: getFunctionName(startMappings, state, options)
     };
 };
 
@@ -872,11 +880,12 @@ const getMappingInfo = (start, end, state) => {
     };
 };
 
-const findOriginalRange = (start, end, state, originalMap) => {
+
+const findOriginalRange = (start, end, state, originalMap, options = {}) => {
 
     const { sourcePath, rangeCache } = state;
 
-    const key = `${start}_${end}`;
+    const key = `${start}_${end}_${Boolean(options.fixOriginalRange)}`;
     if (rangeCache.has(key)) {
         return rangeCache.get(key);
     }
@@ -901,8 +910,8 @@ const findOriginalRange = (start, end, state, originalMap) => {
         return createMappingError(cache.errors);
     }
 
-    const originalStartResult = getOriginalStartPosition(cache, state);
-    const { originalStart } = originalStartResult;
+    const originalStartResult = getOriginalStartPosition(cache, state, options);
+    const { originalStart, originalName } = originalStartResult;
     // could be used for end
     cache.originalStart = originalStart;
 
@@ -918,19 +927,26 @@ const findOriginalRange = (start, end, state, originalMap) => {
     }
 
     const { originalState } = cache;
+    const locator = originalState.locator;
 
-    const inComment = originalState.locator.lineParser.commentParser.isComment(originalStart, originalEnd);
+    const inComment = locator.lineParser.commentParser.isComment(originalStart, originalEnd);
     if (inComment) {
         return createMappingError(['the range in a original comment']);
     }
 
-
     const res = {
         start: originalStart,
         end: originalEnd,
+        name: originalName,
         originalState
     };
 
+    if (options.fixOriginalRange) {
+        const { fixedStart, fixedEnd } = Util.fixSourceRange(locator, originalStart, originalEnd);
+        res.start = fixedStart;
+        res.end = fixedEnd;
+    }
+
     // cache response
     rangeCache.set(key, res);