nodejs / nodejs/node

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

Aperta
#61,586 11 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

stale test_runner
Lingua principale
JavaScript
Stelle
122k
Fork
37.3k
Merge medio
4g 2h
PR unite (30g)
283

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con il repository di riproduzione minima ed esegui i relativi comandi nativi di coverage e di coverage di c8 per confrontare coverage/lcov-native.info con coverage/lcov.info. Traccia la gestione della coverage e di lcov da parte di test_runner per il commento di ignore di example.js e il caso test/example.test.js. Il lavoro è completato quando il branch ignorato non produce più una voce BRDA non coperta e la branch coverage riporta 100%.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
testing-qa
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.