feat(browser): support v8 coverage #6273

AriPerkkio · 2024-08-04T07:13:45Z

Description

Adds support for using V8 coverage in Browser mode
Works only on Playwright + Chromium at the moment. We can later extend support for other providers and chromium based browsers.

import { defineConfig } from "vitest/config";

export default defineConfig({
  test: {
    coverage: {
      provider: "v8",
    },
    browser: {
      provider: "playwright",
      name: "chromium",
    },
  },
});

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 · 2024-08-04T07:16:10Z

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`dd21cf9`
🔍 Latest deploy log	https://app.netlify.com/sites/vitest-dev/deploys/66b9f7df8bcfc80008c2a560
😎 Deploy Preview	https://deploy-preview-6273--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.

test/coverage-test/vitest.workspace.custom.ts

packages/vitest/src/node/config/resolveConfig.ts

packages/coverage-v8/src/browser.ts

packages/coverage-v8/src/provider.ts

packages/coverage-v8/src/browser.ts

packages/coverage-v8/src/provider.ts

…omium

@sheremet-va

##### [v2.1.0](https://github.com/vitest-dev/vitest/releases/tag/v2.1.0) This release makes another big change to the Browser Mode by introducing [locators API](https://vitest.dev/guide/browser/locators.html): ```ts test('renders blog posts', async () => { const screen = page.render(<Blog />) await expect.element(screen.getByRole('heading', { name: 'Blog' })).toBeInTheDocument() const [firstPost] = screen.getByRole('listitem').all() await firstPost.getByRole('button', { name: 'Delete' }).click() expect(screen.getByRole('listitem').all()).toHaveLength(3) }) ``` You can use either [vitest-browser-vue](https://github.com/vitest-dev/vitest-browser-vue), [vitest-browser-svelte ](https://github.com/vitest-dev/vitest-browser-svelte) or [vitest-browser-react](https://github.com/vitest-dev/vitest-browser-react) to render components and make assertions using locators. Locators are also available on the `page` object from `@vitest/browser/context`. ##### 🚀 Features - **api**: - Make spec into a class instead of a tuple - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6355 [<samp>(874a1)</samp>](vitest-dev/vitest@874a121e) - **browser**: - Move page.config to server.config, add more docs - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6252 [<samp>(af2b8)</samp>](vitest-dev/vitest@af2b813c) - Make iframe scalable, improve documentation - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6257 [<samp>(74ca1)</samp>](vitest-dev/vitest@74ca11a4) - Introduce built-in locators - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6084 [<samp>(3347f)</samp>](vitest-dev/vitest@3347f83e) - Support v8 coverage - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6273 [<samp>(34199)</samp>](vitest-dev/vitest@34199bdf) - Support `userEvent.upload` in playwright provider - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6442 [<samp>(cf148)</samp>](vitest-dev/vitest@cf148645) - Support `--inspect` - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6433 [<samp>(0499a)</samp>](vitest-dev/vitest@0499a315) - Support `--inspect-brk` - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6434 [<samp>(7ab0f)</samp>](vitest-dev/vitest@7ab0f4a8) - **cli**: - Extend existing list command to output only a list of file names - by [@Ma-hawaj](https://github.com/Ma-hawaj) and [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6392 [<samp>(008f0)</samp>](vitest-dev/vitest@008f00b2) - **coverage**: - Add `--exclude-after-remap` - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6309 [<samp>(5932a)</samp>](vitest-dev/vitest@5932a7f9) - **mocker**: - Introduce [@vitest/mocker](https://github.com/vitest/mocker) package, allow `{ spy: true }` instead of a factory - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6289 [<samp>(95f02)</samp>](vitest-dev/vitest@95f0203f) - **vitest**: - Add "provide" option - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6253 [<samp>(4409d)</samp>](vitest-dev/vitest@4409d779) - Add return type and promisable mockFactory - by [@syi0808](https://github.com/syi0808) and [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6139 [<samp>(f5e0b)</samp>](vitest-dev/vitest@f5e0b987) - Add `vi.advanceTimersToNextFrame` - by [@bnjm](https://github.com/bnjm) and [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6347 [<samp>(8ff63)</samp>](vitest-dev/vitest@8ff63560) - Allow env to be stubbed to undefined - by [@JSanchezIO](https://github.com/JSanchezIO) and [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6359 [<samp>(c3b27)</samp>](vitest-dev/vitest@c3b2757c) ##### 🐞 Bug Fixes - Correctly resolve nested mocks with `index` file - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6266 [<samp>(081cf)</samp>](vitest-dev/vitest@081cfe03) - Don't panic when coverage.reporter is a string - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6267 [<samp>(7b37d)</samp>](vitest-dev/vitest@7b37d27b) - Align RawMatcherFn type definition with Jest - by [@wheresrhys](https://github.com/wheresrhys) in vitest-dev/vitest#6351 [<samp>(d09f0)</samp>](vitest-dev/vitest@d09f00c7) - Cjs build of vite node server - by [@AkaraChen](https://github.com/AkaraChen) in vitest-dev/vitest#6389 [<samp>(12e70)</samp>](vitest-dev/vitest@12e702bd) - Allow inlining vite's cached dependencies - by [@chriswheeldon-peakon](https://github.com/chriswheeldon-peakon) in vitest-dev/vitest#6284 [<samp>(03208)</samp>](vitest-dev/vitest@03208017) - Print unexpected error message if peer dependencies have a different version - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6446 [<samp>(b992b)</samp>](vitest-dev/vitest@b992b346) - Ignore importer when resolving Vitest - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6469 [<samp>(0b447)</samp>](vitest-dev/vitest@0b447226) - `expect.getState().testPath` always returns correct path - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6472 [<samp>(ac698)</samp>](vitest-dev/vitest@ac698b1c) - UserEvent works consistently between providers - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6480 [<samp>(0b4da)</samp>](vitest-dev/vitest@0b4da69e) - **browser**: - Print correct stack trace for unhandled errors - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6134 [<samp>(1da6c)</samp>](vitest-dev/vitest@1da6cebe) - Use documentElement as the root for selector - by [@sheremet-va](https://github.com/sheremet-va) [<samp>(d8077)</samp>](vitest-dev/vitest@d807767f) - Keep querying elements even if locator is created with elementLocator, add pubic @vitest/browser/utils - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6296 [<samp>(30dc5)</samp>](vitest-dev/vitest@30dc5793) - Produce valid config file if preview provider is used - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6305 [<samp>(7f0ae)</samp>](vitest-dev/vitest@7f0ae292) - Correctly run in-source tests in the browser - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6440 [<samp>(c8531)</samp>](vitest-dev/vitest@c853126e) - Exclude missed packages from optimization, print help message - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6445 [<samp>(8d883)</samp>](vitest-dev/vitest@8d883cf0) - Define mocker as a dependency - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6476 [<samp>(9560a)</samp>](vitest-dev/vitest@9560ab7f) - **coverage**: - Warn if `vitest` and `@vitest/*` versions don't match - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6317 [<samp>(e662c)</samp>](vitest-dev/vitest@e662c7b2) - V8 to support source maps with multiple sources - by [@AriPerkkio](https://github.com/AriPerkkio) and [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6120 [<samp>(1f6cb)</samp>](vitest-dev/vitest@1f6cb59f) - V8 to warn instead of crash when conversion fails - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6318 [<samp>(91dea)</samp>](vitest-dev/vitest@91dea8c1) - Use project specific `vitenode` for uncovered files - by [@AriPerkkio](https://github.com/AriPerkkio) in vitest-dev/vitest#6044 [<samp>(da52d)</samp>](vitest-dev/vitest@da52d23f) - **runner**: - Use `performance.now` instead of `Date.now` for duration - by [@LuciNyan](https://github.com/LuciNyan) in vitest-dev/vitest#6382 [<samp>(fe489)</samp>](vitest-dev/vitest@fe489432) - Async assertion auto await should timeout - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6391 [<samp>(ad6e7)</samp>](vitest-dev/vitest@ad6e72fc) - **snapshot**: - Reject multiple `toMatchInlineSnapshot` updates at the same location - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6332 [<samp>(1606f)</samp>](vitest-dev/vitest@1606f34f) - Improve inline snapshot inside loop rejection - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6339 [<samp>(e0368)</samp>](vitest-dev/vitest@e03683c5) - **typecheck**: - Run both runtime and typecheck tests if `typecheck.include` overlaps with `include` - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6256 [<samp>(153ff)</samp>](vitest-dev/vitest@153ff01b) - **types**: - Allow Callbacks Passed to before\*/after\* to Return Anything - by [@LuciNyan](https://github.com/LuciNyan) in vitest-dev/vitest#6393 [<samp>(f6217)</samp>](vitest-dev/vitest@f6217a22) - **ui**: - Remove "filters" flickering - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6463 [<samp>(0223b)</samp>](vitest-dev/vitest@0223bb79) - Render project name consistently - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6329 [<samp>(94a18)</samp>](vitest-dev/vitest@94a186ec) - **vite-node**: - Disable watcher if hmr is disabled - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6251 [<samp>(c51c6)</samp>](vitest-dev/vitest@c51c67aa) - Fix watch on vite 6 - by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6422 [<samp>(c3ac4)</samp>](vitest-dev/vitest@c3ac43c1) - **vitest**: - Update json reporter output - by [@Emiyaaaaa](https://github.com/Emiyaaaaa) in vitest-dev/vitest#6064 [<samp>(c9979)</samp>](vitest-dev/vitest@c997937b) - Add more type guards for --merge-reports - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6307 [<samp>(0a5d8)</samp>](vitest-dev/vitest@0a5d8169) - Always resolve vitest to the root version - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6369 [<samp>(163d7)</samp>](vitest-dev/vitest@163d7624) - Dispose vmForks listeners to avoid memory leak - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6448 [<samp>(2673c)</samp>](vitest-dev/vitest@2673c3bb) - **workspace**: - Correctly resolve workspace globs and file paths - by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6316 [<samp>(afdcb)</samp>](vitest-dev/vitest@afdcb8f2) ##### [View changes on GitHub](vitest-dev/vitest@v2.0.5...v2.1.0)

