CIで5分以上かかっていたRubocopを1分未満に短縮！

こんにちは！Findy Team+開発チームでEMをしているhamです。

Findy Team+のバックエンドはRuby on Railsで開発しており、Rubyの静的解析ツールとして広く知られているRubocopをTeam+の開発でも積極的に活用しています。

ファインディでは「爆速開発」を掲げており、開発速度に直結するCI（継続的インテグレーション）の実行時間を非常に重視しています。具体的には、CIの実行時間は遅くとも10分以内、理想としては5分以内に完了することを目標にしています。

CIの実行時間短縮に向けた取り組みについては、以前公開した次の記事で詳しくご紹介していますので、ぜひご覧ください。

今回、バックエンドのCIの実行時間を見直したところ、Rubocopの実行時間が5分以上かかっていることに気づきました。これは改善の余地があると感じ、実行時間短縮に取り組むことを決めました。

また、CIではRubocopの他にRSpecでテストを実行しているのですが、RSpecの実行時間の方がRubocopよりも圧倒的に長いためそちらの改善ばかりに気を取られて、Rubocopの実行時間は見過ごされていました。

なお、この時もテストは7分ほどかかっておりRubocopより長かったですが、こちらは並列実行と実行環境のスペックアップを駆使することで3分程度まで短縮できました。

Slow Test

そこで、今回はRubocopの実行時間短縮に取り組むことを決意し、その結果、5分以上かかっていた実行時間を1分未満に短縮できました！

なぜRubocopの実行時間が長かったのか？

CIにおけるRubocopの実行は、基本的に全てのRubyファイルに対して無条件に実行されていました。そのため、プロジェクトの規模が拡大するにつれて、解析対象となるファイル数も増加し、比例して実行時間も伸びていったのが主な原因です。

実行時間短縮のために、次の3つの変更を加えました。

Gitの差分情報を用いて、変更があったファイルのみをRubocopの解析対象とするようにしました。これにより、CIの実行ごとに解析するファイル数を大幅に削減できました。

ファインディではGitHub Actionsを使ってCIを実行しているため変更したファイルを取得できるtj-actions/changed-filesを活用して対象ファイルを取得しました。

前述の変更により通常時は変更ファイルのみを対象としますが、Rubocopの設定ファイル（.rubocop.ymlなど）やRubocop本体や関連Gemのバージョンがアップデートされた場合は全てのファイルを解析するようにしました。

これは、設定変更やバージョンアップによって、これまで問題なかった箇所が新たに指摘される可能性があるため、CIの信頼性を保つ上で重要な対応です。

Rubocopには、コマンド引数に対象ファイルを明示的に指定すると、.rubocop.ymlで指定されている除外設定（Exclude）が無視されるという仕様があり、本来は解析対象外のファイルまで解析されてしまうという問題が発生しました。

これを解決するため、--force-exclusionオプションを利用できることがわかりました。こちらのオプションを指定することで対象ファイルを明示的に指定した場合でも除外設定が反映されるようになります。

bundle exec rubocop -f github --force-exclusion ${{ all_changed_files }}

これらの改善を適用した結果、5分以上かかっていたRubocopの実行時間は1分未満にまで劇的に短縮されました！

After

これにより、CI全体の実行時間が短縮され、開発者はより素早くフィードバックを得られるようになりました。Rubocopの指摘への対応も迅速に行えるようになり、コードの品質維持にも貢献しています。

CIにおける静的解析の実行時間は、テスト実行時間に比べると見過ごされがちですが、積み重なると開発体験を損なう要因となります。今回のRubocopの実行時間短縮で行った次の対応は、実装難易度も低く簡単にできるものでしたが、大きな効果をもたらしてくれました。

もしあなたのプロジェクトでもCIのRubocop実行時間が長いと感じているのであれば、本ブログで紹介した内容が少しでも参考になれば幸いです。変更ファイルのみを対象とする工夫は、他の静的解析ツールにも応用できる可能性がありますので、ぜひ検討してみてください。

ファインディでは一緒に働くメンバーも絶賛募集中です。興味がある方はぜひこちらから ↓