今月末に、クリアコード20周年記念Meatupが開催¹されます。

設立20周年を記念するこのイベントではクリアコード年表公開！#cc20thとアナウンスがあったように、 コンテンツの1つとして「クリアコード年表」というアプリを公開しています。

「クリアコード年表」は設立してからクリアコードがどのようにフリーソフトウェアとビジネスの両立をしてきたかを、タイムラインで表示するものです。

自由にコメントを寄せてもらえるように、年表アプリにアカウント連携のしくみを導入しました。 今回は、年表アプリへのアカウント連携組み込みのさわりを紹介します。

どのアカウントと連携できるようにするか

クリアコードは、これまでさまざまな自由な（場合によっては不自由なこともある）ソフトウェアの開発に関わってきました。 そのため、GitLabとのアカウント連携ははずせません。 実際、自分たちでもGitLabのインスタンスを運用して活用しています。²

クリアコードとこれまで関わりのあったお客さんは、かならずしもGitLabに馴染みがあるとは限りません。より間口を広げるため、GitHubのアカウント連携にも対応することにしました。²

どのようにアカウント連携を実現するか

今回実装した20周年アプリは、普段触っていない技術で作ってみようということで、Rails 8を採用しました。 20周年記念イベント開催までの限定された期間だけ稼働する予定のものなので、素早く立ち上げられることが 大事だったからです。

社内にはRubyに詳しい人も多いので、みんなであれこれいじりやすいだろうという目論見もありました。

アカウント連携については、Devise + OmniAuthに落ち着きました。 以下のようなgemを利用することで、比較的低コストで実現できました。

...
gem 'omniauth-gitlab'
gem 'omniauth-github'
gem 'omniauth-google-oauth2'
gem 'devise-jwt'

今から思えば、 組み込みの認証ジェネレータとOmniAuthを組み合わせたほうがシンプルに実現できた気もします。

今回のアカウント連携での知見としては次のようなものがありました。

• GitLabとセルフホストしているGitLabのインスタンス双方のアカウント連携を実現するにはどうするとよいか
• 複数のアカウント連携を実現するにはどのようなテーブル設計にするとよいか
• アカウント連携の可否を決定するプロバイダー側のアプリをどのように登録するとよいか

1つめのセルフホスト版のGitLabとのアカウント連携については

• config/initializers/devise.rb: クエリ文字列をみてセルフホスト版か区別しコールバック先を振り分ける
• app/controllers/users/omniauth_callbacks_controller.rb: プロバイダー共通のメソッドを用意してセッションで振り分ける

といった工夫が必要でした。

2つめのテーブル設計については、アカウント連携を実現する対象となるプロバイダーと、プロバイダーにおけるUIDの組み合わせを一意に特定するための いわゆる中間テーブルを導入しました。これにより、年表アプリに様々なアカウントからログインできるようになりました。

3つめの、プロバイダー側のアプリについては、プラットフォームごとに流儀がばらばらであることがわかりました。

GitHubの場合は、Developer SettingsのOAuth Appsとしてアプリを登録します。

GitLabの場合は、User SettingsのApplicationsにアプリを登録します。 このとき、アプリにはread_userおよびopenidの権限を付与します。

Googleの場合、Google Cloud Consoleにプロジェクトを作成し、作成したプロジェクトのAPIとサービスに ある認証情報ページにて「認証情報を作成」から「OAuthクライアントID」を選択することでアプリを登録できます。 公開ステータスも適宜設定する必要があり、既定のテスト公開の状態だと外部のアカウント連携に制限がかかることもわかりました。

さいごに

今回は、クリアコード年表アプリへのアカウント連携を組み込むにあたってのさわりの知見を紹介しました。 コード自体は自由なライセンスで公開しています。

ぜひ皆さんのクリアコードにまつわるエピソードを年表アプリへとコメントしてみてください。

年表アプリは、https://20th.clear-code.com/ にて公開しています。

• クリアコード20周年記念Meatupを7月29日に開催するよ！ #cc20th
• クリアコード年表公開！#cc20th
• ただのログ収集じゃない！クリアコード年表アプリを支えるFluentd + eBPF活用術 #cc20th

ツイートする

フォローする