Skip to content

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

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

Closed
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions packages/coverage-v8/src/provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import v8ToIstanbul from 'v8-to-istanbul'
import { cleanUrl } from 'vite-node/utils'

import { BaseCoverageProvider } from 'vitest/coverage'
import { offsetToPosition, originalPositionFor, TraceMap } from 'vitest/utils'
import { version } from '../package.json' with { type: 'json' }

type TransformResults = Map<string, FetchResult>
Expand Down Expand Up @@ -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
Contributor Author

@hi-ogawa hi-ogawa Jan 13, 2025

Choose a reason for hiding this comment

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

Right, I think it's worth reporting on istanbul side and it would also help isolating the issue properly. istanbul-lib-source-maps probably has a similar issue with functions overlapped in a single line (one with source map and other without), so I'll try the repro for that too.

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?

What do you mean by conflicting? In current Vitest, VITE_EXPORTS_LINE_PATTERN seems to have no effect on coverage as I tested in #7132. Also the issue #7130, which is fixed by this PR, happens on user land plugin doing a similar injection and not only caused by new SSR transform.

Copy link
Member

Choose a reason for hiding this comment

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

What do you mean by conflicting?

When using "vite": "https://pkg.pr.new/vite@18983" with this PR, I get:

Statements   : 100% ( 2/2 )
Branches     : 100% ( 0/0 )
Functions    : 100% ( 0/0 )
Lines        : 100% ( 2/2 )

And when removing the VITE_EXPORTS_LINE_PATTERN in the same setup, I get correct results:

Statements   : 100% ( 3/3 )
Branches     : 100% ( 1/1 )
Functions    : 100% ( 1/1 )
Lines        : 100% ( 3/3 )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, that's not what I expected and I haven't actually tested it 😅 I need to debug this thing again. Thanks for checking 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, okay, I remembered this one. Currently it's dropping an entire Object.defineProperty(__vite_ssr_exports__ line which includes original function sum, so this PR alone doesn't fix vitejs/vite#18983.

I'm not sure what's the good way to proceed. From what I understand, VITE_EXPORTS_LINE_PATTERN is not necessary, so we can apply #7132 anytime. What kind of compatibility check needed there?

Copy link
Member

Choose a reason for hiding this comment

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

From what I understand, VITE_EXPORTS_LINE_PATTERN is not necessary

Before this PR it used to be necessary. See here how end of line 4 is included in sourcemaps: https://evanw.github.io/source-map-visualization/#NTY5AGZ1bmN0aW.... That's from main branch. When I remove the VITE_EXPORTS_LINE_PATTERN in main, the function count incorrectly raises to 2.

What kind of compatibility check needed there?

So for vite@18983 we need to remove VITE_EXPORTS_LINE_PATTERN like shown in #7192 (comment).
And once VITE_EXPORTS_LINE_PATTERN is removed, we need to make sure older Vite versions like 5 still keep working as expected.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, I just noticed #7132 first commit passed CI, then 2nd one failed. Sorry, I didn't even look at that. That's another thing unexpected.

// for example, "export getter" injected by Vite ssr transform.
// https://github.com/vitest-dev/vitest/issues/7130
if (sources.isExecuted && sources.sourceMap) {
const traceMap = new TraceMap(sources.sourceMap.sourcemap)
functions = functions.filter((f) => {
if (f.ranges.length === 1) {
const start = f.ranges[0].startOffset - wrapperLength
const end = f.ranges[0].endOffset - wrapperLength - 1
if ([start, end].every(offset => offset >= 0 && offset < sources.source.length)) {
const startPos = offsetToPosition(sources.source, start)
const endPos = offsetToPosition(sources.source, end)
const startSourcePos = originalPositionFor(traceMap, startPos)
const endSourcePos = originalPositionFor(traceMap, endPos)
if (startSourcePos.line === null && endSourcePos.line === null) {
return false
}
}
}
return true
})
}

