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
Refactor newsletter email delivery to use event-driven subscriber (#13692)
Damian Legawiec4e53dbbb34b3
diff --git a/spree/core/app/models/spree/newsletter_subscriber.rb b/spree/core/app/models/spree/newsletter_subscriber.rbindex bae1cc0573..9282774eb2 100644--- a/spree/core/app/models/spree/newsletter_subscriber.rb+++ b/spree/core/app/models/spree/newsletter_subscriber.rb@@ -1,10 +1,7 @@-require_dependency 'spree/newsletter_subscriber/emails'-module Spreeclass NewsletterSubscriber < Spree.base_classhas_prefix_id :sub- include Spree::NewsletterSubscriber::Emailsinclude Spree::Metafieldspublishes_lifecycle_eventsdiff --git a/spree/core/app/models/spree/newsletter_subscriber/emails.rb b/spree/core/app/models/spree/newsletter_subscriber/emails.rbdeleted file mode 100644index 459a533071..0000000000--- a/spree/core/app/models/spree/newsletter_subscriber/emails.rb+++ /dev/null@@ -1,12 +0,0 @@-module Spree- class NewsletterSubscriber < Spree.base_class- module Emails- extend ActiveSupport::Concern-- def deliver_newsletter_email_verification- # you can overwrite this method in your application / extension to send out the confirmation email- # or use `spree_emails` gem- end- end- end-enddiff --git a/spree/core/app/models/spree/order.rb b/spree/core/app/models/spree/order.rbindex 95849f35fe..a1c311eb50 100644--- a/spree/core/app/models/spree/order.rb+++ b/spree/core/app/models/spree/order.rb@@ -3,7 +3,6 @@ require_dependency 'spree/order/currency_updater'require_dependency 'spree/order/digital'require_dependency 'spree/order/payments'require_dependency 'spree/order/store_credit'-require_dependency 'spree/order/emails'require_dependency 'spree/order/gift_card'module Spree@@ -22,7 +21,6 @@ module Spreeinclude Spree::Order::Paymentsinclude Spree::Order::StoreCreditinclude Spree::Order::AddressBook- include Spree::Order::Emailsinclude Spree::Order::Webhooksinclude Spree::Core::NumberGenerator.new(prefix: 'R')include Spree::Order::GiftCard@@ -965,7 +963,6 @@ module Spreepayments.store_credits.pending.each(&:void!)end- send_cancel_emailupdate_with_updater!send_order_canceled_webhookpublish_order_canceled_eventdiff --git a/spree/core/app/models/spree/order/emails.rb b/spree/core/app/models/spree/order/emails.rbdeleted file mode 100644index e74bf3245f..0000000000--- a/spree/core/app/models/spree/order/emails.rb+++ /dev/null@@ -1,24 +0,0 @@-module Spree- class Order < Spree.base_class- module Emails- extend ActiveSupport::Concern-- def deliver_order_confirmation_email- Spree::Deprecation.warn('Spree::Order#deliver_order_confirmation_email is deprecated and will be removed in Spree 5.5. Please create a Subscriber for order.completed event.')- end-- # If you would like to also send confirmation email to store owner(s)- def deliver_store_owner_order_notification_email?- false- end-- def deliver_store_owner_order_notification_email- Spree::Deprecation.warn('Spree::Order#deliver_store_owner_order_notification_email is deprecated and will be removed in Spree 5.5. Please create a Subscriber for order.completed event.')- end-- def send_cancel_email- Spree::Deprecation.warn('Spree::Order#send_cancel_email is deprecated and will be removed in Spree 5.5. Please create a Subscriber for order.canceled event.')- end- end- end-enddiff --git a/spree/core/app/models/spree/reimbursement.rb b/spree/core/app/models/spree/reimbursement.rbindex 571f1abe98..3248561d7c 100644--- a/spree/core/app/models/spree/reimbursement.rb+++ b/spree/core/app/models/spree/reimbursement.rb@@ -4,7 +4,6 @@ module Spreeinclude Spree::Core::NumberGenerator.new(prefix: 'RI', length: 9)include Spree::NumberIdentifier- include Spree::Reimbursement::Emailsclass IncompleteReimbursementError < StandardError; end@@ -116,7 +115,6 @@ module Spreeif unpaid_amount_within_tolerance?reimbursed!reimbursement_success_hooks.each { |h| h.call self }- send_reimbursement_emailelseerrored!reimbursement_failure_hooks.each { |h| h.call self }diff --git a/spree/core/app/models/spree/reimbursement/emails.rb b/spree/core/app/models/spree/reimbursement/emails.rbdeleted file mode 100644index d01b9ecc97..0000000000--- a/spree/core/app/models/spree/reimbursement/emails.rb+++ /dev/null@@ -1,11 +0,0 @@-module Spree- class Reimbursement < Spree.base_class- module Emails- def send_reimbursement_email- # you can overwrite this method in your application / extension to send out the confirmation email- # or use `spree_emails` gem- # YourEmailVendor.deliver_reimbursement_email(id) # `id` = ID of the Reimbursement being sent, you can also pass the entire object using `self`- end- end- end-enddiff --git a/spree/core/app/models/spree/shipment.rb b/spree/core/app/models/spree/shipment.rbindex 8ee6864ff5..552e036895 100644--- a/spree/core/app/models/spree/shipment.rb+++ b/spree/core/app/models/spree/shipment.rb@@ -14,7 +14,6 @@ module Spreeif defined?(Spree::VendorConcern)include Spree::VendorConcernend- include Spree::Shipment::Emailsinclude Spree::Shipment::Webhooksinclude Spree::Shipment::CustomEventsdiff --git a/spree/core/app/models/spree/shipment/emails.rb b/spree/core/app/models/spree/shipment/emails.rbdeleted file mode 100644index 1adf2fb680..0000000000--- a/spree/core/app/models/spree/shipment/emails.rb+++ /dev/null@@ -1,12 +0,0 @@-module Spree- class Shipment < Spree.base_class- module Emails- def send_shipped_email- Spree::Deprecation.warn("Shipment#send_shipped_email is deprecated and will be removed in Spree 5.5. Please use events")- # you can overwrite this method in your application / extension to send out the confirmation email- # or use `spree_emails` gem- # YourEmailVendor.deliver_shipment_notification_email(@shipment.id)- end- end- end-enddiff --git a/spree/core/app/models/spree/shipment_handler.rb b/spree/core/app/models/spree/shipment_handler.rbindex 5776f13c1e..70953a6ad5 100644--- a/spree/core/app/models/spree/shipment_handler.rb+++ b/spree/core/app/models/spree/shipment_handler.rb@@ -1,6 +1,5 @@module Spreeclass ShipmentHandler- include Spree::Shipment::Emailsinclude Spree::IntegrationsConcernclass << self@@ -25,7 +24,6 @@ module Spree@shipment.process_order_payments if Spree::Config[:auto_capture_on_dispatch]@shipment.touch :shipped_atupdate_order_shipment_state- send_shipped_emailendprotecteddiff --git a/spree/core/app/services/spree/newsletter/subscribe.rb b/spree/core/app/services/spree/newsletter/subscribe.rbindex e714a2bddb..d2c067f611 100644--- a/spree/core/app/services/spree/newsletter/subscribe.rb+++ b/spree/core/app/services/spree/newsletter/subscribe.rb@@ -19,8 +19,8 @@ module Spreeendend- # deliver confirmation email after the transaction is completed- subscriber.deliver_newsletter_email_verification unless subscriber.verified?+ # publish event to trigger email delivery via subscriber+ subscriber.publish_event('newsletter_subscriber.subscribed') unless subscriber.verified?subscriberenddiff --git a/spree/core/spec/models/spree/shipment_spec.rb b/spree/core/spec/models/spree/shipment_spec.rbindex 40511d6c99..ad861044be 100644--- a/spree/core/spec/models/spree/shipment_spec.rb+++ b/spree/core/spec/models/spree/shipment_spec.rb@@ -545,7 +545,6 @@ describe Spree::Shipment, type: :model docontext 'when shipment state changes to shipped' dobefore do- allow_any_instance_of(Spree::ShipmentHandler).to receive(:send_shipped_email)allow_any_instance_of(Spree::ShipmentHandler).to receive(:update_order_shipment_state)end@@ -734,7 +733,6 @@ describe Spree::Shipment, type: :model doit 'unstocks them items' doallow_any_instance_of(Spree::ShipmentHandler).to receive(:update_order_shipment_state)- allow_any_instance_of(Spree::ShipmentHandler).to receive(:send_shipped_email)expect(shipment_with_inventory_units.stock_location).to receive(:unstock)subject@@ -750,7 +748,6 @@ describe Spree::Shipment, type: :model doit 'updates shipped_at timestamp' doallow_any_instance_of(Spree::ShipmentHandler).to receive(:update_order_shipment_state)- allow_any_instance_of(Spree::ShipmentHandler).to receive(:send_shipped_email)shipment.ship!expect(shipment.shipped_at).not_to be_nil@@ -761,7 +758,6 @@ describe Spree::Shipment, type: :model doit 'finalizes adjustments' doallow_any_instance_of(Spree::ShipmentHandler).to receive(:update_order_shipment_state)- allow_any_instance_of(Spree::ShipmentHandler).to receive(:send_shipped_email)expect(shipment.adjustments).to all(receive(:finalize!))shipment.ship!diff --git a/spree/core/spec/services/spree/newsletter/subscribe_spec.rb b/spree/core/spec/services/spree/newsletter/subscribe_spec.rbindex 358219c2d8..65703819a4 100644--- a/spree/core/spec/services/spree/newsletter/subscribe_spec.rb+++ b/spree/core/spec/services/spree/newsletter/subscribe_spec.rb@@ -22,7 +22,7 @@ module Spreeendit 'does not send a confirmation email' do- expect_any_instance_of(Spree::NewsletterSubscriber).not_to receive(:deliver_newsletter_email_verification)+ expect_any_instance_of(Spree::NewsletterSubscriber).not_to receive(:publish_event).with('newsletter_subscriber.subscribed')serviceend@@ -41,7 +41,7 @@ module Spreeendit 'does not send a confirmation email' do- expect_any_instance_of(Spree::NewsletterSubscriber).not_to receive(:deliver_newsletter_email_verification)+ expect_any_instance_of(Spree::NewsletterSubscriber).not_to receive(:publish_event).with('newsletter_subscriber.subscribed')serviceend@@ -56,7 +56,7 @@ module Spreelet(:email) { '[email protected]' }it 'sends a confirmation email' do- expect_any_instance_of(Spree::NewsletterSubscriber).to receive(:deliver_newsletter_email_verification).once+ expect_any_instance_of(Spree::NewsletterSubscriber).to receive(:publish_event).with('newsletter_subscriber.subscribed').onceserviceend@@ -82,7 +82,7 @@ module Spreeendit 'does not send a confirmation email' do- expect_any_instance_of(Spree::NewsletterSubscriber).not_to receive(:deliver_newsletter_email_verification)+ expect_any_instance_of(Spree::NewsletterSubscriber).not_to receive(:publish_event).with('newsletter_subscriber.subscribed')serviceend@@ -100,7 +100,7 @@ module Spreeendit 'sends a confirmation email' do- expect_any_instance_of(Spree::NewsletterSubscriber).to receive(:deliver_newsletter_email_verification).once+ expect_any_instance_of(Spree::NewsletterSubscriber).to receive(:publish_event).with('newsletter_subscriber.subscribed').onceserviceenddiff --git a/spree/emails/app/models/spree/newsletter_subscriber/emails.rb b/spree/emails/app/models/spree/newsletter_subscriber/emails.rbdeleted file mode 100644index abae1aab5f..0000000000--- a/spree/emails/app/models/spree/newsletter_subscriber/emails.rb+++ /dev/null@@ -1,13 +0,0 @@-module Spree- class NewsletterSubscriber < Spree.base_class- module Emails- def store- @store ||= Spree::Store.current || Spree::Store.default- end-- def deliver_newsletter_email_verification- NewsletterMailer.email_confirmation(self).deliver_later if store.prefers_send_consumer_transactional_emails?- end- end- end-enddiff --git a/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rb b/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rbnew file mode 100644index 0000000000..c9b20d1614--- /dev/null+++ b/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rb@@ -0,0 +1,25 @@+# frozen_string_literal: true++module Spree+ class NewsletterSubscriberEmailSubscriber < Spree::Subscriber+ subscribes_to 'newsletter_subscriber.subscribed'++ def handle(event)+ subscriber = find_subscriber(event)+ return unless subscriber+ return if subscriber.verified?++ store = Spree::Current.store || Spree::Store.default+ return unless store.prefers_send_consumer_transactional_emails?++ NewsletterMailer.email_confirmation(subscriber).deliver_later+ end++ private++ def find_subscriber(event)+ subscriber_id = event.payload['id']+ Spree::NewsletterSubscriber.find_by_prefix_id(subscriber_id)+ end+ end+enddiff --git a/spree/emails/app/subscribers/spree/order_email_subscriber.rb b/spree/emails/app/subscribers/spree/order_email_subscriber.rbindex 1015d03dbd..e8c8dbd16a 100644--- a/spree/emails/app/subscribers/spree/order_email_subscriber.rb+++ b/spree/emails/app/subscribers/spree/order_email_subscriber.rb@@ -57,7 +57,7 @@ module Spreedef find_order(event)order_id = event.payload['id']- Spree::Order.find_by(id: order_id)+ Spree::Order.find_by_prefix_id(order_id)endendenddiff --git a/spree/emails/app/subscribers/spree/reimbursement_email_subscriber.rb b/spree/emails/app/subscribers/spree/reimbursement_email_subscriber.rbindex c1ddcd2965..39287c5a79 100644--- a/spree/emails/app/subscribers/spree/reimbursement_email_subscriber.rb+++ b/spree/emails/app/subscribers/spree/reimbursement_email_subscriber.rb@@ -18,7 +18,7 @@ module Spreedef find_reimbursement(event)reimbursement_id = event.payload['id']- Spree::Reimbursement.find_by(id: reimbursement_id)+ Spree::Reimbursement.find_by_prefix_id(reimbursement_id)endendenddiff --git a/spree/emails/app/subscribers/spree/shipment_email_subscriber.rb b/spree/emails/app/subscribers/spree/shipment_email_subscriber.rbindex ea3dcc165d..2fc006558f 100644--- a/spree/emails/app/subscribers/spree/shipment_email_subscriber.rb+++ b/spree/emails/app/subscribers/spree/shipment_email_subscriber.rb@@ -18,7 +18,7 @@ module Spreedef find_shipment(event)shipment_id = event.payload['id']- Spree::Shipment.find_by(id: shipment_id)+ Spree::Shipment.find_by_prefix_id(shipment_id)endendenddiff --git a/spree/emails/lib/spree/emails/engine.rb b/spree/emails/lib/spree/emails/engine.rbindex df8472df01..cbfa7ac59f 100644--- a/spree/emails/lib/spree/emails/engine.rb+++ b/spree/emails/lib/spree/emails/engine.rb@@ -14,7 +14,8 @@ module SpreeSpree.subscribers.concat [Spree::OrderEmailSubscriber,Spree::ShipmentEmailSubscriber,- Spree::ReimbursementEmailSubscriber+ Spree::ReimbursementEmailSubscriber,+ Spree::NewsletterSubscriberEmailSubscriber]endenddiff --git a/spree/emails/spec/models/spree/newsletter_subscriber_spec.rb b/spree/emails/spec/models/spree/newsletter_subscriber_spec.rbdeleted file mode 100644index 1caba8a92a..0000000000--- a/spree/emails/spec/models/spree/newsletter_subscriber_spec.rb+++ /dev/null@@ -1,27 +0,0 @@-require 'spec_helper'-describe Spree::NewsletterSubscriber, type: :model, newsletter: true do- let(:store) { Spree::Store.default }- let(:subscriber) { create(:newsletter_subscriber) }-- describe '#deliver_newsletter_email_verification' do- subject(:deliver_newsletter_email_verification) { subscriber.deliver_newsletter_email_verification }-- it 'calls newsletter mailer' do- expect(Spree::NewsletterMailer).to receive(:email_confirmation).with(subscriber).and_return(double(deliver_later: true))-- deliver_newsletter_email_verification- end-- context 'when send_consumer_transactional_emails store setting is disabled' do- before do- allow(Spree::Current).to receive(:store).and_return(store)- allow(store).to receive(:prefers_send_consumer_transactional_emails?).and_return(false)- end-- it 'does not call newsletter mailer' do- expect(Spree::NewsletterMailer).not_to receive(:email_confirmation)- deliver_newsletter_email_verification- end- end- end-enddiff --git a/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rb b/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rbnew file mode 100644index 0000000000..a695235c71--- /dev/null+++ b/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rb@@ -0,0 +1,56 @@+# frozen_string_literal: true++require 'spec_helper'++RSpec.describe Spree::NewsletterSubscriberEmailSubscriber do+ let(:store) { create(:store) }+ let(:newsletter_subscriber) { create(:newsletter_subscriber) }+ let(:subscriber) { described_class.new }++ def mock_event(newsletter_subscriber)+ double('Event', payload: { 'id' => newsletter_subscriber.prefixed_id })+ end++ before do+ allow(Spree::Current).to receive(:store).and_return(store)+ store.update!(preferences: store.preferences.merge(send_consumer_transactional_emails: true))+ end++ describe 'newsletter_subscriber.subscribed event' do+ it 'sends email confirmation' do+ expect(Spree::NewsletterMailer).to receive(:email_confirmation).with(newsletter_subscriber).and_return(double(deliver_later: true))++ subscriber.handle(mock_event(newsletter_subscriber))+ end++ context 'when subscriber is already verified' do+ let(:newsletter_subscriber) { create(:newsletter_subscriber, :verified) }++ it 'does not send email confirmation' do+ expect(Spree::NewsletterMailer).not_to receive(:email_confirmation)++ subscriber.handle(mock_event(newsletter_subscriber))+ end+ end++ context 'when store does not prefer transactional emails' do+ before do+ store.update!(preferences: store.preferences.merge(send_consumer_transactional_emails: false))+ end++ it 'does not send email confirmation' do+ expect(Spree::NewsletterMailer).not_to receive(:email_confirmation)++ subscriber.handle(mock_event(newsletter_subscriber))+ end+ end++ context 'when subscriber not found' do+ it 'does not raise an error' do+ newsletter_subscriber.destroy++ expect { subscriber.handle(mock_event(newsletter_subscriber)) }.not_to raise_error+ end+ end+ end+enddiff --git a/spree/emails/spec/subscribers/spree/order_email_subscriber_spec.rb b/spree/emails/spec/subscribers/spree/order_email_subscriber_spec.rbindex bdcbdd3287..4c7be78228 100644--- a/spree/emails/spec/subscribers/spree/order_email_subscriber_spec.rb+++ b/spree/emails/spec/subscribers/spree/order_email_subscriber_spec.rb@@ -8,7 +8,7 @@ RSpec.describe Spree::OrderEmailSubscriber dolet(:subscriber) { described_class.new }def mock_event(order)- double('Event', payload: { 'id' => order.id })+ double('Event', payload: { 'id' => order.prefixed_id })endbefore dodiff --git a/spree/emails/spec/subscribers/spree/reimbursement_email_subscriber_spec.rb b/spree/emails/spec/subscribers/spree/reimbursement_email_subscriber_spec.rbindex d03d0692f7..21685b24a0 100644--- a/spree/emails/spec/subscribers/spree/reimbursement_email_subscriber_spec.rb+++ b/spree/emails/spec/subscribers/spree/reimbursement_email_subscriber_spec.rb@@ -7,8 +7,8 @@ RSpec.describe Spree::ReimbursementEmailSubscriber dolet(:store) { reimbursement.store }let(:subscriber) { described_class.new }- def mock_event(reimbursement_id)- double('Event', payload: { 'id' => reimbursement_id })+ def mock_event(reimbursement)+ double('Event', payload: { 'id' => reimbursement.prefixed_id })endbefore do@@ -19,7 +19,7 @@ RSpec.describe Spree::ReimbursementEmailSubscriber doit 'sends reimbursement email' doexpect(Spree::ReimbursementMailer).to receive(:reimbursement_email).with(reimbursement.id).and_return(double(deliver_later: true))- subscriber.handle(mock_event(reimbursement.id))+ subscriber.handle(mock_event(reimbursement))endcontext 'when store does not prefer transactional emails' do@@ -30,13 +30,15 @@ RSpec.describe Spree::ReimbursementEmailSubscriber doit 'does not send reimbursement email' doexpect(Spree::ReimbursementMailer).not_to receive(:reimbursement_email)- subscriber.handle(mock_event(reimbursement.id))+ subscriber.handle(mock_event(reimbursement))endendcontext 'when reimbursement not found' doit 'does not raise an error' do- expect { subscriber.handle(mock_event(-1)) }.not_to raise_error+ reimbursement.destroy++ expect { subscriber.handle(mock_event(reimbursement)) }.not_to raise_errorendendenddiff --git a/spree/emails/spec/subscribers/spree/shipment_email_subscriber_spec.rb b/spree/emails/spec/subscribers/spree/shipment_email_subscriber_spec.rbindex 2b420a8a8e..b6b71ce1e5 100644--- a/spree/emails/spec/subscribers/spree/shipment_email_subscriber_spec.rb+++ b/spree/emails/spec/subscribers/spree/shipment_email_subscriber_spec.rb@@ -9,7 +9,7 @@ RSpec.describe Spree::ShipmentEmailSubscriber dolet(:subscriber) { described_class.new }def mock_event(shipment)- double('Event', payload: { 'id' => shipment.id })+ double('Event', payload: { 'id' => shipment.prefixed_id })endbefore do