Skip to content

Commit

Permalink
FIX: Send TL2 promotion message to correct user (discourse#21978)
Browse files Browse the repository at this point in the history
Usually, when a user is promoted to TL2 two messages are sent. The
first one is a system message 'tl2_promotion_message' which triggers a
'system_message_sent' Discourse event.

When the event is fired and if Discourse Narrative Bot is enabled, then
a second message is sent to the recipient of the first message. The
recipients was determined by looking at the list of users that can
access that topic and pick the last one. This method does not work if
'site_contact_group_name' site setting is set because it adds the group
in the list of recipients.

A solution to this problem would have been to select the last user in
the list of 'topic_allowed_users', but an even better solution is to
pass the name of the recipients when the 'system_message_sent'
Discourse event is fired.
  • Loading branch information
nbianca authored Jun 7, 2023
1 parent 928589a commit 10ee926
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 3 deletions.
7 changes: 6 additions & 1 deletion lib/system_message.rb
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,12 @@ def create(type, params = {})

post = I18n.with_locale(@recipient.effective_locale) { creator.create }

DiscourseEvent.trigger(:system_message_sent, post: post, message_type: type)
DiscourseEvent.trigger(
:system_message_sent,
post: post,
message_type: type,
recipient: @recipient,
)

raise StandardError, creator.errors.full_messages.join(" ") if creator.errors.present?

Expand Down
3 changes: 1 addition & 2 deletions plugins/discourse-narrative-bot/plugin.rb
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,7 @@ def avatar_url(user)
next if !SiteSetting.discourse_narrative_bot_enabled
next if args[:message_type] != "tl2_promotion_message"

recipient = args[:post].topic.topic_users.where.not(user_id: args[:post].user_id).last&.user
recipient ||= Discourse.site_contact_user if args[:post].user == Discourse.site_contact_user
recipient = args[:recipient]
next if recipient.nil?

I18n.with_locale(recipient.effective_locale) do
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -831,6 +831,7 @@
:system_message_sent,
post: Post.last,
message_type: "tl2_promotion_message",
recipient: recipient,
)
}.to change { Topic.count }
expect(Topic.last.title).to eq(
Expand All @@ -849,6 +850,7 @@
:system_message_sent,
post: Post.last,
message_type: "tl2_promotion_message",
recipient: recipient,
)
}.to change { Topic.count }
expect(Topic.last.title).to eq(
Expand Down Expand Up @@ -879,11 +881,25 @@
:system_message_sent,
post: Post.last,
message_type: "tl2_promotion_message",
recipient: recipient,
)
}.to change { Topic.count }

topic = Topic.last
expect(topic.title).to eq("german title")
expect(topic.first_post.raw).to eq("german body")
end

it "invites the correct user when users in site_contact_group_name are invited to the system message" do
recipient = Fabricate(:user)
group = Fabricate(:group)
group.add(Fabricate(:user))
SiteSetting.site_contact_group_name = "#{group.name}"

SystemMessage.new(recipient).create("tl2_promotion_message", {})

expect(Topic.last.topic_users.map(&:user_id).sort).to eq(
[DiscourseNarrativeBot::Base.new.discobot_user.id, recipient.id],
)
end
end
1 change: 1 addition & 0 deletions spec/lib/system_message_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
expect(event[:event_name]).to eq(:system_message_sent)
expect(event[:params].first[:post]).to eq(Post.last)
expect(event[:params].first[:message_type]).to eq(:tl2_promotion_message)
expect(event[:params].first[:recipient]).to eq(user)
end

it "sends an event before the system message is sent" do
Expand Down

0 comments on commit 10ee926

Please sign in to comment.