monocart-coverage-reports 2.11.0 → 2.11.1

package/README.md

@@ -1,10 +1,12 @@
 # Monocart Coverage Reports
 
-[![](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
-[![](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
-![](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![npm](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
+![license](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
+![build](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![install size](https://packagephobia.com/badge?p=monocart-coverage-reports)](https://packagephobia.com/result?p=monocart-coverage-reports)
+[![npm graph](https://img.shields.io/badge/npm-graph-blue)](https://npmgraph.js.org/?q=monocart-coverage-reports)
+![dependencies](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
+[![downloads](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
 
 🌐 English | [简体中文](README.zh-Hans.md)
 
@@ -485,6 +487,16 @@ export interface ScriptCoverage {
 export type V8CoverageData = ScriptCoverage[];
 ```
 
+| JavaScript Runtime | V8 Coverage |  |
+| :--------------| :----: | :----------------------  |
+| Chrome (65%) | ✅ | Chromium-based |
+| Safari (18%) | ❌ |  |
+| Edge (5%) | ✅ | Chromium-based |
+| Firefox (2%) | ❌ |  |
+| Node.js | ✅ |  |
+| Deno | ❌ | [issue](https://github.com/denoland/deno/issues/23359) |
+| Bun | ❌ |  |
+
 ## Filtering Results
 ### Using `entryFilter` and `sourceFilter` to filter the results for V8 report
 When V8 coverage data collected, it actually contains the data of all entry files, for example:

package/README.zh-Hans.md

@@ -1,10 +1,12 @@
 # Monocart Coverage Reports
 
-[![](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
-[![](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
-![](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![npm](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
+![license](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
+![build](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![install size](https://packagephobia.com/badge?p=monocart-coverage-reports)](https://packagephobia.com/result?p=monocart-coverage-reports)
+[![npm graph](https://img.shields.io/badge/npm-graph-blue)](https://npmgraph.js.org/?q=monocart-coverage-reports)
+![dependencies](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
+[![downloads](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
 
 🌐 [English](README.md) | 简体中文
 
@@ -489,6 +491,16 @@ export interface ScriptCoverage {
 export type V8CoverageData = ScriptCoverage[];
 ```
 
+| JavaScript Runtime | V8 Coverage |  |
+| :--------------| :----: | :----------------------  |
+| Chrome (65%) | ✅ | Chromium-based |
+| Safari (18%) | ❌ |  |
+| Edge (5%) | ✅ | Chromium-based |
+| Firefox (2%) | ❌ |  |
+| Node.js | ✅ |  |
+| Deno | ❌ | [issue](https://github.com/denoland/deno/issues/23359) |
+| Bun | ❌ |  |
+
 ## Filtering Results
 ## Using `entryFilter` and `sourceFilter` to filter the results for V8 report
 当收集到V8的覆盖数据时，它实际上包含了所有的入口文件的覆盖率数据, 比如有以下3个文件:

package/lib/default/options.js

@@ -88,6 +88,9 @@ module.exports = {
     // {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false.
     cleanCache: false,
 
+    // {number} gc threshold
+    gc: null,
+
     // {function} onEntry hook
     // onEntry: async (entry) => {}
     onEntry: null,

package/lib/generate.js

@@ -340,7 +340,7 @@ const resolveEntrySource = (entry, sourceMapCache, sourceCache) => {
     const url = entry.url;
 
     // source from `source-id.json`
-    const sourceData = sourceCache[url];
+    const sourceData = sourceCache.get(url);
     if (sourceData) {
         entry.source = sourceData.source;
         return;
@@ -424,7 +424,7 @@ const readCoverageData = async (dir, filename, entryFilter, sourceCache) => {
 };
 
 const readSourceList = async (dir, sourceList) => {
-    const sourceCache = {};
+    const sourceCache = new Map();
 
     for (const filename of sourceList) {
         const content = await Util.readFile(path.resolve(dir, filename));
@@ -436,7 +436,7 @@ const readSourceList = async (dir, sourceList) => {
             continue;
         }
         if (json.url) {
-            sourceCache[json.url] = json;
+            sourceCache.set(json.url, json);
         }
     }
 
@@ -476,16 +476,16 @@ const readFromDir = async (mcr, dir) => {
 
     const entryFilter = mcr.getEntryFilter();
 
-    const results = [];
     for (const filename of coverageList) {
         const coverageData = await readCoverageData(dir, filename, entryFilter, sourceCache);
         if (coverageData) {
-            const res = await mcr.add(coverageData);
-            results.push(res);
+            await mcr.add(coverageData);
         }
     }
 
-    return results;
+    // GC
+    sourceCache.clear();
+
 };
 
 module.exports = {

package/lib/index.d.ts

@@ -404,6 +404,13 @@ declare namespace MCR {
         */
         cleanCache?: boolean;
 
+        /**
+         * {number} gc threshold
+         * for example: sets gc to 1024 means that force gc when the memory > 1024M at certain critical stages
+         * https://nodejs.org/docs/latest/api/v8.html#v8setflagsfromstringflags
+         */
+        gc?: number;
+
         /** (V8 only) {function} onEntry hook */
         onEntry?: (entry: V8CoverageEntry) => Promise<void>;
 

package/lib/index.js

@@ -68,6 +68,10 @@ class CoverageReport {
         // init logging for clean after generated
         this.logging = Util.initLoggingLevel(this.options.logging);
 
+        if (Util.isNum(this.options.gc)) {
+            Util.setGC(this.options.gc);
+        }
+
         // init outputDir
         const outputDir = `${this.options.outputDir || defaultOptions.outputDir}`;
         this.options.outputDir = outputDir;
@@ -124,9 +128,8 @@ class CoverageReport {
     // add coverage from dir
     async addFromDir(dir) {
         const time_start = Date.now();
-        const results = await readFromDir(this, dir);
+        await readFromDir(this, dir);
         Util.logTime(`added from dir: ${dir}`, time_start);
-        return results;
     }
 
     // generate report

package/lib/istanbul/istanbul.js

@@ -144,7 +144,7 @@ const addUntestedFiles = async (istanbulData, options) => {
 
 };
 
-const mergeIstanbulDataList = (dataList) => {
+const mergeIstanbulDataList = (dataList, options) => {
     const istanbulCoverageList = dataList.map((it) => it.data);
     const coverageMap = istanbulLibCoverage.createCoverageMap();
     istanbulCoverageList.forEach((coverage) => {
@@ -155,7 +155,7 @@ const mergeIstanbulDataList = (dataList) => {
 };
 
 const mergeIstanbulCoverage = async (dataList, options) => {
-    const istanbulData = mergeIstanbulDataList(dataList);
+    const istanbulData = mergeIstanbulDataList(dataList, options);
     await addUntestedFiles(istanbulData, options);
     return istanbulData;
 };

package/lib/reports/raw.js

@@ -5,14 +5,14 @@ const { ZipFile } = require('../packages/monocart-coverage-vendor.js');
 const { mergeIstanbulDataList } = require('../istanbul/istanbul.js');
 const { mergeV8DataList } = require('../v8/v8.js');
 
-const getMergedData = (type, dataList) => {
+const getMergedData = (type, dataList, options) => {
     if (type === 'istanbul') {
-        return mergeIstanbulDataList(dataList);
+        return mergeIstanbulDataList(dataList, options);
     }
-    return mergeV8DataList(dataList);
+    return mergeV8DataList(dataList, options);
 };
 
-const mergeReport = async (rawDir, rawParent) => {
+const mergeReport = async (rawDir, options) => {
     const coverageFiles = fs.readdirSync(rawDir).filter((n) => n.endsWith('.json') && n.startsWith('coverage-'));
     // console.log(coverageFiles);
 
@@ -29,7 +29,7 @@ const mergeReport = async (rawDir, rawParent) => {
         Util.rmSync(jsonPath);
     }
 
-    const mergedData = await getMergedData(type, dataList);
+    const mergedData = await getMergedData(type, dataList, options);
 
     const dataId = Util.uid();
     const results = {
@@ -99,7 +99,7 @@ const rawReport = async (reportData, reportOptions, options) => {
 
     // merge
     if (rawOptions.merge) {
-        await mergeReport(rawDir, rawParent);
+        await mergeReport(rawDir, options);
     }
 
     // zip

package/lib/utils/gc.js

@@ -0,0 +1,9 @@
+const v8 = require('node:v8');
+const vm = require('node:vm');
+
+if (typeof global.gc !== 'function') {
+    v8.setFlagsFromString('--expose_gc');
+    global.gc = vm.runInNewContext('gc');
+}
+
+module.exports = global.gc;

package/lib/utils/util.js

@@ -3,6 +3,7 @@ const { writeFile, readFile } = require('fs/promises');
 const path = require('path');
 const os = require('os');
 const crypto = require('crypto');
+
 const EC = require('eight-colors');
 const CG = require('console-grid');
 const acornWalk = require('acorn-walk');
@@ -12,6 +13,7 @@ const request = require('./request.js');
 const version = require('../../package.json').version;
 const markdownGrid = require('./markdown.js');
 const { mergeV8Coverage } = require('./merge/merge.js');
+const gc = require('./gc.js');
 
 const {
     findUpSync, supportsColor, minimatch
@@ -37,6 +39,10 @@ const Util = {
     markdownGrid,
     mergeV8Coverage,
 
+    forceGC: () => {
+        gc();
+    },
+
     relativePath: function(p, root) {
         p = `${p}`;
         root = `${root || Util.root}`;
@@ -863,8 +869,28 @@ const Util = {
         console.log(`[MCR] ${message} before ${lengthBefore} => after ${lengthAfter}`);
     },
 
+    setGC: (threshold) => {
+        if (!Util.isNum(threshold)) {
+            threshold = 1024;
+        }
+        Util.gcThreshold = threshold;
+    },
+
+    getMemory: () => {
+        const { heapUsed } = process.memoryUsage();
+        const memory = parseFloat((heapUsed / 1024 ** 2).toFixed(1));
+        return memory;
+    },
+
     // time is debug level, fix the log info, for checking snapshot
     logTime: (message, time_start) => {
+
+        // memory gc
+        let memory = Util.getMemory();
+        if (Util.gcThreshold && Util.gcThreshold < memory) {
+            Util.forceGC();
+        }
+
         if (Util.loggingLevel < Util.loggingLevels.debug && !process.env.MCR_LOG_TIME) {
             return;
         }
@@ -872,9 +898,7 @@ const Util = {
         const durationH = Util.TF(duration);
         const ls = [`[MCR] ${message}`];
 
-        // memory
-        const { heapUsed } = process.memoryUsage();
-        const memory = parseFloat((heapUsed / 1024 ** 2).toFixed(1));
+        memory = Util.getMemory();
         ls.push(` (memory: ${memory}MB)`);
 
         // time

package/lib/v8/v8.js

@@ -164,7 +164,7 @@ const mergeCssRanges = (itemList) => {
         // ranges: [ {start, end} ]
         const ranges = dedupeFlatRanges(concatRanges);
 
-        resolve(ranges || []);
+        resolve(ranges);
     });
 };
 
@@ -173,14 +173,19 @@ const mergeJsFunctions = async (itemList) => {
     return res.functions;
 };
 
-const mergeV8DataList = async (dataList) => {
-    let allList = [];
-    dataList.forEach((d) => {
-        allList = allList.concat(d.data);
-    });
+const mergeV8DataList = async (dataList, options) => {
+    const allList = dataList.map((d) => d.data).flat();
 
-    // remove empty items
-    const coverageList = allList.filter((it) => !it.empty);
+    // separate coverage and empty items
+    const coverageList = [];
+    const allEmptyList = [];
+    allList.forEach((it) => {
+        if (it.empty) {
+            allEmptyList.push(it);
+        } else {
+            coverageList.push(it);
+        }
+    });
 
     // connect all functions and ranges
     const itemMap = {};
@@ -215,7 +220,7 @@ const mergeV8DataList = async (dataList) => {
 
     // first time filter for empty, (not for sources)
     // empty and not in item map
-    const emptyList = allList.filter((it) => it.empty).filter((it) => {
+    const emptyList = allEmptyList.filter((it) => {
         if (itemMap[it.id]) {
             return false;
         }
@@ -225,16 +230,15 @@ const mergeV8DataList = async (dataList) => {
         return true;
     });
 
-    // empty list + merged list
-    const mergedList = emptyList.concat(Object.values(itemMap));
-
+    // merged list + empty list
+    const mergedList = Object.values(itemMap).concat(emptyList);
 
     return mergedList;
 };
 
 const mergeV8Coverage = async (dataList, sourceCache, options) => {
 
-    const mergedList = await mergeV8DataList(dataList);
+    const mergedList = await mergeV8DataList(dataList, options);
 
     // try to load coverage and source by id
     for (const entry of mergedList) {
@@ -254,6 +258,9 @@ const mergeV8Coverage = async (dataList, sourceCache, options) => {
 
     }
 
+    // GC
+    sourceCache.clear();
+
     return mergedList;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.11.0",
+    "version": "2.11.1",
     "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
     "main": "./lib/index.js",
     "bin": {
@@ -59,7 +59,7 @@
         "dev": "npx sf d app",
         "open": "node ./scripts/open.js",
         "eol": "git rm -rf --cached . && git reset --hard HEAD",
-        "patch": "npm version patch && npm run build && npm run test && npm publish",
+        "patch": "npm run build && npm run test && npx sf publish patch -r",
         "beta": "npm version prerelease --preid=beta && npm run build && npm run test && npm publish --tag beta"
     },
     "workspaces": [
@@ -95,7 +95,7 @@
         "convert-source-map": "^2.0.0",
         "diff-sequences": "^29.6.3",
         "esbuild": "^0.24.0",
-        "eslint": "~9.11.1",
+        "eslint": "~9.12.0",
         "eslint-config-plus": "^2.0.2",
         "eslint-plugin-html": "^8.1.2",
         "eslint-plugin-vue": "^9.28.0",