【ITニュース解説】Cleaning house in Nx monorepo, how i removed unused deps safely

システム開発において、複数の関連するプロジェクトやライブラリを一つの大きなリポジトリで管理する手法を「モノレポ」と呼ぶ。この方式は、コードの共有や一貫した開発環境の維持にメリットがあるため、多くの企業で採用されている。モノレポの管理を効率化するためのツールの一つに「Nx」がある。Nxは、モノレポ内の各プロジェクトのビルド、テスト、そしてプロジェクト間の依存関係を効果的に管理する機能を提供する。

開発を進める中で、各プロジェクトは様々な外部のライブラリやパッケージを利用する。これらは「依存関係」と呼ばれ、Node.jsプロジェクトの場合、package.jsonファイルにリストされ、node_modulesディレクトリにインストールされる。例えば、ユーザーインターフェースを構築するReactや、データ処理のためのlodashなど、機能に応じて多くのライブラリが追加されていく。しかし、プロジェクトの要件が変更されたり、特定の機能が削除されたりすると、かつては必要だったが、もはや使われなくなった依存関係がpackage.jsonファイルに残ってしまうことがある。これらが「未使用の依存関係」だ。

未使用の依存関係がプロジェクトに残存することは、いくつかの問題を引き起こす。まず、プロジェクトのビルド時間が不必要に長くなる。使われていないライブラリであっても、ビルドプロセスでそれらを処理するため、ビルドが完了するまでの時間が延び、開発者の生産性を低下させる。次に、最終的な成果物のサイズが肥大化する。例えばウェブアプリケーションの場合、ブラウザにダウンロードされるJavaScriptファイルのサイズが大きくなり、ページの読み込み速度が低下し、ユーザー体験を損なう可能性がある。サーバーサイドアプリケーションでも、デプロイされるコンテナイメージのサイズが増加し、デプロイや起動に余計な時間がかかる原因となる。

さらに、セキュリティリスクが増大する点も無視できない。未使用の依存関係であっても、もしそのライブラリに脆弱性が見つかった場合、プロジェクト全体がそのリスクにさらされることになる。また、古いバージョンのライブラリが残っていると、最新のセキュリティ修正やバグ修正が適用されず、潜在的な危険性を抱え続けることになる。最後に、コードベースの複雑さが増し、開発者がプロジェクトを理解しにくくなる。package.jsonを見ただけでは、どのライブラリが本当に必要で、どれが不要なのかが判断しにくくなり、新しい開発者がプロジェクトに加わる際の学習コストを上げてしまう。

これらの問題に対処するためには、プロジェクトから未使用の依存関係を安全に特定し、削除する作業が不可欠となる。しかし、これを手動で行うのは非常に困難であり、誤って必要な依存関係を削除してしまうと、アプリケーションが動作しなくなり、デバッグに多くの時間を費やすことになる。

ここでNxツールの能力が発揮される。Nxは、モノレポ内の各プロジェクトが外部ライブラリにどのように依存しているかという情報を詳細に管理している。この情報を使って、実際にコード内で利用されている依存関係と、package.jsonには記載されているものの、実際には使われていない依存関係を明確に区別できる。

具体的な手順として、ブログ記事ではNxが提供するnx graphコマンドの活用が紹介されている。このコマンドは、モノレポ内のプロジェクトや、プロジェクトが依存する外部ライブラリの関係性を可視化する機能を持つ。このグラフの情報を解析することで、どのプロジェクトがどの外部ライブラリに実際に依存しているかをプログラム的に把握することが可能になる。

ブログ記事で解説されている未使用の依存関係を特定し削除するプロセスは、以下のようなステップで構成される。まず、モノレポ内の全てのpackage.jsonファイルから、プロジェクトに登録されている全ての依存関係のリストを収集する。次に、nx graphコマンドの出力を解析し、Nxが「実際に使われている」と認識している依存関係のリストを作成する。Nxが「使われている」と判断するのは、コード内でimport文などによって直接参照されている場合や、設定ファイルを通じて間接的に利用されている場合などだ。

これら二つのリスト（package.jsonに記載されている全ての依存関係と、Nxが実際に使われていると認識する依存関係）を比較することで、package.jsonには存在するがNxのグラフには現れない、つまりコードからは参照されていないと思われる依存関係のリストが抽出される。これが「未使用の依存関係」の候補となる。

この候補リストに基づいて、実際に各プロジェクトのpackage.jsonファイルから該当する依存関係を削除する。依存関係を削除した後には、必ずnpm installやyarn installといったパッケージマネージャーのコマンドを実行し、node_modulesディレクトリをクリーンアップして変更を反映させる。

最も重要なステップは、依存関係を削除した後に、影響を受ける可能性のあるプロジェクトのテストを徹底的に実行することだ。nx run-many --target=test --projects=<project-name>のようなコマンドを利用して、対象プロジェクトの全てのテストを実行し、アプリケーションが引き続き正常に動作するかを確認する。このテストは、削除した依存関係が本当に不要だったのか、あるいはNxのグラフ解析だけでは捉えきれなかった間接的な利用があったのかを検証する最終的な確認手段となる。もしテストが失敗した場合は、削除した依存関係のいずれかがアプリケーションの動作に必要だったことを意味するため、その依存関係を元に戻す必要がある。

この一連のプロセスを、手作業ではなくスクリプトとして自動化することで、安全かつ効率的にモノレポの依存関係をクリーンアップできる。定期的にこのクリーンアップ作業を行うことで、プロジェクトの健全性を維持し、開発効率、パフォーマンス、そしてセキュリティを継続的に向上させることが可能となる。モノレポとNxを活用した開発においては、このようにツールの提供する機能を最大限に利用し、体系的なアプローチでコードベースを管理することが、長期的なプロジェクトの成功の鍵となる。