Skip to content

A platform for community discussion. Free, open, simple.

DEV: Apply consistent N+1 fix pattern to ThreadOriginalMessageSerializer (#38667)

Isaac Janzend8330dab1000
diff --git a/plugins/chat/app/queries/chat/messages_query.rb b/plugins/chat/app/queries/chat/messages_query.rb
index 7dfcea64a6b..b0632249d6a 100644
--- a/plugins/chat/app/queries/chat/messages_query.rb
+++ b/plugins/chat/app/queries/chat/messages_query.rb
@@ -106,12 +106,20 @@ module Chat
.includes(:bookmarks)
.includes(uploads: { optimized_videos: :optimized_upload })
.includes(chat_channel: :chatable)
- .includes(thread: %i[original_message last_message])
.includes(:pinned_message)
.where(chat_channel_id: channel.id)
user_includes = SiteSetting.enable_user_status ? %i[user_status user_option] : %i[user_option]
- query.includes(user: user_includes, user_mentions: { user: user_includes })
+ query.includes(
+ user: user_includes,
+ user_mentions: {
+ user: user_includes,
+ },
+ thread: {
+ original_message: [{ user: user_includes }, { user_mentions: { user: user_includes } }],
+ last_message: [:uploads, { user: user_includes }],
+ },
+ )
end
def self.query_around_target(target_message_id, channel, messages)
diff --git a/plugins/chat/app/serializers/chat/thread_original_message_serializer.rb b/plugins/chat/app/serializers/chat/thread_original_message_serializer.rb
index 1e1bbab3653..953e9418dfe 100644
--- a/plugins/chat/app/serializers/chat/thread_original_message_serializer.rb
+++ b/plugins/chat/app/serializers/chat/thread_original_message_serializer.rb
@@ -19,10 +19,8 @@ module Chat
def mentioned_users
object
.user_mentions
- .includes(user: :user_option)
- .limit(SiteSetting.max_mentions_per_chat_message)
- .map(&:user)
- .compact
+ .first(SiteSetting.max_mentions_per_chat_message)
+ .filter_map(&:user)
.sort_by(&:id)
.map { |user| BasicUserSerializer.new(user, root: false, include_status: true) }
.as_json
diff --git a/plugins/chat/app/services/chat/lookup_thread.rb b/plugins/chat/app/services/chat/lookup_thread.rb
index 26851a6be56..12332037371 100644
--- a/plugins/chat/app/services/chat/lookup_thread.rb
+++ b/plugins/chat/app/services/chat/lookup_thread.rb
@@ -34,10 +34,16 @@ module Chat
private
def fetch_thread(params:)
+ user_includes = SiteSetting.enable_user_status ? %i[user_status user_option] : %i[user_option]
+
Chat::Thread.includes(
:channel,
original_message_user: :user_status,
- original_message: :chat_webhook_event,
+ original_message: [
+ :chat_webhook_event,
+ { user: user_includes },
+ { user_mentions: { user: user_includes } },
+ ],
).find_by(id: params.thread_id, channel_id: params.channel_id)
end
diff --git a/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb b/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb
index 03befe970a7..fd4b0c27ac6 100644
--- a/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb
+++ b/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb
@@ -106,6 +106,29 @@ RSpec.describe Chat::Api::ChannelMessagesController do
expect(user_option_queries.size).to eq(2)
end
+
+ it "preloads thread original message mentions to avoid N+1 queries" do
+ channel.update!(threading_enabled: true)
+
+ 3.times do
+ original_message = Fabricate(:chat_message, chat_channel: channel)
+ thread = Fabricate(:chat_thread, channel: channel, original_message: original_message)
+ mentioned = Fabricate(:user)
+ mentioned.set_status!("status", "wave")
+ Fabricate(:user_chat_mention, chat_message: original_message, user: mentioned)
+ reply =
+ Fabricate(:chat_message, chat_channel: channel, thread: thread, message: "thread reply")
+ thread.update!(last_message: reply)
+ end
+
+ get "/chat/api/channels/#{channel.id}/messages"
+
+ queries = track_sql_queries { get "/chat/api/channels/#{channel.id}/messages" }
+ mention_queries =
+ queries.select { |q| q.include?('"chat_mentions"') && q.include?("chat_message_id") }
+
+ expect(mention_queries.size).to eq(1)
+ end
end
end
diff --git a/plugins/chat/spec/requests/chat/api/channel_threads_controller_spec.rb b/plugins/chat/spec/requests/chat/api/channel_threads_controller_spec.rb
index cb5ceb68ff8..058503b98f8 100644
--- a/plugins/chat/spec/requests/chat/api/channel_threads_controller_spec.rb
+++ b/plugins/chat/spec/requests/chat/api/channel_threads_controller_spec.rb
@@ -41,6 +41,32 @@ RSpec.describe Chat::Api::ChannelThreadsController do
expect(response.parsed_body["thread"]["id"]).to eq(thread.id)
end
+ context "with user status enabled" do
+ before { SiteSetting.enable_user_status = true }
+
+ it "preloads user_options to avoid N+1 queries for original message mentions" do
+ thread.original_message.user.set_status!("status", "grinning")
+
+ 3.times do
+ mentioned_user = Fabricate(:user)
+ mentioned_user.set_status!("status", "wave")
+ Fabricate(
+ :user_chat_mention,
+ chat_message: thread.original_message,
+ user: mentioned_user,
+ )
+ end
+
+ get "/chat/api/channels/#{thread.channel_id}/threads/#{thread.id}"
+
+ queries =
+ track_sql_queries { get "/chat/api/channels/#{thread.channel_id}/threads/#{thread.id}" }
+ user_option_queries = queries.select { |query| query.include?('"user_options"') }
+
+ expect(user_option_queries.size).to eq(2)
+ end
+ end
+
context "when the thread original message is deleted" do
before { thread.original_message.trash! }