Support Vitest

[birkskyum]

Vitest - website - github

Blocked by:

• vitest hangs #11268
• support node:inspector #2445 (needed for vitest coverage reporting run --coverage)

[birkskyum]

It seems like the console.ts / console.js that contains:

export default console

Might also have to export the named Console in order to be node compatible.

[paperdave]

Console issue you are seeing is #3625. It's a constructor that returns a console object that has stdout/stderr redirected

[mnik01]

Any workarounds?

[ghiscoding]

might also be worth to know that Vitest itself also have a PR, in draft, to support Bun by using ShadowRealm with this description

Currently, all jsdom tests are failing because bun doesn't seem to correctly support VM module.

[paperdave]

console.console is implemented in the next release
that might fix vitest

[birkskyum]

It's progress, but I get this:

vitest on  main [!?] 
➜ bun --bun x vitest

 DEV  v0.34.4 /Users/admin/repos/vitest

[bun] Warning: worker_threads.Worker option "argv" is not implemented.
[bun] Warning: worker_threads.Worker option "execArgv" is not implemented.
[bun] Warning: worker_threads.Worker option "resourceLimits" is not implemented.

• worker_threads.Worker missing argv and execArgv option #4130
• Implement Worker option argv and execArgv #4075

[AriPerkkio]

Those warning can be ignored, see https://github.com/tinylibs/tinypool/pull/70/files#diff-478191b8d0c43c3d24bfda206ff15909923b8b5a89eec9c967376feded4edfa7R9

[nyxb]

have the same:

[bun] Warning: worker_threads.Worker option "argv" is not implemented.
[bun] Warning: worker_threads.Worker option "execArgv" is not implemented.
[bun] Warning: worker_threads.Worker option "resourceLimits" is not implemented.

and cant ignore tests doesnt finish

and get this if i want cancel need to do it 1000 times before exit:

RangeError: exitCode must be between 0 and 127
      at /Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17951:8
      at _keypressHandler (/Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17946:34)
      at /Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17990:10
      at keypressHandler (/Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17989:33)
      at node:readline:114:54
      at onData (node:readline:476:34)
      at addChunk (node:stream:1940:42)
      at readableAddChunk (node:stream:1894:58)
Cancelling test run. Press CTRL+c again to exit forcefully.

