サイロ化した金融システムを、packwerk を利用して無事故でリファクタリングした話

by coincheck

Slide 1

Slide 1 text

サイロ化した金融システムを、packwerkを利用して無事故でリファクタリングした話 Kota Kusama 2024/10/26

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

©2024 Coincheck Inc. 暗号資産取引サービス「Coincheck」 5 国内最大級の顧客基盤、本人確認済210万のユーザーが利用暗号資産取引の”ファースト口座” IEO/INOのリーディングカンパニー ● 使いやすいUI/UX ● 5年連続アプリDL数国内No.1* ● 国内IEO 6例のうち3例を実施** ● INO（Initial NFT Offering）実績4件 *対象：国内の暗号資産取引アプリ期間：2019年1月〜2023年12月　データ協力：App Tweak **2024年9月末現在

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

©2024 Coincheck Inc. 9 背景コインチェックのプロダクトは、大きく分けても10を超えている ● 日本円入出金 ● 暗号資産入出金 ● 販売所 ● 取引所 ● Coincheck IEO ● Coincheck NFT ● Coincheckつみたて ● Coincheckリワード ● Coincheck OnRamp ● Coincheckでんき・ガス ● 貸暗号資産 ● …etc

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

©2024 Coincheck Inc. 19 どう集約するべきか以下の要因からモジュラーモノリス構造を選択 ● マイクロサービス？ ○ 現状のDB構成や、アーキテクチャ変更による品質担保の観点から非現実的 ○ ある程度のコードの視認性は維持しておきたい ● 共通クラス？ ○ 共通クラス化はされている部分もあった ○ 使用方法の不明確さやドメイン毎の仕様により、クラス内にメソッドが乱立する状態に ● モジュラーモノリス ○ インフラ部分に影響することなく構成を試すことができる ○ 関心の分離を行いつつ、一定の視認性を維持することができる

Slide 20

Slide 20 text

©2024 Coincheck Inc. 20 どう集約するべきか以下の要因からpackwerkを採用 ● 実態は静的解析なので本番に影響を与えない ● 依存関係の検知ができる ● パブリックアクセス領域の設定 ○ 不必要なロジックへの参照を制限できる ● コード移動のみでモジュール化が実現できて認知負荷が低め ○ Railsエンジンも同じメリットはあるものの、上述の依存検知、パブリック領域設定の点で優位

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

©2024 Coincheck Inc. 29 関連gem：packwerk-extensions packwerkで検知する違反を拡充させるgem ● メインはプライバシーチェッカー ● パッケージ内にパブリック領域/パブリッククラスの定義を行い、非パブリック領域への参照を違反として検知 ● パブリック領域の定義方法は下記 ○ publicディレクトリ内にコード類を配置する ○ ファイルの先頭5行に宣言コメントを追加認可ロジックへの直接参照を制限する目的で、この違反検知を有効化している

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

©2024 Coincheck Inc. 42 packwerkの良い点既存動作に極力影響を与えない構造 ● packwerk自体は静的解析なので、本番環境に影響を与えない ● ただし、パッケージ化するにあたってディレクトリ構造を変える必要がある ○ 本来は手動でzeitwerkのオートロードパス追加をする必要があるところ、 packs-railsは起動プロセスをフックして自動的に追加する、とREADMEに記載されている Setting up packs-rails is straightforward. Simply by including packs-rails in your Gemﬁle in all environments, packs-rails will automatically hook into and conﬁgure Rails. →ちょっと見えなくて怖い、ので少し深堀り

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

©2024 Coincheck Inc. このpath個々に対して、パッケージのルートパスを結合して追加をしている 50 packs-railsがやっていること Packs::Rails.conﬁg.pathsの中身はこんな感じ以上の処理がbefore_conﬁguration内で行われるので、後続のzeitwerk によるオートロード対象となり、パッケージ配下のファイルが読み込まれる packs-rails.rb

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

Slide 54

Slide 54 text

©2024 Coincheck Inc. rails/engine/conﬁguration.rb 54 packs-railsがやっていること @app.pathsの中には元々値が入っている packs-railsで注入した各パッケージのパスと、globオプションをもとに、下記のようなカスタムディレクトリやconcernsディレクトリがzeitwerkのオートロードパスに設定される - packs/authorization/models/concerns - packs/authorization/services

Slide 55

Slide 55 text

Slide 56

Slide 56 text

©2024 Coincheck Inc. 56 packwerkの良い点（あらためて） ● 構造 ○ packwerk自体は静的解析なので、本番環境に影響を与えない ○ packs-railsを併用することで、ディレクトリ構造を変更するだけでモジュラーモノリス構造、パッケージ化を安全・低コストに試すことができる ● 機能 ○ パブリック領域の設定ができる ○ 依存関係を制限できる（現状では有用な役割とはなっていない）

Slide 57

Slide 57 text

Slide 58

Slide 58 text

Slide 59

Slide 59 text

Slide 60

Slide 60 text

©2024 Coincheck Inc. 60 packwerkで防ぎきれない観点、とその対策モノリス側で再び同じようなロジックが作成されることを機械的に防ぐことはできない ● まずは全体認知が必要 ○ 各チームへの説明 ○ README.mdの整備 ● 機械的に検知もしたい ○ 今回のケースは、パッケージ内で判定しているステータスの参照をカスタム copを用いて検知 ○ カスタムcop検知を監視するため、リリース時点での rubocop指摘をBigQueryに蓄積し、 LookerStudioで監視する仕組みも整備

Slide 61

Slide 61 text

Slide 62

Slide 62 text

Slide 63

Slide 63 text

Slide 64

Slide 64 text

©2024 Coincheck Inc. 64 まとめ packwerkを利用した認可ロジックの集約で・・・ ● 取引可否の判定をするならココ、という目印ができた👍 ● サービス全体で仕様を横串で確認することが容易になった👍 ● ドメインロジックの複雑度が下がった👍 ● 新しいプロダクトでも認可ロジックの適用がしやすくなった👍 ○ 実績もあり ● 既存プロダクトの仕様変更もしやすくなった👍 ○ 実績もあり ● 巨大なコードベースに対する安全なリファクタリングツールとしてのpackwerkのメリットが見えた👍