Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(coverage): exclude injected functions without mapping #7192

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

hi-ogawa
Copy link
Contributor

@hi-ogawa hi-ogawa commented Jan 8, 2025

Description

This PR filters v8 functions coverage on Vitest side. The idea sounds similar to istanbuljs/v8-to-istanbul#244, but this seems necessary to properly exclude coverage of injected functions at the same line as the original code as seen in the reproduction.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@hi-ogawa hi-ogawa marked this pull request as ready for review January 8, 2025 10:08
@@ -349,6 +350,29 @@ export class V8CoverageProvider extends BaseCoverageProvider<ResolvedCoverageOpt
// If file was executed by vite-node we'll need to add its wrapper
const wrapperLength = sources.isExecuted ? WRAPPER_LENGTH : 0

// filter out functions without mappings,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All code that is not present on source maps should already be excluded from final coverage report. Bundlers tend to inject plenty of helpers, generators and polyfills that are not present on source maps - these should be automatically be excluded.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All code that is not present on source maps should already be excluded from final coverage report.

Was it the case even before having this patch #5457? I agree that should be the expected behavior of v8-to-istanbul in any cases, but there's still an edge case even after the patch when the injected code's line overlaps with original code as in the reproduction #7130 (comment):

// source
console.log("x");

// generated  ("prepended" doesn't get excluded from coverage)
function prepended(){};console.log("x");
function appended(){};

Also it turned out this is also the case for istanbul provider too as seen in the new snapshot test/coverage-test/test/injected-functions.test.ts, which is not fixed in this PR and haven't investigated yet.

This looks to me a bug, which is fixable either Vitest side or v8-to-istanbul eventually. I'm wondering how you see this issue in general. We want to land ssr transform fix vitejs/vite#18983, which can cause this edge case more often, so I would like to know your opinions on whether it's fine to land or wait until we get a better understanding of the issue.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some manual testing with this and see now why this work-around is required. To me this looks like a bug in v8-to-istanbul. Ideally we should file a bug report there with minimal repro and PR later on. Or even better, not use v8-to-istanbul at all and roll our own V8 coverage processing.

The #5457 is only about line coverage and does not affect function coverage at all. The v8-to-istanbul has some special handing for line coverage that is not done for function coverage.

I see that VITE_EXPORTS_LINE_PATTERN is now conflicting when using Vite version from the PR. Can we remove that and be backwards compatible?

Copy link

netlify bot commented Jan 8, 2025

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f5c0d9d
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/677f0a5e87a7620008328a8e
😎 Deploy Preview https://deploy-preview-7192--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing function coverage when transform prepends code right before the function
2 participants