この gem を使っているアプリケーションを探す

技術部開発基盤グループの鈴木 (id:eagletmt) です。 Ruby アプリケーションが使っている gem を一覧できる GemCollector というツールを作りました。 今回はその GemCollector の機能と、GemCollector の利用シーンの拡大について紹介したいと思います

なお GemCollector は Rails Engine の形で gem として公開しています。 https://github.com/cookpad/gem_collector

GemCollector 作成の動機

GemCollector を作った元々の動機は我々開発基盤でメンテナンスしている gem を更新したいとき、とくに非互換を含む変更を行いたいときに、変更の影響を受けるアプリケーションを把握することでした。 社内でよく使われている gem であれば、事前に社内での使われ方を調査し、現実的に修正可能かどうか調べることができます。 そして現実的に修正可能であり実際に変更を行った後も、どのアプリケーションで更新作業が終わっていないかを把握しやすくなります。

GemCollector の動作

通常の Rails Engine を使うときのように、適当な Rails アプリケーションを用意し gem_collector gem をインストールして GemCollector::Engine をマウントして使います。 それに加えて PostgreSQL を用意したり GitHub のアクセストークンを設定したりする必要がありますが、詳しい手順は README をご覧ください。

GemCollector の動作はとてもシンプルで、GitHub の webhook の push イベントを契機としてそのリポジトリの最新のリビジョンを取得し、そこに含まれている Gemfile.lock の情報を DB に入れるだけです。 webhook は GitHub の設定ページから https://gem-collector.example.com/github-webhook を追加してもよいですが、GemCollector の Web UI からも追加できるようになっています。

それぞれの gem を利用しているリポジトリは Web UI から閲覧できるようにしています。実際に GarageClient をすべてのアプリケーションで更新したいときがあり、GemCollector を見ることで GarageClient を利用しているアプリケーションを把握することができました。

またこの利用シーンを拡張する形で、ある gem をバージョン X 以下で使っているリポジトリにバージョンアップのお知らせ issue を立てる機能が @taiki45 によって追加されました。 バージョンでフィルタした上で、作成する issue のタイトルと内容を指定できます。

GemCollector の使い道

最初は非互換な gem の変更の影響を受けるアプリケーションを把握するために書かれたツールでしたが、実際に利用してみるとある gem を使っているリポジトリを把握できると便利な場面が他にもありました。

• 自分のアプリケーションでその gem を使おうとしているが、困っている部分があるのでそこをどう回避しているのかを社内で実際に動いているコードで見ることができる
• 自分がメンテナンスしている gem で Rails 3.x のサポートを切りたいが、まだ Rails 3.x を使っているアプリケーションがあるか調べることができる
• ある gem で security fix を含むバージョンがリリースされたが、社内でアップデートが済んでいないアプリケーションはどれか把握できる

gem の最新度

社内の Gemfile.lock の情報が集まってくると、今度は「自分のアプリケーションが使っている gem はどれだけ最新か」というのも見積もれるようになってきます。 技術部では開発者の生産性向上を目標の1つとしており、生産性に寄与する指標の1つとしてどれだけ最新の gem を使っているかを数値化して使えないだろうかと考えていました。 そこで社内の他のアプリケーションが使っている gem のバージョンと比較してどれくらい上位にあるかのポイントを独自の基準で計算して、Up-to-date Point という数値として表示するようにしました。

https://github.com/cookpad/gem_collector/blob/v1.0.0/app/models/gem_collector/repository.rb#L17-L53

以下のスクリーンショットは GemCollector を動かしているアプリケーションでの実際の例です。概ね最大値である 1.0 に近い値になっていますが、社内で Rails 5.1.0.rc1 を使っているアプリケーションがあるため、Rails 系の gem に対するポイントは 1.0 ではなくなっています。

また、登録されている各リポジトリのポイントを日次で InfluxDB に入れることで、Grafana でリポジトリ毎のポイントの推移を確認できるようにしています。 見易さのために比較的良いスコア (> 0.8) と悪いスコア (< 0.5) に分けて閲覧できるようにしています。

Up-to-date Point はまだ実験的な値で、社内で適用したところ大まかな指標としては間違っていなさそうですが、まだまだ改善点は多そうです。 たとえばこの方法だと、社内で利用者が少ない gem の場合に高得点になりがちです。そのアプリケーションでしか使ってない gem の場合、バージョンに関係なくその gem に対するポイントは 1.0 になってしまいます。 RubyGems.org では週次の PostgreSQL のダンプデータを公開しており、これを利用することでより正確に gem の最新度を見積もれるかもしれません。 https://rubygems.org/pages/data

まとめ

社内のアプリケーションが使っている gem の情報を集める GemCollector と、それの利用シーンについて紹介しました。 GemCollector は単純なしくみですが、これによって見えるようになった情報はとても役に立っています。 GemCollector のようにアプリケーションに関するデータを集め、それを見える状態にしたり数値化してみるのはいかがでしょうか。