Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Move invitation notifications handling to subscriber

Damian Legawiece308a1d7e8bc
diff --git a/admin/spec/controllers/spree/admin/invitations_controller_spec.rb b/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
index ba41a77bba..dcefc0dc99 100644
--- a/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
@@ -252,10 +252,19 @@ RSpec.describe Spree::Admin::InvitationsController, type: :controller do
describe 'PUT #resend' do
stub_authorization!
- it 'resends the invitation' do
+ before do
+ Spree::InvitationEmailSubscriber.unregister!
+ Spree::InvitationEmailSubscriber.register!
+ end
+
+ after do
+ Spree::InvitationEmailSubscriber.unregister!
+ end
+
+ it 'publishes invitation.resend event' do
invitation
clear_enqueued_jobs
- expect { put :resend, params: { id: invitation.id } }.to have_enqueued_job(ActionMailer::MailDeliveryJob)
+ expect { put :resend, params: { id: invitation.id } }.to have_enqueued_job(Spree::Events::SubscriberJob)
end
it 'redirects to invitations path' do
diff --git a/core/app/models/spree/invitation.rb b/core/app/models/spree/invitation.rb
index 7c7bc384b1..39f3ce0d7f 100644
--- a/core/app/models/spree/invitation.rb
+++ b/core/app/models/spree/invitation.rb
@@ -81,7 +81,7 @@ module Spree
def resend!
return if expired? || deleted? || accepted?
- send_invitation_email
+ publish_event('invitation.resend')
end
private
@@ -90,7 +90,6 @@ module Spree
def after_accept
create_role_user
set_accepted_at
- send_acceptance_notification
end
def send_invitation_accepted_event
@@ -98,11 +97,13 @@ module Spree
end
def send_invitation_email
- Spree::InvitationMailer.invitation_email(self).deliver_later
+ publish_event('invitation.create')
end
+ # This method is kept for backwards compatibility.
+ # Email sending is now handled by the InvitationEmailSubscriber via the 'invitation.accept' event.
def send_acceptance_notification
- Spree::InvitationMailer.invitation_accepted(self).deliver_later
+ # no-op - email is sent via event subscriber
end
def set_defaults
diff --git a/core/app/subscribers/spree/invitation_email_subscriber.rb b/core/app/subscribers/spree/invitation_email_subscriber.rb
new file mode 100644
index 0000000000..093a08fd26
--- /dev/null
+++ b/core/app/subscribers/spree/invitation_email_subscriber.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Spree
+ class InvitationEmailSubscriber < Spree::Subscriber
+ subscribes_to 'invitation.create', 'invitation.accept', 'invitation.resend'
+
+ on 'invitation.create', :send_invitation_email
+ on 'invitation.accept', :send_acceptance_notification
+ on 'invitation.resend', :resend_invitation_email
+
+ private
+
+ def send_invitation_email(event)
+ invitation = find_invitation(event)
+ return unless invitation
+
+ InvitationMailer.invitation_email(invitation).deliver_later
+ end
+
+ def send_acceptance_notification(event)
+ invitation = find_invitation(event)
+ return unless invitation
+
+ InvitationMailer.invitation_accepted(invitation).deliver_later
+ end
+
+ def resend_invitation_email(event)
+ invitation = find_invitation(event)
+ return unless invitation
+ return if invitation.expired? || invitation.deleted? || invitation.accepted?
+
+ InvitationMailer.invitation_email(invitation).deliver_later
+ end
+
+ def find_invitation(event)
+ invitation_id = event.payload['id']
+ Spree::Invitation.find_by(id: invitation_id)
+ end
+ end
+end
diff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rb
index 59041272ff..c32b53b368 100644
--- a/core/lib/spree/core/engine.rb
+++ b/core/lib/spree/core/engine.rb
@@ -281,7 +281,6 @@ module Spree
Spree::GiftCard,
Spree::GiftCardBatch,
Spree::Import,
- Spree::Invitation,
Spree::LineItem,
Spree::NewsletterSubscriber,
Spree::Order,
@@ -310,6 +309,9 @@ module Spree
if Spree::Config.events_log_enabled
Spree::EventLogSubscriber.attach_to_notifications
end
+
+ # Register invitation email subscriber
+ Spree::InvitationEmailSubscriber.register!
end
initializer 'spree.promo.register.promotions.actions' do |app|
diff --git a/core/spec/mailers/spree/invitation_mailer_spec.rb b/core/spec/mailers/spree/invitation_mailer_spec.rb
index 669afe42dc..24c0082b91 100644
--- a/core/spec/mailers/spree/invitation_mailer_spec.rb
+++ b/core/spec/mailers/spree/invitation_mailer_spec.rb
@@ -3,7 +3,7 @@ require 'spec_helper'
RSpec.describe Spree::InvitationMailer, type: :mailer do
let(:store) { @default_store }
let(:inviter) { create(:admin_user) }
- let(:invitation) { create(:invitation, email: '[email protected]', inviter: inviter, resource: store) }
+ let(:invitation) { create(:invitation, email: '[email protected]', inviter: inviter, resource: store, skip_email: true) }
let(:spree) { Spree::Core::Engine.routes.url_helpers }
before do
@@ -43,7 +43,7 @@ RSpec.describe Spree::InvitationMailer, type: :mailer do
let(:invitee) { create(:admin_user, first_name: 'John', last_name: 'Doe') }
before do
- allow(invitation).to receive(:invitee).and_return(invitee)
+ invitation.update!(invitee: invitee)
end
it 'renders the subject' do
diff --git a/core/spec/models/spree/invitation_spec.rb b/core/spec/models/spree/invitation_spec.rb
index 06bdd0962c..d1897797dc 100644
--- a/core/spec/models/spree/invitation_spec.rb
+++ b/core/spec/models/spree/invitation_spec.rb
@@ -49,8 +49,22 @@ RSpec.describe Spree::Invitation, type: :model do
expect(invitation.role).to eq(Spree::Role.default_admin_role)
end
- it 'sends invitation email after create' do
- expect { invitation.save }.to have_enqueued_job(ActionMailer::MailDeliveryJob)
+ it 'publishes invitation.create event after create' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('invitation.create') do |event|
+ received_event = event
+ end
+
+ invitation = build(:invitation)
+ invitation.save
+
+ expect(received_event).to be_present
+ expect(received_event.payload['id']).to eq(invitation.id)
+
+ Spree::Events.unsubscribe('invitation.create', subscriber)
+ Spree::Events.reset!
end
it 'sets invitee from email before validation' do
@@ -82,10 +96,23 @@ RSpec.describe Spree::Invitation, type: :model do
expect(invitation.accepted_at).to be_present
end
- it 'sends acceptance notification' do
+ it 'publishes invitation.accept event' do
invitation.invitee = create(:admin_user, :without_admin_role)
- clear_enqueued_jobs
- expect { invitation.accept }.to have_enqueued_job(ActionMailer::MailDeliveryJob)
+
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('invitation.accept') do |event|
+ received_event = event
+ end
+
+ invitation.accept
+
+ expect(received_event).to be_present
+ expect(received_event.payload['id']).to eq(invitation.id)
+
+ Spree::Events.unsubscribe('invitation.accept', subscriber)
+ Spree::Events.reset!
end
it 'creates a resource user' do
@@ -112,47 +139,57 @@ RSpec.describe Spree::Invitation, type: :model do
end
describe '#resend!' do
- it 'sends invitation email if invitation is pending and not expired' do
- invitation
- clear_enqueued_jobs
- expect { invitation.resend! }.to have_enqueued_job(ActionMailer::MailDeliveryJob)
- end
+ it 'publishes invitation.resend event if invitation is pending and not expired' do
+ Spree::Events.activate!
- it 'does not send invitation email if invitation is expired' do
- allow(invitation).to receive(:expired?).and_return(true)
- expect(invitation).not_to receive(:send_invitation_email)
- invitation.resend!
- end
+ received_event = nil
+ subscriber = Spree::Events.subscribe('invitation.resend') do |event|
+ received_event = event
+ end
- it 'does not send invitation email if invitation is accepted' do
- invitation.invitee = create(:admin_user, spree_roles: [])
- invitation.accept
- expect(invitation).not_to receive(:send_invitation_email)
invitation.resend!
+
+ expect(received_event).to be_present
+ expect(received_event.payload['id']).to eq(invitation.id)
+
+ Spree::Events.unsubscribe('invitation.resend', subscriber)
+ Spree::Events.reset!
end
- end
- describe 'custom events' do
- describe 'invitation.accept' do
- it 'publishes invitation.accept event when accepted' do
- invitation.invitee = create(:admin_user, :without_admin_role)
+ it 'does not publish event if invitation is expired' do
+ Spree::Events.activate!
- Spree::Events.activate!
+ received_event = nil
+ subscriber = Spree::Events.subscribe('invitation.resend') do |event|
+ received_event = event
+ end
- received_event = nil
- subscriber = Spree::Events.subscribe('invitation.accept') do |event|
- received_event = event
- end
+ allow(invitation).to receive(:expired?).and_return(true)
+ invitation.resend!
- invitation.accept
+ expect(received_event).to be_nil
- expect(received_event).to be_present
- expect(received_event.metadata['model_class']).to eq('Spree::Invitation')
- expect(received_event.metadata['model_id']).to eq(invitation.id.to_s)
+ Spree::Events.unsubscribe('invitation.resend', subscriber)
+ Spree::Events.reset!
+ end
- Spree::Events.unsubscribe('invitation.accept', subscriber)
- Spree::Events.reset!
+ it 'does not publish event if invitation is accepted' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('invitation.resend') do |event|
+ received_event = event
end
+
+ invitation.invitee = create(:admin_user, spree_roles: [])
+ invitation.accept
+ invitation.resend!
+
+ expect(received_event).to be_nil
+
+ Spree::Events.unsubscribe('invitation.resend', subscriber)
+ Spree::Events.reset!
end
end
+
end
diff --git a/core/spec/subscribers/spree/invitation_email_subscriber_spec.rb b/core/spec/subscribers/spree/invitation_email_subscriber_spec.rb
new file mode 100644
index 0000000000..25cf1c0531
--- /dev/null
+++ b/core/spec/subscribers/spree/invitation_email_subscriber_spec.rb
@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::InvitationEmailSubscriber do
+ include ActiveJob::TestHelper
+
+ let(:store) { @default_store }
+ let(:inviter) { create(:admin_user) }
+ let(:invitee) { create(:admin_user) }
+ let(:invitation) { create(:invitation, email: '[email protected]', inviter: inviter, resource: store, skip_email: true) }
+
+ def publish_event(event_name, invitation)
+ perform_enqueued_jobs(only: Spree::Events::SubscriberJob) do
+ Spree::Events.publish(
+ event_name,
+ { 'id' => invitation.id }
+ )
+ end
+ end
+
+ before do
+ # Unregister first to avoid duplicate subscriptions from engine initialization
+ described_class.unregister!
+ described_class.register!
+ end
+
+ after do
+ described_class.unregister!
+ end
+
+ describe 'invitation.create event' do
+ it 'sends invitation email' do
+ expect(Spree::InvitationMailer).to receive(:invitation_email).with(kind_of(Spree::Invitation)).and_return(double(deliver_later: true))
+
+ publish_event('invitation.create', invitation)
+ end
+
+ context 'when invitation not found' do
+ it 'does not raise an error' do
+ invitation_id = invitation.id
+ invitation.destroy
+
+ expect { publish_event('invitation.create', OpenStruct.new(id: invitation_id)) }.not_to raise_error
+ end
+ end
+ end
+
+ describe 'invitation.accept event' do
+ before do
+ invitation.update!(invitee: invitee)
+ end
+
+ it 'sends acceptance notification email' do
+ expect(Spree::InvitationMailer).to receive(:invitation_accepted).with(kind_of(Spree::Invitation)).and_return(double(deliver_later: true))
+
+ publish_event('invitation.accept', invitation)
+ end
+
+ context 'when invitation not found' do
+ it 'does not raise an error' do
+ invitation_id = invitation.id
+ invitation.destroy
+
+ expect { publish_event('invitation.accept', OpenStruct.new(id: invitation_id)) }.not_to raise_error
+ end
+ end
+ end
+
+ describe 'invitation.resend event' do
+ it 'resends invitation email' do
+ expect(Spree::InvitationMailer).to receive(:invitation_email).with(kind_of(Spree::Invitation)).and_return(double(deliver_later: true))
+
+ publish_event('invitation.resend', invitation)
+ end
+
+ context 'when invitation is expired' do
+ before do
+ invitation.update_column(:expires_at, 1.day.ago)
+ end
+
+ it 'does not send invitation email' do
+ expect(Spree::InvitationMailer).not_to receive(:invitation_email)
+
+ publish_event('invitation.resend', invitation)
+ end
+ end
+
+ context 'when invitation is accepted' do
+ before do
+ invitation.update!(invitee: invitee)
+ invitation.update_column(:status, 'accepted')
+ end
+
+ it 'does not send invitation email' do
+ expect(Spree::InvitationMailer).not_to receive(:invitation_email)
+
+ publish_event('invitation.resend', invitation)
+ end
+ end
+
+ context 'when invitation is deleted' do
+ before do
+ invitation.destroy
+ end
+
+ it 'does not send invitation email' do
+ expect(Spree::InvitationMailer).not_to receive(:invitation_email)
+
+ publish_event('invitation.resend', invitation)
+ end
+ end
+
+ context 'when invitation not found' do
+ it 'does not raise an error' do
+ invitation_id = invitation.id
+ invitation.destroy!
+
+ expect { publish_event('invitation.resend', OpenStruct.new(id: invitation_id)) }.not_to raise_error
+ end
+ end
+ end
+end