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.

Wire status recomputation to its event triggers

Damian Legawiecb66978f9424d
diff --git a/spree/core/app/models/spree/order_updater.rb b/spree/core/app/models/spree/order_updater.rb
index 2060dab30d..f8012064a4 100644
--- a/spree/core/app/models/spree/order_updater.rb
+++ b/spree/core/app/models/spree/order_updater.rb
@@ -112,6 +112,12 @@ module Spree
update_order_total
end
+ # Money only — payment_status/fulfillment_status are written exclusively
+ # by Spree::Orders::RecomputeStatuses, triggered from
+ # Spree::OrderStatusSubscriber on payment/refund/fulfillment/return
+ # events (never inline here: those records change without any money
+ # recalculation running, and most recalculations change no status
+ # inputs).
# The sanctioned post-placement edit path: re-sums typed rows into order
# and per-adjustable totals WITHOUT re-running promotion competition or
# tax estimation (both stay frozen once completed). Called by the admin
diff --git a/spree/core/app/subscribers/spree/order_status_subscriber.rb b/spree/core/app/subscribers/spree/order_status_subscriber.rb
new file mode 100644
index 0000000000..7ef1e96b7a
--- /dev/null
+++ b/spree/core/app/subscribers/spree/order_status_subscriber.rb
@@ -0,0 +1,45 @@
+module Spree
+ # The trigger side of derive-then-persist statuses: any payment, refund,
+ # fulfillment or return-item change recomputes the owning order's
+ # payment_status / fulfillment_status through the single writer
+ # (Spree::Orders::RecomputeStatuses). Synchronous so API responses right
+ # after a capture/void/fulfill already carry the fresh status. Cart-owned
+ # records are skipped — carts have no status columns.
+ class OrderStatusSubscriber < Spree::Subscriber
+ subscribes_to 'payment.created', 'payment.updated', 'payment.deleted',
+ 'payment.completed', 'payment.voided',
+ 'refund.created', 'refund.updated',
+ 'fulfillment.created', 'fulfillment.updated', 'fulfillment.deleted',
+ 'return_item.received', 'return_item.canceled', 'return_item.given',
+ async: false
+
+ def handle(event)
+ order = order_for(event)
+ return unless order
+
+ Spree::Orders::RecomputeStatuses.call(order: order)
+ end
+
+ private
+
+ def order_for(event)
+ resource_class = {
+ 'payment' => Spree::Payment,
+ 'refund' => Spree::Refund,
+ 'fulfillment' => Spree::Fulfillment,
+ 'return_item' => Spree::ReturnItem
+ }[event.resource_type]
+ return if resource_class.nil?
+
+ record = resource_class.find_by_prefix_id(event.payload['id'])
+ # Deleted records are gone by the time the event lands — nothing to
+ # resolve; the deletion flows that matter (fulfillment rebuilds) run
+ # their own recalculation.
+ return if record.nil?
+
+ owner = record.try(:owner) || record.try(:order) ||
+ record.try(:payment)&.try(:owner) || record.try(:return_authorization)&.order
+ owner.is_a?(Spree::Order) ? owner : nil
+ end
+ end
+end
diff --git a/spree/core/spec/subscribers/spree/order_status_subscriber_spec.rb b/spree/core/spec/subscribers/spree/order_status_subscriber_spec.rb
new file mode 100644
index 0000000000..1d6da416b5
--- /dev/null
+++ b/spree/core/spec/subscribers/spree/order_status_subscriber_spec.rb
@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe Spree::OrderStatusSubscriber do
+ let(:order) { create(:completed_order_with_totals, store: @default_store) }
+
+ it 'subscribes to every status-bearing record family' do
+ expect(described_class.subscription_patterns).to include(
+ 'payment.completed', 'payment.voided', 'refund.created',
+ 'fulfillment.updated', 'return_item.received'
+ )
+ end
+
+ it 'recomputes the owning order statuses through the single writer' do
+ payment = create(:payment, order: order, cart: nil, amount: order.total, state: 'completed')
+ order.update_columns(payment_status: nil)
+
+ event = Spree::Event.new(name: 'payment.completed', payload: { 'id' => payment.prefixed_id }, store_id: order.store_id)
+ described_class.new.handle(event)
+
+ expect(order.reload.payment_status).to be_present
+ end
+
+ it 'skips cart-owned records' do
+ cart = create(:cart_with_line_items, store: @default_store)
+ payment = create(:payment, order: nil, cart: cart, amount: 10)
+
+ event = Spree::Event.new(name: 'payment.created', payload: { 'id' => payment.prefixed_id }, store_id: cart.store_id)
+
+ expect { described_class.new.handle(event) }.not_to raise_error
+ end
+end