【初心者向け】Jestで発生する「テスト終了後もプロセスが終了しない」問題：TypeScript/ユニットテスト/Expressにおける非同期処理の影響と解決策をわかりやすく解説

2024-06-20

Jest テスト実行後にプロセスが終了しない問題：TypeScript、ユニットテスト、Expressで解説

Jestを使ってTypeScriptで書いたExpressアプリケーションのユニットテストを実行すると、テストが完了後もプロセスが終了せず、以下の警告メッセージが表示されることがあります。

Jest did not exit one second after the test run has completed.
This usually means that there are asynchronous operations that weren't stopped in your tests.
Consider running Jest with --detectOpenHandles to troubleshoot this issue.

原因

この問題は、Jestがテスト終了後も解放されない非同期処理が存在することを示しています。主に以下の2つの原因が考えられます。

外部リソースの解放漏れ: テスト内でデータベース接続やファイルハンドルなどの外部リソースを開封した場合、適切に解放しないと、Jestが終了できなくなります。
未完了タイマー: setTimeout や setInterval などのタイマーをテスト内で使用している場合、適切にクリアしないと、Jestが終了できなくなります。

解決策

この問題を解決するには、以下の対策を検討する必要があります。

外部リソースの解放

テスト終了後に、afterAll や afterEach などのコールバック関数を使用して、データベース接続やファイルハンドルなどの外部リソースを確実に解放します。
スーパーテストを使用している場合は、agent.close() メソッドを使用して、テスト終了後にサーバー接続を閉じます。

未完了タイマーのクリア

テスト終了後に、clearTimeout や clearInterval などの関数を使用して、未完了タイマーを確実にクリアします。
done コールバック関数を適切に使用して、非同期処理が完了したらJestに通知します。

補足

Jestには、--detectOpenHandles オプションを使用して、解放されていないファイルハンドルを検出する機能があります。このオプションを使用すると、問題の原因となっている箇所を特定しやすくなります。
テストコードをできるだけ同期的に記述することで、非同期処理による問題を回避することができます。

サンプルコード：非同期処理によるJest終了問題の解決

問題の例

import { SuperTest, Test } from 'supertest';
import { app } from './app';

const request = SuperTest(app);

describe('Test the root path', () => {
  test('GET /', async (done) => {
    const response = await request.get('/');
    expect(response.status).toBe(200);
    // 外部リソースの解放漏れ
    // done() コールバック関数を呼び出していない
  });
});

このコードでは、/ パスへのGETリクエストをテストしていますが、非同期処理である request.get() の結果処理後に、done() コールバック関数を呼び出してテスト終了を通知していないため、Jestが終了できなくなります。

import { SuperTest, Test } from 'supertest';
import { app } from './app';

const request = SuperTest(app);

describe('Test the root path', () => {
  test('GET /', async (done) => {
    const response = await request.get('/');
    expect(response.status).toBe(200);

    // 外部リソースの解放
    await database.closeConnection();

    done(); // テスト終了を通知
  });
});

このコードでは、done() コールバック関数を呼び出す前に、外部リソースであるデータベース接続を確実に解放するように修正しています。

この例では、データベース接続を外部リソースとしていますが、ファイルハンドルや未完了タイマーなど、解放が必要な他のリソースにも同様に適用できます。

このサンプルコードを参考に、JestでTypeScriptで書いたExpressアプリケーションのユニットテストにおける非同期処理によるプロセス終了問題を解決してください。

Jest終了問題を解決するその他の方法

await を使用する

Jest 20以降では、done コールバック関数を使用せずに、await キーワードを使用して非同期処理を完了させることができます。

import { SuperTest, Test } from 'supertest';
import { app } from './app';

const request = SuperTest(app);

describe('Test the root path', () => {
  test('GET /', async () => {
    const response = await request.get('/');
    expect(response.status).toBe(200);

    // 外部リソースの解放
    await database.closeConnection();
  });
});

この方法の利点は、コードがより簡潔で読みやすくなることです。一方、欠点は、Jest 20未満のバージョンでは使用できないことです。

finally ブロックを使用する

Promiseのfinally ブロックを使用して、外部リソースの解放などのクリーンアップ処理を確実に実行することができます。

import { SuperTest, Test } from 'supertest';
import { app } from './app';

const request = SuperTest(app);

describe('Test the root path', () => {
  test('GET /', async () => {
    const response = await request.get('/');
    expect(response.status).toBe(200);

    try {
      // テストの実行
    } finally {
      // 外部リソースの解放
      await database.closeConnection();
    }
  });
});