monocart-coverage-reports 2.8.3 → 2.8.5

package/README.md

@@ -39,6 +39,7 @@
 * [Integration with Any Testing Framework](#integration-with-any-testing-framework)
 * [Integration Examples](#integration-examples)
     - [Playwright](#playwright)
+    - [c8](#c8)
     - [CodeceptJS](#codeceptjs)
     - [Jest](#jest)
     - [Vitest](#vitest)
@@ -505,7 +506,7 @@ const coverageOptions = {
     sourceFilter: "**/src/**"
 };
 ```
-Supports multiple patterns:
+Support multiple patterns:
 ```js
 const coverageOptions = {
     entryFilter: {
@@ -914,7 +915,6 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 - [playwright-coverage](https://github.com/cenfun/playwright-coverage) - Example for Playwright coverage reports
 - [playwright-bdd-coverage](https://github.com/cenfun/playwright-bdd-coverage) - Example for Playwright BDD coverage reports
 - [monocart-reporter](https://github.com/cenfun/monocart-reporter) - Playwright custom reporter, supports generating [Code coverage report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
-- [merge-code-coverage](https://github.com/cenfun/merge-code-coverage) - Example for merging code coverage (unit + e2e shard)
 - Coverage for component testing with `monocart-reporter`:
     - [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue)
     - [playwright-ct-react](https://github.com/cenfun/playwright-ct-react)
@@ -924,14 +924,22 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
     - [nextjs-with-playwright-istanbul](https://github.com/cenfun/nextjs-with-playwright-istanbul)
 - see [Collecting V8 Coverage Data with Playwright](#collecting-v8-coverage-data-with-playwright)
 
+### [c8](https://github.com/bcoe/c8)
+- c8 has integrated `MCR` as an experimental feature since [v10.1.0](https://github.com/bcoe/c8/releases/tag/v10.1.0)
+```sh
+c8 --experimental-monocart --reporter=v8 --reporter=console-details node foo.js
+```
+
 ### [CodeceptJS](https://github.com/codeceptjs/CodeceptJS)
-- CodeceptJS is a [BDD](https://codecept.io/bdd/) + [AI](https://codecept.io/ai/) testing framework for e2e testing, it has integrated `MCR` since [v3.5.15](https://github.com/codeceptjs/CodeceptJS/releases/tag/3.5.15), see [plugins/coverage](https://codecept.io/plugins/#coverage). There's no need to use ~~[codeceptjs-monocart-coverage](https://github.com/cenfun/codeceptjs-monocart-coverage)~~ anymore.
+- CodeceptJS is a [BDD](https://codecept.io/bdd/) + [AI](https://codecept.io/ai/) testing framework for e2e testing, it has integrated `MCR` since [v3.5.15](https://github.com/codeceptjs/CodeceptJS/releases/tag/3.5.15), see [plugins/coverage](https://codecept.io/plugins/#coverage)
 
 ### [Jest](https://github.com/jestjs/jest/)
 - [jest-monocart-coverage](https://github.com/cenfun/jest-monocart-coverage) - Jest custom reporter for coverage reports
+- [merge-code-coverage](https://github.com/cenfun/merge-code-coverage) - Example for merging code coverage (Jest unit + Playwright e2e sharding)
 
 ### [Vitest](https://github.com/vitest-dev/vitest)
 - [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - Vitest custom provider module for coverage reports
+- [merge-code-coverage-vitest](https://github.com/cenfun/merge-code-coverage-vitest) - Example for merging code coverage (Vitest unit + Playwright e2e sharding)
 
 ### [Puppeteer](https://github.com/puppeteer/puppeteer/)
 - [jest-puppeteer-coverage](https://github.com/cenfun/jest-puppeteer-coverage) - Example for Jest puppeteer coverage
@@ -1054,17 +1062,25 @@ const coverageOptions = {
 - Node.js 20+
 - VSCode (extensions: eslint/stylelint/vue)
 ```sh
-npm install starfall-cli -g
 npm install
+npx playwright install --with-deps
 
 npm run build
 npm run test
 
 npm run dev
 ```
+- Refreshing `eol=lf` for snapshot of test (Windows)
+```sh
+git add . -u
+git commit -m "Saving files before refreshing line endings"
+
+npm run eol
+```
 
 ### VSCode Extension
 - [Coverage Gutters](https://github.com/ryanluker/vscode-coverage-gutters) - Display test coverage generated by lcov or xml in VSCode editor.
 
 ## Thanks
-- Special thanks to [@edumserrano](https://github.com/edumserrano)
+- [@bcoe](https://github.com/bcoe)
+- [@edumserrano](https://github.com/edumserrano)

package/README.zh-Hans.md

@@ -39,6 +39,7 @@
 * [如何跟其他框架集成](#integration-with-any-testing-framework)
 * [集成的例子](#integration-examples)
     - [Playwright](#playwright)
+    - [c8](#c8)
     - [CodeceptJS](#codeceptjs)
     - [Jest](#jest)
     - [Vitest](#vitest)
@@ -918,7 +919,6 @@ const coverageOptions = {
 - [playwright-coverage](https://github.com/cenfun/playwright-coverage) - Example for Playwright coverage reports
 - [playwright-bdd-coverage](https://github.com/cenfun/playwright-bdd-coverage) - Example for Playwright BDD coverage reports
 - [monocart-reporter](https://github.com/cenfun/monocart-reporter) - Playwright custom reporter, supports generating [Code coverage report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
-- [merge-code-coverage](https://github.com/cenfun/merge-code-coverage) - Example for merging code coverage (unit + e2e shard)
 - Coverage for component testing with `monocart-reporter`:
     - [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue)
     - [playwright-ct-react](https://github.com/cenfun/playwright-ct-react)
@@ -928,14 +928,22 @@ const coverageOptions = {
     - [nextjs-with-playwright-istanbul](https://github.com/cenfun/nextjs-with-playwright-istanbul)
 - see [Collecting V8 Coverage Data with Playwright](#collecting-v8-coverage-data-with-playwright)
 
+### [c8](https://github.com/bcoe/c8)
+- c8 has integrated `MCR` as an experimental feature since [v10.1.0](https://github.com/bcoe/c8/releases/tag/v10.1.0)
+```sh
+c8 --experimental-monocart --reporter=v8 --reporter=console-details node foo.js
+```
+
 ### [CodeceptJS](https://github.com/codeceptjs/CodeceptJS)
-- CodeceptJS is a [BDD](https://codecept.io/bdd/) + [AI](https://codecept.io/ai/) testing framework for e2e testing, it has integrated `MCR` since [v3.5.15](https://github.com/codeceptjs/CodeceptJS/releases/tag/3.5.15), see [plugins/coverage](https://codecept.io/plugins/#coverage). There's no need to use ~~[codeceptjs-monocart-coverage](https://github.com/cenfun/codeceptjs-monocart-coverage)~~ anymore.
+- CodeceptJS is a [BDD](https://codecept.io/bdd/) + [AI](https://codecept.io/ai/) testing framework for e2e testing, it has integrated `MCR` since [v3.5.15](https://github.com/codeceptjs/CodeceptJS/releases/tag/3.5.15), see [plugins/coverage](https://codecept.io/plugins/#coverage)
 
 ### [Jest](https://github.com/jestjs/jest/)
 - [jest-monocart-coverage](https://github.com/cenfun/jest-monocart-coverage) - Jest custom reporter for coverage reports
+- [merge-code-coverage](https://github.com/cenfun/merge-code-coverage) - Example for merging code coverage (Jest unit + Playwright e2e sharding)
 
 ### [Vitest](https://github.com/vitest-dev/vitest)
 - [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - Vitest custom provider module for coverage reports
+- [merge-code-coverage-vitest](https://github.com/cenfun/merge-code-coverage-vitest) - Example for merging code coverage (Vitest unit + Playwright e2e sharding)
 
 ### [Puppeteer](https://github.com/puppeteer/puppeteer/)
 - [jest-puppeteer-coverage](https://github.com/cenfun/jest-puppeteer-coverage) - Example for Jest puppeteer coverage
@@ -1058,17 +1066,25 @@ const coverageOptions = {
 - Node.js 20+
 - VSCode (extensions: eslint/stylelint/vue)
 ```sh
-npm install starfall-cli -g
 npm install
+npx playwright install --with-deps
 
 npm run build
 npm run test
 
 npm run dev
 ```
+- Refreshing `eol=lf` for snapshot of test (Windows)
+```sh
+git add . -u
+git commit -m "Saving files before refreshing line endings"
+
+npm run eol
+```
 
 ### VSCode Extension
 - [Coverage Gutters](https://github.com/ryanluker/vscode-coverage-gutters) - Display test coverage generated by lcov or xml in VSCode editor.
 
 ## Thanks
-- Special thanks to [@edumserrano](https://github.com/edumserrano)
+- [@bcoe](https://github.com/bcoe)
+- [@edumserrano](https://github.com/edumserrano)

package/lib/converter/ast-visitor.js

@@ -32,10 +32,10 @@ const getParentCount = (reverseParents, functionCount) => {
     return functionCount;
 };
 
-const getFunctionRange = (start, end, coverageInfo) => {
+const getFunctionRange = (start, end, type, coverageInfo) => {
 
     const {
-        functionMap, functionNameMap, functionUncoveredRanges
+        functionMap, functionNameMap, functionStaticRanges, functionUncoveredRanges
     } = coverageInfo;
 
     // exact matched in functionMap
@@ -49,6 +49,13 @@ const getFunctionRange = (start, end, coverageInfo) => {
         return nameRange;
     }
 
+    if (type === 'StaticBlock' && functionStaticRanges.length) {
+        const staticRange = Util.findInRanges(start, end, functionStaticRanges, 'startOffset', 'endOffset');
+        if (staticRange) {
+            return staticRange;
+        }
+    }
+
     // find in uncoveredRanges
     return Util.findInRanges(start, end, functionUncoveredRanges, 'startOffset', 'endOffset');
 };
@@ -283,8 +290,10 @@ const updateBranchCount = (group) => {
         if (none) {
             return;
         }
+
         item.block = getFunctionBlock(start, end, functionState);
         setGeneratedOnly(item.block, group.generatedOnly);
+
     });
 
 
@@ -464,6 +473,15 @@ const collectNodes = (ast) => {
             });
         },
 
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static
+        // as a function "functionName": "<static_initializer>",
+        StaticBlock: (node, parents) => {
+            const reverseParents = [].concat(parents).reverse();
+            functionNodes.push({
+                node,
+                reverseParents
+            });
+        },
 
         // ===============================================================================
         // functions
@@ -617,10 +635,12 @@ const getRootFunctionState = (ast, coverageInfo) => {
 const findFunctionRange = (item, coverageInfo) => {
 
     const { node, reverseParents } = item;
-    const { start, end } = node;
+    const {
+        start, end, type
+    } = node;
 
     // try function start/end
-    const functionRange = getFunctionRange(start, end, coverageInfo);
+    const functionRange = getFunctionRange(start, end, type, coverageInfo);
     if (functionRange) {
         return functionRange;
     }
@@ -629,7 +649,7 @@ const findFunctionRange = (item, coverageInfo) => {
     // 0 is function self
     const parent = reverseParents[1];
     if (parent && parent.type === 'MethodDefinition') {
-        return getFunctionRange(parent.start, parent.end, coverageInfo);
+        return getFunctionRange(parent.start, parent.end, parent.type, coverageInfo);
     }
 
 };

package/lib/converter/ast.js

@@ -8,7 +8,9 @@ const { collectAstInfo } = require('./ast-visitor.js');
 const getCoverageInfo = (coverageList) => {
     const functionMap = new Map();
     const functionNameMap = new Map();
+    const functionStaticRanges = [];
     const functionUncoveredRanges = [];
+
     let rootRange;
     coverageList.forEach((block) => {
         const {
@@ -38,9 +40,7 @@ const getCoverageInfo = (coverageList) => {
             functionRange.blockMap = blockMap;
             // uncovered is unique
             const blockUncoveredRanges = blockRanges.filter((it) => it.count === 0);
-            blockUncoveredRanges.sort((a, b) => {
-                return a.startOffset - b.startOffset;
-            });
+            Util.sortOffsetRanges(blockUncoveredRanges);
             functionRange.blockUncoveredRanges = blockUncoveredRanges;
             functionRange.blockCoveredRanges = blockRanges.filter((it) => it.count > 0);
         }
@@ -61,7 +61,11 @@ const getCoverageInfo = (coverageList) => {
             functionNameMap.set(functionRange.startOffset + functionName.length, functionRange);
         }
 
-        // uncovered is unique
+        if (functionName === '<static_initializer>') {
+            functionStaticRanges.push(functionRange);
+        }
+
+        // cache uncovered
         if (functionRange.count === 0) {
             functionUncoveredRanges.push(functionRange);
         }
@@ -69,13 +73,12 @@ const getCoverageInfo = (coverageList) => {
     });
 
     // sort ranges
-    functionUncoveredRanges.sort((a, b) => {
-        return a.startOffset - b.startOffset;
-    });
+    Util.sortOffsetRanges(functionUncoveredRanges);
 
     return {
         functionMap,
         functionNameMap,
+        functionStaticRanges,
         functionUncoveredRanges,
         rootRange
     };

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

@@ -63,9 +63,14 @@ const resolveSourcesContent = (data, url) => {
 
     const { sources, sourcesContent } = data;
 
-    let failed = false;
+    // sources [1,2,3]
+    // sourcesContent could be [null, null, "content"]
+    // some of contents could be missed
+
+    let hasSourceContent = false;
     sources.forEach((file, i) => {
         if (typeof sourcesContent[i] === 'string') {
+            hasSourceContent = true;
             return;
         }
 
@@ -79,16 +84,18 @@ const resolveSourcesContent = (data, url) => {
             const content = Util.readFileSync(path.resolve(sourcePath));
             if (typeof content === 'string') {
                 sourcesContent[i] = content;
+                hasSourceContent = true;
                 return;
             }
         }
 
-        Util.logDebug(EC.red(`failed to load source content ${file}`));
-        failed = true;
+        sourcesContent[i] = '';
+        Util.logDebug(EC.red(`failed to load source content: ${file}`));
+
     });
 
 
-    if (!failed) {
+    if (hasSourceContent) {
         return data;
     }
 };

package/lib/converter/converter.js

@@ -49,7 +49,7 @@ const logMappingErrors = (type, result) => {
 
 const handleIgnoredRanges = (list, ignoredRanges) => {
     list.forEach((item) => {
-        const range = Util.findInRanges(item.start, item.end, ignoredRanges, 'start', 'end');
+        const range = Util.findInRanges(item.start, item.end, ignoredRanges);
         if (range) {
             // console.log(item, range);
             item.ignored = true;
@@ -74,32 +74,7 @@ const applyBytesToLines = (bytes, locator, lineMap) => {
 
         // update lines coverage
         const lines = Util.getRangeLines(sLoc, eLoc);
-
-        lines.forEach((it) => {
-            const lineItem = lineMap.get(it.line);
-            if (!lineItem) {
-                // not found line, could be comment or blank line
-                return;
-            }
-            if (lineItem.ignored) {
-                return;
-            }
-
-            it.count = count;
-
-            // default is covered, so only focus on
-            // 1, biggest covered count
-            // 2, uncovered entire and pieces
-            if (count > 0) {
-                lineItem.coveredCount = Math.max(lineItem.coveredCount, count);
-            } else {
-                if (it.entire) {
-                    lineItem.uncoveredEntire = it;
-                } else {
-                    lineItem.uncoveredPieces.push(it);
-                }
-            }
-        });
+        Util.updateLinesCoverage(lines, count, lineMap);
 
     });
 
@@ -414,6 +389,13 @@ const checkOriginalRangeCode = (range, state, startEndMap, type) => {
         return false;
     }
 
+    // do not check text for `bytes`
+    // it could be `} ` uncovered in `try { } catch`
+    // instead, use `dedupeCountRanges` to accumulate count
+    if (type === 'bytes') {
+        return true;
+    }
+
     // invalid original code
     // Matches any character that is not a word character from the basic Latin alphabet.
     // Equivalent to [^A-Za-z0-9_]
@@ -425,12 +407,6 @@ const checkOriginalRangeCode = (range, state, startEndMap, type) => {
 
     // type: bytes, functions, branches, statements
 
-    // do not check repeated range for `bytes`
-    // instead, use `dedupeCountRanges` to accumulate count
-    if (type === 'bytes') {
-        return true;
-    }
-
     // check repeated range
     const key = `${start}_${end}`;
     if (startEndMap.has(key)) {
@@ -1237,6 +1213,84 @@ const filterCoverageList = (item) => {
     return coverageList;
 };
 
+const initJsCoverageList = (item) => {
+    const coverageList = filterCoverageList(item);
+
+    // function could be covered even it is defined after an uncovered return, see case closures.js
+    // fix uncovered range if there are covered ranges in uncovered range
+
+    const uncoveredBlocks = [];
+    const uncoveredList = [];
+    coverageList.forEach((block) => {
+        block.ranges.forEach((range, i) => {
+            const {
+                count, startOffset, endOffset
+            } = range;
+
+            if (i === 0) {
+                // check only first level
+                if (count > 0) {
+                    const inUncoveredRange = Util.findInRanges(startOffset, endOffset, uncoveredBlocks, 'startOffset', 'endOffset');
+                    if (inUncoveredRange) {
+                        if (!inUncoveredRange.coveredList) {
+                            inUncoveredRange.coveredList = [];
+                            uncoveredList.push(inUncoveredRange);
+                        }
+                        inUncoveredRange.coveredList.push(range);
+                    }
+                }
+            } else {
+                if (count === 0) {
+                    uncoveredBlocks.push({
+                        ... range,
+                        index: i,
+                        ranges: block.ranges
+                    });
+                }
+            }
+        });
+    });
+
+    if (uncoveredList.length) {
+
+        uncoveredList.forEach((it) => {
+            const {
+                ranges, index, count, coveredList
+            } = it;
+
+            // remove previous range first
+            const args = [index, 1];
+
+            Util.sortOffsetRanges(coveredList);
+            let startOffset = it.startOffset;
+            coveredList.forEach((cov) => {
+                // ignore sub functions in the function
+                if (cov.startOffset > startOffset) {
+                    args.push({
+                        startOffset,
+                        endOffset: cov.startOffset,
+                        count
+                    });
+                    startOffset = cov.endOffset;
+                }
+            });
+
+            if (it.endOffset > startOffset) {
+                args.push({
+                    startOffset,
+                    endOffset: it.endOffset,
+                    count
+                });
+            }
+
+            ranges.splice.apply(ranges, args);
+
+        });
+    }
+
+    return coverageList;
+};
+
 // ========================================================================================================
 
 const isCoveredInRanges = (range, uncoveredBytes) => {
@@ -1464,7 +1518,7 @@ const convertV8List = (v8list, options) => {
         let coverageList = [];
         let astInfo;
         if (js) {
-            coverageList = filterCoverageList(item);
+            coverageList = initJsCoverageList(item);
             // remove original functions
             if (!Util.isDebug()) {
                 delete item.functions;

package/lib/index.d.ts

@@ -128,7 +128,7 @@ declare namespace MCR {
         path: string;
         type: "v8" | "istanbul";
         data: any;
-    } | undefined;
+    };
 
 
     export interface MetricsSummary {
@@ -204,12 +204,13 @@ declare namespace MCR {
         watermarks: Watermarks;
         summary: CoverageSummary;
         files: CoverageFile[];
-    } | undefined;
+    };
 
+    export type LoggingType = "off" | "error" | "info" | "debug";
     export interface CoverageReportOptions {
 
         /** {string} logging levels: off, error, info, debug */
-        logging?: string;
+        logging?: LoggingType;
 
         /** {string} Report name. Defaults to "Coverage Report". */
         name?: string;
@@ -222,7 +223,7 @@ declare namespace MCR {
          * 
          * By default, `v8` for V8 data, `html` for Istanbul data
          */
-        reports?: string | string[] | ReportDescription[];
+        reports?: string | (string | ReportDescription)[];
 
         /** {string} output dir */
         outputDir?: string;
@@ -328,7 +329,7 @@ declare namespace MCR {
         onEntry?: (entry: V8CoverageEntry) => Promise<void>;
 
         /** {function} onEnd hook */
-        onEnd?: (coverageResults: CoverageResults) => Promise<void>;
+        onEnd?: (coverageResults: CoverageResults | undefined) => Promise<void>;
 
         [key: string]: any;
     }
@@ -356,7 +357,7 @@ declare namespace MCR {
         /** add coverage data
          * 
          * @param coverageData {array} V8 format, {object} Istanbul format */
-        add: (coverageData: any[] | any) => Promise<AddedResults>;
+        add: (coverageData: any[] | any) => Promise<AddedResults | undefined>;
 
         /**
          * add V8 coverage from a dir
@@ -365,7 +366,7 @@ declare namespace MCR {
         addFromDir: (dir: string) => Promise<void>;
 
         /** generate report */
-        generate: () => Promise<CoverageResults>;
+        generate: () => Promise<CoverageResults | undefined>;
 
         /** check if cache exists */
         hasCache: () => boolean;
@@ -494,6 +495,10 @@ declare namespace MCR {
 
     export function CDPClient(cdpOptions: CDPOptions): Promise<CoverageClient | undefined>;
 
+    export const Util: {
+        initLoggingLevel: (logging: LoggingType) => string;
+    };
+
 }
 
 /** create coverage report */

package/lib/index.js

@@ -279,5 +279,6 @@ MCR.getSnapshot = getSnapshot;
 MCR.diffSnapshot = diffSnapshot;
 MCR.WSSession = WSSession;
 MCR.CDPClient = CDPClient;
+MCR.Util = Util;
 
 module.exports = MCR;

package/lib/index.mjs

@@ -6,3 +6,4 @@ export const diffSnapshot = MCR.diffSnapshot;
 
 export const WSSession = MCR.WSSession;
 export const CDPClient = MCR.CDPClient;
+export const Util = MCR.Util;