AriPerkkio commented Aug 4, 2024

View reviewed changes

test/coverage-test/vitest.workspace.custom.ts Outdated Show resolved Hide resolved

AriPerkkio commented Aug 4, 2024

View reviewed changes

packages/vitest/src/node/config/resolveConfig.ts Outdated Show resolved Hide resolved

AriPerkkio marked this pull request as ready for review August 4, 2024 16:51

sheremet-va requested changes Aug 4, 2024

View reviewed changes

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

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

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

sheremet-va previously approved these changes Aug 5, 2024

View reviewed changes

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

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

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

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

sheremet-va reviewed Aug 5, 2024

View reviewed changes

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

AriPerkkio dismissed sheremet-va’s stale review via 7b711d7 August 6, 2024 05:39

AriPerkkio force-pushed the feat/browser-v8-coverage branch from 7b711d7 to daac5ba Compare August 6, 2024 05:44

sheremet-va reviewed Aug 6, 2024

View reviewed changes

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

sheremet-va previously approved these changes Aug 6, 2024

View reviewed changes

sheremet-va added this to the 2.1.0 milestone Aug 6, 2024

AriPerkkio added 8 commits August 12, 2024 14:50

feat(browser): support v8 coverage

b203f02

fix(coverage): Fetch vue sourcemaps with query params

