そろそろ理解する includes / Understanding includes

RubyKaigi 2024 直前LT祭の発表スライドです。
https://timeedev.connpass.com/event/315946/

スライド内の includes クイズを手元で動かすためのスクリプト：
https://gist.github.com/euglena1215/fb6cd1235278491dc206b9bd6feaf71e

Transcript

1. 2024/05/10　RubyKaigi 2024 直前LT祭 株式会社タイミー　新谷哲平 そろそろ理解する includes @euglena1215
2. 自己紹介 新谷 哲平（@euglena1215） • 株式会社タイミー • バックエンド テックリード ◦ 2024/04/01~ New! • GWにRBS入門しました
3. 自己紹介 新谷 哲平（@euglena1215） • 株式会社タイミー • バックエンド テックリード ◦ 2024/04/01~ New! • GWにRBS入門しました
4. RBS という名前を聞いて パッと思いつく型（方）は... 突然ですが
6. 宣伝 Ruby AST に親しみがない人向け Ruby AST を見たときに身構えないようになることがゴール。
7. 宣伝 Ruby AST に親しみがない人向け Ruby AST を見たときに身構えないようになることがゴール。 タイミーはRBSやっていくぞ！ 💪 💪 💪
8. 宣伝 Ruby AST に親しみがない人向け Ruby AST を見たときに身構えないようになることがゴール。
9. 2024/05/10　RubyKaigi 2024 直前LT祭 株式会社タイミー　新谷哲平 そろそろ理解する includes @euglena1215
10. みなさんに質問 AR::Relation#includes 使ってますか？
11. みなさんに質問 - 使っている方 AR::Relation#includesの 挙動を理解して使っていますか？
12. みなさんに質問 - 使っていない方 AR::Relation#includesの挙動を 理解した上で使わない選択をしてますか？
13. 自分のincludesに対する認識 内部的にいい感じに preload と eager_load を使い分けてるんでしょ？ どう使い分けてるかよく知らないし、 とりあえず preload 使っとくか...
14. こうなりたい AR::Relation#includesの挙動を完全理解！ コードを読めばどんなクエリが 発行されるか一発でわかる！
15. 1 結論
16. ひとことでまとめるの無理でした 😢 これからクイズ形式でincludesの挙動を一緒に理解しましょう！ 結論
17. 2 includes クイズ
18. サンプルコードを表示するのでどんなクエリが発行されるか考えてみましょう！ こちらから手元で動かすことができます https://gist.github.com/euglena1215/fb6cd1235278491dc206b9bd6feaf71e includes クイズ
19. クイズで使われるコードのモデル定義はこんな感じ includes クイズ
20. includes クイズ① Q. どんなクエリが発行されるでしょうか？
21. includes クイズ① Q. どんなクエリが発行されるでしょうか？ A. preload 相当の分割されたクエリが発行される
22. 1. 全てのケース → preload 判定ルール
23. includes クイズ② Q. どんなクエリが発行されるでしょうか？
24. includes クイズ② Q. どんなクエリが発行されるでしょうか？ ここがポイント！
25. includes で指定したフィールドを使って絞り込みたいときに使うメソッド 📝 references ってなんだ？
26. includes で指定したフィールドを使って絞り込みたいときに使うメソッド 📝 references ってなんだ？ ただし、where に文字列ではなくHashで渡せば references は省略可能
27. includes クイズ② Q. どんなクエリが発行されるでしょうか？
28. includes クイズ② Q. どんなクエリが発行されるでしょうか？ A. eager_load 相当の LEFT OUTER JOIN で結合されたクエリ
29. 1. 全てのケース → preload 判定ルール
30. 1. includes 先に references を使っている → eager_load 2. それ以外 → preload 判定ルール
31. 1. includes 先に references を使っている → eager_load 2. includes 先に joins を使っている → eager_load 3. それ以外 → preload 判定ルール joins も同じ挙動
32. includes クイズ③ Q. どんなクエリが発行されるでしょうか？
33. includes クイズ③ Q. どんなクエリが発行されるでしょうか？ ここがポイント！
34. includes クイズ③ Q. どんなクエリが発行されるでしょうか？ A. LEFT OUTER JOIN で結合しつつ、comments.id = 1 での絞り込みが行われる
35. 1. includes 先に references を使っている → eager_load 2. includes 先に joins を使っている → eager_load 3. それ以外 → preload 判定ルール
36. 1. includes 先に references を使っている → eager_load 2. includes 先に joins を使っている → eager_load 3. includes 先で絞り込みを Hash 形式で行っている → eager_load 4. それ以外 → preload 判定ルール
37. includes クイズ④ Q. どんなクエリが発行されるでしょうか？
38. includes クイズ④ Q. どんなクエリが発行されるでしょうか？ ここがポイント！
39. includes クイズ④ Q. どんなクエリが発行されるでしょうか？ A. author も eager_load 相当の LEFT OUTER JOIN で結合される
40. includes クイズ④ Q. どんなクエリが発行されるでしょうか？ A. author も eager_load 相当の LEFT OUTER JOIN で結合される preload と同様 author(user) は クエリが分割されるものだと思ってました 😇
41. 1. includes 先に references を使っている → eager_load 2. includes 先に joins を使っている → eager_load 3. includes 先で絞り込みを Hash 形式で行っている → eager_load 4. それ以外 → preload 判定ルール
42. 1. includes 先に references を使っている → eager_load 2. includes 先に joins を使っている → eager_load 3. includes 先で絞り込みを Hash 形式で1つ以上行っている → 全部 eager_load 4. それ以外 → preload 判定ルール
43. 1. includes 先に references を1つ以上使っている → 全部 eager_load 2. includes 先に joins を1つ以上使っている → 全部 eager_load 3. includes 先で絞り込みを Hash 形式で1つ以上行っている → 全部 eager_load 4. それ以外 → preload 判定ルール references, joins も同様の挙動
44. includes クイズ⑤ Q. どんなクエリが発行されるでしょうか？
45. includes クイズ⑤ Q. どんなクエリが発行されるでしょうか？ ここがポイント！
46. includes クイズ⑥ Q. どんなクエリが発行されるでしょうか？ A. author も eager_load 相当の LEFT OUTER JOIN での結合が行われる
47. 1. includes 先に references を1つ以上使っている → 全部 eager_load 2. includes 先に joins を1つ以上使っている → 全部 eager_load 3. includes 先で絞り込みを Hash 形式で1つ以上行っている → 全部 eager_load 4. それ以外 → preload 判定ルール
48. 1. includes 先に references を1つ以上使っている → 全部 eager_load 2. includes 先に joins を1つ以上使っている → 全部 eager_load 3. includes 先で絞り込みを Hash 形式で1つ以上行っている → 全部 eager_load 4. eager_load を併用している → 全部 eager_load 5. それ以外 → preload 判定ルール
49. 1. includes 先に references を1つ以上使っている → 全部 eager_load 2. includes 先に joins を1つ以上使っている → 全部 eager_load 3. includes 先で絞り込みを Hash 形式で1つ以上行っている → 全部 eager_load 4. eager_load を併用している → 全部 eager_load 5. それ以外 → preload 判定ルール 完成 🎉🎉🎉 したはず...間違いあればこっそり教えてください
50. 1. includes 先に references を1つ以上使っている → 全部 eager_load 2. includes 先に joins を1つ以上使っている → 全部 eager_load 3. include先で絞り込みを Hash形式で1つ以上行っている → 全部 eager_load 4. eager_load を併用している → 全部 eager_load 5. それ以外 → preload 判定ルール 完成 🎉🎉🎉 したはず...間違いあればこっそり教えてください このルール結構厳しくない？🤔
51. includes クイズ 仮にこういった実装がされているとすると... preload 相当の複数のクエリ（3つ）が発行される
52. includes クイズ 例えば何かの機能変更で eager_load を追加すると...
53. includes クイズ⑤ includes 先のフィールドを1つ使って絞り込むよう変更すると... 巨大な1つのクエリに💥
54. 1つのクエリになって問題ある？ • パフォーマンスの制御が困難 ◦ クエリが大きく変化するので、利用するインデックスも変化するかも
55. 1つのクエリになって問題ある？ • パフォーマンスの制御が困難 ◦ クエリが大きく変化するので、利用するインデックスも変化するかも • 変化に本番リリース前に気付くのが難しい ◦ 普段発行されるクエリを検証するテストを書いていますか？ ◦ 十分なデータ量がないQA環境で試しても問題が顕在化しないかも
56. 1つのクエリになって問題ある？ • パフォーマンスの制御が困難 ◦ クエリが大きく変化するので、利用するインデックスも変化するかも • 変化に本番リリース前に気付くのが難しい ◦ 普段発行されるクエリを検証するテストを書いていますか？ ◦ 十分なデータ量がないQA環境で試しても問題が顕在化しないかも • そもそもこのクエリを意図していた？
57. 1つのクエリになって問題ある？ • 実行計画が大きく変化する ◦ 突然パフォーマンスが急激に悪化する可能性 • 実装者が本番リリース前に気付くのが難しい ◦ 自動テストは通ってしまう 個人的にはこちらを期待していた
58. • いずれかのルールによって突然全てが eager_load 相当として扱われ、 1つのクエリになるのは大変厳しい • パフォーマンス上の意図がなければ基本的には preload を使い、同時に絞り 込みを行いたいときだけ eager_load を使う方が無難そう • includes が部分的に preload 相当の挙動をしてくれるといいな... 🥺 自分の考え
59. • いずれかのルールによって突然全てが eager_load 相当として扱われ、 1つのクエリになるのは大変厳しい • パフォーマンス上の意図がなければ基本的には preload を使い、同時に絞り 込みを行いたいときだけ eager_load を使う方が無難そう • includes が部分的に preload 相当の挙動をしてくれるといいな... 🥺 自分の考え みなさんのincludesへの向き合い方を ぜひXで教えてください！ #RubyKaigi2024_直前LT祭