vitest: `@vitest/web-worker` error when using browser environment
Describe the bug
I’m trying to get test coverage output with istanbul but I’ve found out vitest can’t see codes executed in web workers (per #2911). So I figured I could wrap my worker with @vitest/web-worker and execute it in main thread. However, since that worker executes WebAssembly I want to keep using browser environment.
Now, in theory I don’t see any problem with this approach but I’m getting a dynamic import error.
TypeError: Failed to fetch dynamically imported module: http://localhost:5173/home/foo/workspace/bar/node_modules/@vitest/web-worker/dist/index.js?v=1704701752071
This could be just a configuration error on my side, maybe there is a way to bundle this worker wrapper in browser environment but that didn’t shine any ideas to my mind.
Reproduction
If the problem is not obvious I’ll create a reproduction project
System Info
System:
OS: Linux 6.2 Ubuntu 22.04.3 LTS 22.04.3 LTS (Jammy Jellyfish)
CPU: (32) x64 Intel(R) Core(TM) i9-14900K
Memory: 54.16 GB / 62.57 GB
Container: Yes
Shell: 5.8.1 - /usr/bin/zsh
Binaries:
Node: 20.10.0 - ~/.nvm/versions/node/v20.10.0/bin/node
npm: 10.2.3 - ~/.nvm/versions/node/v20.10.0/bin/npm
Browsers:
Chrome: 120.0.6099.129
npmPackages:
@vitejs/plugin-react: ^4.2.1 => 4.2.1
@vitest/browser: ^1.1.3 => 1.1.3
@vitest/coverage-istanbul: ^1.1.3 => 1.1.3
@vitest/coverage-v8: ~1.1.3 => 1.1.3
@vitest/ui: ~1.1.3 => 1.1.3
@vitest/web-worker: ^1.1.3 => 1.1.3
vite: ^5.0.11 => 5.0.11
vitest: ~1.1.3 => 1.1.3
Used Package Manager
npm
Validations
- Follow our Code of Conduct
- Read the Contributing Guidelines.
- Read the docs.
- Check that there isn’t already an issue that reports the same bug to avoid creating a duplicate.
- Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
- The provided reproduction is a minimal reproducible example of the bug.
About this issue
- Original URL
- State: open
- Created 3 years ago
- Comments: 21 (10 by maintainers)
This package is not trying to run web workers in the same thread, it’s a side effect of trying to bring Web Worker API to Node.js. Since web workers are already supported in the browser, this package is not needed there.
The proper way would be to communicate with the worker, although I am not sure it’s a good idea to send messages to user workers which would trigger user land event listeners. Maybe something like BroadcastChannel API is better suited. We can inject it by checking for
workerquery in the transform hook.Here you go @AriPerkkio: ~https://github.com/DenizUgur/vitest-worker-coverage~
Coverage collection for browser’s Workers is not supported. I don’t think this has been looked into before as there as been no feature requests for it.
Istanbul instrumented files collect the coverage data into global scope. In Vitest’s case that’s in
globalThis.__VITEST_COVERAGE__object. After running all tests of a file, we collect that object back to main process. In this case we don’t see Worker’s coverage as it’s in its own context. We would need something like:And when ever
new Worker()is invoked, we would need to store those in the scope:And then in here we would also collect coverage from each worker:
https://github.com/vitest-dev/vitest/blob/9ec3f743edfd0a5996a4c6eced35bbf95cf1604e/packages/coverage-istanbul/src/index.ts#L10-L19
I did some quick hacky testing and run into issues with Istanbul. For some reason writing into
globalThisinside Worker did not work. Vitest might need to rewrite some parts of Istanbul instrumented code as well: https://github.com/istanbuljs/istanbuljs/blob/5584b50305a6a17d3573aea25c84e254d4a08b65/packages/istanbul-lib-instrument/src/visitor.js#L688-L691.So to summarize: It should be possible to collect coverage from Workers. If something like this would be implemented I think we should also look into hooking into
node:child_processandnode:worker_threads.