できない.dev

Vitest「bench is not a function」の原因と直し方

Vitest 5 の bench is not a function は、test で包み、引数から受け取った bench を使えば直る。
bench は vitest から import できなくなった。

公開:

症状できない · exit 1
npx vitest bench --run
…
⎯⎯⎯⎯⎯⎯ Failed Suites 1 ⎯⎯⎯⎯⎯⎯⎯
 FAIL  |bench| sort.bench.js [ sort.bench.js ]
TypeError: bench is not a function
解決後できた · exit 0
npx vitest bench --run
…
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  21:50:48
   Duration  1.25s (tests 97%, transform 2%, import 1%)

2026-11-07 に node:24(Vitest 5.1.0 / Node.js 24.22.2) で実際に打って取った出力。検証環境の詳細

要約

TypeError: bench is not a function は、Vitest 5 で import { bench } from "vitest" と書いたベンチマークのファイルを、npx vitest bench で走らせると出る。
5.0 でベンチマークの API が作り直され、vitest は bench という名前を出さなくなった。
import した bench は undefined なので、呼んだところで止まる。

5 の bench は、test の関数が受け取る引数(テストのコンテキスト)から取り出す(公式の移行ガイド(新しいタブで開く))。
*.bench.js の最上位や describe の中で bench() を呼ぶ書き方は、5 ではファイルを読み込んだところで落ちる。

実行例

node:24 のコンテナで Vitest 5.1.0 を入れ、describe の中で bench を呼ぶファイルを npx vitest bench --run で走らせると、TypeError で終了コード 1 になった。
test で包んで bench.compare に渡すと、2 つの書き方を測った表が出た。

$ cat sort.bench.js
import { bench, describe } from "vitest";
 
const numbers = Array.from({ length: 1000 }, (_, i) => (i * 7919) % 1000);
 
describe("sort", () => {
  bench("toSorted", () => {
    numbers.toSorted((a, b) => a - b);
  });
 
  bench("slice + sort", () => {
    numbers.slice().sort((a, b) => a - b);
  });
});
$ npx vitest bench --run
 RUN  v5.1.0 /tmp/tmp.JHXQT3TZon
 
 ❯ |bench| sort.bench.js (0 test)
 
⎯⎯⎯⎯⎯⎯ Failed Suites 1 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  |bench| sort.bench.js [ sort.bench.js ]
TypeError: bench is not a function
 ❯ sort.bench.js:6:3
      4|
      5| describe("sort", () => {
      6|   bench("toSorted", () => {
       |   ^
      7|     numbers.toSorted((a, b) => a - b);
      8|   });
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
 
 Test Files  1 failed (1)
      Tests  no tests
   Start at  21:50:47
   Duration  112ms (worker 97%, environment 3%)
$ echo $?
1
$ node -e 'import("vitest").then((m) => console.log(typeof m.bench))'
undefined
$ cat sort.bench.js
import { test } from "vitest";
 
const numbers = Array.from({ length: 1000 }, (_, i) => (i * 7919) % 1000);
 
test("sort", async ({ bench }) => {
  await bench.compare(
    bench("toSorted", () => {
      numbers.toSorted((a, b) => a - b);
    }),
    bench("slice + sort", () => {
      numbers.slice().sort((a, b) => a - b);
    }),
    { time: 300 },
  );
});
$ npx vitest bench --run
 RUN  v5.1.0 /tmp/tmp.JHXQT3TZon
 
 ✓ |bench| sort.bench.js (1 test) 1121ms
   ✓ sort 1121ms
     name                 hz     min     max    mean     p75     p99    p995    p999     rme  samples
     slice + sort  14,137.85  0.0605  1.5316  0.0765  0.0737  0.2140  0.2885  0.5087  ±1.71%     3922   fastest
     toSorted      12,735.40  0.0596  0.6449  0.0855  0.0958  0.2346  0.2823  0.4152  ±1.37%     3509
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  21:50:48
   Duration  1.25s (tests 97%, transform 2%, import 1%)
$ echo $?
0

— 2026-11-07 時点の出力

検証環境Node.js 24.22.2 / npm 11.19.1 / Python 3.11.2 / 2026-11-07 検証(ほか 2 件)
検証日
実行環境
node:24 Debian GNU/Linux 12 (bookworm)
バージョン
  • Node.js 24.22.2
  • npm 11.19.1
  • Python 3.11.2
  • Git 2.39.5
  • Vitest 5.1.0

この記事の「実行例」は、上記の環境で実際にコマンドを実行して得られた出力をそのまま掲載しています。 再現手順はリポジトリの検証スクリプトとして管理し、定期的に再実行して出力を更新しています。

解決策

1. test で包み、引数の bench を使う

import { test } from "vitest";
 
test("sort", async ({ bench }) => {
  await bench("toSorted", () => {
    numbers.toSorted((a, b) => a - b);
  }).run();
});

1 つの処理を測るときは、bench() の戻り値の .run() を await する。
test の名前は、結果の表の上に出る行の名前になる。

2. 比べるときは bench.compare に渡す

test("sort", async ({ bench }) => {
  await bench.compare(
    bench("toSorted", () => {
      numbers.toSorted((a, b) => a - b);
    }),
    bench("slice + sort", () => {
      numbers.slice().sort((a, b) => a - b);
    }),
    { time: 300 },
  );
});

4 で describe の中に bench を並べて比べていたなら、bench.compare に渡す。
公式のベンチマークのガイド(新しいタブで開く)によると、bench.compare は渡したベンチマークを交互に走らせ、結果を 1 つの表にまとめる。
最後の引数の time は計測にかける時間で、実行例では 300 にして全体を 1 秒ほどで終えた。

bench.skip・bench.only・bench.todo も無くなったので、包んだ test の test.skip・test.only・test.todo を使う。
vitest bench が拾うのは *.bench.js や *.benchmark.ts のような名前のファイルで、ファイルの中で bench を使っているかどうかでは決まらない。

よくある原因

  1. 4 までの書き方のまま Vitest を 5 に上げた。
    npm install -D vitest で入る最新版は 5 系で、4 のベンチマークのファイルは 1 本も走らない。