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.

Retire the state machine on Invitation

Damian Legawiec7241b1669f6c
diff --git a/spree/api/app/controllers/spree/api/v3/admin/invitation_acceptances_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/invitation_acceptances_controller.rb
index 4e984e2885..c9d6d69e46 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/invitation_acceptances_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/invitation_acceptances_controller.rb
@@ -32,13 +32,13 @@ module Spree
return if performed?
@invitation.invitee = user
- @invitation.accept!
+ result = Spree.invitation_accept_workflow.call(invitation: @invitation)
+
+ return render_service_error(result.error) unless result.success?
refresh_token = Spree::RefreshToken.create_for(user, audience: JWT_AUDIENCE_ADMIN, request_env: request_env_for_token)
set_refresh_cookie(refresh_token)
render json: auth_response(user)
- rescue ActiveRecord::RecordInvalid => e
- render_validation_error(e.record.errors)
end
private
diff --git a/spree/core/app/models/spree/invitation.rb b/spree/core/app/models/spree/invitation.rb
index 9c2826d37c..0025a7b868 100644
--- a/spree/core/app/models/spree/invitation.rb
+++ b/spree/core/app/models/spree/invitation.rb
@@ -37,20 +37,15 @@ module Spree
scope :not_expired, -> { where('expires_at > ?', Time.current) }
#
- # State Machine
+ # Status
#
- state_machine initial: :pending, attribute: :status do
- state :accepted do
- validate :accept_invitation_within_time_limit
- validates :invitee, presence: true
- end
-
- event :accept do
- transition pending: :accepted
- end
- after_transition to: :accepted, do: :after_accept
- after_transition to: :accepted, do: :publish_invitation_accepted_event
- end
+ # No state machine — acceptance runs through Spree::Invitations::Accept
+ # (docs/plans/6.0-service-workflows.md), which checks the expiry window
+ # and the invitee before it writes. Those were state-scoped validations
+ # on the machine's `accepted` state; as workflow guards they refuse the
+ # acceptance outright instead of leaving a record that fails to save.
+ include Spree::HasStatus
+ has_status :pending, :accepted, default: :pending
#
# Callbacks
@@ -81,6 +76,25 @@ module Spree
expires_at < Time.current
end
+ # @deprecated Call Spree.invitation_accept_workflow — removed in 6.1.
+ def accept
+ Spree::Deprecation.warn('Spree::Invitation#accept is deprecated and will be removed in Spree 6.1. Call Spree.invitation_accept_workflow instead.')
+ Spree.invitation_accept_workflow.call(invitation: self).success?
+ end
+
+ # @deprecated Call Spree.invitation_accept_workflow — removed in 6.1.
+ def accept!
+ Spree::Deprecation.warn('Spree::Invitation#accept! is deprecated and will be removed in Spree 6.1. Call Spree.invitation_accept_workflow instead.')
+ result = Spree.invitation_accept_workflow.call(invitation: self)
+
+ if result.failure?
+ errors.add(:base, result.error.value.to_s)
+ raise ActiveRecord::RecordInvalid, self
+ end
+
+ true
+ end
+
# Resends the invitation email if the invitation is pending and not expired
def resend!
return if expired? || deleted? || accepted?
@@ -90,16 +104,6 @@ module Spree
private
- # this method can be extended by developers now
- def after_accept
- create_role_user
- set_accepted_at
- end
-
- def publish_invitation_accepted_event
- publish_event('invitation.accepted')
- end
-
def publish_invitation_created_event
publish_event('invitation.created')
end
@@ -150,28 +154,10 @@ module Spree
end
end
- def set_accepted_at
- update!(accepted_at: Time.current)
- end
-
- def create_role_user
- return if invitee.blank?
-
- role_user = resource.add_user(invitee, role)
- self.role_user = role_user
- save!
- end
-
def set_invitee_from_email
return if invitee.present?
self.invitee = Spree.admin_user_class.find_by(email: email)
end
-
- def accept_invitation_within_time_limit
- if Time.current > expires_at
- errors.add(:base, 'Invitation expired')
- end
- end
end
end
diff --git a/spree/core/spec/models/spree/admin_user_spec.rb b/spree/core/spec/models/spree/admin_user_spec.rb
index 02a4f7f9e9..5d9ebb46b5 100644
--- a/spree/core/spec/models/spree/admin_user_spec.rb
+++ b/spree/core/spec/models/spree/admin_user_spec.rb
@@ -81,7 +81,7 @@ describe Spree.admin_user_class, type: :model do
context 'other users accept invitation' do
before do
- invitation.accept!
+ Spree.invitation_accept_workflow.call(invitation: invitation)
end
it 'does not remove other user\'s role' do
diff --git a/spree/core/spec/models/spree/invitation_spec.rb b/spree/core/spec/models/spree/invitation_spec.rb
index 726e9e8b77..1e0f2803b4 100644
--- a/spree/core/spec/models/spree/invitation_spec.rb
+++ b/spree/core/spec/models/spree/invitation_spec.rb
@@ -20,13 +20,16 @@ RSpec.describe Spree::Invitation, type: :model do
end
context 'when invitation is accepted after expiration' do
- it 'is invalid' do
- invitation.expires_at = 1.day.ago
- expect(invitation.accept).to be_falsey
+ it 'is refused' do
+ invitation.save!
+ invitation.update_column(:expires_at, 1.day.ago)
+
+ result = Spree.invitation_accept_workflow.call(invitation: invitation)
- expect(invitation.accepted_at).not_to be_present
+ expect(result).not_to be_success
+ expect(result.error.value).to eq(:invitation_expired)
+ expect(invitation.reload.accepted_at).not_to be_present
expect(invitation.status).to eq('pending')
- expect(invitation.errors[:base]).to include('Invitation expired')
end
end
@@ -83,14 +86,14 @@ RSpec.describe Spree::Invitation, type: :model do
context 'when accepting an invitation' do
it 'changes status to accepted' do
invitation.invitee = create(:admin_user, :without_admin_role)
- invitation.accept
+ Spree.invitation_accept_workflow.call(invitation: invitation)
expect(invitation.status).to eq('accepted')
end
it 'sets accepted_at timestamp' do
expect(invitation.accepted_at).to be_nil
invitation.invitee = create(:admin_user, :without_admin_role)
- invitation.accept
+ Spree.invitation_accept_workflow.call(invitation: invitation)
expect(invitation.accepted_at).to be_present
end
@@ -98,12 +101,12 @@ RSpec.describe Spree::Invitation, type: :model do
invitation.invitee = create(:admin_user, :without_admin_role)
expect(invitation).to receive(:publish_event).with('invitation.accepted')
- invitation.accept
+ Spree.invitation_accept_workflow.call(invitation: invitation)
end
it 'creates a resource user' do
invitation.invitee = create(:admin_user, :without_admin_role)
- expect { invitation.accept }.to change(invitation, :role_user).from(nil).to(Spree::RoleUser)
+ expect { Spree.invitation_accept_workflow.call(invitation: invitation) }.to change(invitation, :role_user).from(nil).to(Spree::RoleUser)
expect(invitation.role_user.user).to eq(invitation.invitee)
expect(invitation.role_user.resource).to eq(invitation.resource)
expect(invitation.role_user.invitation).to eq(invitation)
@@ -139,7 +142,7 @@ RSpec.describe Spree::Invitation, type: :model do
it 'does not publish event if invitation is accepted', events: true do
invitation.invitee = create(:admin_user, :without_admin_role)
expect(invitation).to receive(:publish_event).with('invitation.accepted')
- invitation.accept
+ Spree.invitation_accept_workflow.call(invitation: invitation)
expect(invitation).not_to receive(:publish_event)
invitation.resend!
diff --git a/spree/core/spec/workflows/spree/invitations/accept_spec.rb b/spree/core/spec/workflows/spree/invitations/accept_spec.rb
new file mode 100644
index 0000000000..237d7c7f47
--- /dev/null
+++ b/spree/core/spec/workflows/spree/invitations/accept_spec.rb
@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Invitations::Accept do
+ subject { described_class.call(invitation: invitation) }
+
+ let(:invitation) { create(:invitation, invitee: invitee) }
+ let(:invitee) { create(:admin_user, :without_admin_role) }
+
+ it 'marks the invitation accepted and stamps the time' do
+ expect { subject }.to change { invitation.reload.status }.from('pending').to('accepted')
+ expect(invitation.accepted_at).to be_present
+ end
+
+ it 'grants the invitee the role they were invited to' do
+ subject
+
+ expect(invitation.role_user.user).to eq(invitee)
+ expect(invitation.role_user.role).to eq(invitation.role)
+ end
+
+ it 'publishes invitation.accepted', events: true do
+ allow(invitation).to receive(:publish_event).with(anything)
+ expect(invitation).to receive(:publish_event).with('invitation.accepted')
+
+ subject
+ end
+
+ context 'when already accepted' do
+ before { invitation.update!(status: 'accepted') }
+
+ it 'refuses' do
+ expect(subject).not_to be_success
+ expect(subject.error.value).to eq(:invitation_already_accepted)
+ end
+ end
+
+ context 'when expired' do
+ before { invitation.update_column(:expires_at, 1.day.ago) }
+
+ it 'refuses and leaves the invitation pending' do
+ expect(subject).not_to be_success
+ expect(subject.error.value).to eq(:invitation_expired)
+ expect(invitation.reload.status).to eq('pending')
+ end
+ end
+
+ context 'without an invitee' do
+ let(:invitee) { nil }
+
+ it 'refuses' do
+ expect(subject).not_to be_success
+ expect(subject.error.value).to eq(:invitation_invitee_missing)
+ end
+ end
+end