monocart-coverage-reports 2.8.6 → 2.8.7

package/README.md

@@ -35,6 +35,7 @@
 * [Common issues](#common-issues)
     - [Unexpected coverage](#unexpected-coverage)
     - [Unparsable source](#unparsable-source)
+    - [JavaScript heap out of memory](#javascript-heap-out-of-memory)
 * [Debug for Coverage and Sourcemap](#debug-for-coverage-and-sourcemap)
 * [Integration with Any Testing Framework](#integration-with-any-testing-framework)
 * [Integration Examples](#integration-examples)
@@ -141,6 +142,9 @@ For more information, see [Command Line](#command-line)
 - `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) 
 
+- `codacy`
+    - coverage data for [Codacy](https://api.codacy.com/swagger#tocscoveragereport) API
+
 - `console-summary` shows coverage summary in the console
 
 ![](./assets/console-summary.png)
@@ -881,6 +885,15 @@ const coverageOptions = {
 }
 ```
 
+### JavaScript heap out of memory
+When there are a lot of raw v8 coverage files to process, it may cause OOM. We can try the following Node.js options:
+```sh
+- run: npm run test:coverage
+    env:
+        NODE_OPTIONS: --max-old-space-size=8192
+```
+
+
 ## 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.
 - Start debugging for v8 report with option `logging: 'debug'`
@@ -900,6 +913,11 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 
 ![](./assets/debug-sourcemap.png)
 
+- Show time logs with env `MCR_LOG_TIME`
+```js
+process.env.MCR_LOG_TIME = true
+```
+
 ## Integration with Any Testing Framework
 - API
     - Collecting coverage data when any stage of the test is completed, and adding the coverage data to the coverage reporter. `await mcr.add(coverageData)`

package/README.zh-Hans.md

@@ -35,6 +35,7 @@
 * [常见问题](#common-issues)
     - [Unexpected coverage](#unexpected-coverage)
     - [Unparsable source](#unparsable-source)
+    - [JavaScript heap out of memory](#javascript-heap-out-of-memory)
 * [如何调试覆盖率数据和查看sourcemap](#debug-for-coverage-and-sourcemap)
 * [如何跟其他框架集成](#integration-with-any-testing-framework)
 * [集成的例子](#integration-examples)
@@ -141,6 +142,9 @@ mcr node my-app.js -r v8,console-details
 - `codecov`
     - 专属支持[Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format)的报告, see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
 
+- `codacy`
+    - 专属支持[Codacy](https://api.codacy.com/swagger#tocscoveragereport) API的报告
+
 - `console-summary` 在控制台显示覆盖率概要
 
 ![](./assets/console-summary.png)
@@ -884,6 +888,15 @@ const coverageOptions = {
 }
 ```
 
+### JavaScript heap out of memory
+内存溢出问题可能出现在有太多的原生V8覆盖率文件要处理. 我们可以使用Node.js的一个选项来增加内存使用:
+```sh
+- run: npm run test:coverage
+    env:
+        NODE_OPTIONS: --max-old-space-size=8192
+```
+
+
 ## Debug for Coverage and Sourcemap
 > 当你觉得覆盖率存在问题的时候，`MCR`支持自行调试来核验覆盖率的准确性
 - 首先打开调试设置`logging: 'debug'`
@@ -903,6 +916,11 @@ const coverageOptions = {
 
 ![](./assets/debug-sourcemap.png)
 
+- 使用环境变量`MCR_LOG_TIME`显示时间日志
+```js
+process.env.MCR_LOG_TIME = true
+```
+
 ## Integration with Any Testing Framework
 通用集成方案
 - 通过API接口在程序集成

package/lib/converter/converter.js

@@ -147,8 +147,7 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
         blank: blankCount,
         comment: commentCount
     };
-    // data lines for codecov
-    // https://docs.codecov.com/docs/codecov-custom-coverage-format
+    // data lines
     const dataLines = {};
 
     // no ignore items

package/lib/generate.js

@@ -90,6 +90,7 @@ const getReportGroup = (reports, lcov, dataType) => {
 
         // both
         'codecov': 'both',
+        'codacy': 'both',
         'console-details': 'both',
         'console-summary': 'both',
         'raw': 'both'
@@ -280,6 +281,42 @@ const handleCodecovReport = async (reportData, reportOptions, options) => {
     return Util.relativePath(jsonPath);
 };
 
+const handleCodacyReport = async (reportData, reportOptions, options) => {
+    const codacyOptions = {
+        outputFile: 'codacy.json',
+        ... reportOptions
+    };
+
+    const jsonPath = path.resolve(options.outputDir, codacyOptions.outputFile);
+
+    // https://api.codacy.com/swagger#tocscoveragereport
+    const fileReports = [];
+    reportData.files.forEach((item) => {
+        const { sourcePath, data } = item;
+
+        const coverage = {};
+        for (const [key, value] of Object.entries(data.lines)) {
+            if (typeof value === 'number') {
+                coverage[key] = value;
+            } else {
+                // partial coverage not supported?
+                coverage[key] = 0;
+            }
+        }
+
+        fileReports.push({
+            filename: sourcePath,
+            coverage
+        });
+    });
+    const codacyData = {
+        fileReports
+    };
+
+    await Util.writeFile(jsonPath, JSON.stringify(codacyData));
+    return Util.relativePath(jsonPath);
+};
+
 const handleConsoleDetailsReport = (reportData, reportOptions, options) => {
     const cdOptions = {
         maxCols: 50,
@@ -464,6 +501,7 @@ const generateCoverageReports = async (dataList, sourceCache, options) => {
 
     const buildInBothReports = {
         'codecov': handleCodecovReport,
+        'codacy': handleCodacyReport,
         'console-details': handleConsoleDetailsReport,
         'console-summary': handleConsoleSummaryReport,
         'raw': handleRawReport
@@ -854,9 +892,16 @@ const resolveEntrySourceMap = (entry, sourceMapCache) => {
     }
 };
 
-const readCoverageData = (item, entryFilter, sourceCache) => {
+const readCoverageData = async (dir, filename, entryFilter, sourceCache) => {
 
-    const json = item.json;
+    const content = await Util.readFile(path.resolve(dir, filename));
+    if (!content) {
+        return;
+    }
+    const json = JSON.parse(content);
+    if (!json) {
+        return;
+    }
 
     // raw v8 json
     let coverageData = json.result;
@@ -886,6 +931,26 @@ const readCoverageData = (item, entryFilter, sourceCache) => {
     return coverageData;
 };
 
+const readSourceList = async (dir, sourceList) => {
+    const sourceCache = {};
+
+    for (const filename of sourceList) {
+        const content = await Util.readFile(path.resolve(dir, filename));
+        if (!content) {
+            continue;
+        }
+        const json = JSON.parse(content);
+        if (!json) {
+            continue;
+        }
+        if (json.url) {
+            sourceCache[json.url] = json;
+        }
+    }
+
+    return sourceCache;
+};
+
 const readFromDir = async (mcr, dir) => {
 
     if (!dir || !fs.existsSync(dir)) {
@@ -894,56 +959,34 @@ const readFromDir = async (mcr, dir) => {
     }
 
     const files = fs.readdirSync(dir);
-    const list = [];
+
+    const coverageList = [];
+    const sourceList = [];
+
     files.forEach((filename) => {
-        if (filename.startsWith('coverage-')) {
-            list.push({
-                type: 'coverage',
-                filename
-            });
-            return;
-        }
-        if (filename.startsWith('source-')) {
-            list.push({
-                type: 'source',
-                filename
-            });
+        // read all json files
+        if (filename.endsWith('.json')) {
+            // could be source files generated by register hooks
+            if (filename.startsWith('source-')) {
+                sourceList.push(filename);
+            } else {
+                coverageList.push(filename);
+            }
         }
     });
 
-    if (!list.length) {
+    if (!coverageList.length) {
         Util.logInfo(`No coverage files in the dir: ${dir}`);
         return;
     }
 
-    const contentList = await Promise.all(list.map((it) => Util.readFile(path.resolve(dir, it.filename))));
-    const sourceCache = {};
-    const coverageFiles = [];
-
-    contentList.forEach((content, i) => {
-        if (!content) {
-            return;
-        }
-        const json = JSON.parse(content);
-        if (!json) {
-            return;
-        }
-        const item = list[i];
-        if (item.type === 'source') {
-            if (json.url) {
-                sourceCache[json.url] = json;
-            }
-        } else {
-            item.json = json;
-            coverageFiles.push(item);
-        }
-    });
+    const sourceCache = await readSourceList(dir, sourceList);
 
     const entryFilter = mcr.getEntryFilter();
 
     const results = [];
-    for (const item of coverageFiles) {
-        const coverageData = readCoverageData(item, entryFilter, sourceCache);
+    for (const filename of coverageList) {
+        const coverageData = await readCoverageData(dir, filename, entryFilter, sourceCache);
         if (coverageData) {
             const res = await mcr.add(coverageData);
             results.push(res);

package/lib/index.d.ts

@@ -107,6 +107,9 @@ declare namespace MCR {
         ['codecov'] | ["codecov", {
             outputFile?: string;
         }] |
+        ['codacy'] | ["codacy", {
+            outputFile?: string;
+        }] |
         ['console-summary'] | ['console-summary', {
             metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
         }] |
@@ -190,7 +193,7 @@ declare namespace MCR {
             branches?: CoverageRange[];
             functions?: CoverageRange[];
             ignores?: IgnoredRange[];
-            /** codecov json format */
+            /** common json format */
             lines: {
                 [key: string]: number | string;
             };

package/lib/index.js

@@ -141,6 +141,9 @@ class CoverageReport {
             return;
         }
 
+        // GC, no OOM
+        this.fileCache.clear();
+
         const { dataList, sourceCache } = inputData;
 
         // empty output dir except cache dir before generate reports
@@ -161,16 +164,21 @@ class CoverageReport {
 
         const coverageResults = await generateCoverageReports(dataList, sourceCache, this.options);
 
-        if (this.logging !== 'debug') {
-            Util.rmSync(this.options.cacheDir);
-        }
-
         const onEnd = this.options.onEnd;
         if (typeof onEnd === 'function') {
             await onEnd.call(this, coverageResults);
         }
 
-        Util.logTime(`generated coverage reports: ${EC.cyan(coverageResults.reportPath)}`, time_start);
+        // remove cache dir after finished
+        if (!Util.isDebug()) {
+            Util.rmSync(this.options.cacheDir);
+        }
+
+        let reportPath = '';
+        if (coverageResults.reportPath) {
+            reportPath = EC.cyan(coverageResults.reportPath);
+        }
+        Util.logTime(`generated coverage reports: ${reportPath}`, time_start);
 
         return coverageResults;
     }