JestでJest did not exit one second after the test run has completedでテストが終了してもJestのプロセスが終了しない時のデバッグ
Jest でテストを実行すると
Ran all test suites matching path\/to\/hoge.spec.ts/i.
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.といった表示とともに全てのテストが Pass になっているのに関わらず Jest のプロセスが数分間終了しない問題に遭遇することがあります。
エラー文で検索すると Puppeteer や DB コネクションの修了処理を忘れていてテスト時に起動した別プロセスが終了していないため、Jest がそれらの終了を待ってしまうことが多いみたいです。
このような場合はツールの修了処理を追加してあげれば改善することが多いのですが、このようなツールを利用していないプロジェクトで起きた場合は原因特定・修正をする必要が出てきます。
Jest のデバッグ実行
Jest には Chromium 系のブラウザに付いている Dev Tools を利用したトラブルシューティング機能があります。(Node.js の機能ですが Jest はこれを正式にサポートしています)
上記のエラーメッセージと一緒に当該の問題が発生しているテストのファイル名が表示されていると思います。このファイルのみをデバッグ実行して原因を探っていきます。
Jest のドキュメントに従って
node --inspect-brk node_modules/.bin/jest --runInBand /path/to/sample.spec.jsを実行した後、Chromium 系のブラウザで chrome://inspect にアクセスすると Remote Target に Jest のプロセスが表示されるのでinspectをクリックすると見慣れた Dev tools が別ウィンドウで表示されます。
インスペクターは必ず Jest の実行直前で一時停止するようになっているのでCtrl + pを押して対象のテストファイルを開き問題箇所周辺をデバッグしていくことができます。
割と忘れやすいのが、ブレイクポイントを張り終えた後、再実行しようとターミナルでCtrl + cして再実行するとdev toolsとのセッションが切れます。がしかし、dev toolsの画面は自動で閉じません。Jestの再実行の後にさっきまでのdev toolsのウィンドウを閉じた後、再びchrome://inspectから同様に起動してください。dev toolsの作業内容はウィンドウを閉じても保持されるため新しいウィンドウでもさっき頑張って貼ったブレイクポイントのところでちゃんと止まります。
デバッグ勘所
私がこのエラーに遭遇した時に行っているデバッグ方法をを紹介します。
最初に疑うところ
私の経験則ですが、非同期やイベント周りでエラーや考慮漏れがあるとこのようなエラーになることが多かったです。テストの中で作られた Promose オブジェクトが pending のままになっていたり、Reject を返しているのにそれらを考慮していない時などにもこのようなエラーになったことがあります。
console.log を眺める
Jest をターミナルで実行している時にもconsole.logは表示されますが、ログが出力された該当箇所へのジャンプは dev tools でないとできません。
ORM ライブラリなどが実行中に出力するログの出力元に何かヒントがある可能性があります。
catch されていない例外をみる
実行中に例外が投げられており、その例外をキャッチしていない箇所に自動でブレイクポイントを設定できます。(参考)
ここでは try-catch していない Error, Promse.reject があるとそこで実行が止まります。意図していない箇所で止まっている場合にはそこを修正することでテストの実行が改善する可能性があります。
それでも見つからない場合/改善しない場合は”Pause on caught exceptions”にチェックを入れることでtry-catchしている部分ももれなく実行を一時停止することができます。
Jest上で実行されている別プロセスがないか確認する
testやdescribeの最終行にブレイクポイントを張り実行を一時停止した状態で別のターミナルでhtopなどを用いてJestの子プロセスとして起動中（終了していない）プロセスが残っていないかを確認する
Jestの小プロセスにpuppeteerなどが残っているとこのようにnode --inspect-brk ...の子プロセスに表示されます。
プロセスの終了が行われていればnode --inspect-brk ...の子プロセスは１つも表示されなくなります。
