定数参照のトラップとそれを回避するために行う2つのこと / Kaigi on Rails 2023

by hogucc

Slide 1

Slide 1 text

定数参照のトラップとそれを回避するために行う2 つのこと Kaigi on Rails 2023 OGUCHI Haruka @hogucc

Slide 2

Slide 2 text

フィヨルドブートキャンプ卒業生株式会社エンペイで働いていますエンペイでは主に教育業界の集金業務のキャッシュレス化・DX 化を実現するenpay というプロダクトを開発しています今年は弊社もKaigi on Rails のスポンサーとして協賛させていただいております🎉 Haruka Oguchi @hogucc

Slide 3

Slide 3 text

Part 1 定数参照のハマりどころを理解するための前提知識の共有 Part 2 ハマりどころをしくみで回避する方法の模索トークの概要 Ruby やRails 初心者の方向けのトークです

Slide 4

Slide 4 text

参照したかったのとは違う定数を参照してしまった！ ... ってことありませんか？

Slide 5

Slide 5 text

uninitialized constant エラーが発生することで気づける指定した定数が定義されていなかったそのまま別の値が参照されてしまったらエラーにならないので気づきづらい別の定数が参照されてしまった意図した定数参照になっていない原因

Slide 6

Slide 6 text

実行してみるまで結果がわからないのってスリルありませんか？最悪そのまま本番環境へデプロイされて障害が発生...

Slide 7

Slide 7 text

Ruby やRails の定数探索のしくみを理解する Ruby やRails のしくみを知る意図しない定数参照を回避するために私たちができること意図した定数を参照するようなしくみを作る知識のしくみ化

Slide 8

Slide 8 text

Ruby やRails の定数探索のしくみを理解する

Slide 9

Slide 9 text

Ruby ではアルファベットの大文字から始まる名前が定数として扱われる Rails のcontroller 名やmodel 名もクラスなので定数クラス名やモジュール名も定数

Slide 10

Slide 10 text

定数の読み込み定数の参照定数の探索ここから遡って説明します定数が取得されるまでの大まかな流れ

Slide 11

Slide 11 text

定数が参照されているスコープ外側のスコープ（トップレベルは除く）スーパークラス Ruby の定数探索アルゴリズムトップレベル

Slide 12

Slide 12 text

定数が参照されているスコープ外側のスコープ（トップレベルは除く）スーパークラス Ruby の定数探索アルゴリズムトップレベル見つからなかったらエラーを返す

Slide 13

Slide 13 text

MY_CONSTANT = "I’m from the top level scope" module MyModule MY_CONSTANT = "I’m from the my module scope" class ParentClass MY_CONSTANT = "I’m from the super class scope” end class MyClass < ParentClass MY_CONSTANT = "I’m from the current scope” def self.show_constant puts MY_CONSTANT end end end Ruby の定数探索アルゴリズム

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

定数の読み込み定数の参照定数の探索次はここ定数の値が参照されるまでのざっくりとした流れ

Slide 20

Slide 20 text

Ruby の定数参照のパターン :: をつけずに参照する定数の間に:: をつけて参照する先頭に :: をつけてトップレベルから参照する例）Zoo 例）Zoo::Animals 例）::Zoo 1 2 3

Slide 21

Slide 21 text

MY_CONSTANT = "Top Level Constant" module MyModule MY_CONSTANT = "Current Level Constant" puts ::MY_CONSTANT end 先頭に:: をつけてトップレベルから探索する “Top Level Constant” が出力される

Slide 22

Slide 22 text

定数の読み込み定数の参照定数の探索次はここ定数の値が参照されるまでのざっくりとした流れ

Slide 23

Slide 23 text

require やload は不要同一ファイル内の定数を読み込む require やload が必要別ファイルの定数を読み込む定数の読み込み autoload で定数が初めて参照されたときに定数が定義されたファイルを読み込むことができる

Slide 24

Slide 24 text

require "application_controller" require "user" class UsersController < ApplicationController def index @users = User.all end end require は必要ない！ Rails のautoload

Slide 25

Slide 25 text

app 配下に後から追加したカスタムディレクトリも対象デフォルトではapp 配下のassets, javascript, views を除くすべてのサブディレクトリが対象 Q. なぜrequire がいらないのか A. Rails のconfig.autoload_paths に設定されたパスは自動読み込みの対象になるため

Slide 26

Slide 26 text

