【Remix】Tests closed successfully but something prevents Vite server from exiting

解決したいこと

Vitestのカバレッジ機能を導入したが、テスト実行時に以下のような注釈が出るようになってしまった。

close timed out after 10000ms
Tests closed successfully but something prevents Vite server from exiting
You can try to identify the cause by enabling "hanging-process" reporter. See https://vitest.dev/config/#reporter

ゴール

このように注釈が出なくなること。

$ yarn run test:coverage

 RUN  v3.0.6 /Users/username/remix-sample
      Coverage enabled with v8

 ✓ test/services/calcService.test.ts (1 test) 2ms
   ✓ adds 1 + 2 equals 3

 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  08:22:10
   Duration  1.23s (transform 67ms, setup 0ms, collect 39ms, tests 2ms, environment 0ms, prepare 128ms)

 % Coverage report from v8
-------------------|---------|----------|---------|---------|-------------------
File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-------------------|---------|----------|---------|---------|-------------------
All files          |    1.08 |    66.66 |   66.66 |    1.08 |
 app               |       0 |    66.66 |   66.66 |       0 |
  entry.client.tsx |       0 |        0 |       0 |       0 |
  entry.server.tsx |       0 |      100 |     100 |       0 | 7-140
  root.tsx         |       0 |        0 |       0 |       0 | 1-45
 app/routes        |       0 |       50 |      50 |       0 |
  _index.tsx       |       0 |      100 |     100 |       0 | 3-138
  sample.tsx       |       0 |        0 |       0 |       0 | 1-7
 app/services      |     100 |      100 |     100 |     100 |
  calcService.ts   |     100 |      100 |     100 |     100 |
-------------------|---------|----------|---------|---------|-------------------

原因

原因は以下のところである。

Vite | Remix

The Remix Vite plugin is only intended for use in your application's development server and production builds. While there are other Vite-based tools such as Vitest and Storybook that make use of the Vite config file, the Remix Vite plugin has not been designed for use with these tools. We currently recommend excluding the plugin when used with other Vite-based tools.

RemixのViteプラグインは、開発サーバーと本番ビルドで利用するように意図されていて、
VitestやStorybookで使うように設計されていないとのこと。

解決策

vite.config.jsに「VitestのときはRemixプラグインを利用しない」という設定をする。

export default defineConfig({
  plugins: [
    // これ
    !process.env.VITEST &&
      remix({
        future: {
          v3_fetcherPersist: true,
          v3_relativeSplatPath: true,
          v3_throwAbortReason: true,
          v3_singleFetch: true,
          v3_lazyRouteDiscovery: true,
        },
      }),
    tsconfigPaths(),
  ],
  test: {
    globals: true,
    coverage: {
      enabled: true,
      include: ["app/**"],
      reporter: ["text", "html"],
    },
  },
});