nodejs / nodejs/node

test_runner: node:coverage ignore comments exclude DA but leave BRDA in lcov output

オープン
#61,586 コメント 11 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

stale test_runner
主要言語
JavaScript
スター
122k
フォーク
37.3k
平均マージ
4日 2時間
マージ済み PR(30日)
283

説明

Version

v24.13.0

Platform

Darwin 24.6.0 (macOS)

Subsystem

test_runner

What steps will reproduce the bug?
  1. Create a file with a branch and /* node:coverage ignore next */ comment:
// src/example.js
function getValue(condition) {
  if (condition) {
    return 'truthy';
  }
  /* node:coverage ignore next */
  return 'falsy';
}

module.exports = { getValue };
  1. Create a test that only covers the truthy branch:
// test/example.test.js
const { describe, it } = require('node:test');
const assert = require('node:assert');
const { getValue } = require('../src/example.js');

describe('getValue', () => {
  it('should return truthy when condition is true', () => {
    assert.strictEqual(getValue(true), 'truthy');
  });
});
  1. Run with coverage:
node --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info --test test/example.test.js
  1. Examine the generated lcov.info
How often does it reproduce? Is there a required condition?

Always reproducible.

What is the expected behavior? Why is that the expected behavior?

The /* node:coverage ignore next */ comment should exclude both:

  • The DA (line coverage) entry for the ignored line
  • The BRDA (branch coverage) entry for the branch leading to the ignored code

This is the expected behavior because:

  1. The purpose of ignore comments is to exclude code from coverage calculations
  2. c8 (which also uses V8 coverage) correctly handles this by marking both DA and BRDA as covered for ignored lines
What do you see instead?
  • DA: Line 6 (return 'falsy';) is correctly excluded from the lcov output
  • BRDA: Branch entry remains as uncovered: BRDA:4,2,0,0
BRDA:1,0,0,1
BRDA:1,1,0,1
BRDA:4,2,0,0    <-- This branch should be excluded but remains as uncovered
BRF:3
BRH:2           <-- Only 2 of 3 branches hit (66.67%)
DA:1,1
DA:2,1
DA:3,1
DA:4,1
DA:5,0
DA:7,1          <-- DA:6 is missing (correctly excluded)
...

This causes branch coverage to report 66.67% instead of 100%, which impacts CI/CD pipelines that enforce branch coverage thresholds.

Additional information

Comparison with c8:

Using c8 with /* c8 ignore next */ on the same code structure produces the correct result:

DA:5,1          # Line marked as covered (ignored)
DA:6,1          # Line marked as covered (ignored)
BRDA:5,2,0,1    # Branch marked as covered (ignored)
BRF:3
BRH:3           # All 3 branches "hit" (100%)

Minimal reproduction repository:

https://github.com/tobigumo/node-coverage-brda-bug

git clone https://github.com/tobigumo/node-coverage-brda-bug.git
cd node-coverage-brda-bug
npm install
npm run test
# Compare coverage/lcov-native.info (Node.js native - has bug) with coverage/lcov.info (c8 - correct)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

最小再現リポジトリから始め、そのネイティブの coverage コマンドと c8 の coverage コマンドを実行して、coverage/lcov-native.info と coverage/lcov.info を比較します。example.js の ignore コメントと test/example.test.js のケースについて、test_runner の coverage および lcov の処理を追跡します。無視されたブランチが未カバーの BRDA エントリを生成しなくなり、ブランチカバレッジが 100% と報告されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
testing-qa
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
68/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。