Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Use Custom Domains in `spree_emails` when generating URLs to Storefront (#12947)
Damian Legawiec3af065037d9e
diff --git a/core/app/mailers/spree/base_mailer.rb b/core/app/mailers/spree/base_mailer.rbindex a6e77ad4ec..0a4c3d2913 100644--- a/core/app/mailers/spree/base_mailer.rb+++ b/core/app/mailers/spree/base_mailer.rb@@ -40,7 +40,7 @@ module Spree# http://guides.rubyonrails.org/action_mailer_basics.html#generating-urls-in-action-mailer-viewsdef ensure_default_action_mailer_url_host(store_url = nil)ActionMailer::Base.default_url_options ||= {}- ActionMailer::Base.default_url_options[:host] ||= store_url.presence || current_store.url+ ActionMailer::Base.default_url_options[:host] ||= store_url.presence || current_store.url_or_custom_domainenddef set_email_localediff --git a/emails/app/mailers/spree/order_mailer.rb b/emails/app/mailers/spree/order_mailer.rbindex b52054a923..924100cc96 100644--- a/emails/app/mailers/spree/order_mailer.rb+++ b/emails/app/mailers/spree/order_mailer.rb@@ -5,14 +5,14 @@ module Spreecurrent_store = @order.storesubject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')subject += "#{current_store.name} #{Spree.t('order_mailer.confirm_email.subject')} ##{@order.number}"- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url_or_custom_domain, reply_to: reply_to_address)enddef store_owner_notification_email(order)@order = order.respond_to?(:id) ? order : Spree::Order.find(order)current_store = @order.storesubject = Spree.t('order_mailer.store_owner_notification_email.subject', store_name: current_store.name)- mail(to: current_store.new_order_notifications_email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)+ mail(to: current_store.new_order_notifications_email, from: from_address, subject: subject, store_url: current_store.url_or_custom_domain, reply_to: reply_to_address)enddef cancel_email(order, resend = false)@@ -20,7 +20,7 @@ module Spreecurrent_store = @order.storesubject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')subject += "#{current_store.name} #{Spree.t('order_mailer.cancel_email.subject')} ##{@order.number}"- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url_or_custom_domain, reply_to: reply_to_address)enddef payment_link_email(order_id)diff --git a/emails/app/mailers/spree/reimbursement_mailer.rb b/emails/app/mailers/spree/reimbursement_mailer.rbindex 544dd1007a..7bd8b3ea93 100644--- a/emails/app/mailers/spree/reimbursement_mailer.rb+++ b/emails/app/mailers/spree/reimbursement_mailer.rb@@ -6,7 +6,7 @@ module Spreecurrent_store = @reimbursement.store || Spree::Store.defaultsubject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')subject += "#{current_store.name} #{Spree.t('reimbursement_mailer.reimbursement_email.subject')} ##{@order.number}"- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url_or_custom_domain, reply_to: reply_to_address)endendenddiff --git a/emails/app/mailers/spree/shipment_mailer.rb b/emails/app/mailers/spree/shipment_mailer.rbindex 0cb29c7801..fc37de4cd4 100644--- a/emails/app/mailers/spree/shipment_mailer.rb+++ b/emails/app/mailers/spree/shipment_mailer.rb@@ -8,7 +8,7 @@ module Spreecurrent_store = @shipment.storesubject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')subject += "#{current_store.name} #{Spree.t('shipment_mailer.shipped_email.subject')} ##{@order.number}"- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url_or_custom_domain, reply_to: reply_to_address)endendenddiff --git a/emails/spec/mailers/spree/order_mailer_spec.rb b/emails/spec/mailers/spree/order_mailer_spec.rbindex 51d13a68a6..16578986f8 100644--- a/emails/spec/mailers/spree/order_mailer_spec.rb+++ b/emails/spec/mailers/spree/order_mailer_spec.rb@@ -261,16 +261,26 @@ describe Spree::OrderMailer, type: :mailer docontext 'emails contain only urls of the store where the order was made' doit 'shows proper host url in email content' do- ActionMailer::Base.default_url_options[:host] = order.store.urldescribed_class.confirm_email(order).deliver_nowexpect(ActionMailer::Base.default_url_options[:host]).to eq(order.store.url)endit 'shows proper host url in email content #2' do- ActionMailer::Base.default_url_options[:host] = second_order.store.urldescribed_class.confirm_email(second_order).deliver_nowexpect(ActionMailer::Base.default_url_options[:host]).to eq(second_order.store.url)end++ context 'with custom domain' do+ let!(:custom_domain) { create(:custom_domain, store: store, url: 'my-store.com') }++ it 'uses custom domain for URLs in emails' do+ email = described_class.confirm_email(order).deliver_now+ expect(ActionMailer::Base.default_url_options[:host]).to eq('my-store.com')+ # testing HTML body+ expect(email.body.parts.last.body).to include('my-store.com')+ expect(email.body.parts.last.body).not_to include(store.url)+ end+ endenddescribe '#payment_link_email' dodiff --git a/emails/spec/mailers/spree/reimbursement_mailer_spec.rb b/emails/spec/mailers/spree/reimbursement_mailer_spec.rbindex 57773457c5..123828c9b6 100644--- a/emails/spec/mailers/spree/reimbursement_mailer_spec.rb+++ b/emails/spec/mailers/spree/reimbursement_mailer_spec.rb@@ -74,12 +74,4 @@ describe Spree::ReimbursementMailer, type: :mailer doendendend-- context 'emails contain only urls of the store where the order was made' do- it 'shows proper host url in email content' do- ActionMailer::Base.default_url_options[:host] = reimbursement.order.store.url- described_class.reimbursement_email(reimbursement).deliver_now- expect(ActionMailer::Base.default_url_options[:host]).to eq(reimbursement.order.store.url)- end- endenddiff --git a/emails/spec/mailers/spree/shipment_mailer_spec.rb b/emails/spec/mailers/spree/shipment_mailer_spec.rbindex 2270ba3b86..509cc490cd 100644--- a/emails/spec/mailers/spree/shipment_mailer_spec.rb+++ b/emails/spec/mailers/spree/shipment_mailer_spec.rb@@ -83,12 +83,4 @@ describe Spree::ShipmentMailer, type: :mailer doexpect(shipped_email).to have_body_text("Dear #{order.name}")endend-- context 'emails contain only urls of the store where the order was made' do- it 'shows proper host url in email content' do- ActionMailer::Base.default_url_options[:host] = store.url- described_class.shipped_email(shipment).deliver_now- expect(ActionMailer::Base.default_url_options[:host]).to eq(shipment.order.store.url)- end- endenddiff --git a/emails/spec/mailers/spree/test_mailer_spec.rb b/emails/spec/mailers/spree/test_mailer_spec.rbindex 4922da988d..ccfe573f5e 100644--- a/emails/spec/mailers/spree/test_mailer_spec.rb+++ b/emails/spec/mailers/spree/test_mailer_spec.rb@@ -19,18 +19,4 @@ describe Spree::TestMailer, type: :mailer doSpree::TestMailer.test_email('[email protected]')end.not_to raise_errorend-- context 'action mailer host' do- it 'falls back to spree store url' do- ActionMailer::Base.default_url_options = {}- Spree::TestMailer.test_email('[email protected]').deliver_now- expect(ActionMailer::Base.default_url_options[:host]).to eq(@default_store.url)- end-- it 'uses developer set host' do- ActionMailer::Base.default_url_options[:host] = 'test.test'- Spree::TestMailer.test_email('[email protected]').deliver_now- expect(ActionMailer::Base.default_url_options[:host]).to eq('test.test')- end- endenddiff --git a/emails/spec/spec_helper.rb b/emails/spec/spec_helper.rbindex af6b0e9a63..0cb893e15f 100644--- a/emails/spec/spec_helper.rb+++ b/emails/spec/spec_helper.rb@@ -73,6 +73,7 @@ RSpec.configure do |config|Spree::Webhooks.disabled = truereset_spree_preferencesI18n.locale = :en+ ActionMailer::Base.default_url_options = {}endconfig.include FactoryBot::Syntax::Methods