メインコンテンツへスキップ
見出し画像

JestからVitestに移行したらテスト実行時間が1/5になった話

    テストが遅くて開発が止まる、あの感覚

    CIを回すたびに「テスト終わるの待ちながら別作業するか」となっていた。
    ローカルでもそう。npm test を打って、コーヒーを入れて戻ってきても、まだグルグルしている。

    うちのプロジェクトはNext.js + TypeScript構成で、テストファイルが80ファイルほど。
    Jestでの実行時間は平均して2分30秒前後だった。
    CIで並列化しても1分40秒ぐらい。
    毎回それだけ待たされると、PRのレビューサイクルがじわじわ遅れていく。

    「Vitestが速い」という話は前から聞いていた。
    でも正直、動いているものを触る気になれなくて半年ぐらい放置していた。
    あるとき別のプロジェクトでVitestを触る機会があって、そのあまりの速さに驚いて本格的に移行を検討し始めた。

    結論から言うと、移行後のローカル実行が約28秒になった。
    2分30秒が28秒。
    約1/5どころか、むしろ1/6近い削減だった。

    JestとVitestで何が違うのか

    速さの理由を先に整理しておく。

    Jestは内部でBabelを使ってトランスパイルする。
    TypeScriptもJSXも、一度Babelがかまないと動かない。
    プロジェクトが大きくなればなるほど、このトランスパイルのコストが積み上がっていく。

    VitestはViteのエコシステム上に乗っている。
    ViteはESBuildでトランスパイルするのでとにかく速い。
    加えて、テストファイルの依存グラフをViteが把握しているので、変更があったファイルに関係するテストだけを賢く再実行してくれる。
    watchモードの体験が根本的に違う。

    もう一つ大きいのが、設定ファイルの共有だ。
    Jestはjest.config.tsを別に書いて、tsconfig.jsonのpathsも別途moduleNameMapperで再定義して……という二度手間がある。
    VitestはViteの設定をそのまま引き継ぐので、aliasやパス解決の設定を二重管理する必要がない。

    実際の移行手順

    移行作業は3時間ほどで完了した。
    大半がテストコードの修正ではなく、importの書き換えだった。

    まず依存関係を整理する。

    # Jestを削除
    npm uninstall jest jest-environment-jsdom @types/jest babel-jest ts-jest
    
    # Vitestを追加
    npm install -D vitest @vitest/ui jsdom @testing-library/jest-dom

    次にvite.config.tsにtest設定を追加する。

    import { defineConfig } from 'vite'
    import react from '@vitejs/plugin-react'
    import path from 'path'
    
    export default defineConfig({
      plugins: [react()],
      resolve: {
        alias: {
          '@': path.resolve(__dirname, './src'),
        },
      },
      test: {
        globals: true,
        environment: 'jsdom',
        setupFiles: ['./src/test/setup.ts'],
        include: ['**/*.test.{ts,tsx}'],
        coverage: {
          provider: 'v8',
          reporter: ['text', 'lcov'],
        },
      },
    })

    あとは各テストファイルの先頭にある import { describe, it, expect } from '@jest/globals' のような記述を削除する。globals: true にしているので、describe・it・expect・beforeEach・afterEachはグローバルで使えるようになる。

    package.jsonのscriptsも更新する。

    {
      "scripts": {
        "test": "vitest run",
        "test:watch": "vitest",
        "test:ui": "vitest --ui",
        "test:coverage": "vitest run --coverage"
      }
    }

    vitest run が一回実行して終了するモード、vitest 単体がwatchモードだ。
    これはJestと逆の感覚なので最初戸惑った。

    移行でハマったポイント

    スムーズに終わったように書いたが、実際には3つハマりどころがあった。

    一つ目は vi.mock() のホイスティング問題だ。
    Jestでは jest.mock('module') をファイルのどこに書いても自動的に先頭に巻き上がってくれた。
    Vitestでも同様の動作をするはずなのだが、ファクトリ関数の中で外部変数を参照していると動かないケースがあった。

    // これがJestでは動いていたが、Vitestで壊れた
    const mockFn = vi.fn()
    vi.mock('./module', () => ({
      someFunction: mockFn  // ファクトリ外の変数を参照
    }))

    解決策は vi.hoisted() を使うことだ。

    const mockFn = vi.hoisted(() => vi.fn())
    
    vi.mock('./module', () => ({
      someFunction: mockFn
    }))

    二つ目は jest.spyOn から vi.spyOn への移行で、これはただの置き換えなので問題ないのだが、スパイのリセット方法が少し違う。
    Jestでは mockRestore() でよかったが、Vitestでは mockReset() と mockRestore() で挙動が異なる。mockReset() は実装をリセットするが元の実装には戻さない。
    元の実装に戻したい場合は mockRestore() を使う。
    これを混同して2時間悩んだ。

    三つ目はTypeScriptの型定義周りだ。@types/jest をアンインストールすると、tsconfig.jsonで型が解決できなくなることがある。@vitest/globals をtypes配列に追加することで解決した。

    {
      "compilerOptions": {
        "types": ["vitest/globals"]
      }
    }

    ただし globals: true を設定している場合は不要なケースも多い。
    自分の環境では必要だった。

    watchモードが開発体験を変えた

    移行してから一番変わったのは、watchモードの使い方だ。

    Jestのwatchモードも使えたのだが、変更検知から再実行完了まで10〜15秒かかっていた。
    それだと「watchモードで常時監視しながら開発する」という体験にならなかった。
    エディタでコードを書いて、ターミナルに切り替えて npm test を打って、待って確認する、という手動サイクルが染みついていた。

    VitestのwatchモードはTDDを前提にした設計になっている。
    ファイル保存から再実行完了まで2〜3秒。
    これだと本当に赤→緑→リファクタのリズムで開発できる。

    vitest --ui を使うとブラウザベースのUIが起動して、テスト一覧と結果をリアルタイムで確認できる。
    カバレッジも視覚的に確認できるので、テスト網羅の感覚がつかみやすい。
    最初はターミナルでいいと思っていたが、使い始めると手放せなくなった。

    移行しないほうがいいケース

    全員にすぐ移行を勧めるかというと、そうでもない。

    一つは、CJSモジュールに強く依存しているプロジェクトだ。
    VitestはESMネイティブなので、CommonJSのライブラリとの相性が悪い場面がある。require() をベースにした古いライブラリを多用していると、モジュール解決でハマりやすい。

    もう一つは、Jestの細かいオプションを使い込んでいるプロジェクトだ。
    Jestは10年以上の歴史があり、エッジケースへの対応が厚い。fakeTimers の動作や、スナップショットテストの細かい挙動など、JestとVitestで微妙に違う部分がある。
    テスト数が数百を超えるプロジェクトで一気に移行しようとすると、想定外の差異に時間を取られる可能性がある。

    その場合は段階移行も選択肢になる。
    新規テストファイルはVitestで書き、既存のJestテストはそのまま残してCIで並列実行する方法だ。
    設定は増えるが、リスクを分散できる。

    まとめ

    移行にかかったコストは3時間ほどで、ハマりポイントも把握できた今なら同規模のプロジェクトで1〜2時間で終わると思う。
    それに対してテスト実行時間が1/5になった恩恵は、毎日積み重なる。

    Vitestへの移行を検討しているなら、まず小さなサイドプロジェクトか新規機能のテストだけで試してみるのがいい。
    設定の簡潔さとwatchモードの速さを体感すれば、本プロジェクトへの移行モチベーションが自然と生まれる。

    globals: true 設定と vi.hoisted() の存在だけ覚えておけば、大半のプロジェクトは詰まらずに移行できる。

     
     
    AIを使っているのに、なぜか時間が減らない。 → 足りないのは「ツール」じゃなく「判断軸」 10年の現場経験で「迷わない基準」を整理。 1記事1判断軸。 副業の時給が3,000円から上がらない人向け。

    あなたへのおすすめ