mirror of
https://github.com/discourse/discourse.git
synced 2024-12-12 08:06:57 +08:00
d3f02a1270
This commit fleshes out and adds functionality for the new `#hashtag` search and lookup system, still hidden behind the `enable_experimental_hashtag_autocomplete` feature flag. **Serverside** We have two plugin API registration methods that are used to define data sources (`register_hashtag_data_source`) and hashtag result type priorities depending on the context (`register_hashtag_type_in_context`). Reading the comments in plugin.rb should make it clear what these are doing. Reading the `HashtagAutocompleteService` in full will likely help a lot as well. Each data source is responsible for providing its own **lookup** and **search** method that returns hashtag results based on the arguments provided. For example, the category hashtag data source has to take into account parent categories and how they relate, and each data source has to define their own icon to use for the hashtag, and so on. The `Site` serializer has two new attributes that source data from `HashtagAutocompleteService`. There is `hashtag_icons` that is just a simple array of all the different icons that can be used for allowlisting in our markdown pipeline, and there is `hashtag_context_configurations` that is used to store the type priority orders for each registered context. When sending emails, we cannot render the SVG icons for hashtags, so we need to change the HTML hashtags to the normal `#hashtag` text. **Markdown** The `hashtag-autocomplete.js` file is where I have added the new `hashtag-autocomplete` markdown rule, and like all of our rules this is used to cook the raw text on both the clientside and on the serverside using MiniRacer. Only on the server side do we actually reach out to the database with the `hashtagLookup` function, on the clientside we just render a plainer version of the hashtag HTML. Only in the composer preview do we do further lookups based on this. This rule is the first one (that I can find) that uses the `currentUser` based on a passed in `user_id` for guardian checks in markdown rendering code. This is the `last_editor_id` for both the post and chat message. In some cases we need to cook without a user present, so the `Discourse.system_user` is used in this case. **Chat Channels** This also contains the changes required for chat so that chat channels can be used as a data source for hashtag searches and lookups. This data source will only be used when `enable_experimental_hashtag_autocomplete` is `true`, so we don't have to worry about channel results suddenly turning up. ------ **Known Rough Edges** - Onebox excerpts will not render the icon svg/use tags, I plan to address that in a follow up PR - Selecting a hashtag + pressing the Quote button will result in weird behaviour, I plan to address that in a follow up PR - Mixed hashtag contexts for hashtags without a type suffix will not work correctly, e.g. #ux which is both a category and a channel slug will resolve to a category when used inside a post or within a [chat] transcript in that post. Users can get around this manually by adding the correct suffix, for example ::channel. We may get to this at some point in future - Icons will not show for the hashtags in emails since SVG support is so terrible in email (this is not likely to be resolved, but still noting for posterity) - Additional refinements and review fixes wil
827 lines
32 KiB
Ruby
827 lines
32 KiB
Ruby
# frozen_string_literal: true
|
||
|
||
require 'email/sender'
|
||
|
||
RSpec.describe Email::Sender do
|
||
before do
|
||
SiteSetting.secure_uploads_allow_embed_images_in_emails = false
|
||
end
|
||
fab!(:post) { Fabricate(:post) }
|
||
let(:mock_smtp_transaction_response) { "250 Ok: queued as 2l3Md07BObzB8kRyHZeoN0baSUAhzc7A-NviRioOr80=@mailhog.example" }
|
||
|
||
def stub_deliver_response(message)
|
||
message.stubs(:deliver!).returns(
|
||
Net::SMTP::Response.new("250", mock_smtp_transaction_response)
|
||
)
|
||
end
|
||
|
||
context "when disable_emails is enabled" do
|
||
fab!(:user) { Fabricate(:user) }
|
||
fab!(:moderator) { Fabricate(:moderator) }
|
||
|
||
context "when disable_emails is enabled for everyone" do
|
||
before { SiteSetting.disable_emails = "yes" }
|
||
|
||
it "doesn't deliver mail when mails are disabled" do
|
||
message = UserNotifications.email_login(moderator)
|
||
Email::Sender.new(message, :email_login).send
|
||
|
||
expect(ActionMailer::Base.deliveries).to eq([])
|
||
end
|
||
|
||
it "delivers mail when mails are disabled but the email_type is admin_login" do
|
||
message = UserNotifications.admin_login(moderator)
|
||
Email::Sender.new(message, :admin_login).send
|
||
|
||
expect(ActionMailer::Base.deliveries.first.to).to eq([moderator.email])
|
||
end
|
||
|
||
it "delivers mail when mails are disabled but the email_type is test_message" do
|
||
message = TestMailer.send_test(moderator.email)
|
||
Email::Sender.new(message, :test_message).send
|
||
|
||
expect(ActionMailer::Base.deliveries.first.to).to eq([moderator.email])
|
||
end
|
||
end
|
||
|
||
context "when disable_emails is enabled for non-staff users" do
|
||
before { SiteSetting.disable_emails = "non-staff" }
|
||
|
||
it "doesn't deliver mail to normal user" do
|
||
Mail::Message.any_instance.expects(:deliver!).never
|
||
message = Mail::Message.new(to: user.email, body: "hello")
|
||
stub_deliver_response(message)
|
||
expect(Email::Sender.new(message, :hello).send).to eq(nil)
|
||
end
|
||
|
||
it "delivers mail to staff user" do
|
||
Mail::Message.any_instance.expects(:deliver!).once
|
||
message = Mail::Message.new(to: moderator.email, body: "hello")
|
||
Email::Sender.new(message, :hello).send
|
||
end
|
||
|
||
it "delivers mail to staff user when confirming new email if user is provided" do
|
||
Mail::Message.any_instance.expects(:deliver!).once
|
||
Fabricate(:email_change_request, {
|
||
user: moderator,
|
||
new_email: "newemail@testmoderator.com",
|
||
old_email: moderator.email,
|
||
change_state: EmailChangeRequest.states[:authorizing_new]
|
||
})
|
||
message = Mail::Message.new(
|
||
to: "newemail@testmoderator.com", body: "hello"
|
||
)
|
||
Email::Sender.new(message, :confirm_new_email, moderator).send
|
||
end
|
||
end
|
||
end
|
||
|
||
it "doesn't deliver mail when the message is of type NullMail" do
|
||
Mail::Message.any_instance.expects(:deliver!).never
|
||
message = ActionMailer::Base::NullMail.new
|
||
expect(Email::Sender.new(message, :hello).send).to eq(nil)
|
||
end
|
||
|
||
it "doesn't deliver mail when the message is nil" do
|
||
Mail::Message.any_instance.expects(:deliver!).never
|
||
Email::Sender.new(nil, :hello).send
|
||
end
|
||
|
||
it "doesn't deliver when the to address is nil" do
|
||
message = Mail::Message.new(body: 'hello')
|
||
message.expects(:deliver!).never
|
||
Email::Sender.new(message, :hello).send
|
||
end
|
||
|
||
it "doesn't deliver when the to address uses the .invalid tld" do
|
||
message = Mail::Message.new(body: 'hello', to: 'myemail@example.invalid')
|
||
message.expects(:deliver!).never
|
||
expect { Email::Sender.new(message, :hello).send }.
|
||
to change { SkippedEmailLog.where(reason_type: SkippedEmailLog.reason_types[:sender_message_to_invalid]).count }.by(1)
|
||
end
|
||
|
||
it "doesn't deliver when the body is nil" do
|
||
message = Mail::Message.new(to: 'eviltrout@test.domain')
|
||
message.expects(:deliver!).never
|
||
Email::Sender.new(message, :hello).send
|
||
end
|
||
|
||
describe ".host_for" do
|
||
it "defaults to localhost" do
|
||
expect(Email::Sender.host_for(nil)).to eq("localhost")
|
||
end
|
||
|
||
it "returns localhost for a weird host" do
|
||
expect(Email::Sender.host_for("this is not a real host")).to eq("localhost")
|
||
end
|
||
|
||
it "parses hosts from urls" do
|
||
expect(Email::Sender.host_for("http://meta.discourse.org")).to eq("meta.discourse.org")
|
||
end
|
||
|
||
it "downcases hosts" do
|
||
expect(Email::Sender.host_for("http://ForumSite.com")).to eq("forumsite.com")
|
||
end
|
||
|
||
end
|
||
|
||
context 'with a valid message' do
|
||
let(:reply_key) { "abcd" * 8 }
|
||
|
||
let(:message) do
|
||
message = Mail::Message.new(
|
||
to: 'eviltrout@test.domain',
|
||
body: '**hello**'
|
||
)
|
||
stub_deliver_response(message)
|
||
message
|
||
end
|
||
|
||
let(:email_sender) { Email::Sender.new(message, :valid_type) }
|
||
|
||
it 'calls deliver' do
|
||
message.expects(:deliver!).once
|
||
email_sender.send
|
||
end
|
||
|
||
context "when no plus addressing" do
|
||
before { SiteSetting.reply_by_email_address = '%{reply_key}@test.com' }
|
||
|
||
it 'should not set the return_path' do
|
||
email_sender.send
|
||
expect(message.header[:return_path].to_s).to eq("")
|
||
end
|
||
end
|
||
|
||
context "with plus addressing" do
|
||
before { SiteSetting.reply_by_email_address = 'replies+%{reply_key}@test.com' }
|
||
|
||
it 'should set the return_path' do
|
||
email_sender.send
|
||
expect(message.header[:return_path].to_s).to eq("replies+verp-#{EmailLog.last.bounce_key}@test.com")
|
||
end
|
||
end
|
||
|
||
context "when topic id is present" do
|
||
fab!(:category) { Fabricate(:category, name: 'Name With Space') }
|
||
fab!(:topic) { Fabricate(:topic, category: category) }
|
||
fab!(:post) { Fabricate(:post, topic: topic) }
|
||
|
||
before do
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
message.header['X-Discourse-Topic-Id'] = topic.id
|
||
end
|
||
|
||
it 'should add the right header' do
|
||
email_sender.send
|
||
|
||
expect(message.header['List-ID']).to be_present
|
||
expect(message.header['List-ID'].to_s).to match('name-with-space')
|
||
end
|
||
end
|
||
|
||
context "when topic id is not present" do
|
||
it 'should add the right header' do
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-ID']).to be_present
|
||
end
|
||
end
|
||
|
||
context "when reply_key is present" do
|
||
fab!(:user) { Fabricate(:user) }
|
||
let(:email_sender) { Email::Sender.new(message, :valid_type, user) }
|
||
let(:reply_key) { PostReplyKey.find_by!(post_id: post.id, user_id: user.id).reply_key }
|
||
|
||
before do
|
||
SiteSetting.reply_by_email_address = 'replies+%{reply_key}@test.com'
|
||
SiteSetting.email_custom_headers = 'Auto-Submitted: auto-generated|Mail-Reply-To: sender-name+%{reply_key}@domain.net'
|
||
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
end
|
||
|
||
it 'replaces headers with reply_key if present' do
|
||
message.header[Email::MessageBuilder::ALLOW_REPLY_BY_EMAIL_HEADER] = 'test-%{reply_key}@test.com'
|
||
message.header['Reply-To'] = 'Test <test-%{reply_key}@test.com>'
|
||
message.header['Auto-Submitted'] = 'auto-generated'
|
||
message.header['Mail-Reply-To'] = 'sender-name+%{reply_key}@domain.net'
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Reply-To'].to_s).to eq("Test <test-#{reply_key}@test.com>")
|
||
expect(message.header['Auto-Submitted'].to_s).to eq('auto-generated')
|
||
expect(message.header['Mail-Reply-To'].to_s).to eq("sender-name+#{reply_key}@domain.net")
|
||
end
|
||
|
||
it 'removes headers with reply_key if absent' do
|
||
message.header['Auto-Submitted'] = 'auto-generated'
|
||
message.header['Mail-Reply-To'] = 'sender-name+%{reply_key}@domain.net'
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Reply-To'].to_s).to eq('')
|
||
expect(message.header['Auto-Submitted'].to_s). to eq('auto-generated')
|
||
expect(message.header['Mail-Reply-To'].to_s).to eq('')
|
||
end
|
||
end
|
||
|
||
describe "adds Precedence header" do
|
||
fab!(:topic) { Fabricate(:topic) }
|
||
fab!(:post) { Fabricate(:post, topic: topic) }
|
||
|
||
before do
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
message.header['X-Discourse-Topic-Id'] = topic.id
|
||
end
|
||
|
||
it 'should add the right header' do
|
||
email_sender.send
|
||
expect(message.header['Precedence']).to be_present
|
||
end
|
||
end
|
||
|
||
describe "removes custom Discourse headers from digest/registration/other mails" do
|
||
it 'should remove the right headers' do
|
||
email_sender.send
|
||
expect(message.header['X-Discourse-Topic-Id']).not_to be_present
|
||
expect(message.header['X-Discourse-Post-Id']).not_to be_present
|
||
expect(message.header['X-Discourse-Reply-Key']).not_to be_present
|
||
end
|
||
end
|
||
|
||
describe "email threading" do
|
||
fab!(:topic) { Fabricate(:topic) }
|
||
|
||
fab!(:post_1) { Fabricate(:post, topic: topic, post_number: 1) }
|
||
fab!(:post_2) { Fabricate(:post, topic: topic, post_number: 2) }
|
||
fab!(:post_3) { Fabricate(:post, topic: topic, post_number: 3) }
|
||
fab!(:post_4) { Fabricate(:post, topic: topic, post_number: 4) }
|
||
fab!(:post_5) { Fabricate(:post, topic: topic, post_number: 5) }
|
||
fab!(:post_6) { Fabricate(:post, topic: topic, post_number: 6) }
|
||
|
||
let!(:post_reply_1_4) { PostReply.create(post: post_1, reply: post_4) }
|
||
let!(:post_reply_2_4) { PostReply.create(post: post_2, reply: post_4) }
|
||
let!(:post_reply_3_4) { PostReply.create(post: post_3, reply: post_4) }
|
||
let!(:post_reply_4_5) { PostReply.create(post: post_4, reply: post_5) }
|
||
let!(:post_reply_4_6) { PostReply.create(post: post_4, reply: post_6) }
|
||
let!(:post_reply_5_6) { PostReply.create(post: post_5, reply: post_6) }
|
||
|
||
before do
|
||
message.header['X-Discourse-Topic-Id'] = topic.id
|
||
end
|
||
|
||
it "doesn't set References or In-Reply-To headers on the first post, only generates a Message-ID and saves it against the post" do
|
||
message.header['X-Discourse-Post-Id'] = post_1.id
|
||
|
||
email_sender.send
|
||
post_1.reload
|
||
|
||
expect(message.header['Message-Id'].to_s).to eq("<discourse/post/#{post_1.id}@test.localhost>")
|
||
expect(post_1.outbound_message_id).to eq("discourse/post/#{post_1.id}@test.localhost")
|
||
expect(message.header['In-Reply-To'].to_s).to be_blank
|
||
expect(message.header['References'].to_s).to be_blank
|
||
end
|
||
|
||
it "uses the existing Message-ID header from the incoming email when sending the first post email" do
|
||
incoming = Fabricate(
|
||
:incoming_email,
|
||
topic: topic,
|
||
post: post_1,
|
||
message_id: "blah1234@someemailprovider.com",
|
||
created_via: IncomingEmail.created_via_types[:handle_mail]
|
||
)
|
||
post_1.update!(outbound_message_id: incoming.message_id)
|
||
message.header['X-Discourse-Post-Id'] = post_1.id
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-Id'].to_s).to eq("<blah1234@someemailprovider.com>")
|
||
expect(message.header['In-Reply-To'].to_s).to be_blank
|
||
expect(message.header['References'].to_s).to be_blank
|
||
end
|
||
|
||
it "if no post is directly replied to then the Message-ID of post 1 via outbound_message_id should be used" do
|
||
message.header['X-Discourse-Post-Id'] = post_2.id
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-Id'].to_s).to eq("<discourse/post/#{post_2.id}@test.localhost>")
|
||
expect(message.header['In-Reply-To'].to_s).to eq("<discourse/post/#{post_1.id}@test.localhost>")
|
||
expect(message.header['References'].to_s).to eq("<discourse/post/#{post_1.id}@test.localhost>")
|
||
end
|
||
|
||
it "sets the References header to the most recently created replied post, as well as the OP, if there are no other replies in the chain" do
|
||
message.header['X-Discourse-Post-Id'] = post_4.id
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-ID'].to_s).to eq("<discourse/post/#{post_4.id}@test.localhost>")
|
||
expect(message.header['References'].to_s).to eq("<discourse/post/#{post_1.id}@test.localhost> <discourse/post/#{post_3.id}@test.localhost>")
|
||
end
|
||
|
||
it "sets the In-Reply-To header to all the posts that the post is connected to via PostReply" do
|
||
message.header['X-Discourse-Post-Id'] = post_6.id
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-ID'].to_s).to eq("<discourse/post/#{post_6.id}@test.localhost>")
|
||
expect(message.header['In-Reply-To'].to_s).to eq("<discourse/post/#{post_4.id}@test.localhost> <discourse/post/#{post_5.id}@test.localhost>")
|
||
end
|
||
|
||
it "sets the In-Reply-To and References header to the most recently created replied post and includes the parents of that post in References, as well as the OP" do
|
||
message.header['X-Discourse-Post-Id'] = post_4.id
|
||
PostReply.create(post: post_2, reply: post_3)
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-ID'].to_s).to eq("<discourse/post/#{post_4.id}@test.localhost>")
|
||
expect(message.header['In-Reply-To'].to_s).to eq("<discourse/post/#{post_1.id}@test.localhost> <discourse/post/#{post_2.id}@test.localhost> <discourse/post/#{post_3.id}@test.localhost>")
|
||
|
||
references = [
|
||
"<discourse/post/#{post_1.id}@test.localhost>",
|
||
"<discourse/post/#{post_2.id}@test.localhost>",
|
||
"<discourse/post/#{post_3.id}@test.localhost>"
|
||
]
|
||
expect(message.header['References'].to_s).to eq(references.join(" "))
|
||
end
|
||
|
||
it "handles a complex reply tree to the OP for References, only using one Message-ID if there are multiple parents for a post" do
|
||
message.header['X-Discourse-Post-Id'] = post_6.id
|
||
PostReply.create(post: post_2, reply: post_6)
|
||
|
||
email_sender.send
|
||
|
||
expect(message.header['Message-ID'].to_s).to eq("<discourse/post/#{post_6.id}@test.localhost>")
|
||
expect(message.header['In-Reply-To'].to_s).to eq("<discourse/post/#{post_2.id}@test.localhost> <discourse/post/#{post_4.id}@test.localhost> <discourse/post/#{post_5.id}@test.localhost>")
|
||
|
||
references = [
|
||
"<discourse/post/#{post_1.id}@test.localhost>",
|
||
"<discourse/post/#{post_3.id}@test.localhost>",
|
||
"<discourse/post/#{post_4.id}@test.localhost>",
|
||
"<discourse/post/#{post_5.id}@test.localhost>"
|
||
]
|
||
expect(message.header['References'].to_s).to eq(references.join(" "))
|
||
end
|
||
end
|
||
|
||
describe "merges custom mandrill header" do
|
||
before do
|
||
ActionMailer::Base.smtp_settings[:address] = "smtp.mandrillapp.com"
|
||
message.header['X-MC-Metadata'] = { foo: "bar" }.to_json
|
||
end
|
||
|
||
it 'should set the right header' do
|
||
email_sender.send
|
||
expect(message.header['X-MC-Metadata'].to_s).to match(message.message_id)
|
||
end
|
||
end
|
||
|
||
describe "merges custom sparkpost header" do
|
||
before do
|
||
ActionMailer::Base.smtp_settings[:address] = "smtp.sparkpostmail.com"
|
||
message.header['X-MSYS-API'] = { foo: "bar" }.to_json
|
||
end
|
||
|
||
it 'should set the right header' do
|
||
email_sender.send
|
||
expect(message.header['X-MSYS-API'].to_s).to match(message.message_id)
|
||
end
|
||
end
|
||
|
||
context 'with email logs' do
|
||
let(:email_log) { EmailLog.last }
|
||
|
||
it 'should create the right log' do
|
||
expect do
|
||
email_sender.send
|
||
end.to_not change { PostReplyKey.count }
|
||
|
||
expect(email_log).to be_present
|
||
expect(email_log.email_type).to eq('valid_type')
|
||
expect(email_log.to_address).to eq('eviltrout@test.domain')
|
||
expect(email_log.user_id).to be_blank
|
||
expect(email_log.raw).to eq(nil)
|
||
end
|
||
|
||
context 'when the email is sent using group SMTP credentials' do
|
||
let(:reply) { Fabricate(:post, topic: post.topic, reply_to_user: post.user, reply_to_post_number: post.post_number) }
|
||
let(:notification) { Fabricate(:posted_notification, user: post.user, post: reply) }
|
||
let(:message) do
|
||
GroupSmtpMailer.send_mail(
|
||
group,
|
||
post.user.email,
|
||
post
|
||
)
|
||
end
|
||
let(:group) { Fabricate(:smtp_group) }
|
||
|
||
before do
|
||
SiteSetting.enable_smtp = true
|
||
stub_deliver_response(message)
|
||
end
|
||
|
||
it 'adds the group id and raw content to the email log' do
|
||
TopicAllowedGroup.create(topic: post.topic, group: group)
|
||
|
||
email_sender.send
|
||
|
||
expect(email_log).to be_present
|
||
expect(email_log.email_type).to eq('valid_type')
|
||
expect(email_log.to_address).to eq(post.user.email)
|
||
expect(email_log.user_id).to be_blank
|
||
expect(email_log.smtp_group_id).to eq(group.id)
|
||
expect(email_log.raw).to include("Hello world")
|
||
end
|
||
|
||
it "does not add any of the mailing list headers" do
|
||
TopicAllowedGroup.create(topic: post.topic, group: group)
|
||
email_sender.send
|
||
|
||
expect(message.header['List-ID']).to eq(nil)
|
||
expect(message.header['List-Archive']).to eq(nil)
|
||
expect(message.header['Precedence']).to eq(nil)
|
||
expect(message.header['List-Unsubscribe']).to eq(nil)
|
||
end
|
||
|
||
it "removes the Auto-Submitted header" do
|
||
TopicAllowedGroup.create!(topic: post.topic, group: group)
|
||
email_sender.send
|
||
|
||
expect(message.header['Auto-Submitted']).to eq(nil)
|
||
end
|
||
end
|
||
end
|
||
|
||
context "with email log with a post id and topic id" do
|
||
let(:topic) { post.topic }
|
||
|
||
before do
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
message.header['X-Discourse-Topic-Id'] = topic.id
|
||
end
|
||
|
||
let(:email_log) { EmailLog.last }
|
||
|
||
it 'should create the right log' do
|
||
email_sender.send
|
||
expect(email_log.post_id).to eq(post.id)
|
||
expect(email_log.topic_id).to eq(topic.id)
|
||
expect(email_log.topic.id).to eq(topic.id)
|
||
end
|
||
end
|
||
|
||
context 'with email parts' do
|
||
it 'should contain the right message' do
|
||
email_sender.send
|
||
|
||
expect(message).to be_multipart
|
||
expect(message.text_part.content_type).to eq('text/plain; charset=UTF-8')
|
||
expect(message.html_part.content_type).to eq('text/html; charset=UTF-8')
|
||
expect(message.html_part.body.to_s).to match("<p><strong>hello</strong></p>")
|
||
end
|
||
end
|
||
end
|
||
|
||
context "with attachments" do
|
||
fab!(:small_pdf) do
|
||
SiteSetting.authorized_extensions = 'pdf'
|
||
UploadCreator.new(file_from_fixtures("small.pdf", "pdf"), "small.pdf")
|
||
.create_for(Discourse.system_user.id)
|
||
end
|
||
fab!(:large_pdf) do
|
||
SiteSetting.authorized_extensions = 'pdf'
|
||
UploadCreator.new(file_from_fixtures("large.pdf", "pdf"), "large.pdf")
|
||
.create_for(Discourse.system_user.id)
|
||
end
|
||
fab!(:csv_file) do
|
||
SiteSetting.authorized_extensions = 'csv'
|
||
UploadCreator.new(file_from_fixtures("words.csv", "csv"), "words.csv")
|
||
.create_for(Discourse.system_user.id)
|
||
end
|
||
fab!(:image) do
|
||
SiteSetting.authorized_extensions = 'png'
|
||
UploadCreator.new(file_from_fixtures("logo.png", "images"), "logo.png")
|
||
.create_for(Discourse.system_user.id)
|
||
end
|
||
fab!(:post) { Fabricate(:post) }
|
||
fab!(:reply) do
|
||
raw = <<~RAW
|
||
Hello world! It’s a great day!
|
||
#{UploadMarkdown.new(small_pdf).attachment_markdown}
|
||
#{UploadMarkdown.new(large_pdf).attachment_markdown}
|
||
#{UploadMarkdown.new(image).image_markdown}
|
||
#{UploadMarkdown.new(csv_file).attachment_markdown}
|
||
RAW
|
||
reply = Fabricate(:post, raw: raw, topic: post.topic, user: Fabricate(:user))
|
||
reply.link_post_uploads
|
||
reply
|
||
end
|
||
fab!(:notification) { Fabricate(:posted_notification, user: post.user, post: reply) }
|
||
let(:message) do
|
||
UserNotifications.user_posted(
|
||
post.user,
|
||
post: reply,
|
||
notification_type: notification.notification_type,
|
||
notification_data_hash: notification.data_hash
|
||
)
|
||
end
|
||
|
||
it "adds only non-image uploads as attachments to the email" do
|
||
SiteSetting.email_total_attachment_size_limit_kb = 10_000
|
||
Email::Sender.new(message, :valid_type).send
|
||
|
||
expect(message.attachments.length).to eq(3)
|
||
expect(message.attachments.map(&:filename))
|
||
.to contain_exactly(*[small_pdf, large_pdf, csv_file].map(&:original_filename))
|
||
end
|
||
|
||
it "changes the hashtags to the slug with a # symbol beforehand rather than the full name of the resource" do
|
||
SiteSetting.enable_experimental_hashtag_autocomplete = true
|
||
category = Fabricate(:category, slug: "dev")
|
||
reply.update!(raw: reply.raw + "\n wow this is #dev")
|
||
reply.rebake!
|
||
Email::Sender.new(message, :valid_type).send
|
||
expected = <<~HTML
|
||
<a href=\"#{Discourse.base_url}#{category.url}\" data-type=\"category\" data-slug=\"dev\" style=\"text-decoration: none; font-weight: bold; color: #006699;\"><span>#dev</span>
|
||
HTML
|
||
expect(message.html_part.body.to_s).to include(expected.chomp)
|
||
end
|
||
|
||
context "when secure uploads enabled" do
|
||
before do
|
||
setup_s3
|
||
store = stub_s3_store
|
||
|
||
SiteSetting.secure_uploads = true
|
||
SiteSetting.login_required = true
|
||
SiteSetting.email_total_attachment_size_limit_kb = 14_000
|
||
SiteSetting.secure_uploads_max_email_embed_image_size_kb = 5_000
|
||
|
||
Jobs.run_immediately!
|
||
Jobs::PullHotlinkedImages.any_instance.expects(:execute)
|
||
FileStore::S3Store.any_instance.expects(:has_been_uploaded?).returns(true).at_least_once
|
||
CookedPostProcessor.any_instance.stubs(:get_size).returns([244, 66])
|
||
|
||
@secure_image_file = file_from_fixtures("logo.png", "images")
|
||
@secure_image = UploadCreator.new(@secure_image_file, "logo.png")
|
||
.create_for(Discourse.system_user.id)
|
||
@secure_image.update_secure_status(override: true)
|
||
@secure_image.update(access_control_post_id: reply.id)
|
||
reply.update(raw: reply.raw + "\n" + "#{UploadMarkdown.new(@secure_image).image_markdown}")
|
||
reply.rebake!
|
||
end
|
||
|
||
it "does not attach images when embedding them is not allowed" do
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.length).to eq(3)
|
||
end
|
||
|
||
context "when embedding secure images in email is allowed" do
|
||
before do
|
||
SiteSetting.secure_uploads_allow_embed_images_in_emails = true
|
||
end
|
||
|
||
it "can inline images with duplicate names" do
|
||
@secure_image_2 = UploadCreator.new(file_from_fixtures("logo-dev.png", "images"), "logo.png").create_for(Discourse.system_user.id)
|
||
@secure_image_2.update_secure_status(override: true)
|
||
@secure_image_2.update(access_control_post_id: reply.id)
|
||
|
||
Jobs::PullHotlinkedImages.any_instance.expects(:execute)
|
||
reply.update(raw: "#{UploadMarkdown.new(@secure_image).image_markdown}\n#{UploadMarkdown.new(@secure_image_2).image_markdown}")
|
||
reply.rebake!
|
||
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.size).to eq(2)
|
||
expect(message.to_s.scan(/cid:[\w\-@.]+/).length).to eq(2)
|
||
expect(message.to_s.scan(/cid:[\w\-@.]+/).uniq.length).to eq(2)
|
||
end
|
||
|
||
it "does not attach images that are not marked as secure" do
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.length).to eq(4)
|
||
end
|
||
|
||
it "does not embed images that are too big" do
|
||
SiteSetting.secure_uploads_max_email_embed_image_size_kb = 1
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.length).to eq(3)
|
||
end
|
||
|
||
it "uses the email styles to inline secure images and attaches the secure image upload to the email" do
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.length).to eq(4)
|
||
expect(message.attachments.map(&:filename))
|
||
.to contain_exactly(*[small_pdf, large_pdf, csv_file, @secure_image].map(&:original_filename))
|
||
expect(message.attachments["logo.png"].body.raw_source.force_encoding("UTF-8")).to eq(File.read(@secure_image_file))
|
||
expect(message.html_part.body).to include("cid:")
|
||
expect(message.html_part.body).to include("embedded-secure-image")
|
||
expect(message.attachments.length).to eq(4)
|
||
end
|
||
|
||
it "uses correct UTF-8 encoding for the body of the email" do
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.html_part.body).not_to include("Itâ\u0080\u0099s")
|
||
expect(message.html_part.body).to include("It’s")
|
||
expect(message.html_part.charset.downcase).to eq("utf-8")
|
||
end
|
||
|
||
context "when the uploaded secure image has an optimized image" do
|
||
let!(:optimized) { Fabricate(:optimized_image, upload: @secure_image) }
|
||
let!(:optimized_image_file) { file_from_fixtures("smallest.png", "images") }
|
||
|
||
before do
|
||
url = Discourse.store.store_optimized_image(optimized_image_file, optimized)
|
||
optimized.update(url: Discourse.store.absolute_base_url + '/' + url)
|
||
Discourse.store.cache_file(optimized_image_file, File.basename("#{optimized.sha1}.png"))
|
||
end
|
||
|
||
it "uses the email styles and the optimized image to inline secure images and attaches the secure image upload to the email" do
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.length).to eq(4)
|
||
expect(message.attachments.map(&:filename))
|
||
.to contain_exactly(*[small_pdf, large_pdf, csv_file, @secure_image].map(&:original_filename))
|
||
expect(message.attachments["logo.png"].body.raw_source.force_encoding("UTF-8")).to eq(File.read(optimized_image_file))
|
||
expect(message.html_part.body).to include("cid:")
|
||
expect(message.html_part.body).to include("embedded-secure-image")
|
||
end
|
||
|
||
it "uses the optimized image size in the max size limit calculation, not the original image size" do
|
||
SiteSetting.email_total_attachment_size_limit_kb = 45
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.attachments.length).to eq(4)
|
||
expect(message.attachments["logo.png"].body.raw_source.force_encoding("UTF-8")).to eq(File.read(optimized_image_file))
|
||
end
|
||
end
|
||
end
|
||
end
|
||
|
||
it "adds only non-image uploads as attachments to the email and leaves the image intact with original source" do
|
||
SiteSetting.email_total_attachment_size_limit_kb = 10_000
|
||
Email::Sender.new(message, :valid_type).send
|
||
|
||
expect(message.attachments.length).to eq(3)
|
||
expect(message.attachments.map(&:filename))
|
||
.to contain_exactly(*[small_pdf, large_pdf, csv_file].map(&:original_filename))
|
||
expect(message.html_part.body).to include("<img src=\"#{Discourse.base_url}#{image.url}\"")
|
||
end
|
||
|
||
it "respects the size limit and attaches only files that fit into the max email size" do
|
||
SiteSetting.email_total_attachment_size_limit_kb = 40
|
||
Email::Sender.new(message, :valid_type).send
|
||
|
||
expect(message.attachments.length).to eq(2)
|
||
expect(message.attachments.map(&:filename))
|
||
.to contain_exactly(*[small_pdf, csv_file].map(&:original_filename))
|
||
end
|
||
|
||
it "structures the email as a multipart/mixed with a multipart/alternative first part" do
|
||
SiteSetting.email_total_attachment_size_limit_kb = 10_000
|
||
Email::Sender.new(message, :valid_type).send
|
||
|
||
expect(message.content_type).to start_with("multipart/mixed")
|
||
expect(message.parts.size).to eq(4)
|
||
expect(message.parts[0].content_type).to start_with("multipart/alternative")
|
||
expect(message.parts[0].parts.size).to eq(2)
|
||
end
|
||
|
||
it "uses correct UTF-8 encoding for the body of the email" do
|
||
Email::Sender.new(message, :valid_type).send
|
||
expect(message.html_part.body).not_to include("Itâ\u0080\u0099s")
|
||
expect(message.html_part.body).to include("It’s")
|
||
expect(message.html_part.charset.downcase).to eq("utf-8")
|
||
end
|
||
end
|
||
|
||
context 'with a deleted post' do
|
||
it 'should skip sending the email' do
|
||
post = Fabricate(:post, deleted_at: 1.day.ago)
|
||
|
||
message = Mail::Message.new to: 'disc@ourse.org', body: 'some content'
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
message.header['X-Discourse-Topic-Id'] = post.topic_id
|
||
message.expects(:deliver!).never
|
||
|
||
email_sender = Email::Sender.new(message, :valid_type)
|
||
expect { email_sender.send }.to change { SkippedEmailLog.count }
|
||
|
||
log = SkippedEmailLog.last
|
||
expect(log.reason_type).to eq(SkippedEmailLog.reason_types[:sender_post_deleted])
|
||
end
|
||
|
||
end
|
||
|
||
context 'with a deleted topic' do
|
||
it 'should skip sending the email' do
|
||
post = Fabricate(:post, topic: Fabricate(:topic, deleted_at: 1.day.ago))
|
||
|
||
message = Mail::Message.new to: 'disc@ourse.org', body: 'some content'
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
message.header['X-Discourse-Topic-Id'] = post.topic_id
|
||
message.expects(:deliver!).never
|
||
|
||
email_sender = Email::Sender.new(message, :valid_type)
|
||
expect { email_sender.send }.to change { SkippedEmailLog.count }
|
||
|
||
log = SkippedEmailLog.last
|
||
expect(log.reason_type).to eq(SkippedEmailLog.reason_types[:sender_topic_deleted])
|
||
end
|
||
|
||
end
|
||
|
||
context 'with a user' do
|
||
let(:message) do
|
||
message = Mail::Message.new to: 'eviltrout@test.domain', body: 'test body'
|
||
stub_deliver_response(message)
|
||
message
|
||
end
|
||
|
||
fab!(:user) { Fabricate(:user) }
|
||
let(:email_sender) { Email::Sender.new(message, :valid_type, user) }
|
||
|
||
before do
|
||
email_sender.send
|
||
@email_log = EmailLog.last
|
||
end
|
||
|
||
it 'should have the current user_id' do
|
||
expect(@email_log.user_id).to eq(user.id)
|
||
end
|
||
|
||
it 'should have the smtp_transaction_response message' do
|
||
expect(@email_log.smtp_transaction_response).to eq(mock_smtp_transaction_response)
|
||
end
|
||
|
||
describe "post reply keys" do
|
||
fab!(:post) { Fabricate(:post) }
|
||
|
||
before do
|
||
message.header['X-Discourse-Post-Id'] = post.id
|
||
message.header['Reply-To'] = "test-%{reply_key}@test.com"
|
||
end
|
||
|
||
describe 'when allow reply by email header is not present' do
|
||
it 'should not create a post reply key' do
|
||
expect { email_sender.send }.to_not change { PostReplyKey.count }
|
||
end
|
||
end
|
||
|
||
describe 'when allow reply by email header is present' do
|
||
let(:header) { Email::MessageBuilder::ALLOW_REPLY_BY_EMAIL_HEADER }
|
||
|
||
before do
|
||
message.header[header] = "test-%{reply_key}@test.com"
|
||
end
|
||
|
||
it 'should create a post reply key' do
|
||
expect { email_sender.send }.to change { PostReplyKey.count }.by(1)
|
||
post_reply_key = PostReplyKey.last
|
||
|
||
expect(message.header['Reply-To'].value).to eq(
|
||
"test-#{post_reply_key.reply_key}@test.com"
|
||
)
|
||
|
||
expect(message.header[header]).to eq(nil)
|
||
expect(post_reply_key.user_id).to eq(user.id)
|
||
expect(post_reply_key.post_id).to eq(post.id)
|
||
expect { email_sender.send }.not_to change { PostReplyKey.count }
|
||
end
|
||
|
||
it 'should find existing key' do
|
||
existing_post_reply_key = PostReplyKey.create(post_id: post.id, user_id: user.id)
|
||
expect { email_sender.send }.not_to change { PostReplyKey.count }
|
||
post_reply_key = PostReplyKey.last
|
||
expect(post_reply_key).to eq(existing_post_reply_key)
|
||
end
|
||
|
||
end
|
||
end
|
||
end
|
||
|
||
context "with cc addresses" do
|
||
let(:message) do
|
||
message = Mail::Message.new to: 'eviltrout@test.domain', body: 'test body', cc: 'someguy@test.com;otherguy@xyz.com'
|
||
stub_deliver_response(message)
|
||
message
|
||
end
|
||
|
||
fab!(:user) { Fabricate(:user) }
|
||
let(:email_sender) { Email::Sender.new(message, :valid_type, user) }
|
||
|
||
it "logs the cc addresses in the email log (but not users if they do not match the emails)" do
|
||
email_sender.send
|
||
email_log = EmailLog.last
|
||
expect(email_log.cc_addresses).to eq("someguy@test.com;otherguy@xyz.com")
|
||
expect(email_log.cc_users).to eq([])
|
||
end
|
||
|
||
it "logs the cc users if they match the emails" do
|
||
user1 = Fabricate(:user, email: "someguy@test.com")
|
||
user2 = Fabricate(:user, email: "otherguy@xyz.com")
|
||
email_sender.send
|
||
email_log = EmailLog.last
|
||
expect(email_log.cc_addresses).to eq("someguy@test.com;otherguy@xyz.com")
|
||
expect(email_log.cc_users).to match_array([user1, user2])
|
||
end
|
||
end
|
||
end
|