feat(learn): Collecting code coverage

[avivkeller]

Description

This PR introduces a learning article on collecting code coverage in Node.js. However, it should not be merged until support for thresholds is included in the next semver-minor release, which is expected to be next week.

Related Issues

Support for code coverage: nodejs/node#46017
Support for code coverage inclusion/exclusion: nodejs/node#53553
Support for code coverage thresholds: nodejs/node#54429

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run npm run format to ensure the code follows the style guide.
• I have run npm run test to check if all tests are passing.
• I have run npx turbo build to check if the website builds without errors.
• [N/A] I've covered new added functionality with unit tests if necessary.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nodejs-org	✅ Ready (Inspect)	Visit Preview	Sep 26, 2024 5:03pm

[avivkeller]

This is currently marked as draft until the next semver-minor release of Node.js

[avivkeller]

https://nodejs-org-git-fork-redyetidev-code-coverage-learn-openjs.vercel.app/en/learn/test-runner/collecting-code-coverage

[AugustinMauroy]

This is my first feedback, I think the introduction should be improved to put it in context. It should be remembered that the learn section is intended for non-experts.

[vercel]

Deployment failed with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

[AugustinMauroy]

LGTM !

[mikeesto]

Thanks for writing this, reads well

[avivkeller]

I've undrafted this, as the release proposal for v22.8.0 is ready at nodejs/node#54560, but it still shouldn't land until that does.

The expected release date is 2024-08-26 2024-09-02

[github-actions]

Unit Test Coverage Report

Lines	Statements	Branches	Functions
	90.54% (594/656)	76.29% (177/232)	94.57% (122/129)

Unit Test Report

Tests	Skipped	Failures	Errors	Time
131	0 💤	0 ❌	0 🔥	6.027s ⏱️

[bmuenzenmeyer]

this is great - looking forward to it

[AugustinMauroy]

Can we have last review form @nodejs/test_runner

[mcollina]

This is amazing. However I'm not sure we should be landing this before having stabilized the code coverage functionality.

[mcollina]

This is amazing. However I'm not sure we should be landing this before having stabilized the code coverage functionality.

[avivkeller]

I think this is okay to land once v22.8.0 releases, as it specifies that the --experimental-code-coverage command is needed, indicating that it is experimental. Would you like me to add a notice at the beginning that this is experimental, or just hold off until it's stabilized?

[mcollina]

I think it's better to hold off until it's stable.

[ovflowd]

Is there an ETA for the stabilization of it?

[avivkeller]

IMO code coverage (w/o the --enable-source-maps flag) is pretty stable. I haven't seen many bugs with it in a while.

I asked a few weeks ago, and it was pointed out that statement coverage isn't supported, however, I'm not sure if that's in the plans for the immediate future of code coverage.

The original issue tracking the stability has been closed as completed, as all tasks were completed, which might mean it's ready to be stable. I've left a comment asking.

[ovflowd]

I'm fine keeping this open for the meantime, the problem is it becoming stale.

[avivkeller]

I'm also happy to close and reopen it, as chances are there will be some significant changes to the coverage reporter before stabilization, and this only collecting merge conflicts.