monocart-coverage-reports 2.7.7 → 2.7.8

package/README.md

@@ -50,6 +50,8 @@
     - [Codecov](#codecov)
     - [Coveralls](#coveralls)
     - [Sonar Cloud](#sonar-cloud)
+* [Contributing](#contributing)
+* [Changelog](CHANGELOG.md)
 * [Thanks](#thanks)
 
 ## Usage
@@ -222,19 +224,24 @@ const mcr = MCR(coverageOptions);
     - vite: [vite-plugin-istanbul](https://github.com/ifaxity/vite-plugin-istanbul)
     - rollup: [rollup-plugin-istanbul](https://github.com/artberri/rollup-plugin-istanbul)
     - swc: [swc-plugin-coverage-instrument](https://github.com/kwonoj/swc-plugin-coverage-instrument)
+
 - Browser
     - Collecting coverage data from `window.__coverage__`, example: [test-istanbul.js](./test/test-istanbul.js)
+
 - Node.js
     - Collecting coverage data from `global.__coverage__`
 
+- CDP
+    - `getIstanbulCoverage()` see [`CDPClient` API](#collecting-v8-coverage-data-with-cdpclient-api)
+
 ## Collecting V8 Coverage Data
 - Before coverage collection: Enabling `sourcemap` for source code
     - [webpack](https://webpack.js.org/configuration/): `devtool: source-map` and `mode: development`, example [webpack.config-v8.js](./test/build/webpack.config-v8.js)
-    - [rollup](https://rollupjs.org/configuration-options/): `sourcemap: true`
+    - [rollup](https://rollupjs.org/configuration-options/): `sourcemap: true` and `treeshake: false`
+    - [esbuild](https://esbuild.github.io/api/): `sourcemap: true`, `treeShaking: false` and `minify: false`
     - [vite](https://vitejs.dev/config/build-options.html): `sourcemap: true` and `minify: false`
-    - [esbuild](https://esbuild.github.io/api/): `sourcemap: true` and `minify: false`
 
-- Browser (Chromium Only)
+- Browser (Chromium-based Only)
     - [Collecting V8 Coverage Data with Playwright](#collecting-v8-coverage-data-with-playwright)
     - [Collecting Raw V8 Coverage Data with Puppeteer](#collecting-raw-v8-coverage-data-with-puppeteer)
 
@@ -331,7 +338,27 @@ Possible solutions:
     - see [Command Line](#command-line)
 
 ### Collecting V8 Coverage Data with `CDPClient` API
-- Work with node debugger port `--inspect=9229`
+- `CDPClient` available APIs
+```js
+startJSCoverage: () => Promise<void>;
+stopJSCoverage: () => Promise<V8CoverageEntry[]>;
+
+startCSSCoverage: () => Promise<void>;
+stopCSSCoverage: () => Promise<V8CoverageEntry[]>;
+
+/** start both js and css coverage */
+startCoverage: () => Promise<void>;
+/** stop and return both js and css coverage */
+stopCoverage: () => Promise<V8CoverageEntry[]>;
+
+/** write the coverage started by NODE_V8_COVERAGE to disk on demand, returns v8 coverage dir */
+writeCoverage: () => Promise<string>;
+
+/** get istanbul coverage data */
+getIstanbulCoverage: (coverageKey?: string) => Promise<any>;
+```
+
+- Work with node debugger port `--inspect=9229` or browser debugging port `--remote-debugging-port=9229`
 ```js
 const MCR = require('monocart-coverage-reports');
 const client = await MCR.CDPClient({
@@ -341,6 +368,7 @@ await client.startJSCoverage();
 // run your test here
 const coverageData = await client.stopJSCoverage();
 ```
+
 - Work with [Playwright CDPSession](https://playwright.dev/docs/api/class-cdpsession)
 ```js
 const { chromium } = require('playwright');
@@ -357,6 +385,7 @@ await client.startCoverage();
 await page.goto("your page url");
 const coverageData = await client.stopCoverage();
 ```
+
 - Work with [Puppeteer CDPSession](https://pptr.dev/api/puppeteer.cdpsession)
 ```js
 const puppeteer = require('puppeteer');
@@ -373,6 +402,7 @@ await client.startCoverage();
 await page.goto("your page url");
 const coverageData = await client.stopCoverage();
 ```
+
 - Work with [Selenium Webdriver](https://www.selenium.dev/documentation/webdriver/) WebSocket (Chrome/Edge Browser)
 ```js
 const { Builder, Browser } = require('selenium-webdriver');
@@ -384,29 +414,6 @@ const client = await MCR.CDPClient({
     session
 })
 ```
- - `CDPClient` available APIs
- ```js
-/** start js coverage */
-startJSCoverage: () => Promise<void>;
-/** stop and return js coverage */
-stopJSCoverage: () => Promise<V8CoverageEntry[]>;
-
-/** start css coverage */
-startCSSCoverage: () => Promise<void>;
-/** stop and return css coverage */
-stopCSSCoverage: () => Promise<V8CoverageEntry[]>;
-
-/** start both js and css coverage */
-startCoverage: () => Promise<void>;
-/** stop and return both js and css coverage */
-stopCoverage: () => Promise<V8CoverageEntry[]>;
-
-/** write the coverage started by NODE_V8_COVERAGE to disk on demand, returns v8 coverage dir */
-writeCoverage: () => Promise<string>;
-
-/** get istanbul coverage data */
-getIstanbulCoverage: (coverageKey?: string) => Promise<any>;
- ```
 
 ### V8 Coverage Data API
 - [JavaScript code coverage in V8](https://v8.dev/blog/javascript-code-coverage)
@@ -700,6 +707,12 @@ Options:
 mcr -c mcr.config.js -- sub-cli -c sub-cli.config.js
 ```
 
+- Examples
+    - [Mocha](#mocha)
+    - [tsx](#tsx)
+    - [ts-node](#ts-node)
+    - [AVA](#ava)
+
 ## Config File
 Loading config file by priority:
 - Custom config file:
@@ -969,6 +982,18 @@ const coverageOptions = {
         -Dsonar.exclusions=dist/*,packages/*
 ```
 
+## Contributing
+```sh
+# Node.js 20+
+npm install starfall-cli -g
+npm install
+
+npm run build
+npm run test
+
+npm run dev
+```
+
 ### VSCode Extension
 - [Coverage Gutters](https://github.com/ryanluker/vscode-coverage-gutters) - Display test coverage generated by lcov or xml in VSCode editor.
 

package/lib/client/cdp-client.js

@@ -12,10 +12,7 @@ const getDebuggerUrl = async (options) => {
     const protocol = options.secure ? 'https' : 'http';
 
     const url = `${protocol}://${options.host}:${options.port}/json/list`;
-    const [err, res] = await Util.request({
-        url,
-        timeout: options.timeout
-    });
+    const [err, res] = await Util.request(url);
     if (err) {
         return [err];
     }

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

@@ -19,9 +19,7 @@ const loadSourceMap = async (url = '') => {
         return JSON.parse(content);
     }
 
-    const [err, res] = await Util.request({
-        url
-    });
+    const [err, res] = await Util.request(url);
 
     if (err) {
         Util.logDebug(EC.red(`${err.message} ${url}`));

package/lib/converter/converter.js

@@ -5,8 +5,8 @@
  */
 
 const EC = require('eight-colors');
-const { Locator } = require('monocart-formatter');
 
+const { Locator } = require('monocart-locator');
 const Util = require('../utils/util.js');
 
 const findOriginalRange = require('./find-original-range.js');
@@ -984,9 +984,13 @@ const initOriginalList = (state, originalDecodedMap, options) => {
 
     const { sources, sourcesContent } = state.sourceMap;
 
+    const lengthBefore = sources.length;
+    let lengthAfter = 0;
+
     sources.forEach((sourcePath, sourceIndex) => {
 
         // filter
+        // do not change for sourceIndex
         if (!sourceFilter(sourcePath)) {
             // console.log('-', sourcePath);
             return;
@@ -1034,8 +1038,11 @@ const initOriginalList = (state, originalDecodedMap, options) => {
         };
 
         originalStateMap.set(sourceIndex, originalState);
+        lengthAfter += 1;
     });
 
+    Util.logFilter(`source filter (${state.sourcePath}):`, lengthBefore, lengthAfter);
+
     return originalStateMap;
 };
 
@@ -1044,6 +1051,8 @@ const collectOriginalList = (state, originalStateMap) => {
     const { fileUrls } = state;
     const distFile = state.sourcePath;
 
+    let added = 0;
+
     // collect original files
     originalStateMap.forEach((originalState) => {
 
@@ -1070,8 +1079,11 @@ const collectOriginalList = (state, originalStateMap) => {
         // save v8 data and add to originalList
         originalState.v8Data = sourceItem;
         state.originalList.push(originalState);
+        added += 1;
     });
 
+    Util.logDebug(`added source files: ${EC.yellow(added)}`);
+
 };
 
 // ========================================================================================================

package/lib/generate.js

@@ -686,6 +686,7 @@ const getInputData = async (inputList, all, cacheDir, addHandler) => {
     // dataList for data type, before `add` we don't which one is tested, because using hash id
     const emptyData = getEmptyData(all, dataList);
     if (emptyData) {
+        Util.logDebug(`added empty files for all: ${EC.yellow(emptyData.length)}`);
         const coverageResults = await addHandler(emptyData);
         // after `add`
         if (coverageResults) {
@@ -782,7 +783,11 @@ const readCoverageData = (filePath, entryFilter, sourceCache) => {
 
     // filter node internal files, should no anonymous for nodejs
     coverageData = coverageData.filter((entry) => entry.url && entry.url.startsWith('file:'));
+
+    const lengthBefore = coverageData.length;
     coverageData = coverageData.filter(entryFilter);
+    const lengthAfter = coverageData.length;
+    Util.logFilter('entry filter (addFromDir):', lengthBefore, lengthAfter);
 
     if (!Util.isList(coverageData)) {
         // Util.logDebug('No coverage data after filter');

package/lib/index.js

@@ -61,6 +61,9 @@ class CoverageReport {
             return;
         }
 
+        // before clean cache, do no call initOptions again in hasCache
+        this.fixedOptions = true;
+
         // init logging for clean after generated
         this.logging = Util.initLoggingLevel(this.options.logging);
 
@@ -79,7 +82,6 @@ class CoverageReport {
             this.cleanCache();
         }
 
-        this.fixedOptions = true;
     }
 
     // add coverage data: {array} V8 format, {object} Istanbul format