monocart-coverage-reports 2.4.3 → 2.5.0

package/README.md

@@ -24,6 +24,8 @@
 * [Node.js V8 Coverage Report for Server Side](#nodejs-v8-coverage-report-for-server-side)
 * [Multiprocessing Support](#multiprocessing-support)
 * [Merge Coverage Reports](#merge-coverage-reports)
+* [Resolve `sourcePath` for the Source Files](#resolve-sourcepath-for-the-source-files)
+* [Adding Empty Coverage for Untested Files](#adding-empty-coverage-for-untested-files)
 * [Ignoring Uncovered Codes](#ignoring-uncovered-codes)
 * [Chromium Coverage API](#chromium-coverage-api)
 * [V8 Coverage Data Format](#v8-coverage-data-format)
@@ -54,26 +56,22 @@ console.log(coverageResults.summary);
 - [lib/default/options.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
 
 ## Available Reports
-- `v8` (V8 data only)
-    - Test in browser
-        - Build with webpack: [V8](https://cenfun.github.io/monocart-coverage-reports/v8) and [V8 Minify](https://cenfun.github.io/monocart-coverage-reports/v8-minify)
-        - Build with [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild)
-        - Collect with [puppeteer](https://cenfun.github.io/monocart-coverage-reports/puppeteer/) 
-        - [anonymous](https://cenfun.github.io/monocart-coverage-reports/anonymous/) and [css](https://cenfun.github.io/monocart-coverage-reports/css/)
-    - Test in Node.js
-        - Collect with [env](https://cenfun.github.io/monocart-coverage-reports/v8-node-env), and also V8 [API](https://cenfun.github.io/monocart-coverage-reports/v8-node-api), [Inspector](https://cenfun.github.io/monocart-coverage-reports/v8-node-ins) and [CDP](https://cenfun.github.io/monocart-coverage-reports/v8-node-cdp)
-        - Web server example: [koa](https://cenfun.github.io/monocart-coverage-reports/v8-node-koa/)
+> V8 build-in reports (V8 data only):
+- `v8`
+    - Browser: Build with webpack [V8](https://cenfun.github.io/monocart-coverage-reports/v8) and [V8 Minify](https://cenfun.github.io/monocart-coverage-reports/v8-minify); Build with [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild); Collect with [puppeteer](https://cenfun.github.io/monocart-coverage-reports/puppeteer/); [anonymous](https://cenfun.github.io/monocart-coverage-reports/anonymous/) and [css](https://cenfun.github.io/monocart-coverage-reports/css/)
+    - Node.js: Collect with [env](https://cenfun.github.io/monocart-coverage-reports/v8-node-env), and also V8 [API](https://cenfun.github.io/monocart-coverage-reports/v8-node-api), [Inspector](https://cenfun.github.io/monocart-coverage-reports/v8-node-ins) and [CDP](https://cenfun.github.io/monocart-coverage-reports/v8-node-cdp); Web server example: [koa](https://cenfun.github.io/monocart-coverage-reports/v8-node-koa/)
 
 ![](test/v8.gif)
 
-- `v8-json` (V8 data only)
+- `v8-json`
     - [V8 coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
-- `codecov` (V8 data only)
+- `codecov`
     - coverage data for [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format), see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
-    
-    ![](test/console-summary.png)
+- `console-details` Show file coverage and uncovered lines in the console. Like `text`, but for V8.
 
-> Istanbul [build-in reports](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib)
+![](test/console-details.png)
+
+> Istanbul build-in reports (both V8 and istanbul data):
 - `clover`
 - `cobertura`
 - `html`
@@ -93,8 +91,11 @@ console.log(coverageResults.summary);
 - `text-lcov`
 - `text-summary`
 
-> Other reports
-- `console-summary` shows coverage summary in console
+> Other reports:
+- `console-summary` shows coverage summary in the console
+
+![](test/console-summary.png)
+
 - `raw` only keep all original data, which can be used for other reports input with `inputDir`
     - see [Merge Coverage Reports](#merge-coverage-reports)
 
@@ -258,16 +259,14 @@ mcr "node ./test/test-node-env.js" -c test/cli-options.js
 | Coverage data | [Istanbul](https://github.com/gotwarlost/istanbul/blob/master/coverage.json.md) (Object) | [V8](#v8-coverage-data-format) (Array) | [V8](#v8-coverage-data-format) (Array) |
 | Output | [Istanbul reports](#available-reports) | [V8 reports](#available-reports)  | [Istanbul reports](#available-reports) |
 | - Bytes | ❌ | ✅ | ❌ |
-| - Statements | ✅ | ❌ | ☑️❔ |
-| - Branches | ✅ | ☑️❔ | ☑️❔ |
+| - Statements | ✅ | ✅ | ✅ |
+| - Branches | ✅ | ✅ | ✅ |
 | - Functions | ✅ | ✅ | ✅ |
 | - Lines | ✅ | ✅ | ✅ |
 | - Execution counts | ✅ | ✅ | ✅ |
 | CSS coverage | ❌ | ✅ | ✅ |
 | Minified code | ❌ | ✅ | ❌ |
 
-❔ - Partial or conditional support
-
 ## Compare Workflows
 - Istanbul Workflows
     - 1, [Collecting Istanbul coverage data](#collecting-istanbul-coverage-data)
@@ -451,7 +450,10 @@ const coverageOptions = {
 };
 await new CoverageReport(coverageOptions).generate();
 ```
-If the source file comes from the sourcemap, then its path is a virtual path. Using the `sourcePath` option to convert it.
+
+## Resolve `sourcePath` for the Source Files
+If the source file comes from the sourcemap, then its path is a virtual path. Using the `sourcePath` option to resolve a custom path.
+For example, we have tested multiple dist files, which contain some common files. We hope to merge the coverage of the same files, so we need to unify the `sourcePath` in order to be able to merge the coverage data.
 ```js
 const coverageOptions = {
     sourcePath: (filePath) => {
@@ -468,6 +470,44 @@ const coverageOptions = {
 ```
 see example: [./test/test-merge.js](./test/test-merge.js)
 
+## Adding Empty Coverage for Untested Files
+By default the untested files will not be included in the coverage report, we can first add empty coverage data for all files, so the files with coverage data will be merged, and untested files will retain 0% coverage.
+```js
+const fs = require('fs');
+const path = require('path');
+const { pathToFileURL } = require('url');
+const MCR = require('monocart-coverage-reports');
+
+const dir = "./src";
+const coverageData = [];
+const fileList = fs.readdirSync(dir);
+for (const filename of fileList) {
+    const filePath = path.resolve(dir, filename);
+    const source = fs.readFileSync(filePath).toString('utf-8');
+    const sourcePath = path.relative(process.cwd(), filePath);
+    const url = pathToFileURL(sourcePath).toString();
+    const extname = path.extname(filename);
+    if (['.css'].includes(extname)) {
+        coverageData.push({
+            empty: true,
+            type: 'css',
+            url,
+            text: source
+        });
+    } else {
+        coverageData.push({
+            empty: true,
+            type: 'js',
+            url,
+            source
+        });
+    }
+}
+const options = require('path-to/same-options.js');
+await MCR(options).add(coverageData);
+```
+see example: [./test/cli-options.js](./test/cli-options.js)
+
 ## Ignoring Uncovered Codes
 To ignore codes, use the special comment which starts with `v8 ignore `:
 - Ignoring all until stop
@@ -575,15 +615,15 @@ see source code [v8-to-istanbul.js](https://github.com/istanbuljs/v8-to-istanbul
 ### How Monocart Works
 We implemented new converter instead of v8-to-istanbul:
 - 1, Trying to fix the middle position if not found the exact mapping for the position.
-- 2, Finding all functions and branches by parsing the source code [AST](https://github.com/acornjs/acorn), however the V8 cannot provide effective branch coverage information, so the branches is still not perfect but close to reality.
+- 2, Finding all functions, statements and branches by parsing the source code [AST](https://github.com/acornjs/acorn), however the V8 cannot provide effective branch coverage information for `AssignmentPattern`.
 
 | AST                   | V8             | 
 | :---------------------| :------------- | 
 | AssignmentPattern     | 🛇 Not Support | 
-| ConditionalExpression | ✔ Not Perfect | 
-| IfStatement           | ✔ Not Perfect | 
-| LogicalExpression     | ✔ Not Perfect | 
-| SwitchStatement       | ✔ Not Perfect | 
+| ConditionalExpression | ✔  | 
+| IfStatement           | ✔  | 
+| LogicalExpression     | ✔  | 
+| SwitchStatement       | ✔  | 
 
 ## Debug for Coverage and Sourcemap
 > Sometimes, the coverage is not what we expect. The next step is to figure out why, and we can easily find out the answer step by step through debugging.

package/lib/converter/ast-visitor.js

@@ -117,18 +117,21 @@ const createBranchGroup = (type, node, parents, branchMap) => {
         group.operator = node.operator;
     }
 
-    branchMap.set(start, group);
+    // could be same start
+    const branchKey = `${start}_${end}`;
+
+    branchMap.set(branchKey, group);
     return group;
 };
 
 const addBranch = (group, node, locationMap) => {
     const { start, end } = node;
 
-    const branchStart = group.start;
+    const branchKey = `${group.start}_${group.end}`;
 
     const branchInfo = {
         // for get previous group for LogicalExpression
-        branchStart,
+        branchKey,
         start,
         end,
         // branch count default to 0
@@ -203,23 +206,16 @@ const IfStatement = (group, parentCount) => {
 
 // const b = tf2 || tf1 || a;
 const LogicalExpression = (group, parentCount) => {
-    const { noBlockList, blockCount } = updateBlockLocations(group.locations);
-    if (!noBlockList.length) {
-        return;
-    }
 
-    if (group.operator === '&&') {
-        // console.log(group.start, noBlockList);
-        noBlockList.forEach((item) => {
+    // from left to right
+    group.locations.forEach((item, i) => {
+        if (item.block) {
+            item.count = item.block.count;
+        } else {
             item.count = parentCount;
-        });
-        return;
-    }
-
-    const count = parentCount - blockCount;
-    noBlockList.forEach((item) => {
-        item.count = count;
+        }
     });
+
 };
 
 const SwitchStatement = (group, parentCount) => {
@@ -408,7 +404,7 @@ const collectNodes = (ast) => {
             // =============================================================
             // id: { type: 'Identifier', name: '__webpack_modules__' },
             const name = node.id && node.id.name;
-            if (name === '__webpack_modules__' && node.init) {
+            if (name === '__webpack_modules__' && node.init && node.init.properties) {
                 // mark all as wrap function
                 node.init.properties.forEach((it) => {
                     it.value._wrapKey = it.key && it.key.value;
@@ -501,12 +497,15 @@ const collectNodes = (ast) => {
             const { left, right } = node;
             // console.log(left.start, right.start);
 
+            // could be same branch start
+            // const da = arguments.length > 1 && typeof arguments[1] !== 'undefined' ? arguments[1] : true;
+
             let group;
             // link to same branch start if LogicalExpression
             const prevLocation = locationMap.get(node.start);
             if (prevLocation) {
                 // console.log('link branch ==================', type);
-                group = branchMap.get(prevLocation.branchStart);
+                group = branchMap.get(prevLocation.branchKey);
             } else {
                 group = createBranchGroup('LogicalExpression', node, parents, branchMap);
                 addBranch(group, left, locationMap);
@@ -574,6 +573,26 @@ const getRootFunctionState = (ast, coverageInfo) => {
     return rootState;
 };
 
+const findFunctionRange = (item, coverageInfo) => {
+
+    const { node, reverseParents } = item;
+    const { start, end } = node;
+
+    // try function start/end
+    const functionRange = getFunctionRange(start, end, coverageInfo);
+    if (functionRange) {
+        return functionRange;
+    }
+
+    // try if class MethodDefinition
+    // 0 is function self
+    const parent = reverseParents[1];
+    if (parent && parent.type === 'MethodDefinition') {
+        return getFunctionRange(parent.start, parent.end, coverageInfo);
+    }
+
+};
+
 const collectAstInfo = (ast, coverageInfo) => {
 
     const {
@@ -611,7 +630,8 @@ const collectAstInfo = (ast, coverageInfo) => {
             isFunction: true,
             count: functionItem.count
         };
-        const functionRange = getFunctionRange(start, end, coverageInfo);
+
+        const functionRange = findFunctionRange(item, coverageInfo);
         if (functionRange) {
             if (isWrap) {
                 functionRange.wrap = true;

package/lib/converter/ast.js

@@ -159,8 +159,8 @@ const getJsAstInfo = (item, coverageList) => {
         // most time for node.js file
         allowReturnOutsideFunction: true,
         allowImportExportEverywhere: true,
-        allowSuperOutsideMethod: true,
         allowAwaitOutsideFunction: true,
+        allowSuperOutsideMethod: true,
         // first line: #!/usr/bin/env node
         allowHashBang: true
     };

package/lib/converter/converter.js

@@ -579,11 +579,12 @@ const handleOriginalBranchesCoverage = (state, originalStateMap) => {
                 return newLoc;
             }
 
+            // before new range
+            newLoc.generatedStart = newLoc.start;
+            newLoc.generatedEnd = newLoc.end;
             // mapping to new range
             newLoc.start = locResult.start;
             newLoc.end = locResult.end;
-            newLoc.generatedStart = newLoc.start;
-            newLoc.generatedEnd = newLoc.end;
 
             return newLoc;
         });

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

@@ -371,8 +371,9 @@ const getGeneratedText = (m1, m2, state, offset) => {
 // ========================================================================================================
 
 const getFixedOriginalStart = (start, mappings, state, rangeInfo) => {
-    const { originalState, crossStart } = rangeInfo;
+
     const [m1, m2] = mappings;
+    const { originalState, crossStart } = rangeInfo;
 
     // cross file from start of line
     if (crossStart) {
@@ -410,18 +411,8 @@ const getFixedOriginalStart = (start, mappings, state, rangeInfo) => {
 
 const getFixedOriginalEnd = (end, mappings, state, rangeInfo) => {
 
-    const { decodedMappings } = state;
-
-    // end is exclusive, try previous one if exact match
-    const prevMapping = findMapping(decodedMappings, end - 1);
-    if (prevMapping && !Array.isArray(prevMapping)) {
-        return {
-            originalEnd: prevMapping.originalOffset + 1
-        };
-    }
-
-    const { originalState, crossEnd } = rangeInfo;
     const [m1, m2] = mappings;
+    const { originalState, crossEnd } = rangeInfo;
 
     // cross file until e1 line end (not file end)
     if (crossEnd) {
@@ -431,6 +422,39 @@ const getFixedOriginalEnd = (end, mappings, state, rangeInfo) => {
         };
     }
 
+    // end is exclusive
+    // quick check previous one if exact match
+    // most of case is matching "}"
+    if (m1.generatedOffset === end - 1) {
+        return {
+            originalEnd: m1.originalOffset + 1
+        };
+    }
+
+    // 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];
+        if (gt === ot) {
+            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, direction);
     const { generatedText, generatedPos } = getGeneratedText(m1, m2, state, end);
@@ -621,23 +645,13 @@ const getOriginalState = (startMappings, endMappings, originalMap) => {
     };
 };
 
-const findOriginalRange = (start, end, state, originalMap) => {
-
-    const { sourcePath, decodedMappings } = state;
-
-    const createMappingError = (errors) => {
+const getMappingInfo = (decodedMappings, start, end) => {
+    // possible no length
+    if (decodedMappings.length < 2) {
         return {
             error: true,
-            start,
-            end,
-            sourcePath,
-            errors
+            errors: ['invalid decoded mappings (length < 2)']
         };
-    };
-
-    // possible no length
-    if (decodedMappings.length < 2) {
-        return createMappingError(['not found decoded mappings']);
     }
 
     // start: inclusive
@@ -660,6 +674,33 @@ const findOriginalRange = (start, end, state, originalMap) => {
         };
     }
 
+    return {
+        startMappings,
+        endMappings
+    };
+};
+
+const findOriginalRange = (start, end, state, originalMap) => {
+
+    const { sourcePath, decodedMappings } = state;
+
+    const createMappingError = (errors) => {
+        return {
+            error: true,
+            start,
+            end,
+            sourcePath,
+            errors
+        };
+    };
+
+    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);

package/lib/generate.js

@@ -72,6 +72,7 @@ const getReportGroup = (reports, lcov, dataType) => {
         'v8': 'v8',
         'v8-json': 'v8',
         'codecov': 'v8',
+        'console-details': 'v8',
 
         // istanbul
         'clover': 'istanbul',
@@ -126,22 +127,9 @@ const getReportGroup = (reports, lcov, dataType) => {
 
 // ========================================================================================================
 
-const capitalizeFirstLetter = (string) => {
-    return string.charAt(0).toUpperCase() + string.slice(1);
-};
-
 const pFormatter = (v, row, column) => {
     if (typeof v === 'number') {
-        const p = Util.PSF(v, 100, 2);
-        if (row.status === 'low') {
-            return EC.red(p);
-        }
-        if (row.status === 'medium') {
-            return EC.yellow(p);
-        }
-        if (row.status === 'high') {
-            return EC.green(p);
-        }
+        return Util.getColorStrByStatus(Util.PSF(v, 100, 2), row.status);
     }
     return v;
 };
@@ -153,9 +141,12 @@ const nFormatter = (v) => {
     return v;
 };
 
-const showConsoleSummary = (reportData, reportOptions, options) => {
+const handleConsoleSummaryReport = (reportData, reportOptions, options) => {
 
-    const { metrics } = reportOptions;
+    const csOptions = {
+        metrics: [],
+        ... reportOptions
+    };
 
     const {
         summary, name, type
@@ -165,23 +156,12 @@ const showConsoleSummary = (reportData, reportOptions, options) => {
         EC.logCyan(name);
     }
 
-    const allMetrics = {
-        v8: ['bytes', 'statements', 'branches', 'functions', 'lines'],
-        istanbul: ['statements', 'branches', 'functions', 'lines']
-    };
-
-    let list = allMetrics[type];
-    if (Util.isList(metrics)) {
-        const newList = list.filter((k) => metrics.includes(k));
-        if (newList.length) {
-            list = newList;
-        }
-    }
+    const metrics = Util.getMetrics(type, csOptions.metrics);
 
-    const rows = list.map((k) => {
+    const rows = metrics.map((k) => {
         return {
             ... summary[k],
-            name: capitalizeFirstLetter(k)
+            name: Util.capitalizeFirstLetter(k)
         };
     });
 
@@ -216,7 +196,7 @@ const showConsoleSummary = (reportData, reportOptions, options) => {
     });
 };
 
-const saveRawReport = (reportData, reportOptions, options) => {
+const handleRawReport = (reportData, reportOptions, options) => {
     const rawOptions = {
         outputDir: 'raw',
         ... reportOptions
@@ -285,8 +265,8 @@ const generateCoverageReports = async (dataList, sourceCache, options) => {
     // console.log(Object.keys(coverageResults));
 
     const buildInBothReports = {
-        'console-summary': showConsoleSummary,
-        'raw': saveRawReport
+        'console-summary': handleConsoleSummaryReport,
+        'raw': handleRawReport
     };
 
     const bothGroup = options.reportGroup.both;

package/lib/index.d.ts

@@ -36,6 +36,11 @@ declare namespace MCR {
         ['codecov'] | ["codecov", {
             outputFile?: string;
         }] |
+        ['console-details'] | ['console-details', {
+            maxCols?: number;
+            skipPercent?: number;
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+        }] |
         ['clover'] | ['clover', {
             file?: string;
         }] |