fix(browser): support `coverage.reportsDirectory` with multiple directories by AriPerkkio · Pull Request #5056 · vitest-dev/vitest

AriPerkkio · 2024-01-28T10:31:24Z

Description

Fixes Coverage Report Path in Browser Mode Does Not Consider "reportsDirectory" #5013

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-01-28T10:31:28Z

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Name	Link
🔨 Latest commit	`9f29f05`
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/65bd08bb4af8250009b0b999
😎 Deploy Preview	https://deploy-preview-5056--fastidious-cascaron-4ded94.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.

userquin · 2024-01-28T11:39:59Z

@AriPerkkio both client and server should be in sync: https://github.com/vitest-dev/vitest/blob/main/packages/ui/node/index.ts

Check #3917

AriPerkkio · 2024-01-28T15:10:57Z

Are they currently in sync? Before this fix I see following with coverage.reportsDirectory: './one/two/three/':

packages/ui/node/index.ts: coverageFolder: [ '/Users/xyz/vitest/test/repro/one/two/three', '/three/' ]
packages/ui/client/composables/navigation.ts: coverageUrl: '/three/index.html'

In browser mode this '/three/index.html' is not served.

Would the correct fix be to add this logic into packages/browser/src/node/index.ts as @hi-ogawa suggested in #5013 - I think:

vitest/packages/ui/node/index.ts

Line 20 in d53b858

    
           coverageFolder && server.middlewares.use(coveragePath!, sirv(coverageFolder[0], {

AriPerkkio · 2024-01-31T05:50:33Z

Are there any existing test cases for browser's watch mode? I guess only UI has those e2e-tests?

sheremet-va · 2024-01-31T09:44:21Z

We have a browser test in test/watch/file-watching.test.ts. For the UI part, we don't have any tests.

AriPerkkio · 2024-02-01T18:35:26Z

There are no existing test cases where this could be added easily. I've tried to build a new one into test/ui but for some reason Playwright sees only a blank page there.

And now I'm again running into the case where browser mode picks non-existing test cases and fails:

I'll try to verify these changes manually with multiple different configuration options once the error above stops showing up. But I'm not sure if adding a regression test is doable for now.

userquin

The logic seems to be the same included in the vitest:ui plugin

…tories

AriPerkkio · 2024-02-02T15:26:33Z

I've now tested multiple different variations of reportsDirectory and it seems to work OK.

About the error mentioned in #5056 (comment). This is something I've seen many times ever since browser mode was implemented. We've also seen this on CI.

Browser mode seems to attempt to run test cases that do not belong to the current project that is being run. It includes test cases from previous browser mode runs. I'm starting to think there is some kind of 24h caching that causes this. When I ran into this bug this time, I tried removing all node_modules, installing fresh dependencies and building project. I even rebooted my laptop and it still came up. I searched node_modules and pnpm store path location for matches of the erroneous test case but there were none. I was hoping some .vite or .vitest cache would be the root cause. The error came up with all browser.provider options - even the none one. The error disappeared now that I ran tests again today - I had not done any changes in between. 🤷

AriPerkkio force-pushed the fix/browser-coverage-dir branch from 89e498d to b57f074 Compare January 30, 2024 18:44

AriPerkkio marked this pull request as ready for review January 31, 2024 05:49

AriPerkkio requested a review from userquin January 31, 2024 05:50

userquin mentioned this pull request Feb 2, 2024

Coverage Report Path in Browser Mode Does Not Consider "reportsDirectory" #5013

Closed

6 tasks

userquin previously approved these changes Feb 2, 2024

View reviewed changes

fix(browser): support coverage.reportsDirectory with multiple direc…

9f29f05

…tories

AriPerkkio dismissed userquin’s stale review via 9f29f05 February 2, 2024 15:22

AriPerkkio force-pushed the fix/browser-coverage-dir branch from b57f074 to 9f29f05 Compare February 2, 2024 15:22

AriPerkkio merged commit ae73f27 into vitest-dev:main Feb 2, 2024

AriPerkkio deleted the fix/browser-coverage-dir branch February 2, 2024 16:27

sheremet-va added this to the 1.3.0 milestone Feb 9, 2024

AriPerkkio mentioned this pull request Feb 11, 2024

Zombie browser process from the prevoius run connects to vitest WebSocket endpoint #5165

Closed

renovate bot referenced this pull request in ariakit/ariakit Feb 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

fix(browser): support `coverage.reportsDirectory` with multiple directories#5056

fix(browser): support `coverage.reportsDirectory` with multiple directories#5056
AriPerkkio merged 1 commit intovitest-dev:mainfrom
AriPerkkio:fix/browser-coverage-dir

AriPerkkio commented Jan 28, 2024 •

edited

Loading

Uh oh!

netlify bot commented Jan 28, 2024 •

edited

Loading

Uh oh!

userquin commented Jan 28, 2024

Uh oh!

AriPerkkio commented Jan 28, 2024

Uh oh!

AriPerkkio commented Jan 31, 2024

Uh oh!

sheremet-va commented Jan 31, 2024 •

edited

Loading

Uh oh!

AriPerkkio commented Feb 1, 2024

Uh oh!

userquin left a comment

Uh oh!

AriPerkkio commented Feb 2, 2024 •

edited

Loading

Uh oh!

Uh oh!

Comments

Conversation

AriPerkkio commented Jan 28, 2024 • 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 Jan 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Uh oh!

userquin commented Jan 28, 2024

Uh oh!

AriPerkkio commented Jan 28, 2024

Uh oh!

AriPerkkio commented Jan 31, 2024

Uh oh!

sheremet-va commented Jan 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AriPerkkio commented Feb 1, 2024

Uh oh!

userquin left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

AriPerkkio commented Jan 28, 2024 •

edited

Loading

netlify bot commented Jan 28, 2024 •

edited

Loading

sheremet-va commented Jan 31, 2024 •

edited

Loading

AriPerkkio commented Feb 2, 2024 •

edited

Loading