Skip to content

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

DEV: Add plugin APIs to preload data for `/user-cards.json` (#45213)

Arpit Jalan116844c193f4
diff --git a/app/controllers/users_controller.rb b/app/controllers/users_controller.rb
index ff3b6828b99..95a4dac5898 100644
--- a/app/controllers/users_controller.rb
+++ b/app/controllers/users_controller.rb
@@ -199,9 +199,13 @@ class UsersController < ApplicationController
preload_fields =
User.allowed_user_custom_fields(guardian) +
- UserField.all.pluck(:id).map { |fid| "#{User::USER_FIELD_PREFIX}#{fid}" }
+ UserField.all.pluck(:id).map { |fid| "#{User::USER_FIELD_PREFIX}#{fid}" } +
+ DiscoursePluginRegistry.user_cards_preloaded_custom_fields
User.preload_custom_fields(users, preload_fields)
User.preload_recent_time_read(users)
+ DiscoursePluginRegistry.user_cards_preloaders.each do |preloader|
+ preloader.call(users, guardian)
+ end
render json: users, each_serializer: UserCardSerializer
end
diff --git a/lib/discourse_plugin_registry.rb b/lib/discourse_plugin_registry.rb
index b68a7a52e38..3b3658236ac 100644
--- a/lib/discourse_plugin_registry.rb
+++ b/lib/discourse_plugin_registry.rb
@@ -96,6 +96,8 @@ class DiscoursePluginRegistry
define_filtered_register :topic_thumbnail_sizes
define_filtered_register :topic_preloader_associations
define_filtered_register :category_list_topics_preloader_associations
+ define_filtered_register :user_cards_preloaded_custom_fields
+ define_filtered_register :user_cards_preloaders
define_filtered_register :api_parameter_routes
define_filtered_register :api_key_scope_mappings
diff --git a/lib/plugin/instance.rb b/lib/plugin/instance.rb
index a9eb1b28531..bedba50a6d2 100644
--- a/lib/plugin/instance.rb
+++ b/lib/plugin/instance.rb
@@ -355,6 +355,46 @@ class Plugin::Instance
TopicList.on_preload_user_ids(enabled: method(:enabled?), &block)
end
+ # Preloads a user custom field for the users serialized by `/user-cards.json`,
+ # so it can be read while serializing them without N+1 queries. It is not
+ # added to the response.
+ #
+ # The field is preloaded under its string name, so read it with a string key
+ # (`user.custom_fields["field_name"]`). A symbol key raises a NotPreloadedError.
+ #
+ # @param field [String, Symbol] The name of the user custom field.
+ #
+ # @example
+ # register_user_cards_preloaded_custom_field(:card_theme)
+ #
+ # @return [void]
+ def register_user_cards_preloaded_custom_field(field)
+ DiscoursePluginRegistry.register_user_cards_preloaded_custom_field(field.to_s, self)
+ end
+
+ # Allows plugins to load data for all the users serialized by `/user-cards.json`
+ # at once, instead of querying per user in their serializer attributes. The
+ # block runs after core has preloaded the users' associations and custom fields.
+ #
+ # @yieldparam users [Array<User>] The users that will be serialized.
+ # @yieldparam guardian [Guardian] The guardian of the requesting user.
+ #
+ # @example
+ # add_to_class(:user, :muted_by_current_user=) { |muted| @muted_by_current_user = muted }
+ # add_to_class(:user, :muted_by_current_user) { @muted_by_current_user }
+ #
+ # register_user_cards_preloader do |users, guardian|
+ # next if guardian.anonymous?
+ #
+ # muted_ids = guardian.user.muted_users.where(id: users.map(&:id)).pluck(:id)
+ # users.each { |user| user.muted_by_current_user = muted_ids.include?(user.id) }
+ # end
+ #
+ # @return [void]
+ def register_user_cards_preloader(&block)
+ DiscoursePluginRegistry.register_user_cards_preloader(block, self)
+ end
+
# Allow to eager load additional tables in Search. Useful to avoid N+1 performance problems.
# Example usage:
# register_search_topic_eager_load do |opts|
diff --git a/spec/requests/users_controller_spec.rb b/spec/requests/users_controller_spec.rb
index 801f7e3393f..f11721922e2 100644
--- a/spec/requests/users_controller_spec.rb
+++ b/spec/requests/users_controller_spec.rb
@@ -6137,6 +6137,51 @@ RSpec.describe UsersController do
expect(parsed.map { |u| u["username"] }).to contain_exactly(user.username, user2.username)
end
end
+
+ context "when plugins register user cards preloaders" do
+ let(:plugin) { Plugin::Instance.new }
+ let(:preloaded) { [] }
+
+ before do
+ user2.upsert_custom_fields("plugin_field" => "plugin value")
+
+ plugin.register_user_cards_preloaded_custom_field(:plugin_field)
+ plugin.register_user_cards_preloader do |users, guardian|
+ users.each do |card_user|
+ preloaded << [card_user.id, card_user.custom_fields["plugin_field"], guardian.user&.id]
+ end
+ end
+ end
+
+ after do
+ DiscoursePluginRegistry.reset_register!(:user_cards_preloaded_custom_fields)
+ DiscoursePluginRegistry.reset_register!(:user_cards_preloaders)
+ end
+
+ it "passes the visible users to the preloaders with plugin custom fields preloaded" do
+ hidden_user = Fabricate(:user)
+ hidden_user.user_option.update_columns(hide_profile: true)
+ sign_in(another_user)
+
+ get "/user-cards.json?user_ids=#{user.id},#{user2.id},#{hidden_user.id}"
+
+ expect(response.status).to eq(200)
+ expect(preloaded).to contain_exactly(
+ [user.id, nil, another_user.id],
+ [user2.id, "plugin value", another_user.id],
+ )
+ expect(response.parsed_body["users"].map { |card| card["custom_fields"] }).to all(be_blank)
+ end
+
+ it "skips preloaders of disabled plugins" do
+ allow(plugin).to receive(:enabled?).and_return(false)
+
+ get "/user-cards.json?user_ids=#{user.id},#{user2.id}"
+
+ expect(response.status).to eq(200)
+ expect(preloaded).to be_empty
+ end
+ end
end
describe "#badges" do