const converter = v8ToIstanbul(
url,
wrapperLength,
Expand Down
1 change: 1 addition & 0 deletions packages/utils/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export { nanoid } from './nanoid'
export {
lineSplitRE,
offsetToLineNumber,
offsetToPosition,
positionToOffset,
} from './offset'
export { shuffle } from './random'
Expand Down
11 changes: 10 additions & 1 deletion packages/utils/src/offset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ export function positionToOffset(
}

export function offsetToLineNumber(source: string, offset: number): number {
return offsetToPosition(source, offset).line
}

export function offsetToPosition(
source: string,
offset: number,
): { line: number; column: number } {
if (offset > source.length) {
throw new Error(
`offset is longer than source length! offset ${offset} > length ${source.length}`,
Expand All @@ -30,13 +37,15 @@ export function offsetToLineNumber(source: string, offset: number): number {
const nl = /\r\n/.test(source) ? 2 : 1
let counted = 0
let line = 0
let column = 0
for (; line < lines.length; line++) {
const lineLength = lines[line].length + nl
if (counted + lineLength >= offset) {
column = offset - counted
break
}

counted += lineLength
}
return line + 1
return { line: line + 1, column }
}
1 change: 1 addition & 0 deletions packages/vitest/src/utils/source-map.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export {
lineSplitRE,
offsetToLineNumber,
offsetToPosition,
positionToOffset,
} from '@vitest/utils'
export {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import MagicString from 'magic-string'
import { defineConfig } from 'vitest/config'

export default defineConfig({
plugins: [
{
name: 'repro',
transform(code, id, _options) {
if (id.endsWith('injected-functions.ts')) {
const output = new MagicString(code)
output.prepend(`;function prepended(){};`)
output.append(`;function appended(){};`)
return {
code: output.toString(),
map: output.generateMap({ hires: 'boundary' }),
}
}
},
},
],
})
4 changes: 4 additions & 0 deletions test/coverage-test/fixtures/src/injected-functions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
function original() {
console.log("hello")
}
original()
4 changes: 4 additions & 0 deletions test/coverage-test/fixtures/test/injected-functions.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { test } from 'vitest'
import "../src/injected-functions";

test('basic', () => {})
81 changes: 81 additions & 0 deletions test/coverage-test/test/injected-functions.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
import { expect } from 'vitest'
import { isV8Provider, readCoverageMap, runVitest, test } from '../utils'

test('filter out functions injected by plugin', async () => {
const { stderr } = await runVitest({
include: ['fixtures/test/injected-functions.test.ts'],
coverage: {
reporter: ['json', 'html'],
include: ['fixtures/src/injected-functions.ts'],
},
config: 'fixtures/configs/vitest.config.injected-functions.ts',
})
expect(stderr).toBe('')

const coverageMap = await readCoverageMap()
const fileCoverage = coverageMap.fileCoverageFor('<process-cwd>/fixtures/src/injected-functions.ts')
if (isV8Provider()) {
expect(fileCoverage.fnMap).toMatchInlineSnapshot(`
{
"0": {
"decl": {
"end": {
"column": 1,
"line": 3,
},
"start": {
"column": 0,
"line": 1,
},
},
"line": 1,
"loc": {
"end": {
"column": 1,
"line": 3,
},
"start": {
"column": 0,
"line": 1,
},
},
"name": "original",
},
}
`)
}
else {
expect(fileCoverage.fnMap).toMatchInlineSnapshot(`
{
"0": {
"decl": {
"end": {
"column": 20,
"line": 1,
},
"start": {
"column": 9,
"line": 1,
},
},
"loc": {
"end": {
"column": null,
"line": 3,
},
"start": {
"column": 20,
"line": 1,
},
},
"name": "original",
},
}
`)
}
expect(fileCoverage.f).toMatchInlineSnapshot(`
{
"0": 1,
}
`)
})
Loading