Skip to content

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

PERF: Add Users to Group Improvements Pt. 2 (#38901)

Bannon Tanner0acfe07701b9
diff --git a/app/controllers/groups_controller.rb b/app/controllers/groups_controller.rb
index 86ea757438d..79456108a0a 100644
--- a/app/controllers/groups_controller.rb
+++ b/app/controllers/groups_controller.rb
@@ -415,7 +415,7 @@ class GroupsController < ApplicationController
notify = params[:notify_users]&.to_s == "true"
uniq_users = users.uniq
- uniq_users.each { |user| add_user_to_group(group, user, notify) }
+ add_users_to_group(group, uniq_users, notify)
group_ids = [group.id]
@@ -479,7 +479,7 @@ class GroupsController < ApplicationController
raise Discourse::InvalidAccess unless group.public_admission
return if group.users.exists?(id: current_user.id)
- add_user_to_group(group, current_user)
+ add_users_to_group(group, [current_user])
end
def handle_membership_request
@@ -572,23 +572,25 @@ class GroupsController < ApplicationController
raise Discourse::InvalidParameters.new("user_ids or usernames or user_emails must be present")
end
- removed_users = []
- skipped_users = []
+ removed_user_ids = GroupManager.new(group).remove(users.map(&:id))
+ GroupActionLogger.new(current_user, group).bulk_log_remove_users_from_group(removed_user_ids)
+
+ removed_usernames = []
+ skipped_usernames = []
users.each do |user|
- if group.remove(user)
- removed_users << user.username
- GroupActionLogger.new(current_user, group).log_remove_user_from_group(user)
+ if removed_user_ids.include?(user.id)
+ removed_usernames << user.username
else
if group.users.exclude? user
- skipped_users << user.username
+ skipped_usernames << user.username
else
raise Discourse::InvalidParameters
end
end
end
- render json: success_json.merge!(usernames: removed_users, skipped_usernames: skipped_users)
+ render json: success_json.merge!(usernames: removed_usernames, skipped_usernames:)
end
def leave
@@ -785,14 +787,13 @@ class GroupsController < ApplicationController
private
- def add_user_to_group(group, user, notify = false)
- group.add(user)
- GroupActionLogger.new(current_user, group).log_add_user_to_group(user)
- group.notify_added_to_group(user) if notify
- rescue ActiveRecord::RecordNotUnique
- # Under concurrency, we might attempt to insert two records quickly and hit a DB
- # constraint. In this case we can safely ignore the error and act as if the user
- # was added to the group.
+ def add_users_to_group(group, users, notify = false)
+ user_ids = users.map(&:id)
+ added_user_ids = GroupManager.new(group).add(user_ids)
+ GroupActionLogger.new(current_user, group).bulk_log_add_users_to_group(added_user_ids)
+ if notify && added_user_ids.present?
+ Jobs.enqueue(:notify_users_added_to_group, user_ids: added_user_ids, group_id: group.id)
+ end
end
def group_params(automatic: false)
diff --git a/app/jobs/regular/notify_users_added_to_group.rb b/app/jobs/regular/notify_users_added_to_group.rb
new file mode 100644
index 00000000000..5d2f2042335
--- /dev/null
+++ b/app/jobs/regular/notify_users_added_to_group.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Jobs
+ class NotifyUsersAddedToGroup < ::Jobs::Base
+ def execute(args)
+ user_ids = args[:user_ids]
+ group_id = args[:group_id]
+ return if group_id.blank? || user_ids.blank?
+
+ group = Group.find_by(id: group_id)
+ return if group.nil?
+
+ User.where(id: user_ids).find_each { |user| group.notify_added_to_group(user) }
+ end
+ end
+end
diff --git a/app/models/group.rb b/app/models/group.rb
index 783d56dc2be..c20d3c35398 100644
--- a/app/models/group.rb
+++ b/app/models/group.rb
@@ -856,140 +856,11 @@ class Group < ActiveRecord::Base
end
def bulk_add(user_ids, automatic: false)
- return [] if user_ids.blank?
-
- added_user_ids = nil
-
- Group.transaction do
- sql = <<~SQL
- INSERT INTO group_users
- (group_id, user_id, notification_level, created_at, updated_at)
- SELECT
- :group_id,
- u.id,
- :notification_level,
- CURRENT_TIMESTAMP,
- CURRENT_TIMESTAMP
- FROM users AS u
- WHERE u.id IN (:user_ids)
- AND NOT EXISTS (
- SELECT 1 FROM group_users AS gu
- WHERE gu.user_id = u.id AND
- gu.group_id = :group_id
- )
- RETURNING user_id
- SQL
-
- added_user_ids =
- DB.query_single(
- sql,
- group_id: self.id,
- user_ids: user_ids,
- notification_level: self.default_notification_level,
- )
-
- return [] if added_user_ids.blank?
-
- if self.primary_group?
- User
- .where(id: added_user_ids)
- .where("flair_group_id IS NOT DISTINCT FROM primary_group_id")
- .update_all(flair_group_id: self.id)
-
- DB.exec(<<~SQL, user_ids: added_user_ids, new_title: self.title)
- UPDATE users u
- SET title = :new_title
- WHERE u.id IN (:user_ids)
- AND u.primary_group_id IS NOT NULL
- AND EXISTS (
- SELECT 1 FROM groups g
- WHERE g.id = u.primary_group_id
- AND g.title = u.title
- )
- SQL
-
- User.where(id: added_user_ids).update_all(primary_group_id: self.id)
- end
-
- if self.title.present?
- User.where(id: added_user_ids, title: [nil, ""]).update_all(title: self.title)
- end
-
- Group.update_counters(self.id, user_count: added_user_ids.size)
- end
-
- if self.grant_trust_level.present? && !self.grant_trust_level.zero?
- Jobs.enqueue(
- :bulk_grant_trust_level,
- user_ids: added_user_ids,
- trust_level: self.grant_trust_level,
- )
- end
-
- GroupUser.bulk_set_category_notifications(self, added_user_ids)
- GroupUser.bulk_set_tag_notifications(self, added_user_ids)
-
- User.where(id: added_user_ids).find_each { |user| trigger_user_added_event(user, automatic) }
-
- bulk_publish_category_updates(added_user_ids)
-
- added_user_ids
+ GroupManager.new(self).add(user_ids, automatic:)
end
def bulk_remove(user_ids)
- return [] if user_ids.blank?
-
- group_users_to_remove = group_users.where(user_id: user_ids)
- return [] if group_users_to_remove.empty?
-
- removed_user_ids = group_users_to_remove.pluck(:user_id)
-
- webhook_payloads = build_user_removed_webhook_payloads(group_users_to_remove)
-
- Group.transaction do
- group_users.where(user_id: removed_user_ids).delete_all
-
- User.where(primary_group_id: self.id, id: removed_user_ids).update_all(primary_group_id: nil)
- User.where(flair_group_id: self.id, id: removed_user_ids).update_all(flair_group_id: nil)
-
- if self.title.present?
- DB.exec(<<~SQL, user_ids: removed_user_ids, title: self.title)
- UPDATE users u
- SET title = NULL
- WHERE u.id IN (:user_ids)
- AND u.title = :title
- AND NOT EXISTS (
- SELECT 1 FROM group_users gu
- JOIN groups g ON g.id = gu.group_id
- WHERE gu.user_id = u.id
- AND g.title IS NOT NULL AND g.title <> ''
- )
- AND NOT EXISTS (
- SELECT 1 FROM user_badges ub
- JOIN badges b ON b.id = ub.badge_id
- WHERE ub.user_id = u.id
- AND b.allow_title = true
- )
- SQL
-
- User
- .where(id: removed_user_ids, title: self.title)
- .find_each { |user| user.update_column(:title, user.next_best_title) }
- end
-
- Group.update_counters(self.id, user_count: -removed_user_ids.size)
- end
-
- if self.grant_trust_level.present? && !self.grant_trust_level.zero?
- Jobs.enqueue(:bulk_grant_trust_level, user_ids: removed_user_ids, recalculate: true)
- end
-
- bulk_publish_category_updates(removed_user_ids)
-
- User.where(id: removed_user_ids).find_each { |user| trigger_user_removed_event(user) }
- enqueue_user_removed_webhook_events(webhook_payloads)
-
- removed_user_ids
+ GroupManager.new(self).remove(user_ids)
end
def recalculate_user_count
@@ -1291,43 +1162,6 @@ class Group < ActiveRecord::Base
private
- def bulk_publish_category_updates(user_ids)
- return if user_ids.blank?
- return unless categories.exists?
-
- if user_ids.size == 1
- user = User.find(user_ids.first)
- publish_category_updates(user)
- else
- Discourse.request_refresh!(user_ids:)
- end
- end
-
- def build_user_removed_webhook_payloads(group_users_relation)
- return unless WebHook.active_web_hooks(:group_user)
-
- payloads = []
- group_users_relation.find_each do |gu|
- payloads << {
- id: gu.id,
- payload: WebHook.generate_payload(:group_user, gu, WebHookGroupUserSerializer),
- }
- end
- payloads
- end
-
- def enqueue_user_removed_webhook_events(webhook_payloads)
- webhook_payloads&.each do |webhook_payload|
- WebHook.enqueue_hooks(
- :group_user,
- :user_removed_from_group,
- id: webhook_payload[:id],
- payload: webhook_payload[:payload],
- group_ids: [self.id],
- )
- end
- end
-
def send_membership_notification(user)
Notification.create!(
notification_type: Notification.types[:membership_request_accepted],
@@ -1336,26 +1170,6 @@ class Group < ActiveRecord::Base
)
end
- def publish_category_updates(user)
- if categories.count < PUBLISH_CATEGORIES_LIMIT
- guardian = Guardian.new(user)
- group_categories = categories.map { |c| Category.set_permission!(guardian, c) }
- updated_categories = group_categories.select(&:permission)
- removed_category_ids = group_categories.reject(&:permission).map(&:id)
-
- MessageBus.publish(
- "/categories",
- {
- categories: ActiveModel::ArraySerializer.new(updated_categories).as_json,
- deleted_categories: removed_category_ids,
- },
- user_ids: [user.id],
- )
- else
- Discourse.request_refresh!(user_ids: [user.id])
- end
- end
-
def validate_grant_trust_level
unless TrustLevel.valid?(self.grant_trust_level)
self.errors.add(
diff --git a/app/services/group_action_logger.rb b/app/services/group_action_logger.rb
index b547ae4f51d..2278fac13ea 100644
--- a/app/services/group_action_logger.rb
+++ b/app/services/group_action_logger.rb
@@ -25,23 +25,19 @@ class GroupActionLogger
end
def log_add_user_to_group(target_user, subject = nil)
- GroupHistory.create!(
- default_params.merge(
- action: GroupHistory.actions[:add_user_to_group],
- target_user: target_user,
- subject: subject,
- ),
- )
+ bulk_log_add_users_to_group([target_user.id], subject)
end
def log_remove_user_from_group(target_user, subject = nil)
- GroupHistory.create!(
- default_params.merge(
- action: GroupHistory.actions[:remove_user_from_group],
- target_user: target_user,
- subject: subject,
- ),
- )
+ bulk_log_remove_users_from_group([target_user.id], subject)
+ end
+
+ def bulk_log_add_users_to_group(target_user_ids, subject = nil)
+ bulk_log(target_user_ids, :add_user_to_group, subject)
+ end
+
+ def bulk_log_remove_users_from_group(target_user_ids, subject = nil)
+ bulk_log(target_user_ids, :remove_user_from_group, subject)
end
def log_change_group_settings
@@ -78,4 +74,23 @@ class GroupActionLogger
def default_params
{ group: @group, acting_user: @acting_user }
end
+
+ def bulk_log(target_user_ids, action, subject = nil)
+ return if target_user_ids.blank?
+
+ now = Time.now
+ GroupHistory.insert_all!(
+ target_user_ids.map do |user_id|
+ {
+ group_id: @group.id,
+ acting_user_id: @acting_user.id,
+ target_user_id: user_id,
+ action: GroupHistory.actions[action],
+ created_at: now,
+ updated_at: now,
+ subject: subject,
+ }
+ end,
+ )
+ end
end
diff --git a/lib/group_manager.rb b/lib/group_manager.rb
index e1f2b4e3b48..67c95bb26f8 100644
--- a/lib/group_manager.rb
+++ b/lib/group_manager.rb
@@ -1,19 +1,219 @@
# frozen_string_literal: true
class GroupManager
- include HasErrors
-
def initialize(group)
@group = group
end
def add(user_ids, automatic: false)
return [] if user_ids.blank?
- @group.bulk_add(user_ids, automatic:)
+
+ added_user_ids = bulk_add_transaction(user_ids)
+ return [] if added_user_ids.blank?
+
+ if @group.grant_trust_level.present? && [email protected]_trust_level.zero?
+ Jobs.enqueue(
+ :bulk_grant_trust_level,
+ user_ids: added_user_ids,
+ trust_level: @group.grant_trust_level,
+ )
+ end
+
+ GroupUser.bulk_set_category_notifications(@group, added_user_ids)
+ GroupUser.bulk_set_tag_notifications(@group, added_user_ids)
+
+ User
+ .where(id: added_user_ids)
+ .find_each { |user| @group.trigger_user_added_event(user, automatic) }
+
+ bulk_publish_category_updates(added_user_ids)
+
+ added_user_ids
end
def remove(user_ids)
return [] if user_ids.blank?
- @group.bulk_remove(user_ids)
+
+ group_users_to_remove = @group.group_users.where(user_id: user_ids)
+ return [] if group_users_to_remove.empty?
+
+ removed_user_ids = group_users_to_remove.pluck(:user_id)
+
+ webhook_payloads = build_user_removed_webhook_payloads(group_users_to_remove)
+
+ bulk_remove_transaction(removed_user_ids)
+
+ if @group.grant_trust_level.present? && [email protected]_trust_level.zero?
+ Jobs.enqueue(:bulk_grant_trust_level, user_ids: removed_user_ids, recalculate: true)
+ end
+
+ bulk_publish_category_updates(removed_user_ids)
+
+ User.where(id: removed_user_ids).find_each { |user| @group.trigger_user_removed_event(user) }
+ enqueue_user_removed_webhook_events(webhook_payloads)
+
+ removed_user_ids
+ end
+
+ private
+
+ def bulk_add_transaction(user_ids)
+ added_user_ids = nil
+
+ Group.transaction do
+ sql = <<~SQL
+ INSERT INTO group_users
+ (group_id, user_id, notification_level, created_at, updated_at)
+ SELECT
+ :group_id,
+ u.id,
+ :notification_level,
+ CURRENT_TIMESTAMP,
+ CURRENT_TIMESTAMP
+ FROM users AS u
+ WHERE u.id IN (:user_ids)
+ AND NOT EXISTS (
+ SELECT 1 FROM group_users AS gu
+ WHERE gu.user_id = u.id AND
+ gu.group_id = :group_id
+ )
+ ON CONFLICT (group_id, user_id) DO NOTHING
+ RETURNING user_id
+ SQL
+
+ added_user_ids =
+ DB.query_single(
+ sql,
+ group_id: @group.id,
+ user_ids: user_ids,
+ notification_level: @group.default_notification_level,
+ )
+
+ return added_user_ids if added_user_ids.blank?
+
+ if @group.primary_group?
+ User
+ .where(id: added_user_ids)
+ .where("flair_group_id IS NOT DISTINCT FROM primary_group_id")
+ .update_all(flair_group_id: @group.id)
+
+ DB.exec(<<~SQL, user_ids: added_user_ids, new_title: @group.title)
+ UPDATE users u
+ SET title = :new_title
+ WHERE u.id IN (:user_ids)
+ AND u.primary_group_id IS NOT NULL
+ AND EXISTS (
+ SELECT 1 FROM groups g
+ WHERE g.id = u.primary_group_id
+ AND g.title = u.title
+ )
+ SQL
+
+ User.where(id: added_user_ids).update_all(primary_group_id: @group.id)
+ end
+
+ if @group.title.present?
+ User.where(id: added_user_ids, title: [nil, ""]).update_all(title: @group.title)
+ end
+
+ Group.update_counters(@group.id, user_count: added_user_ids.size)
+ end
+
+ added_user_ids
+ end
+
+ def bulk_remove_transaction(removed_user_ids)
+ Group.transaction do
+ @group.group_users.where(user_id: removed_user_ids).delete_all
+
+ User.where(primary_group_id: @group.id, id: removed_user_ids).update_all(
+ primary_group_id: nil,
+ )
+ User.where(flair_group_id: @group.id, id: removed_user_ids).update_all(flair_group_id: nil)
+
+ if @group.title.present?
+ DB.exec(<<~SQL, user_ids: removed_user_ids, title: @group.title)
+ UPDATE users u
+ SET title = NULL
+ WHERE u.id IN (:user_ids)
+ AND u.title = :title
+ AND NOT EXISTS (
+ SELECT 1 FROM group_users gu
+ JOIN groups g ON g.id = gu.group_id
+ WHERE gu.user_id = u.id
+ AND g.title IS NOT NULL AND g.title <> ''
+ )
+ AND NOT EXISTS (
+ SELECT 1 FROM user_badges ub
+ JOIN badges b ON b.id = ub.badge_id
+ WHERE ub.user_id = u.id
+ AND b.allow_title = true
+ )
+ SQL
+
+ User
+ .where(id: removed_user_ids, title: @group.title)
+ .find_each { |user| user.update_column(:title, user.next_best_title) }
+ end
+
+ Group.update_counters(@group.id, user_count: -removed_user_ids.size)
+ end
+ end
+
+ def publish_category_updates(user)
+ if @group.categories.count < Group::PUBLISH_CATEGORIES_LIMIT
+ guardian = Guardian.new(user)
+ group_categories = @group.categories.map { |c| Category.set_permission!(guardian, c) }
+ updated_categories = group_categories.select(&:permission)
+ removed_category_ids = group_categories.reject(&:permission).map(&:id)
+
+ MessageBus.publish(
+ "/categories",
+ {
+ categories: ActiveModel::ArraySerializer.new(updated_categories).as_json,
+ deleted_categories: removed_category_ids,
+ },
+ user_ids: [user.id],
+ )
+ else
+ Discourse.request_refresh!(user_ids: [user.id])
+ end
+ end
+
+ def bulk_publish_category_updates(user_ids)
+ return if user_ids.blank?
+ return unless @group.categories.exists?
+
+ if user_ids.size == 1
+ user = User.find(user_ids.first)
+ publish_category_updates(user)
+ else
+ Discourse.request_refresh!(user_ids:)
+ end
+ end
+
+ def build_user_removed_webhook_payloads(group_users_relation)
+ return unless WebHook.active_web_hooks(:group_user)
+
+ payloads = []
+ group_users_relation.find_each do |group_user|
+ payloads << {
+ id: group_user.id,
+ payload: WebHook.generate_payload(:group_user, group_user, WebHookGroupUserSerializer),
+ }
+ end
+ payloads
+ end
+
+ def enqueue_user_removed_webhook_events(webhook_payloads)
+ webhook_payloads&.each do |webhook_payload|
+ WebHook.enqueue_hooks(
+ :group_user,
+ :user_removed_from_group,
+ id: webhook_payload[:id],
+ payload: webhook_payload[:payload],
+ group_ids: [@group.id],
+ )
+ end
end
end
diff --git a/spec/lib/group_manager_spec.rb b/spec/lib/group_manager_spec.rb
index 62ded50137c..16fcf195e2a 100644
--- a/spec/lib/group_manager_spec.rb
+++ b/spec/lib/group_manager_spec.rb
@@ -8,7 +8,7 @@ RSpec.describe GroupManager do
subject(:manager) { GroupManager.new(group) }
describe "#add" do
- it "delegates to group.bulk_add and returns added user IDs" do
+ it "adds users to group and returns added user IDs" do
result = manager.add([user.id, user2.id])
expect(result).to contain_exactly(user.id, user2.id)
@@ -19,21 +19,12 @@ RSpec.describe GroupManager do
expect(manager.add([])).to eq([])
expect(manager.add(nil)).to eq([])
end
-
- it "passes automatic flag through to bulk_add" do
- events =
- DiscourseEvent.track_events(:user_added_to_group) do
- manager.add([user.id], automatic: true)
- end
-
- expect(events.first[:params][2][:automatic]).to eq(true)
- end
end
describe "#remove" do
- before { group.bulk_add([user.id, user2.id]) }
+ before { manager.add([user.id, user2.id]) }
- it "delegates to group.bulk_remove and returns removed user IDs" do
+ it "removes users from group and returns removed user IDs" do
result = manager.remove([user.id, user2.id])
expect(result).to contain_exactly(user.id, user2.id)
diff --git a/spec/requests/groups_controller_spec.rb b/spec/requests/groups_controller_spec.rb
index 86a51716851..18952c10fb7 100644
--- a/spec/requests/groups_controller_spec.rb
+++ b/spec/requests/groups_controller_spec.rb
@@ -1662,6 +1662,8 @@ RSpec.describe GroupsController do
end
it "notifies users when the param is present" do
+ Jobs.run_immediately!
+
expect {
put "/groups/#{group.id}/members.json",
params: {
diff --git a/spec/services/group_action_logger_spec.rb b/spec/services/group_action_logger_spec.rb
index 120f6603e4e..4a33533c250 100644
--- a/spec/services/group_action_logger_spec.rb
+++ b/spec/services/group_action_logger_spec.rb
@@ -93,6 +93,61 @@ RSpec.describe GroupActionLogger do
end
end
+ describe "#bulk_log_add_users_to_group" do
+ fab!(:user2, :user)
+
+ it "creates a record for each user" do
+ expect { logger.bulk_log_add_users_to_group([user.id, user2.id]) }.to change {
+ GroupHistory.where(action: GroupHistory.actions[:add_user_to_group]).count
+ }.by(2)
+
+ records =
+ GroupHistory.where(action: GroupHistory.actions[:add_user_to_group], group: group).last(2)
+
+ expect(records.map(&:acting_user)).to all(eq(group_owner))
+ expect(records.map(&:target_user)).to contain_exactly(user, user2)
+ end
+
+ it "does nothing when target_users is empty" do
+ expect { logger.bulk_log_add_users_to_group([]) }.not_to change { GroupHistory.count }
+ end
+
+ it "forwards the subject when present" do
+ logger.bulk_log_add_users_to_group([user.id], "added_users")
+
+ expect(GroupHistory.last.subject).to eq("added_users")
+ end
+ end
+
+ describe "#bulk_log_remove_users_from_group" do
+ fab!(:user2, :user)
+
+ it "creates a record for each user" do
+ expect { logger.bulk_log_remove_users_from_group([user.id, user2.id]) }.to change {
+ GroupHistory.where(action: GroupHistory.actions[:remove_user_from_group]).count
+ }.by(2)
+
+ records =
+ GroupHistory.where(
+ action: GroupHistory.actions[:remove_user_from_group],
+ group: group,
+ ).last(2)
+
+ expect(records.map(&:acting_user)).to all(eq(group_owner))
+ expect(records.map(&:target_user)).to contain_exactly(user, user2)
+ end
+
+ it "does nothing when target_users is empty" do
+ expect { logger.bulk_log_remove_users_from_group([]) }.not_to change { GroupHistory.count }
+ end
+
+ it "forwards the subject when present" do
+ logger.bulk_log_remove_users_from_group([user.id], "remove_users")
+
+ expect(GroupHistory.last.subject).to eq("remove_users")
+ end
+ end
+
describe "#log_group_creation" do
subject(:log_creation) { logger.log_group_creation }