VitestのspyOnは同一ファイルの別関数をモックできない

vi.spyOn とは#

vi.spyOn を用いると、vi.mock と異なり部分的なモックが可能。そのためプライベートメソッドやプリミティブなメソッドをモックすることもできる。

1
jest.spyOn(window, "fetch").mockImplementation((...args) => {
2
  console.warn("window.fetch is not mocked for this call", ...args);
3
  throw new Error("This must be mocked!");
4
});

spy と付いているが、返り値は vi.fn()であり、スパイではなくモックとして使われていることが多い。

同一ファイルの別関数をモックできない#

次のようなコードを実行すると TypeError: Cannot redefine property エラーが出る。

1
import * as example from "./example";
2

3
vi.spyOn(example, "message").mockImplementationOnce(() => "hello");
4

5
it("test", () => {
6
  expect(example.greet()).toBe("hello");
7
});

Jest で同一のコードを記述すると問題なく実行できる。正確には、Jest でも esbuild/swc を利用する場合、同様のエラーが出る。

Vitest と Jest でなぜ違うか#

esbuild/swc と、tsc/babel の esm→cjs 変換方法の違いによって発生している。tsc/babel では exports.someMethod を呼ぶのに対して、esbuild/swc では、standalone なメソッドをコールするため、同一ファイルにある別関数をモックできなくなる。

Vitest spyOn has different behaviour than jest’s · Issue #1329 · vitest-dev/vitest

どうすればいいか#

これは Vitest の問題であるとは言い難く、そもそも同一ファイルの別関数をモックすることは、テストの設計上あまり推奨されないため、メソッドを別ファイルに分けることを推奨する。

全く推奨しないが、class やオブジェクトにモックするものをまとめるという手段も存在する。