不要な Swift コードを静的解析で安全かつ継続的に消していく

こんにちは、iOS エンジニアの @manicmaniac です。現在スタディサプリ iOS アプリ開発チームのエンジニアリングマネージャをしています。

スタディサプリ iOS アプリは開発開始から7年以上が経過した、そこそこ歴史のあるプロダクトとなっています。そこそこ長い歴史の中では、「スタディサプリ」が React Native から卒業するまで、あるいは技術的負債への感謝と敬意で触れたように大小さまざまの利用技術の変遷があり、開発者の入れ替えがあり、多数の新機能の追加や削除がありました。したがって、コードベースには歴史の生き証人のような不要コードがポツポツと存在しています。

今回はこれらの不要コードを削除する活動を、ツールの助けを得て行った話をします。

不要コードとは

さきほどから不要なコードと言っていますが、今回は到達不能なコードに話を絞ります。たとえば、参照されない変数やクラス、あるいは xib ファイルなんかがそれにあたります。

これらのコードは実行されることがないにもかかわらず、読み手に負担をかけたり、余計な依存関係を導入したり、ビルド時間を奪ったり、場合によってはバイナリサイズや実行時メモリのフットプリント増大を招いたりします。

静的解析ツールの活用

幸い Swift には Periphery という不要コードを解析して警告を出してくれるツールがあるので、これを利用しました。すでに日本語の解説記事がいくつかあるので、具体的な使い方の説明はそちらに譲ります。

仕組みとしては Xcode ビルドシステムがビルド時に作成してくれる IndexStore を解析することで不要なコードを検出しているようです。したがって、デフォルトでは Periphery を実行すると xcodebuild が実行されます。あらかじめビルドをするなどして IndexStore を作成しておけば、ビルドをスキップして解析だけ行うこともできます。

静的解析による成果

当初 Periphery を実行したところ、1700 件以上の警告が出てしまいました。

警告の中には自動生成のコードに対するものだったり、規約上必要だが使われない引数 (sender とか notification) に対するもののような無視できるものが含まれていました。それらを除いたうえで、いくつかの PR に分けて作業を進めました。静的解析も完璧ではないので、万一にも到達可能なコードを削除しないよう、PR の分量を減らしてレビュー可能にすることや、コンフリクトを避ける狙いでした。

Remove unused classes なる PR