autoload のメリット 1 2 3 開発環境ではアプリを再起動しなくてもコードの変更がリアルタイムに反映されるファイル名とクラス名の不整合があればロード時に検出される本番環境ではアプリケーション起動時にすべてのコードを読み込む。都度ロードを挟まないことでパフォーマンスを最適化

Slide 27

Slide 27 text

autoload のメリット 1 2 3 開発環境ではアプリを再起動しなくてもコードの変更がリアルタイムに反映されるファイル名とクラス名の不整合があればロード時に検出される本番環境ではアプリケーション起動時にすべてのコードを読み込む。都度ロードを挟まないことでパフォーマンスを最適化 Zeitwerk というコードローダーが定数のロードを担っている

Slide 28

Slide 28 text

定数参照のハマりどころをしくみで回避

Slide 29

Slide 29 text

# app/controllers/user/notifications_controller.rb class User::NotificationsController < ApplicationController def index roles = User::ROLES end end # app/models/user.rb class User < ApplicationRecord ROLES = ["member", "guest"] end 定数参照の失敗例① model のUser::ROLES を参照したかったのに controller のUser が参照されエラーになってしまった... ～階層化していたcontroller の名前空間とmodel のクラス名が被ってしまったケース～

Slide 30

Slide 30 text

# app/controllers/user/notifications_controller.rb class User::NotificationsController < ApplicationController def index roles = User::ROLES end end # app/models/user.rb class User < ApplicationRecord ROLES = ["member", "guest"] end 定数参照の失敗例① ～階層化していたcontroller の名前空間とmodel のクラス名が被ってしまったケース～ ::User::ROLES のようにトップレベルから参照すればOK

Slide 31

Slide 31 text

module Wrapper module Aws class S3 def self.upload_file s3 = Aws::S3::Client.new(region: ‘xxxx’) end end end end 定数参照の失敗例② 〜名前空間がネストしたモジュールやクラス〜 unitialized constant Wrapper::Aws::S3::Client というエラーが発生🥺 Aws::S3::Client はgem に定義されたクラス

Slide 32

Slide 32 text

module Wrapper module Aws class S3 def self.upload_file s3 = Aws::S3::Client.new(region: ‘xxxx’) end end end end 定数参照の失敗例② 〜名前空間がネストしたモジュールやクラス〜 Wrapper::Aws::S3 とみなされて、Client という定数は存在しない、とエラーになっていた💦 Wrapper まで辿って Aws::S3 を発見！

Slide 33

Slide 33 text

マージされた内容をテストテスト環境ユーザーが使う環境本番環境 Pull Request をマージ開発環境開発→テスト→エラー発見→開発→またテスト... エラー発生😢 修正 OK! エラーになった箇所はこの環境から参照される

Slide 34

Slide 34 text

マージされた内容をテストテスト環境ユーザーが使う環境本番環境 Pull Request をマージ開発環境開発→テスト→エラー発見→開発→またテスト... エラー発生😢 修正 OK! エラーになった箇所はこの環境から参照される開発環境の時点で気づきたかった... ！さっき見たこの知識があれば気づけた！ ... かも？

Slide 35

Slide 35 text

class S3 def self.upload_file s3 = Aws::S3::Client.new(region: ‘xxxx’) end end 絶対に気づける... ？もともとはS3 というクラスで、後から Wrapper::Aws::S3 という名前空間が切られたとしたら気づける... ？複数箇所の定数を一度に直した後、別の定数が参照されていることに気づける...? 自分さえ間違えなければそれでいい... ？

Slide 36

Slide 36 text

gem を作りました

Slide 37

Slide 37 text

いま参照している定数がどの定数としてRuby に認識されているかを知りたい gem で実現したいこと定数の候補を出力してほしい全ての定数の先頭に :: をつけることを強制しても解決はできそうですが、やりたいことに対してオーバーキルしている感があり、やめました意図せず別の定数参照しちゃってた問題を解決別の名前空間の定数も検索

Slide 38

Slide 38 text

いま参照している定数がどの定数としてRuby に認識されているかを知りたい定数の候補を出力してほしい ConstantVision.search("HOGE", "Fuga::Piyo") # => origin: xxx, candidates: ["yyy", "zzz"] constant_vision というgem を作りました https://github.com/hogucc/constant_vision

Slide 39

Slide 39 text

No content

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

①知識をつける ②しくみで解決するトラップを回避するために行う2 つのこと技術で問題解決するのは楽しい！同じ問題を抱えた他の誰かも幸せになれるかも

Slide 42

Slide 42 text

Thank you!