monocart-coverage-reports 2.3.4 → 2.4.0

package/README.md

@@ -2,6 +2,7 @@
 
 [![](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
 [![](https://badgen.net/npm/dw/monocart-coverage-reports)](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/static.yml)
 
@@ -405,10 +406,11 @@ console.log(coverageResults.summary);
 
 ## Merge Coverage Reports
 The following usage scenarios may require merging coverage reports:
-- When the code is executed in different environments, like Node.js Server Side and browser Client Side (Next.js for instance). Each environment may generate its own coverage report. Merging them can give a more comprehensive view of the test coverage.
+- When the code is executed in different environments, like Node.js Server Side and browser Client Side (Next.js for instance). Each environment may generate its own coverage report. Merging them can give a more comprehensive view of the test coverage. see example [nextjs-with-playwright](https://github.com/cenfun/nextjs-with-playwright) for automatic report merging.
 - When the code is subjected to different kinds of testing. For example, unit tests with Jest might cover certain parts of the code, while end-to-end tests with Playwright might cover other parts. Merging these different coverage reports can provide a holistic view of what code has been tested.
 - When tests are run on different machines or different shards, each might produce its own coverage report. Merging these can give a complete picture of the test coverage across all machines or shards.
 
+If the reports cannot be merged automatically, then here is how to manually merge the reports.
 First, using the `raw` report to export the original coverage data to the specified directory.
 ```js
 const coverageOptions = {

package/lib/converter/ast-visitor.js

@@ -0,0 +1,646 @@
+const Util = require('../utils/util.js');
+
+const getParentFunctionState = (reverseParents) => {
+    const parentFunction = reverseParents.find((it) => it._state && it._state.isFunction);
+    if (!parentFunction) {
+        return;
+    }
+    return parentFunction._state;
+};
+
+const getParentCount = (reverseParents, functionCount) => {
+    // parent count
+    const parent = reverseParents.find((it) => it._state);
+    if (parent) {
+        return parent._state.count;
+    }
+    // root function count
+    return functionCount;
+};
+
+const getFunctionRange = (start, end, coverageInfo) => {
+
+    const {
+        functionMap, functionNameMap, functionUncoveredRanges
+    } = coverageInfo;
+
+    // exact matched in functionMap
+    const range = functionMap.get(start);
+    if (range) {
+        return range;
+    }
+    // exact matched in functionNameMap
+    const nameRange = functionNameMap.get(start);
+    if (nameRange) {
+        return nameRange;
+    }
+
+    // find in uncoveredRanges
+    return Util.findInRanges(start, end, functionUncoveredRanges, 'startOffset', 'endOffset');
+};
+
+const getFunctionBlock = (start, end, functionState) => {
+    if (!functionState) {
+        return;
+    }
+
+    const { range } = functionState;
+    if (!range) {
+        return;
+    }
+
+    const {
+        blockMap, blockUncoveredRanges, blockCoveredRanges
+    } = range;
+
+    if (!blockMap) {
+        return;
+    }
+
+    const block = blockMap.get(start);
+    if (block) {
+        return block;
+    }
+
+    const uncoveredBlock = Util.findInRanges(start, end, blockUncoveredRanges, 'startOffset', 'endOffset');
+    if (uncoveredBlock) {
+        return uncoveredBlock;
+    }
+
+    // the block is not exact correct, if there is a block wrapped
+    // [x8]{ var a = b || [x4]c }, b is no block, but it can be found in x8 block
+    const coveredBlocks = blockCoveredRanges.filter((it) => start >= it.startOffset && end <= it.endOffset);
+    if (coveredBlocks.length) {
+        return coveredBlocks.pop();
+    }
+
+};
+
+const addNodeCount = (item) => {
+
+    const { node, reverseParents } = item;
+
+    if (node._state) {
+        return;
+    }
+
+    const { start, end } = node;
+    const functionState = getParentFunctionState(reverseParents);
+    const block = getFunctionBlock(start, end, functionState);
+    if (block) {
+        node._state = {
+            count: block.count
+        };
+    }
+
+};
+
+// =======================================================================================
+
+const createBranchGroup = (type, node, parents, branchMap) => {
+    const { start, end } = node;
+    // clone and reverse parents
+    const reverseParents = [].concat(parents).reverse();
+    const group = {
+        type,
+
+        start,
+        // could be updated if multiple locations
+        end,
+
+        locations: [],
+        reverseParents
+    };
+
+    if (type === 'LogicalExpression') {
+        // && or ||
+        group.operator = node.operator;
+    }
+
+    branchMap.set(start, group);
+    return group;
+};
+
+const addBranch = (group, node, locationMap) => {
+    const { start, end } = node;
+
+    const branchStart = group.start;
+
+    const branchInfo = {
+        // for get previous group for LogicalExpression
+        branchStart,
+        start,
+        end,
+        // branch count default to 0
+        count: 0
+    };
+
+    group.locations.push(branchInfo);
+
+    // update group end
+    if (end > group.end) {
+        group.end = end;
+    }
+
+    locationMap.set(start, branchInfo);
+
+    return branchInfo;
+};
+
+const addNoneBranch = (group) => {
+    group.locations.push({
+        none: true,
+        count: 0
+    });
+};
+
+// =======================================================================================
+
+const updateBlockLocations = (locations) => {
+    const noBlockList = [];
+    let blockCount = 0;
+    locations.forEach((item) => {
+        if (item.block) {
+            item.count = item.block.count;
+            blockCount += item.count;
+            return;
+        }
+        noBlockList.push(item);
+    });
+
+    return {
+        noBlockList,
+        blockCount
+    };
+};
+
+// const a = tf1 ? 'true' : 'false';
+const ConditionalExpression = (group, parentCount) => {
+    const { noBlockList, blockCount } = updateBlockLocations(group.locations);
+    if (!noBlockList.length) {
+        return;
+    }
+    let count = parentCount - blockCount;
+    noBlockList.forEach((item) => {
+        item.count = count;
+        count = 0;
+    });
+};
+
+const IfStatement = (group, parentCount) => {
+    const { noBlockList, blockCount } = updateBlockLocations(group.locations);
+    if (!noBlockList.length) {
+        return;
+    }
+    // console.log(parentCount, 'uncovered list', noBlockList.length, group.start);
+    let count = parentCount - blockCount;
+    noBlockList.forEach((item) => {
+        item.count = count;
+        count = 0;
+    });
+
+};
+
+// 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) => {
+            item.count = parentCount;
+        });
+        return;
+    }
+
+    const count = parentCount - blockCount;
+    noBlockList.forEach((item) => {
+        item.count = count;
+    });
+};
+
+const SwitchStatement = (group, parentCount) => {
+    const { noBlockList, blockCount } = updateBlockLocations(group.locations);
+    if (!noBlockList.length) {
+        return;
+    }
+    const count = parentCount - blockCount;
+    noBlockList.forEach((item) => {
+        item.count = count;
+    });
+};
+
+const AssignmentPattern = (group, parentCount) => {
+    group.locations.forEach((item) => {
+        item.count = parentCount;
+    });
+};
+
+// =======================================================================================
+
+const updateBranchCount = (group) => {
+
+    const {
+        type, locations, reverseParents
+    } = group;
+
+    const functionState = getParentFunctionState(reverseParents);
+
+    const functionCount = functionState.count;
+
+    // default is 0, no need continue
+    if (functionCount === 0) {
+        return;
+    }
+
+    // parent is block statement or function
+    let parentCount = getParentCount(reverseParents, functionCount);
+    // parent is group range
+    const groupBlock = getFunctionBlock(group.start, group.end, functionState);
+    if (groupBlock) {
+        parentCount = groupBlock.count;
+    }
+
+    // calculate branches count
+    locations.forEach((item) => {
+        const {
+            start, end, none
+        } = item;
+        if (none) {
+            return;
+        }
+        item.block = getFunctionBlock(start, end, functionState);
+    });
+
+
+    const handlers = {
+        ConditionalExpression,
+        IfStatement,
+        LogicalExpression,
+        SwitchStatement,
+        AssignmentPattern
+    };
+
+    const handler = handlers[type];
+    if (handler) {
+        handler(group, parentCount);
+    }
+
+};
+
+const generateBranches = (branchMap) => {
+
+    // calculate count for all branches
+    branchMap.forEach((group) => {
+        updateBranchCount(group);
+    });
+
+    // init branches
+    const branches = [];
+    branchMap.forEach((group) => {
+
+        // add start/end for none with group start/end
+        group.locations.forEach((item) => {
+            if (item.none) {
+                item.start = group.start;
+                item.end = group.end;
+            }
+        });
+
+        branches.push({
+            type: group.type,
+            start: group.start,
+            end: group.end,
+            locations: group.locations
+        });
+    });
+
+    // sort branches
+    branches.sort((a, b) => {
+        return a.start - b.start;
+    });
+
+    return branches;
+};
+
+// =======================================================================================
+// All programs in JavaScript are made of statements and they end with semicolons (;) except block statements which is used to group zero or more statements.
+// Statements are just perform some actions but do not produce any value or output whereas expressions return some value.
+// Expressions return value, statements do not.
+const generateStatements = (statementNodes) => {
+
+    statementNodes.forEach((item) => {
+        const {
+            node,
+            reverseParents
+        } = item;
+
+        const { start, end } = node;
+
+        item.count = 1;
+
+        // isFunction
+        if (node._state) {
+            item.count = node._state.count;
+            return;
+        }
+
+        const functionState = getParentFunctionState(reverseParents);
+        if (!functionState) {
+            // there is a root range, it impossible not found
+            return;
+        }
+
+        // function uncovered
+        if (functionState.count === 0) {
+            item.count = 0;
+            return;
+        }
+
+        const block = getFunctionBlock(start, end, functionState);
+        if (block) {
+            item.count = block.count;
+            return;
+        }
+
+        item.count = functionState.count;
+
+    });
+
+    // remove block statement
+    statementNodes = statementNodes.filter((item) => {
+        return item.node.type !== 'BlockStatement';
+    });
+
+    const statements = statementNodes.map((item) => {
+        const {
+            node,
+            count
+        } = item;
+        const { start, end } = node;
+        return {
+            start,
+            end,
+            count
+        };
+    });
+
+    return statements;
+};
+
+// =======================================================================================
+
+const collectNodes = (ast) => {
+    const functionNodes = [];
+    const statementNodes = [];
+    const blockNodes = [];
+    const branchMap = new Map();
+    // locationMap for chain LogicalExpression locations
+    const locationMap = new Map();
+
+    Util.visitAst(ast, {
+
+        VariableDeclarator(node, parents) {
+
+            // =============================================================
+            // id: { type: 'Identifier', name: '__webpack_modules__' },
+            const name = node.id && node.id.name;
+            if (name === '__webpack_modules__' && node.init) {
+                // mark all as wrap function
+                node.init.properties.forEach((it) => {
+                    it.value._wrapKey = it.key && it.key.value;
+                });
+                // console.log('==========================', node.type);
+                // console.log(name, parents.length);
+            }
+            // =============================================================
+
+        },
+
+        // ===============================================================================
+        // statements
+
+        Statement: (node, parents) => {
+            const reverseParents = [].concat(parents).reverse();
+            statementNodes.push({
+                node,
+                reverseParents
+            });
+        },
+
+
+        // ===============================================================================
+        // functions
+        // Function include FunctionDeclaration, ArrowFunctionExpression, FunctionExpression
+        Function(node, parents) {
+            const reverseParents = [].concat(parents).reverse();
+            functionNodes.push({
+                node,
+                reverseParents
+            });
+        },
+
+        // ===============================================================================
+        // branches
+
+        // `for` block, the count not equal to parent
+        BlockStatement: (node, parents) => {
+
+            // fix branch count: BRDA
+            const reverseParents = [].concat(parents).reverse();
+            blockNodes.push({
+                node,
+                reverseParents
+            });
+
+        },
+
+        // default-arg assignment logic.
+        // function default arguments
+        AssignmentPattern: (node, parents) => {
+            const group = createBranchGroup('AssignmentPattern', node, parents, branchMap);
+            addBranch(group, node, locationMap);
+        },
+
+        // cond-expr a ternary expression. e.g.: x ? y : z
+        // Ternary
+        // var b = a ? 'consequent' : 'alternate';
+        ConditionalExpression: (node, parents) => {
+            const { consequent, alternate } = node;
+            const group = createBranchGroup('ConditionalExpression', node, parents, branchMap);
+            addBranch(group, consequent, locationMap);
+            addBranch(group, alternate, locationMap);
+        },
+
+        // if an if statement; can also be else if.
+        // An IF statement always has exactly two branches:
+        // one where the condition is FALSE and one where the condition is TRUE
+        IfStatement: (node, parents) => {
+            const { consequent, alternate } = node;
+            const group = createBranchGroup('IfStatement', node, parents, branchMap);
+            addBranch(group, consequent, locationMap);
+
+            // console.log('if type', consequent.type);
+
+            if (alternate) {
+                addBranch(group, alternate, locationMap);
+            } else {
+                // add none branch
+                addNoneBranch(group);
+                // no need update group end, there is no end
+            }
+        },
+
+        // binary-expr a logical expression with a binary operand. e.g.: x && y
+        // var b = a || b || c;
+        // do not use BinaryExpression
+        LogicalExpression: (node, parents) => {
+            const { left, right } = node;
+            // console.log(left.start, right.start);
+
+            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);
+            } else {
+                group = createBranchGroup('LogicalExpression', node, parents, branchMap);
+                addBranch(group, left, locationMap);
+            }
+
+            addBranch(group, right, locationMap);
+
+            // console.log(group.locations.map((it) => it.start));
+
+            // sort branch locations
+            // a || b || c
+            // first, left a and right c
+            // then, left a and right b
+            if (prevLocation) {
+                const { locations } = group;
+                locations.sort((a, b) => {
+                    return a.start - b.start;
+                });
+                // update group end after sorted
+                const lastEnd = locations[locations.length - 1].end;
+                if (lastEnd > group.end) {
+                    group.end = lastEnd;
+                }
+            }
+        },
+
+        // switch a switch statement.
+        SwitchStatement: (node, parents) => {
+            const group = createBranchGroup('SwitchStatement', node, parents, branchMap);
+            const cases = node.cases;
+            cases.forEach((switchCase) => {
+                // console.log('switchCase', switchCase.start);
+                addBranch(group, switchCase, locationMap);
+            });
+        }
+
+    });
+
+    return {
+        functionNodes,
+        statementNodes,
+        blockNodes,
+        branchMap
+    };
+};
+
+const getRootFunctionState = (ast, coverageInfo) => {
+    const rootState = {
+        isFunction: true,
+        count: 1
+    };
+    const rootRange = coverageInfo.rootRange;
+    if (rootRange) {
+        rootState.range = rootRange;
+        rootState.count = rootRange.count;
+
+        // could be not from 0
+        // 0 881 { startOffset: 77, endOffset: 881,
+        // const { start, end } = ast;
+        // console.log(start, end, rootRange);
+
+    }
+    ast._state = rootState;
+
+    return rootState;
+};
+
+const collectAstInfo = (ast, coverageInfo) => {
+
+    const {
+        functionNodes, statementNodes, blockNodes, branchMap
+    } = collectNodes(ast);
+
+    // root function state
+    const rootState = getRootFunctionState(ast, coverageInfo);
+
+    const functions = [];
+    functionNodes.forEach((item) => {
+        const { node } = item;
+        const {
+            start, end, id
+        } = node;
+        const bodyStart = node.body.start;
+        const bodyEnd = node.body.end;
+        const functionName = id && id.name;
+        const isWrap = Boolean(node._wrapKey);
+
+        const functionItem = {
+            start,
+            end,
+            bodyStart,
+            bodyEnd,
+            functionName,
+            count: rootState.count
+        };
+        if (isWrap) {
+            functionItem.wrap = true;
+        }
+        functions.push(functionItem);
+
+        const functionState = {
+            isFunction: true,
+            count: functionItem.count
+        };
+        const functionRange = getFunctionRange(start, end, coverageInfo);
+        if (functionRange) {
+            if (isWrap) {
+                functionRange.wrap = true;
+            }
+            functionState.range = functionRange;
+            functionState.count = functionRange.count;
+            functionItem.count = functionRange.count;
+        }
+        node._state = functionState;
+
+        // console.log(item.reverseParents.map((it) => it.type));
+
+    });
+
+    blockNodes.forEach((item) => {
+        addNodeCount(item);
+    });
+
+    const branches = generateBranches(branchMap);
+    const statements = generateStatements(statementNodes);
+
+    return {
+        functions,
+        branches,
+        statements
+    };
+
+};
+
+module.exports = {
+    collectAstInfo
+};