ApplicationController の継承を分割してエラーを減らした話/dividing-application-controller

Transcript

1. ApplicationController の 継承を分割して エラーを減らした話 森塚 真年(@sanfrecce_osaka) 2024/03/01 Wantedly x Qiita Meetup #2 Ruby を用いたプロダクト開発 #wantedly_qiita_meetup
2. 自己紹介 森塚 真年 GitHub: @sanfrecce-osaka Twitter(X): @sanfrecce_osaka Qiita: @sanfrecce_osaka from: 大阪府枚方市 趣味: コミュニティ・勉強会 株式会社エンペイ Ruby3.2/Rails7.0 Node.js v18/Vue.js 3.3/Vuetify 3.4
3. 前提 : この発表での ApplicationController について 具象コントローラの基底クラスを ApplicationController と呼称 呼び分けが面倒なので便宜上 基底クラスを継承した基底クラスも API の基底ク ラスも ApplicationController 長いので AC という略称も使います
4. 本編
5. こんなことありませんか？
6. 例 : mastdon(v4.2.8)
7. class ApplicationController < ActionController::Base # 略 # if/unless/only/except オプション 😇 before_action :store_referrer, except: :raise_not_found, if: :devise_controller? before_action :require_functional!, if: :user_signed_in? before_action :set_cache_control_defaults # skip_before_action 😇 skip_before_action :verify_authenticity_token, only: :raise_not_found # 略 end
8. # AC を継承した AC 😇 class Disputes::BaseController < ApplicationController # 略 # 継承先の AC で skip_before_action 😇 skip_before_action :require_functional! before_action :set_body_classes before_action :authenticate_user! before_action :set_cache_headers # 略 end
9. # AC を継承した AC を継承した AC 😇 class Settings::ApplicationsController < Settings::BaseControl before_action :set_application, only: [:show, :update, :destroy, :regenerate] before_action :prepare_scopes, only: [:create, :update] # 略 end
10. module Settings module TwoFactorAuthentication class ConfirmationsController < BaseController # 略 # 具象コントローラで skip_before_action 😇 skip_before_action :require_functional! before_action :require_challenge! before_action :ensure_otp_secret # 略 end end end
11. つらい 😹 AC が関心を持ちすぎている 異なるユースケースの関心が含まれている リスコフの置換原則が守られていない 結果、色んなところで分岐が発生する
12. enpay でも頻発 障害 バグ 修正漏れ
13. どのように解決するのか 責務ごとに境界を区切る 境界ごとに AC を作成する AC の直接の親クラスは ActionController::Base API の場合は ActionController::API 境界ごとにインターフェース( パス) を統一する
14. module や namespace で 境界を区切る resources :payments, module: :payments do resources :histories end namespece: :account do resources :settings end
15. 境界ごとに ApplicationController を作成
16. module Payments class ApplicationController < ActionController::Base before_action :validate_params before_action :authenticate_account! before_action :authorize! # 略
17. private # 共通の振る舞いがない場合は空実装 def validate_params end def authorize! # 具象コントローラで共通の処理 end end end
18. module Accounts class ApplicationController < ActionController::Base # 重複は許容。共通化したい場合は module や concern に切り出す before_action :validate_params before_action :authenticate_account! before_action :authorize! # 略
19. private # 共通の振る舞いがない場合は空実装 def validate_params end def authorize! # 具象コントローラで共通の処理 end end end
20. ユースケースごとに異なる場合 module Payments class HistoriesController < ApplicatonController # 略 private # 共通の振る舞いがない場合はオーバーライド def validate_params # 具象コントローラ個別の処理 end def authorize! super # 共通処理を呼び出す # 具象コントローラ個別の処理 end
21. 境界を切る基準 URL( パス) payments/{payment_id} URL( パス) をインターフェースと捉える 認証 認可 ロギング キャッシュ エラー監視 layout の指定 etc
22. 境界を分けていけば どの選択肢も選べそう！ そのまま モジュラモノリス Rails エンジン
23. やってみて
24. うまくいったこと コードを読み書きする際に考えることが減った 疎結合 分岐減 単純な構成なので理解しやすい Sentry の通知や障害も減った AC で責務ごとの規約・関心を表現できる
25. 一方
26. やりたかったこと id の部分のインターフェースを統一させたい module( ディレクトリ) ごとに AC を作りたい
27. # こう書けるとスッキリするが /payments/{payment_id} ではなく # /payments/{id} になる resources :payments, module: :payments do # ここは /payments/{payment_id} resources :histories end
28. # param を使って指定すると /payments/{payment_id} になるが resources :payments, param: :payment_id, module: :payments do # ここが /payments/{payment_payment_id} になってしまう 　resources :histories end
29. # これでもいけるけど # module: :payments を 2回 書くのも嫌なので・・・ resources :payments, param: :payment_id, module: :payments resources :payments, only: [], module: :payments do resources :histories end
30. scope module: :payments do # 最終的にこんな形に resources :payments, param: :payment_id resources :payments, only: [] do resources :histories end end
31. ご清聴 ありがとうございました