トークルームがメッセージを持っているかどうかにより発生するN+1問題。

Question

前提・実現したいこと

LINEの様なメッセージ機能を実装しました。
モデルは下記にて記載致しますが、UserとMessageモデルがEntryとRoomと言う中間テーブルを持っています。
ユーザーが他のユーザーとのトークルームを作成した時点で空のEntryが作成されますが、Messageを持たないEntryはトークルーム一覧画面(rooms/index.html.erb)には表示しないようにしています。

メッセージのやり取りや表示関連は既に実装出来ているのですが、N+1問題に関して一つ問題点があります。(尚、N+1問題解決の為にBulletと言うgemを使用し、問題が感知された場合はポップアップが表示されるようになっています。)

MessageのないEntryを持つユーザーがrooms/index.html.erbを表示すると、以下のポップアップが表示されます。

AVOID eager loading detected
  Entry => [:user]
  Remove from your query: .includes([:user])
Call stack

こちらはrooms_controller.rbにおいて、N+1問題を避けるためにEntry.includes(:room, :user)としている箇所があるのですが、この:user部分を省けと言われているようです。

しかし、通常Messageを持ったEntryで構成されたトークルーム一覧画面(rooms/index.html.erb)を表示する際、N+1問題を避けるために.includes(:user)は必要になります。

ですのでこれを省くと、Messageを持たないEntryを抱えているユーザーのページ上では問題が解決しますが、Messageを持つEntryのみを抱えているユーザーのページ上では、当然以下の様に逆に怒られます。

Use eager loading detected
  Entry => [:user]
  Add from your query: .includes([:user]) # :user 部分を付け加えて下さい。
Call stack

該当のソースコード

user.rb

class User < ApplicationRecord
  has_many :messages, dependent: :destroy
  has_many :entries, dependent: :destroy
  has_many :rooms, through: :entries
end

entry.rb

class Entry < ApplicationRecord
  belongs_to :user
  belongs_to :room
  
  has_many :messages, through: :room
end

room.rb

class Room < ApplicationRecord
  has_many :messages, dependent: :destroy
  has_many :entries, dependent: :destroy
  has_many :users, through: :entries
end

message.rb

class Message < ApplicationRecord
  validates :content, {presence: true}
  belongs_to :user
  belongs_to :room
  
  has_one :entry, through: :room
end

rooms_controller.rb

  private
  def set_another_entries
    # ログイン中のユーザーの持つEntryを配列にする。
    my_room_ids = @current_user.entries.pluck(:room_id)
    # 上で定義した「ログイン中のユーザーの持つEntry」の内、自分以外の相手一覧を表示する。
    @another_entries = Entry.includes(:room, :user).where(room_id: my_room_ids).where('entries.user_id != ?', @current_user.id)    
    
    @entries = @another_entries.includes(:messages).to_a # エントリーを配列にする。
      .reject {|entry| entry.messages.blank?} # messageデータのないエントリーは表示において除外する。
      .sort_by {|entry| entry.messages.order(created_at: :desc).first.created_at} # messageが作成された順で並べ替える。
      .reverse # Entryを降順に表示する。
  end

試したこと

そもそも、Messageがあるかないかでなぜ:userの部分が引っ掛かるのかがよく分かりませんでした。
「Nilでない場合のみ実行する」と言う意味合いで以下の様に&.を用いて記述してみたりもしましたが、ダメでした…。

rooms_controller.rb

@another_entries = Entry&.includes(:room, :user).where(room_id: my_room_ids).where('entries.user_id != ?', @current_user.id)

どなたかご助言を頂けますと有難いです。

補足情報（FW/ツールのバージョンなど）

ruby 2.6.4p104
RubyGems 3.0.3
Rails 5.2.3

Answer 1

こちらはrooms_controller.rbにおいて、N+1問題を避けるためにEntry.includes(:room, :user)としている箇所があるのですが、この:user部分を省けと言われているようです。

「Eager Loadした先を全く使わない」という条件が実用上ほぼ発生しないのであれば、無視して構いません。下手に条件分岐を入れてメンテナンス性が下がるほうが厄介な問題となる危険が大きいです。

Comments

[maisumakun]

AVOID eager loadingを気にすべきなのは、ロードしたものの全く、あるいはほぼ使わないときだけで大丈夫です。

[punchan36]

有難うございます！

「Eager Loadした先」とは、私の場合で言いますと各トークルームのユーザーやメッセージ情報で、これは繰り返し処理の回数分きちんと参照されるので記述はそのままで良い、と言う事でしょうか。

「Eager Loadした先を全く使わない」と言う状況がイメージ出来ませんでした…。
全く関係のないテーブル情報を間違ってincludeしてしまっている場合などでしょうか？

[maisumakun]

> 全く関係のないテーブル情報を間違ってincludeしてしまっている場合などでしょうか？

はい、そういう場合です（後からビューの側を改変したなどで、使わないものが残ってしまうことがあります）。

[punchan36]

有難うございました。
ポップアップが表示された事で条件反射で編集に走ってしまいました。

大抵の場合、マストで考えなければならないのはUSE eager loadingの方ですね。勉強になりました！