fix(coverage): `vite-node` to pass correct execution wrapper offset #7417

AriPerkkio · 2025-02-04T10:56:15Z

Description

Fixes Incorrect coverage in web workers with @vitest/web-worker and @vitest/coverage-v8 #7379
Proper fix for TypeError: Cannot read properties of undefined (reading 'endCol') #6297

Makes vite-node to hold info about the execution wrapper it uses when executing modules. Coverage providers are passed this info on the test runner thread so that they can attach it into the coverage results. There's no longer need to hard-code the wrapper length on main thread codebase. The example web-worker.test.ts has a case where in a single test runner thread some code is executed with 185 long wrapper and some with ~430 long wrapper.

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:.

netlify · 2025-02-04T10:58:38Z

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`89102c3`
🔍 Latest deploy log	https://app.netlify.com/sites/vitest-dev/deploys/67ac6c5dc5f70e000834fac7
😎 Deploy Preview	https://deploy-preview-7417--vitest-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

packages/coverage-v8/src/provider.ts

packages/vite-node/src/types.ts

hi-ogawa

Makes sense to me 👍
I'm wondering what happens if the same file is imported from test and from @vitest/web-worker. Does startOffset conflict (last loaded win?) and so coverage is likely broken?

packages/coverage-v8/src/index.ts

test/coverage-test/test/web-worker.test.ts

AriPerkkio · 2025-02-07T06:25:34Z

Makes sense to me 👍 I'm wondering what happens if the same file is imported from test and from @vitest/web-worker. Does startOffset conflict (last loaded win?) and so coverage is likely broken?

Yep, coverage could break then. Also V8 gets confused as the same file ID had different contents when executed. The script coverage is a mess then.

sheremet-va · 2025-02-07T15:31:48Z

Do we need to update vitest's package.json's peerDependencies? Is it technically a breaking change?

packages/vitest/src/runtime/execute.ts

packages/vitest/src/node/types/coverage.ts

packages/vite-node/src/types.ts

AriPerkkio · 2025-02-07T15:41:18Z

Do we need to update vitest's package.json's peerDependencies? Is it technically a breaking change?

Which package here?

vitest/packages/vitest/package.json

Lines 124 to 132 in 12eaf3e

    
           "peerDependencies": { 
        
             "@edge-runtime/vm": "*", 
        
             "@types/debug": "^4.1.12", 
        
             "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", 
        
             "@vitest/browser": "workspace:*", 
        
             "@vitest/ui": "workspace:*", 
        
             "happy-dom": "*", 
        
             "jsdom": "*" 
        
           },

