discourse/plugins/chat/spec/mailers/user_notifications_spec.rb
Joffrey JAFFEUX 57584c38c0
FIX: correctly uses private_email site setting in chat (#24528)
Chat will now check for the state of `SiteSetting.private_email` when sending the summary, when enabled, the mail will not display user information, channel information other than the ID and no message information, only the count of messages.
2023-11-23 15:54:22 +01:00

722 lines
26 KiB
Ruby
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# frozen_string_literal: true
require "rails_helper"
describe UserNotifications do
fab!(:chatters_group) { Fabricate(:group) }
fab!(:sender) { Fabricate(:user, group_ids: [chatters_group.id]) }
fab!(:user) { Fabricate(:user, group_ids: [chatters_group.id]) }
before do
SiteSetting.chat_enabled = true
SiteSetting.chat_allowed_groups = chatters_group.id
end
def refresh_auto_groups
Group.refresh_automatic_groups!
user.reload
sender.reload
end
describe ".chat_summary" do
context "with private channel" do
fab!(:channel) do
refresh_auto_groups
create_dm_channel(sender, [sender, user])
end
it "calls guardian can_join_chat_channel?" do
Fabricate(:chat_message, user: sender, chat_channel: channel)
Guardian.any_instance.expects(:can_join_chat_channel?).once
email = described_class.chat_summary(user, {})
email.subject
end
describe "email subject" do
context "when private_email setting is enabled" do
before { SiteSetting.private_email = true }
it "has a generic subject" do
Fabricate(:chat_message, user: sender, chat_channel: channel)
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(
I18n.t(
"user_notifications.chat_summary.subject.private_message",
email_prefix: SiteSetting.email_prefix.presence || SiteSetting.title,
),
)
end
end
it "includes the sender username in the subject" do
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.direct_message_from_1",
email_prefix: SiteSetting.title,
username: sender.username,
)
Fabricate(:chat_message, user: sender, chat_channel: channel)
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(expected_subject)
expect(email.subject).to include(sender.username)
end
it "only includes the name of the user who sent the message even if the DM has multiple participants" do
another_participant = Fabricate(:user, group_ids: [chatters_group.id])
Fabricate(
:user_chat_channel_membership_for_dm,
user: another_participant,
chat_channel: channel,
)
Chat::DirectMessageUser.create!(
direct_message: channel.chatable,
user: another_participant,
)
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.direct_message_from_1",
email_prefix: SiteSetting.title,
username: sender.username,
)
Fabricate(:chat_message, user: sender, chat_channel: channel)
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(expected_subject)
expect(email.subject).to include(sender.username)
expect(email.subject).not_to include(another_participant.username)
end
it "includes both usernames when there are exactly two DMs with unread messages" do
another_dm_user = Fabricate(:user, group_ids: [chatters_group.id])
refresh_auto_groups
another_dm_user.reload
another_channel = create_dm_channel(user, [another_dm_user, user])
Fabricate(:chat_message, user: another_dm_user, chat_channel: another_channel)
Fabricate(:chat_message, user: sender, chat_channel: channel)
email = described_class.chat_summary(user, {})
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.direct_message_from_2",
email_prefix: SiteSetting.title,
username1: another_dm_user.username,
username2: sender.username,
)
expect(email.subject).to eq(expected_subject)
expect(email.subject).to include(sender.username)
expect(email.subject).to include(another_dm_user.username)
end
it "displays a count when there are more than two DMs with unread messages" do
user = Fabricate(:user, group_ids: [chatters_group.id])
senders = []
3.times do
sender = Fabricate(:user, group_ids: [chatters_group.id])
refresh_auto_groups
sender.reload
senders << sender
channel = create_dm_channel(sender, [sender, user])
user
.user_chat_channel_memberships
.where(chat_channel_id: channel.id)
.update!(following: true)
Fabricate(:chat_message, user: sender, chat_channel: channel)
end
email = described_class.chat_summary(user, {})
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.direct_message_from_more",
email_prefix: SiteSetting.title,
username: senders.first.username,
count: 2,
)
expect(email.subject).to eq(expected_subject)
end
it "returns an email if the user is not following the direct channel" do
user
.user_chat_channel_memberships
.where(chat_channel_id: channel.id)
.update!(following: false)
Fabricate(:chat_message, user: sender, chat_channel: channel)
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
end
end
end
context "with public channel" do
fab!(:channel) { Fabricate(:category_channel) }
fab!(:chat_message) { Fabricate(:chat_message, user: sender, chat_channel: channel) }
# using fab! for user_membership below makes these specs flaky
let!(:user_membership) do
Fabricate(
:user_chat_channel_membership,
chat_channel: channel,
user: user,
last_read_message_id: chat_message.id - 2,
)
end
before do
channel.add(sender)
channel.update!(last_message: chat_message)
end
it "doesn't return an email if there are no unread mentions" do
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
context "with channel-wide mentions" do
before { Jobs.run_immediately! }
def create_chat_message_with_mentions_and_notifications(content)
# Sometimes it's not enough to just fabricate a message
# and we have to create it like here. In this case all the necessary
# db records for mentions and notifications will be created under the hood.
Chat::CreateMessage.call(
chat_channel_id: channel.id,
guardian: sender.guardian,
message: content,
)
end
it "returns email for @all mention by default" do
create_chat_message_with_mentions_and_notifications("Mentioning @all")
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
end
it "returns email for @here mention by default" do
user.update(last_seen_at: 1.second.ago)
create_chat_message_with_mentions_and_notifications("Mentioning @here")
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
end
context "when channel-wide mentions are disabled in a channel" do
before { channel.update!(allow_channel_wide_mentions: false) }
it "doesn't return email for @all mention" do
create_chat_message_with_mentions_and_notifications("Mentioning @all")
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return email for @here mention" do
user.update(last_seen_at: 1.second.ago)
create_chat_message_with_mentions_and_notifications("Mentioning @here")
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
end
context "when user has disabled channel-wide mentions" do
before { user.user_option.update!(ignore_channel_wide_mention: true) }
it "doesn't return email for @all mention" do
create_chat_message_with_mentions_and_notifications("Mentioning @all")
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return email for @here mention" do
user.update(last_seen_at: 1.second.ago)
create_chat_message_with_mentions_and_notifications("Mentioning @here")
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
end
end
describe "email subject" do
context "with regular mentions" do
before do
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: chat_message,
notification: notification,
)
end
context "when private_email setting is enabled" do
before { SiteSetting.private_email = true }
it "has a generic subject" do
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(
I18n.t(
"user_notifications.chat_summary.subject.private_message",
email_prefix: SiteSetting.email_prefix.presence || SiteSetting.title,
),
)
end
end
it "includes the sender username in the subject" do
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.chat_channel_1",
email_prefix: SiteSetting.title,
channel: channel.title(user),
)
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(expected_subject)
expect(email.subject).to include(channel.title(user))
end
it "includes both channel titles when there are exactly two with unread mentions" do
another_chat_channel = Fabricate(:category_channel, name: "Test channel")
another_chat_message =
Fabricate(:chat_message, user: sender, chat_channel: another_chat_channel)
Fabricate(
:user_chat_channel_membership,
chat_channel: another_chat_channel,
user: sender,
)
Fabricate(
:user_chat_channel_membership,
chat_channel: another_chat_channel,
user: user,
last_read_message_id: another_chat_message.id - 2,
)
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: another_chat_message,
notification: notification,
)
another_chat_channel.update!(last_message: another_chat_message)
email = described_class.chat_summary(user, {})
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.chat_channel_2",
email_prefix: SiteSetting.title,
channel1: channel.title(user),
channel2: another_chat_channel.title(user),
)
expect(email.subject).to eq(expected_subject)
expect(email.subject).to include(channel.title(user))
expect(email.subject).to include(another_chat_channel.title(user))
end
it "displays a count when there are more than two channels with unread mentions" do
2.times do |n|
another_chat_channel = Fabricate(:category_channel, name: "Test channel #{n}")
another_chat_message =
Fabricate(:chat_message, user: sender, chat_channel: another_chat_channel)
Fabricate(
:user_chat_channel_membership,
chat_channel: another_chat_channel,
user: sender,
)
Fabricate(
:user_chat_channel_membership,
chat_channel: another_chat_channel,
user: user,
last_read_message_id: another_chat_message.id - 2,
)
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: another_chat_message,
notification: notification,
)
another_chat_channel.update!(last_message: another_chat_message)
end
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.chat_channel_more",
email_prefix: SiteSetting.title,
channel: channel.title(user),
count: 2,
)
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(expected_subject)
end
end
context "with both unread DM messages and mentions" do
before do
refresh_auto_groups
channel = create_dm_channel(sender, [sender, user])
Fabricate(:chat_message, user: sender, chat_channel: channel)
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: chat_message,
notification: notification,
)
end
it "always includes the DM second" do
expected_subject =
I18n.t(
"user_notifications.chat_summary.subject.chat_channel_and_direct_message",
email_prefix: SiteSetting.title,
channel: channel.title(user),
username: sender.username,
)
email = described_class.chat_summary(user, {})
expect(email.subject).to eq(expected_subject)
end
end
end
describe "When there are mentions" do
before do
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: chat_message,
notification: notification,
)
end
describe "selecting mentions" do
it "doesn't return an email if the user can't see chat" do
SiteSetting.chat_allowed_groups = ""
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return an email if the user can't see any of the included channels" do
channel.chatable.destroy!
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return an email if the user is not following the channel" do
user_membership.update!(following: false)
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return an email if the membership object doesn't exist" do
user_membership.destroy!
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return an email if the sender was deleted" do
sender.destroy!
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return an email when the user already saw the mention" do
user_membership.update!(last_read_message_id: chat_message.id)
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "returns an email when the user haven't read a message yet" do
user_membership.update!(last_read_message_id: nil)
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
end
it "doesn't return an email when the unread count belongs to a different channel" do
user_membership.update!(last_read_message_id: chat_message.id)
second_channel = Fabricate(:chat_channel)
Fabricate(
:user_chat_channel_membership,
chat_channel: second_channel,
user: user,
last_read_message_id: chat_message.id - 1,
)
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "doesn't return an email if the message was deleted" do
chat_message.trash!
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
it "returns an email when the user has unread private messages" do
user_membership.update!(last_read_message_id: chat_message.id)
refresh_auto_groups
channel = create_dm_channel(sender, [sender, user])
Fabricate(:chat_message, user: sender, chat_channel: channel)
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
end
it "returns an email if the user read all the messages included in the previous summary" do
user_membership.update!(
last_read_message_id: chat_message.id,
last_unread_mention_when_emailed_id: chat_message.id,
)
new_message = Fabricate(:chat_message, user: sender, chat_channel: channel)
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: new_message,
notification: notification,
)
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
end
it "doesn't return an email if the mention is older than 1 week" do
chat_message.update!(created_at: 1.5.weeks.ago)
email = described_class.chat_summary(user, {})
expect(email.to).to be_blank
end
end
describe "mail contents" do
context "when private_email setting is enabled" do
before { SiteSetting.private_email = true }
it "has a generic channel title name" do
email = described_class.chat_summary(user, {})
expect(email.html_part.body.to_s).to include(
I18n.t("system_messages.private_channel_title", id: channel.id),
)
end
it "doesnt include message content" do
email = described_class.chat_summary(user, {})
expect(email.html_part.body.to_s).to_not include(chat_message.cooked_for_excerpt)
end
it "doesnt include user info" do
email = described_class.chat_summary(user, {})
expect(email.html_part.body.to_s).to_not include(chat_message.user.small_avatar_url)
expect(email.html_part.body.to_s).to_not include(chat_message.user.username)
end
end
it "returns an email when the user has unread mentions" do
email = described_class.chat_summary(user, {})
expect(email.to).to contain_exactly(user.email)
expect(email.html_part.body.to_s).to include(chat_message.cooked_for_excerpt)
user_avatar =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row img")
expect(user_avatar.attribute("src").value).to eq(sender.small_avatar_url)
expect(user_avatar.attribute("alt").value).to eq(sender.username)
more_messages_channel_link =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".more-messages-link")
expect(more_messages_channel_link.attribute("href").value).to eq(chat_message.full_url)
expect(more_messages_channel_link.text).to include(
I18n.t("user_notifications.chat_summary.view_messages", count: 1),
)
end
it "displays the sender's name when the site is configured to prioritize it" do
SiteSetting.enable_names = true
SiteSetting.prioritize_username_in_ux = false
email = described_class.chat_summary(user, {})
user_name = Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row span")
expect(user_name.text).to include(sender.name)
user_avatar =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row img")
expect(user_avatar.attribute("alt").value).to eq(sender.name)
end
it "displays the sender's username when the site is configured to prioritize it" do
SiteSetting.enable_names = true
SiteSetting.prioritize_username_in_ux = true
email = described_class.chat_summary(user, {})
user_name = Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row span")
expect(user_name.text).to include(sender.username)
user_avatar =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row img")
expect(user_avatar.attribute("alt").value).to eq(sender.username)
end
it "displays the sender's username when names are disabled" do
SiteSetting.enable_names = false
SiteSetting.prioritize_username_in_ux = false
email = described_class.chat_summary(user, {})
user_name = Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row span")
expect(user_name.text).to include(sender.username)
user_avatar =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row img")
expect(user_avatar.attribute("alt").value).to eq(sender.username)
end
it "displays the sender's username when the site is configured to prioritize it" do
SiteSetting.enable_names = false
SiteSetting.prioritize_username_in_ux = true
email = described_class.chat_summary(user, {})
user_name = Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row span")
expect(user_name.text).to include(sender.username)
user_avatar =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".message-row img")
expect(user_avatar.attribute("alt").value).to eq(sender.username)
end
context "when there are more than two mentions" do
it "includes a view more link " do
2.times do
msg = Fabricate(:chat_message, user: sender, chat_channel: channel)
notification = Fabricate(:notification)
Fabricate(:chat_mention, user: user, chat_message: msg, notification: notification)
end
email = described_class.chat_summary(user, {})
more_messages_channel_link =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".more-messages-link")
expect(more_messages_channel_link.attribute("href").value).to eq(
chat_message.full_url,
)
expect(more_messages_channel_link.text).to include(
I18n.t("user_notifications.chat_summary.view_more", count: 1),
)
end
context "when private_email setting is enabled" do
before { SiteSetting.private_email = true }
it "has only a link to view all messages" do
2.times do
msg = Fabricate(:chat_message, user: sender, chat_channel: channel)
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: msg,
notification: notification,
)
end
email = described_class.chat_summary(user, {})
more_messages_channel_link =
Nokogiri::HTML5.fragment(email.html_part.body.to_s).css(".more-messages-link")
expect(more_messages_channel_link.text).to include(
I18n.t("user_notifications.chat_summary.view_messages", count: 3),
)
end
end
end
it "doesn't repeat mentions we already sent" do
user_membership.update!(
last_read_message_id: chat_message.id - 1,
last_unread_mention_when_emailed_id: chat_message.id,
)
new_message =
Fabricate(:chat_message, user: sender, chat_channel: channel, cooked: "New message")
notification = Fabricate(:notification)
Fabricate(
:chat_mention,
user: user,
chat_message: new_message,
notification: notification,
)
email = described_class.chat_summary(user, {})
body = email.html_part.body.to_s
expect(body).not_to include(chat_message.cooked_for_excerpt)
expect(body).to include(new_message.cooked_for_excerpt)
end
end
end
end
end
def create_dm_channel(sender, target_users)
result =
Chat::CreateDirectMessageChannel.call(
guardian: sender.guardian,
target_usernames: target_users.map(&:username),
)
service_failed!(result) if result.failure?
result.channel
end
end