できない.dev

Vitest「test.poolOptions was removed in Vitest 4」の原因と直し方

Vitest 4 の test.poolOptions was removed in Vitest 4 は、中身を test の直下に移せば直る。
4 は警告を出すだけで poolOptions を読まず、execArgv などが効かないままテストが走る。

公開:

要約

Vitest 4 で npx vitest run を打つと、最初に次の行が出ることがある。

 DEPRECATED  `test.poolOptions` was removed in Vitest 4. All previous `poolOptions` are now top-level options. Please, refer to the migration guide: https://vitest.dev/guide/migration#pool-rework

Vitest 4 はテストを走らせるプールの仕組みを作り直し、poolOptions を無くした。
中に書いていた項目は test の直下に置く(公式の移行ガイド(新しいタブで開く))。
この行は警告で、4 は poolOptions の中身を読まずにテストを続ける。
そのため execArgv で渡したはずの Node のオプションが効かず、別のテストの失敗として表に出る。

解決策

1. poolOptions の中身を test の直下に移す

Vitest 3 では次のように書いていた。

import { defineConfig } from "vitest/config";
 
export default defineConfig({
  test: {
    poolOptions: {
      forks: { execArgv: ["--expose-gc"] },
    },
  },
});

Vitest 4 では forks の 1 段を外し、中の項目を test に置く。

import { defineConfig } from "vitest/config";
 
export default defineConfig({
  test: {
    execArgv: ["--expose-gc"],
  },
});

移したあとは DEPRECATED の行が消え、globalThis.gc を確かめるテストも通った。
プロジェクトごとに設定を分けたいときは、Test Projects の各プロジェクトに execArgv や isolate を書ける。

2. 名前の変わった設定を書き換える

移行ガイドが挙げる置き換えは次のとおりである。

  • maxThreads と maxForks は maxWorkers にする。
  • singleThread と singleFork は maxWorkers: 1 と isolate: false にする。
    テストの間でモジュールがリセットされることに頼っていたなら、beforeAll で vi.resetModules() を呼ぶセットアップファイルを足す。
  • VM のプールの memoryLimit は vmMemoryLimit にする。
    threads.useAtomics は無くなった。

旧名の maxForks を test の直下に書いても、4.1.12 では警告もエラーも出なかった。
古い名前が残っていないかは、設定ファイルを目で確かめる。

警告の行にあるリンク先は、Vitest 5 が出た今は 5 の移行ガイドを開き、プールの節は載っていない。
4 の移行ガイドは v4.vitest.dev にある。

よくある原因

  1. Vitest 3 の設定のまま 4 に上げた。
    3 では poolOptions.forks.execArgv のように、プールごとに設定を書いていた。
    4.1.12 では forks と threads のどちらの下に書いても同じ行が出て、--expose-gc を渡したはずのテストで globalThis.gc が undefined になった。
  2. 4 で名前が変わった設定を使っている。
    移行ガイドによると、maxThreads と maxForks は maxWorkers にまとまり、環境変数の VITEST_MAX_THREADS と VITEST_MAX_FORKS も VITEST_MAX_WORKERS になった。