17946 |   async function _keypressHandler(str, key) {
17947 |     if (str === "" || str === "\x1B" || key && key.ctrl && key.name === "c") {
17948 |       if (!ctx.isCancelling) {
17949 |         ctx.logger.logUpdate.clear();
17950 |         ctx.logger.log(c.red("Cancelling test run. Press CTRL+c again to exit forcefully.\n"));
17951 |         process.exitCode = 130;
            ^
RangeError: exitCode must be between 0 and 127
      at /Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17951:8
      at _keypressHandler (/Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17946:34)
      at /Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17990:10
      at keypressHandler (/Users/nyxb/projects/github_packages/eslint-config/node_modules/vitest/dist/vendor-node.81dd929c.js:17989:33)
      at node:readline:114:54
      at onData (node:readline:476:34)
      at addChunk (node:stream:1940:42)
      at readableAddChunk (node:stream:1894:58)

[IndranilKhedkar]

Same here - error: "vitest" exited with code 9 (SIGKILL)

[pafeltowicz]

I have same problem

[birkskyum]

Hmm... if I now make a small test file like this , and run, it seems to just freeze:

➜ bun --bun x vitest

 DEV  v1.1.1 /Users/admin/repos/histoire-vue3-starter

[MkSavin]

The argument implementation warning was removed in version 1.0.22, but vitest still doesn't work.
It turns out that we need to wait for the implementation of bun's virtualization or the integration of shadowrealm api in vitest

[Rhymmor]

Getting this error while running bun x -b vitest run.

OS: Darwin 23.1.0 arm64 arm

Bun v1.0.35, Vitest v1.4.0

> bun x -b vitest run  

82 |                                    `You can download it from ${msvcDownloadLink}`,
83 |                            { cause: error }
84 |                    );
85 |            }
86 | 
87 |            throw new Error(
             ^
error: Cannot find module @rollup/rollup-darwin-arm64. npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). Please try `npm i` again after removing both package-lock.json and node_modules directory.
 cause: {
  "name": "ResolveMessage",
  "position": null,
  "message": "Cannot find module \"@rollup/rollup-darwin-arm64\" from \"***/rollup/dist/native.js\"",
  "level": "error",
  "specifier": "@rollup/rollup-darwin-arm64",
  "importKind": "require-call",
  "referrer": "***/rollup/dist/native.js"
}

      at requireWithFriendlyError (***/node_modules/rollup/dist/native.js:87:9)
      at ***/node_modules/rollup/dist/native.js:96:48

[redbit86k]

Maybe interesting fact:

if you take the node:20 docker image and install bun there, then our
bun run vitest --coverage --run --watch false
completes without problems.

if we use the oven:bun image it just hangs.
Hope this fact maybe helps someone as a workaround if possible...

[birkskyum]

With the node one, does it pass with the '--bun' flag?

[redbit86k]

Sadly
bun run --bun vitest --coverage --run
does not finish.
Also does not work on my local dev machine (ubuntu24lts), just hangs

[birkskyum]

I know bun has a competing bun test, but as of writing vitest is quickly becoming a staple, so it would be great if bun could support it as well. If people can adopt bun in their projects, and then consider swapping the test runner, that would give a much nicer migration story towards bun.

https://2023.stateofjs.com/en-US/libraries/#tools_arrows

[birkskyum]

Still issue with vitest 2.x / bun 1.1.22-canary.85+cacbaba52

➜ bun --bun x vitest

 DEV  v2.0.5

[marviobezerra]

+1

[JarekToro]

+1

[birkskyum]

Tried with latest stable bun 1.1.27 - it hangs, and also makes these weird symbols instead of interrupting why I try to escape it

[Extarys]

In the meantime, is there a way to run tests with vitest on a project made with bun?
The project rely on Bun.hash, etc so I cannot switch to node just for the tests.

I'm asking here because other people coming here might find the information useful too. :)

[belgattitude]

I'm maintainer of few modest oss packages.

I'd love bun to support vitest for few reasons, but the first would be to be able to run my current packages on it.

That would allow me to eventually report bugs or performance regressions related to bun .

Most of my repos currently depends on vitest and run on node and @vercel/runtime-edge by default. That way I can ensure my test suite runs on the two runtimes. Adding bun would be great addition.

I also use vitest to benchmark, with supporting vitest I could provide also few comparisons that might give more visibility to performance differences or regressions (they're connected to codpeed)

While I love the bun integrated feature, I feel the ecosystem is converging towards vitest (storybook, playwright...). Maintaining different test suite is difficult.

[nazarhussain]

The issue running Vitest with the Bun is related to the tinypool package which is used internally by the Vitest. I created another pool which will avoid using tinypool and work on Bun and Deno as well.

https://www.npmjs.com/package/vitest-in-process-pool

[birkskyum]

@nazarhussain well done! There is already vitest support in deno, so it's mainly a bun need. What's the best way to try it?

[nazarhussain]

Yes, Deno is supported as runtime with vitest. For usage first install vitest-in-process-pool package as dev dependencies and then use the following code to configure vitest to use specific pool for the different runtimes. Also we need to disable the code coverage in the Bun environment.

import path from "node:path";
import { defineConfig, ViteUserConfig } from "vitest/config";

export type Runtime = "node" | "deno" | "bun";

export function getRuntime(): Runtime {
  if ("bun" in process.versions) return "bun";
  if ("deno" in process.versions) return "deno";

  return "node";
}

export function getPoolOptions(runtime: Runtime): ViteUserConfig["test"] {
  if (runtime === "node") {
    return {
      pool: "threads",
      poolOptions: {
        threads: {
          singleThread: true,
          minThreads: 2,
          maxThreads: 10,
        },
      },
    };
  }

  return {
    pool: "vitest-in-process-pool",
    coverage: {
      enabled: false,
    },
  };
}


export default defineConfig({
  test: {
    ...getPoolOptions(getRuntime()),
    include: ["**/*.test.ts"],
  }
});