Or you mean about using mixed versions? A year ago (#5208) we made the decision that Vitest monorepo's packages do not work with mixed versions. All packages must have the same version. And we've been introducing breaking changes between the packages ever since. There are also runtime warnings in @vitest/browser, @vitest/ui and coverage packages about mixed versions.

test/core/test/web-worker-node.test.ts

@hi-ogawa

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@vitest/coverage-v8](https://github.com/vitest-dev/vitest/tree/main/packages/coverage-v8#readme) ([source](https://github.com/vitest-dev/vitest/tree/HEAD/packages/coverage-v8)) | devDependencies | patch | [`3.0.5` -> `3.0.7`](https://renovatebot.com/diffs/npm/@vitest%2fcoverage-v8/3.0.5/3.0.7) | | [vitest](https://github.com/vitest-dev/vitest) ([source](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest)) | devDependencies | patch | [`3.0.5` -> `3.0.7`](https://renovatebot.com/diffs/npm/vitest/3.0.5/3.0.7) | --- ### Release Notes <details> <summary>vitest-dev/vitest (@vitest/coverage-v8)</summary> ### [`v3.0.7`](https://github.com/vitest-dev/vitest/releases/tag/v3.0.7) [Compare Source](vitest-dev/vitest@v3.0.6...v3.0.7) ##### 🐞 Bug Fixes - **browser**: Support webdriverio 9 - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#7553 [<samp>(b1949)</samp>](vitest-dev/vitest@b1949c97) - **deps**: Update all non-major dependencies - in vitest-dev/vitest#7543 [<samp>(365ff)</samp>](vitest-dev/vitest@365ffe6b) - **expect**: Correct generic MatchersObject this type in expect.extend - by [@Workingstiff-s](https://github.com/Workingstiff-s) in vitest-dev/vitest#7526 [<samp>(d5765)</samp>](vitest-dev/vitest@d5765f71) - **mocker**: Include more modules to prefix-only module list - by [@btea](https://github.com/btea) in vitest-dev/vitest#7524 [<samp>(a12ec)</samp>](vitest-dev/vitest@a12ec008) - **spy**: Clear/reset/restore mocks in stack order - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7499 [<samp>(f7100)</samp>](vitest-dev/vitest@f71004ff) ##### 🏎 Performance - **browser**: Do wdio context switching only once per file - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#7549 [<samp>(aaa58)</samp>](vitest-dev/vitest@aaa58556) ##### [View changes on GitHub](vitest-dev/vitest@v3.0.6...v3.0.7) ### [`v3.0.6`](https://github.com/vitest-dev/vitest/releases/tag/v3.0.6) [Compare Source](vitest-dev/vitest@v3.0.5...v3.0.6) ##### 🐞 Bug Fixes - Fix `getMockedSystemTime` for `useFakeTimer` - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7405 [<samp>(03912)</samp>](vitest-dev/vitest@03912b43) - Compat for jest-image-snapshot - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7390 [<samp>(9542b)</samp>](vitest-dev/vitest@9542b699) - Ensure project names are readable in dark terminals - by [@rgrove](https://github.com/rgrove) in vitest-dev/vitest#7371 [<samp>(bb94c)</samp>](vitest-dev/vitest@bb94c19f) - Exclude `queueMicrotask` from default fake timers to not break node fetch - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7505 [<samp>(167a9)</samp>](vitest-dev/vitest@167a98d7) - **browser**: - Fix mocking modules out of root - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7415 [<samp>(d3acb)</samp>](vitest-dev/vitest@d3acbd8b) - Fix `toHaveClass` typing - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7383 [<samp>(7ef23)</samp>](vitest-dev/vitest@7ef238c0) - Relax locator selectors methods - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#7422 [<samp>(1b8c5)</samp>](vitest-dev/vitest@1b8c5c9e) - Resolve thread count from `maxWorkers` - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#7483 [<samp>(adbb2)</samp>](vitest-dev/vitest@adbb25ab) - Cleanup timeout on resolve and give more information in the error - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#7487 [<samp>(5a45a)</samp>](vitest-dev/vitest@5a45a7ca) - **coverage**: - `vite-node` to pass correct execution wrapper offset - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#7417 [<samp>(1f2e5)</samp>](vitest-dev/vitest@1f2e5552) - Preserve moduleExecutionInfo in non-isolated runs - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#7486 [<samp>(f31a0)</samp>](vitest-dev/vitest@f31a07bb) - **deps**: - Update all non-major dependencies - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7363 [<samp>(e348b)</samp>](vitest-dev/vitest@e348bd4c) - Update all non-major dependencies - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7507 [<samp>(6cc40)</samp>](vitest-dev/vitest@6cc408d6) - **init**: - Invalid browser config - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#7475 [<samp>(8fe64)</samp>](vitest-dev/vitest@8fe641b4) - **reporters**: - Render tasks in tree when in TTY - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#7503 [<samp>(027ce)</samp>](vitest-dev/vitest@027ce9bb) - **vite-node**: - Remove fake first line mapping on Vite 6 - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#7124 [<samp>(b9973)</samp>](vitest-dev/vitest@b997355b) - **watch**: - Properly remove cache after removing existing test files - by [@soc221b](https://github.com/soc221b) in vitest-dev/vitest#7399 [<samp>(01a59)</samp>](vitest-dev/vitest@01a59721) - **workspace**: - Forward `inspect` related cli options - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#7373 [<samp>(ed15b)</samp>](vitest-dev/vitest@ed15b5b3) ##### [View changes on GitHub](vitest-dev/vitest@v3.0.5...v3.0.6) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.justinelmore.dev/jelmore1674/build-changelog/pulls/91 Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

AriPerkkio force-pushed the fix/coverage-web-worker-v8 branch from 954d2a1 to 0f3f4f5 Compare February 4, 2025 14:35

AriPerkkio changed the title ~~fix(coverage): @vitest/web-worker with v8 coverage~~ fix(coverage): vite-node to pass correct execution wrapper offset Feb 6, 2025

AriPerkkio force-pushed the fix/coverage-web-worker-v8 branch 2 times, most recently from e7a39cc to 4e458b0 Compare February 6, 2025 15:21

AriPerkkio mentioned this pull request Feb 6, 2025

TypeError: Cannot read properties of undefined (reading 'endCol') #6297

Closed

6 tasks

AriPerkkio commented Feb 6, 2025

View reviewed changes

packages/coverage-v8/src/provider.ts Show resolved Hide resolved

AriPerkkio force-pushed the fix/coverage-web-worker-v8 branch from 4e458b0 to 008b10d Compare February 6, 2025 15:36

AriPerkkio marked this pull request as ready for review February 6, 2025 15:36

AriPerkkio commented Feb 6, 2025

View reviewed changes

packages/vite-node/src/types.ts Show resolved Hide resolved

AriPerkkio requested review from hi-ogawa and sheremet-va and removed request for hi-ogawa February 6, 2025 15:40

hi-ogawa previously approved these changes Feb 7, 2025

View reviewed changes

packages/coverage-v8/src/index.ts Outdated Show resolved Hide resolved

hi-ogawa reviewed Feb 7, 2025

View reviewed changes

test/coverage-test/test/web-worker.test.ts Show resolved Hide resolved

AriPerkkio dismissed hi-ogawa’s stale review via 0e40759 February 7, 2025 07:39

sheremet-va requested changes Feb 7, 2025

View reviewed changes

packages/vitest/src/runtime/execute.ts Show resolved Hide resolved

packages/vitest/src/node/types/coverage.ts Outdated Show resolved Hide resolved

packages/vite-node/src/types.ts Show resolved Hide resolved

AriPerkkio force-pushed the fix/coverage-web-worker-v8 branch 2 times, most recently from e5fa58a to 89102c3 Compare February 12, 2025 09:39

sheremet-va reviewed Feb 12, 2025

View reviewed changes

test/core/test/web-worker-node.test.ts Outdated Show resolved Hide resolved

AriPerkkio added 3 commits February 13, 2025 12:51

test: failing test for vitest-dev#7379

27b97c8

fix(vite-node): hold info about vm context wrapper offset

e5ccef3

fix(coverage): v8 to use vm context offset from vite-node

20a348b

AriPerkkio force-pushed the fix/coverage-web-worker-v8 branch from 8c9f3f8 to 20a348b Compare February 13, 2025 10:53

AriPerkkio requested a review from sheremet-va February 13, 2025 11:37

sheremet-va approved these changes Feb 13, 2025

View reviewed changes

AriPerkkio merged commit 1f2e555 into vitest-dev:main Feb 13, 2025
13 checks passed

AriPerkkio deleted the fix/coverage-web-worker-v8 branch February 13, 2025 15:13

AriPerkkio mentioned this pull request Feb 13, 2025

fix(coverage): preserve moduleExecutionInfo in non-isolated runs #7486

Merged

6 tasks

renovate bot mentioned this pull request Feb 26, 2025

chore(deps): update all non-major dependencies sxzz/stale-dep#66

Merged

1 task

renovate bot mentioned this pull request May 10, 2025

fix(deps): update all dependencies un-ts/cf-cleaner#64

Open

1 task

renovate bot mentioned this pull request Jul 23, 2025

fix(deps): update all non-major dependencies with stable version (patch) Kong/public-ui-components#1774

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(coverage): `vite-node` to pass correct execution wrapper offset #7417

fix(coverage): `vite-node` to pass correct execution wrapper offset #7417

Uh oh!

AriPerkkio commented Feb 4, 2025 •

edited

Loading

Uh oh!

netlify bot commented Feb 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

hi-ogawa left a comment

Uh oh!

Uh oh!

Uh oh!

AriPerkkio commented Feb 7, 2025

Uh oh!

sheremet-va commented Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AriPerkkio commented Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

fix(coverage): vite-node to pass correct execution wrapper offset #7417

fix(coverage): vite-node to pass correct execution wrapper offset #7417

Uh oh!

Conversation

AriPerkkio commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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

Tests

Documentation

Changesets

Uh oh!

netlify bot commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vitest-dev ready!

Uh oh!

Uh oh!

Uh oh!

hi-ogawa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AriPerkkio commented Feb 7, 2025

Uh oh!

sheremet-va commented Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AriPerkkio commented Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fix(coverage): `vite-node` to pass correct execution wrapper offset #7417

fix(coverage): `vite-node` to pass correct execution wrapper offset #7417

AriPerkkio commented Feb 4, 2025 •

edited

Loading

netlify bot commented Feb 4, 2025 •

edited

Loading