c001143

fix(cli): throw error when v8-coverage+browser without playwright+chr…

5a0b4b2

…omium

fix: dummy fetchCache for browser mode

487cd25

fix: root relative file paths

580569f

fix: handle @fs protocol, enable more tests for browser mode

c3c408f

fix: review fixes

1e3e598

fix: rename removeRoot

dd21cf9

AriPerkkio dismissed sheremet-va’s stale review via dd21cf9 August 12, 2024 11:54

AriPerkkio force-pushed the feat/browser-v8-coverage branch from f11b6d8 to dd21cf9 Compare August 12, 2024 11:54

sheremet-va approved these changes Aug 12, 2024

View reviewed changes

sheremet-va merged commit 34199bd into vitest-dev:main Aug 12, 2024
15 checks passed

AriPerkkio deleted the feat/browser-v8-coverage branch August 12, 2024 14:07

sheremet-va pushed a commit that referenced this pull request Sep 12, 2024

feat(browser): support v8 coverage (#6273)

76479b0

Laurry-gee mentioned this pull request Oct 5, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.1 Laurry-gee/workers-ns#129

Open

WontonSam mentioned this pull request Oct 5, 2024

[Snyk] Upgrade vitest from 0.29.8 to 2.1.1 WontonSam/function-examples#55

Open

leonardoadame mentioned this pull request Oct 5, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.1 leonardoadame/Affiliate-tech#946

Open

This was referenced Oct 24, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.2 leonardoadame/Affiliate-tech#1002

Open

[Snyk] Upgrade vitest from 0.31.4 to 2.1.2 leonardoadame/Affiliate-tech#1004

Open

This was referenced Oct 30, 2024

[Snyk] Upgrade @vitest/coverage-v8 from 1.6.0 to 2.1.2 nerds-github/starlight#13

Open

[Snyk] Upgrade vitest from 1.6.0 to 2.1.2 nerds-github/starlight#14

Open

Laurry-gee mentioned this pull request Oct 30, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.2 Laurry-gee/workers-ns#174

Open

WontonSam mentioned this pull request Nov 3, 2024

[Snyk] Upgrade vitest from 0.29.8 to 2.1.2 WontonSam/function-examples#61

Open

HaLaGu1L mentioned this pull request Nov 3, 2024

[Snyk] Upgrade vitest from 2.0.5 to 2.1.2 HaLaGu1L/cloudflare-docsdss#4

Open

nerds-github mentioned this pull request Nov 6, 2024

[Snyk] Upgrade @vitest/coverage-v8 from 1.6.0 to 2.1.3 nerds-github/starlight#15

Open

Laurry-gee mentioned this pull request Nov 6, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.3 Laurry-gee/workers-ns#197

Open

This was referenced Nov 6, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.3 leonardoadame/Affiliate-tech#1051

Open

[Snyk] Upgrade vitest from 0.31.4 to 2.1.3 leonardoadame/Affiliate-tech#1052

Open

Laurry-gee mentioned this pull request Nov 7, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.3 Laurry-gee/workers-ns#202

Open

This was referenced Nov 7, 2024

[Snyk] Upgrade vitest from 0.31.4 to 2.1.3 leonardoadame/Affiliate-tech#1054

Open

[Snyk] Upgrade vitest from 0.31.4 to 2.1.3 leonardoadame/Affiliate-tech#1061

Open

WontonSam mentioned this pull request Nov 10, 2024

[Snyk] Upgrade vitest from 0.29.8 to 2.1.3 WontonSam/function-examples#63

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(browser): support v8 coverage #6273

feat(browser): support v8 coverage #6273

AriPerkkio commented Aug 4, 2024 •

edited

Loading

netlify bot commented Aug 4, 2024 •

edited

Loading

feat(browser): support v8 coverage #6273

feat(browser): support v8 coverage #6273

Conversation

AriPerkkio commented Aug 4, 2024 • edited Loading

Description

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

Tests

Documentation

Changesets

netlify bot commented Aug 4, 2024 • edited Loading

✅ Deploy Preview for vitest-dev ready!

AriPerkkio commented Aug 4, 2024 •

edited

Loading

netlify bot commented Aug 4, 2024 •

edited

Loading