monocart-coverage-reports 2.7.2 → 2.7.3

package/README.md

@@ -312,20 +312,26 @@ Options:
   --inline                     inline html for v8 report
   --assetsPath <path>          assets path if not inline
   --lcov                       generate lcov.info file
+  --import <module>            preload module at startup
+  --require <module>           preload module at startup
   -h, --help                   display help for command
 ```
 
 - Loading config file by priority:
-    - custom config file with `-c` or `--config`
+    - Custom config file with `-c` or `--config`
     - `mcr.config.js`
     - `mcr.config.cjs`
     - `mcr.config.mjs`
     - `mcr.config.json` - json format
+    - `mcr.config.ts` (requires preloading the ts execution module)
     - `.mcrrc.js`
     - `.mcrrc` - json format
-    - `mcr.config.ts` (requires preloading the typescript module)
 
 - Working with `tsx`, see [mcr-tsx](https://github.com/cenfun/mcr-tsx)
+    ```sh
+    npx mcr --import tsx tsx ./src/example.ts
+    ```
+
 - Working with `ts-node`, see [mcr-ts-node](https://github.com/cenfun/mcr-ts-node)
 
 ## Compare Reports

package/lib/cli.js

@@ -152,7 +152,7 @@ const executeCommand = async (command, cliOptions) => {
 };
 
 process.on('uncaughtException', function(err) {
-    Util.logError(`ERROR: ${err.message || err}`);
+    Util.logError(`Process uncaughtException: ${err.message || err}`);
 });
 
 program

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

@@ -128,6 +128,17 @@ const saveSourceFile = async (filePath, data) => {
 
 };
 
+const getInlineSourceMap = (content) => {
+    let smc;
+    try {
+        smc = convertSourceMap.fromSource(content);
+    } catch (e) {
+        // ignore "//# sourceMappingURL=" in a string
+        // console.log(e);
+    }
+    return smc;
+};
+
 const collectSourceMaps = async (v8list, options) => {
 
     const smList = [];
@@ -166,7 +177,7 @@ const collectSourceMaps = async (v8list, options) => {
         // check sourceMap only for js
         if (type === 'js' && !sourceData.sourceMap) {
             // from inline sync
-            const smc = convertSourceMap.fromSource(source);
+            const smc = getInlineSourceMap(source);
             if (smc) {
                 sourceData.sourceMap = resolveSourceMap(smc.sourcemap, url);
                 smList.push({

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

@@ -129,13 +129,18 @@ const getComparedPosition = (info, direction) => {
     gt = gt.trimEnd();
     ot = ot.trimEnd();
 
-    // no content after trim
-    if (!ot.length) {
+    // no original content after trim
+    if (!ot) {
         return {
             pos: direction === 'start' ? oLen : 0
         };
     }
 
+    // no generated content after trim
+    if (!gt) {
+        return;
+    }
+
     // same content
     if (gt === ot) {
         return {
@@ -273,16 +278,16 @@ const getFixedPosition = (info, direction) => {
 
 // ========================================================================================================
 
-const getOriginalEndOffset = (m, rangeInfo) => {
+const getOriginalEndOffset = (m, cache) => {
     if (!m.originalEndOffset) {
-        const line = rangeInfo.originalState.locator.getLine(m.originalLine + 1);
+        const line = cache.originalState.locator.getLine(m.originalLine + 1);
         m.originalEndOffset = line ? line.end : m.originalOffset;
     }
     return m.originalEndOffset;
 };
 
-const getOriginalText = (m1, m2, rangeInfo) => {
-    const originalLocator = rangeInfo.originalState.locator;
+const getOriginalText = (m1, m2, cache) => {
+    const originalLocator = cache.originalState.locator;
 
     const o1 = m1.originalOffset;
     const o2 = m2.originalOffset;
@@ -299,7 +304,7 @@ const getOriginalText = (m1, m2, rangeInfo) => {
     // esbuild fixing two mapping have same original
     // m1 to end line
     if (o1 === o2) {
-        const originalEndOffset = getOriginalEndOffset(m1, rangeInfo);
+        const originalEndOffset = getOriginalEndOffset(m1, cache);
         return {
             originalOffset: o1,
             originalText: originalLocator.getSlice(o1, originalEndOffset)
@@ -319,12 +324,12 @@ const getOriginalText = (m1, m2, rangeInfo) => {
 
     // if (direction === 'start') {
     // should be m2 ?
-    // console.log(direction, rangeInfo.originalState.sourcePath);
+    // console.log(direction, cache.originalState.sourcePath);
     // console.log(m1, m2);
     // }
 
     // should be wrong, ignore m2
-    const originalEndOffset = getOriginalEndOffset(m1, rangeInfo);
+    const originalEndOffset = getOriginalEndOffset(m1, cache);
     return {
         originalOffset: o1,
         originalText: originalLocator.getSlice(o1, originalEndOffset)
@@ -385,10 +390,10 @@ const getGeneratedText = (m1, m2, state, offset) => {
 
 // ========================================================================================================
 
-const getFixedOriginalStart = (start, mappings, state, rangeInfo) => {
+const getFixedOriginalStart = (start, mappings, state, cache) => {
 
     const [m1, m2] = mappings;
-    const { originalState, crossStart } = rangeInfo;
+    const { originalState, crossStart } = cache;
 
     // cross file from start of line
     if (crossStart) {
@@ -398,7 +403,7 @@ const getFixedOriginalStart = (start, mappings, state, rangeInfo) => {
     }
 
     const direction = 'start';
-    const { originalText, originalOffset } = getOriginalText(m1, m2, rangeInfo);
+    const { originalText, originalOffset } = getOriginalText(m1, m2, cache);
     const { generatedText, generatedPos } = getGeneratedText(m1, m2, state, start);
 
     const info = {
@@ -426,14 +431,14 @@ const getFixedOriginalStart = (start, mappings, state, rangeInfo) => {
     };
 };
 
-const getFixedOriginalEnd = (end, mappings, state, rangeInfo) => {
+const getFixedOriginalEnd = (end, mappings, state, cache) => {
 
     const [m1, m2] = mappings;
-    const { originalState, crossEnd } = rangeInfo;
+    const { originalState, crossEnd } = cache;
 
     // cross file until e1 line end (not file end)
     if (crossEnd) {
-        const originalEndOffset = getOriginalEndOffset(m1, rangeInfo);
+        const originalEndOffset = getOriginalEndOffset(m1, cache);
         return {
             originalEnd: originalEndOffset
         };
@@ -448,33 +453,8 @@ const getFixedOriginalEnd = (end, mappings, state, rangeInfo) => {
         };
     }
 
-    // quick check next one if exact match
-    // most of case is same string
-    if (m2.generatedOffset === end + 1) {
-        const gt = state.locator.source[end];
-        const oi = m2.originalOffset - 1;
-        const ot = originalState.locator.source[oi];
-        // it could be ; but it quite far away
-        if (gt === ot && [';', ','].includes(gt)) {
-            return {
-                originalEnd: oi
-            };
-        }
-
-        // Not applicable
-        // console.log('==================================');
-        // console.log({
-        //     gp: state.sourcePath,
-        //     g: end,
-        //     gt,
-        //     op: originalState.sourcePath,
-        //     o: oi,
-        //     ot
-        // });
-    }
-
     const direction = 'end';
-    const { originalText, originalOffset } = getOriginalText(m1, m2, rangeInfo);
+    const { originalText, originalOffset } = getOriginalText(m1, m2, cache);
     const { generatedText, generatedPos } = getGeneratedText(m1, m2, state, end);
 
     const info = {
@@ -506,23 +486,57 @@ const getFixedOriginalEnd = (end, mappings, state, rangeInfo) => {
 
 // ========================================================================================================
 
-const getOriginalStart = (start, startMapping, state, rangeInfo) => {
-    if (Array.isArray(startMapping)) {
-        return getFixedOriginalStart(start, startMapping, state, rangeInfo);
+const getOriginalStartPosition = (cache, state) => {
+
+    const { start, startMappings } = cache;
+
+    if (Array.isArray(startMappings)) {
+        return getFixedOriginalStart(start, startMappings, state, cache);
     }
+
     // Exact match
     return {
-        originalStart: startMapping.originalOffset
+        originalStart: startMappings.originalOffset
     };
 };
 
-const getOriginalEnd = (end, endMapping, state, rangeInfo) => {
-    if (Array.isArray(endMapping)) {
-        return getFixedOriginalEnd(end, endMapping, state, rangeInfo);
+const getOriginalExclusiveEnd = (cache, state) => {
+    // end, exclusive mappings
+    const { end } = cache;
+    const { decodedMappings } = state;
+    const endMappings = findMapping(decodedMappings, end);
+    if (Array.isArray(endMappings)) {
+        return getFixedOriginalEnd(end, endMappings, state, cache);
     }
-    // Exact match
+
+    // Exact match end
     return {
-        originalEnd: endMapping.originalOffset
+        originalEnd: endMappings.originalOffset
+    };
+};
+
+const getOriginalEndPosition = (cache, state) => {
+
+    const { endMappings, originalState } = cache;
+
+    // (end - 1), inclusive
+    if (Array.isArray(endMappings)) {
+        return getOriginalExclusiveEnd(cache, state);
+    }
+
+    // Exact match (end - 1)
+
+    // check end char
+    const oi = endMappings.originalOffset;
+    const originalEndChar = originalState.locator.getSlice(oi, oi + 1);
+    // the char should never end with "{" or "("
+    if (['{', '('].includes(originalEndChar)) {
+        return getOriginalExclusiveEnd(cache, state);
+    }
+
+    // inclusive to exclusive
+    return {
+        originalEnd: oi + 1
     };
 };
 
@@ -536,9 +550,6 @@ const checkSourceFileIndexes = (startIndexes, endIndexes) => {
                 sourceIndex: s1
             };
         }
-        return {
-            error: true
-        };
     };
 
     const checkIndex21 = (s1, s2, e1) => {
@@ -553,9 +564,6 @@ const checkSourceFileIndexes = (startIndexes, endIndexes) => {
                 sourceIndex: e1
             };
         }
-        return {
-            error: true
-        };
     };
 
     const checkIndex12 = (s1, e1, e2) => {
@@ -570,9 +578,6 @@ const checkSourceFileIndexes = (startIndexes, endIndexes) => {
                 sourceIndex: s1
             };
         }
-        return {
-            error: true
-        };
     };
 
     const checkIndex22 = (s1, s2, e1, e2) => {
@@ -602,10 +607,6 @@ const checkSourceFileIndexes = (startIndexes, endIndexes) => {
         // both between two mappings: 38,39 ~ 38,39
         // if (s1 === e1 && s2 === e2) {
         // }
-
-        return {
-            error: true
-        };
     };
 
     // both exact matched
@@ -626,13 +627,20 @@ const checkSourceFileIndexes = (startIndexes, endIndexes) => {
 
 };
 
-const getOriginalState = (startMappings, endMappings, originalMap) => {
+const getOriginalState = (start, end, state, originalMap) => {
+
+    const mappingInfo = getMappingInfo(start, end, state);
+    if (mappingInfo.error) {
+        return mappingInfo;
+    }
+
+    const { startMappings, endMappings } = mappingInfo;
 
     // check source file indexes
     const startIndexes = [].concat(startMappings).map((it) => it.sourceIndex);
     const endIndexes = [].concat(endMappings).map((it) => it.sourceIndex);
-    const rangeInfo = checkSourceFileIndexes(startIndexes, endIndexes);
-    if (rangeInfo.error) {
+    const results = checkSourceFileIndexes(startIndexes, endIndexes);
+    if (!results) {
         return {
             error: true,
             errors: [`invalid source indexes: ${EC.yellow(`${startIndexes} ~ ${endIndexes}`)}`]
@@ -641,7 +649,7 @@ const getOriginalState = (startMappings, endMappings, originalMap) => {
 
     const {
         sourceIndex, crossStart, crossEnd
-    } = rangeInfo;
+    } = results;
 
     // if (crossStart || crossEnd) {
     //     console.log(EC.magenta('cross file'), EC.yellow(`${startIndexes} ~ ${endIndexes}`));
@@ -655,11 +663,17 @@ const getOriginalState = (startMappings, endMappings, originalMap) => {
         };
     }
 
+    // cache for original info
     return {
         // for debug
         // startIndexes,
         // endIndexes,
 
+        start,
+        end,
+        startMappings,
+        endMappings,
+
         sourceIndex,
         crossStart,
         crossEnd,
@@ -667,7 +681,9 @@ const getOriginalState = (startMappings, endMappings, originalMap) => {
     };
 };
 
-const getMappingInfo = (decodedMappings, start, end) => {
+const getMappingInfo = (start, end, state) => {
+
+    const { decodedMappings } = state;
     // possible no length
     if (decodedMappings.length < 2) {
         return {
@@ -677,9 +693,6 @@ const getMappingInfo = (decodedMappings, start, end) => {
     }
 
     // start: inclusive
-    // end: exclusive
-    // could be 4 mappings found
-
     const startMappings = findMapping(decodedMappings, start);
     if (!startMappings) {
         return {
@@ -688,7 +701,8 @@ const getMappingInfo = (decodedMappings, start, end) => {
         };
     }
 
-    const endMappings = findMapping(decodedMappings, end);
+    // end: exclusive
+    const endMappings = findMapping(decodedMappings, end - 1);
     if (!endMappings) {
         return {
             error: true,
@@ -696,6 +710,7 @@ const getMappingInfo = (decodedMappings, start, end) => {
         };
     }
 
+    // could be 4 mappings found
     return {
         startMappings,
         endMappings
@@ -704,7 +719,7 @@ const getMappingInfo = (decodedMappings, start, end) => {
 
 const findOriginalRange = (start, end, state, originalMap) => {
 
-    const { sourcePath, decodedMappings } = state;
+    const { sourcePath } = state;
 
     const createMappingError = (errors) => {
         return {
@@ -716,29 +731,17 @@ const findOriginalRange = (start, end, state, originalMap) => {
         };
     };
 
-    const mappingInfo = getMappingInfo(decodedMappings, start, end);
-    if (mappingInfo.error) {
-        return createMappingError(mappingInfo.errors);
-    }
-
-    const { startMappings, endMappings } = mappingInfo;
-
-    const rangeInfo = getOriginalState(startMappings, endMappings, originalMap);
-    if (rangeInfo.error) {
-        return createMappingError(rangeInfo.errors);
-    }
-
-    const originalStartResult = getOriginalStart(start, startMappings, state, rangeInfo);
-    if (originalStartResult.error) {
-        return createMappingError(originalStartResult.errors);
-    }
-
-    const originalEndResult = getOriginalEnd(end, endMappings, state, rangeInfo);
-    if (originalEndResult.error) {
-        return createMappingError(originalEndResult.errors);
+    const cache = getOriginalState(start, end, state, originalMap);
+    if (cache.error) {
+        return createMappingError(cache.errors);
     }
 
+    const originalStartResult = getOriginalStartPosition(cache, state);
     const { originalStart } = originalStartResult;
+    // could be used for end
+    cache.originalStart = originalStart;
+
+    const originalEndResult = getOriginalEndPosition(cache, state);
     const { originalEnd } = originalEndResult;
 
     // range start > end
@@ -746,7 +749,7 @@ const findOriginalRange = (start, end, state, originalMap) => {
         return createMappingError([`invalid original start > end: ${EC.yellow(originalStart)} > ${EC.yellow(originalEnd)}`]);
     }
 
-    const { originalState } = rangeInfo;
+    const { originalState } = cache;
 
     return {
         start: originalStart,

package/lib/index.js

@@ -28,12 +28,15 @@ const resolveConfigOptions = async (configPath) => {
         err = ee;
     }
 
-    if (err || !configOptions) {
+    if (err) {
         Util.logError(`ERROR: failed to load config "${configPath}": ${err && err.message} `);
         return;
     }
 
-    configOptions = configOptions.default || configOptions;
+    // could be multiple level default
+    while (configOptions && configOptions.default) {
+        configOptions = configOptions.default;
+    }
 
     return configOptions;
 };
@@ -237,9 +240,9 @@ class CoverageReport {
             'mcr.config.cjs',
             'mcr.config.mjs',
             'mcr.config.json',
+            'mcr.config.ts',
             '.mcrrc.js',
-            '.mcrrc',
-            'mcr.config.ts'
+            '.mcrrc'
         ];
 
         const existsList = configList.filter((p) => p && fs.existsSync(p));
@@ -262,7 +265,8 @@ class CoverageReport {
             return;
         }
 
-        Util.logInfo(`Loaded config: ${EC.cyan(configPath)}`);
+        Util.logInfo(`Loaded: ${EC.cyan(configPath)}`);
+
         // init options again
         this.options = {
             ... defaultOptions,

package/lib/register/hooks.js

@@ -3,35 +3,53 @@ const path = require('path');
 const Util = require('../utils/util.js');
 const { convertSourceMap } = require('../packages/monocart-coverage-vendor.js');
 
-async function load(url, context, nextLoad) {
-
-    const loaded = await nextLoad(url, context);
-    const { source, format } = loaded;
-    const dir = process.env.NODE_V8_COVERAGE;
+function saveFile(url, source, dir) {
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, {
+            recursive: true
+        });
+    }
 
-    if (dir && typeof source === 'string' && (format === 'module' || format === 'commonjs')) {
+    const id = Util.calculateSha1(url + source);
+    const filePath = path.resolve(dir, `source-${id}.json`);
+    if (!fs.existsSync(filePath)) {
+        fs.writeFileSync(filePath, JSON.stringify({
+            url,
+            source
+        }));
+    }
 
-        if (convertSourceMap.mapFileCommentRegex.test(source)) {
+}
 
-            if (!fs.existsSync(dir)) {
-                fs.mkdirSync(dir, {
-                    recursive: true
-                });
-            }
+function saveSource(url, loaded, dir) {
 
-            const id = Util.calculateSha1(url + source);
-            const filePath = path.resolve(dir, `source-${id}.json`);
-            if (!fs.existsSync(filePath)) {
-                fs.writeFileSync(filePath, JSON.stringify({
-                    url,
-                    source
-                }));
-            }
+    // filter node modules
+    if (url.startsWith('node:')) {
+        return;
+    }
 
-        }
+    const { source, format } = loaded;
+    if (typeof source !== 'string' || !['module', 'commonjs'].includes(format)) {
+        // no source or wrong format
+        return;
+    }
 
+    if (!convertSourceMap.mapFileCommentRegex.test(source)) {
+        // no sourcemap
+        return;
     }
 
+    saveFile(url, source, dir);
+
+}
+
+async function load(url, context, nextLoad) {
+    const loaded = await nextLoad(url, context);
+    const dir = process.env.NODE_V8_COVERAGE;
+    if (dir) {
+        // only for coverage enabled
+        saveSource(url, loaded, dir);
+    }
     return loaded;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.7.2",
+    "version": "2.7.3",
     "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
     "main": "./lib/index.js",
     "bin": {
@@ -27,25 +27,30 @@
         "build-docs": "node ./scripts/build-docs.js",
         "build-test": "node ./scripts/build-test.js",
         "build": "sf lint && sf b -p && npm run build-test",
-        "test-node": "npm run test-node-env && npm run test-node-api && npm run test-node-ins && npm run test-node-cdp && npm run test-node-koa && npm run test-node-vm",
         "test-node-env": "cross-env NODE_V8_COVERAGE=.temp/v8-coverage-env node ./test/test-node-env.js && node ./test/generate-report.js",
         "test-node-api": "cross-env NODE_V8_COVERAGE=.temp/v8-coverage-api node ./test/test-node-api.js",
-        "test-node-fgc": "node ./test/test-node-fgc.js",
         "test-node-ins": "node ./test/test-node-ins.js",
         "test-node-cdp": "node --inspect=9229 ./test/test-node-cdp.js",
-        "test-node-koa": "node ./test/test-node-koa.js",
         "test-node-vm": "node ./test/test-node-vm.js",
+        "test-node-koa": "node ./test/test-node-koa.js",
+        "test-node-fgc": "node ./test/test-node-fgc.js",
+        "test-node": "npm run test-node-env && npm run test-node-api && npm run test-node-ins && npm run test-node-cdp && npm run test-node-vm && npm run test-node-koa",
         "test-istanbul": "node ./test/test-istanbul.js",
         "test-v8": "node ./test/test-v8.js",
         "test-puppeteer": "node ./test/test-puppeteer.js",
-        "test-browser": "node ./test/test-browser.js && npm run test-istanbul && npm run test-v8 && npm run test-puppeteer && npm run test-anonymous && npm run test-css",
         "test-anonymous": "node ./test/test-anonymous.js",
         "test-css": "node ./test/test-css.js",
-        "test-client": "node ./test/test-client.js",
+        "test-minify": "node ./test/test-minify.js",
+        "test-esbuild": "node ./test/test-esbuild.js",
+        "test-rollup": "node ./test/test-rollup.js",
+        "test-v8-and-istanbul": "node ./test/test-v8-and-istanbul.js",
+        "test-browser": "npm run test-istanbul && npm run test-v8 && npm run test-puppeteer && npm run test-anonymous && npm run test-css && npm run test-minify && npm run test-esbuild && npm run test-rollup && npm run test-v8-and-istanbul",
         "test-cli": "npx mcr node ./test/specs/node.test.js -c test/mcr.config.cli.js",
+        "test-tsx": "npx mcr tsx ./test/specs/tsx.test.ts -c test/mcr.config.tsx.js",
         "test-merge": "node ./test/test-merge.js",
         "test-merge-istanbul": "node ./test/test-merge-istanbul.js",
-        "test-all": "npm run test-browser && npm run test-node && npm run test-cli && npm run test-merge && npm run build-docs",
+        "test-client": "node ./test/test-client.js",
+        "test-all": "npm run test-node && npm run test-browser && npm run test-cli && npm run test-tsx && npm run test-merge && npm run build-docs",
         "test": "npx mcr npm run test-all -c test/mcr.config.mcr.js",
         "test:snap": "cross-env TEST_SNAPSHOT=true npm run test",
         "dev": "sf d v8",
@@ -77,6 +82,7 @@
     },
     "devDependencies": {
         "commander": "^12.0.0",
+        "esbuild": "^0.20.2",
         "eslint": "^8.57.0",
         "eslint-config-plus": "^1.0.6",
         "eslint-plugin-html": "^8.0.0",