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.

[SD-1515] Emit payment.paid after the payment is moved to complete (#11457)

seb8233e43b1554
diff --git a/api/app/models/spree/api/webhooks/payment_decorator.rb b/api/app/models/spree/api/webhooks/payment_decorator.rb
index 37ecff10ff..68e7fa46de 100644
--- a/api/app/models/spree/api/webhooks/payment_decorator.rb
+++ b/api/app/models/spree/api/webhooks/payment_decorator.rb
@@ -6,6 +6,12 @@ module Spree
super
queue_webhooks_requests!('payment.voided')
end
+
+ def after_completed
+ super
+ queue_webhooks_requests!('payment.paid')
+ order.queue_webhooks_requests!('order.paid') if order.paid?
+ end
end
end
end
diff --git a/api/app/models/spree/api/webhooks/shipment_decorator.rb b/api/app/models/spree/api/webhooks/shipment_decorator.rb
index c7c6ae2d7e..3f46b0cca9 100644
--- a/api/app/models/spree/api/webhooks/shipment_decorator.rb
+++ b/api/app/models/spree/api/webhooks/shipment_decorator.rb
@@ -5,13 +5,7 @@ module Spree
def after_ship
super
queue_webhooks_requests!('shipment.shipped')
- order.queue_webhooks_requests!('order.shipped') if all_order_shipments_were_shipped?
- end
-
- private
-
- def all_order_shipments_were_shipped?
- order.shipments.shipped.size == order.shipments.size
+ order.queue_webhooks_requests!('order.shipped') if order.fully_shipped?
end
end
end
diff --git a/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb b/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb
index e948ebe2e7..638ce58520 100644
--- a/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb
+++ b/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb
@@ -1,51 +1,161 @@
require 'spec_helper'
describe Spree::Payment do
+ let(:body) { Spree::Api::V2::Platform::PaymentSerializer.new(payment).serializable_hash.to_json }
let(:payment) { create(:payment) }
+ let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
- describe '#void' do
- let(:body) { Spree::Api::V2::Platform::PaymentSerializer.new(payment).serializable_hash.to_json }
- let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
+ before do
+ ENV['DISABLE_SPREE_WEBHOOKS'] = nil
+ allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
+ allow(queue_requests).to receive(:call).with(any_args)
+ allow(payment).to receive_message_chain(:state_changes, :create!)
+ end
- shared_examples 'queues a webhook request' do
- before do
- ENV['DISABLE_SPREE_WEBHOOKS'] = nil
- # Avoid creating a new state change after transitioning as is defined in the model
- # because after_void queues the HTTP request before finishing the transition, hence
- # the total state changes that are sent in the body is one less.
- allow(payment).to receive_message_chain(:state_changes, :create!)
- allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
- allow(queue_requests).to receive(:call).with(any_args)
- end
+ after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }
- after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }
+ shared_examples 'emitting the event' do |event|
+ it do
+ expect(queue_requests).to have_received(:call).with(event: event, body: body).once
+ end
+ end
- it 'executes QueueRequests.call with a payment.voided event and {} body after invoking void' do
- payment.void
- expect(queue_requests).to have_received(:call).with(event: 'payment.voided', body: body).once
- end
+ describe 'payment.paid' do
+ shared_examples 'emits payment.paid' do
+ before { payment.complete }
+
+ it_behaves_like 'emitting the event', 'payment.paid'
+ end
+
+ context 'processing -> completed' do
+ before { payment.started_processing }
+
+ include_examples 'emits payment.paid'
end
- context 'when transitioning from pending to void' do
+ context 'pending -> completed' do
before { payment.pend }
- include_examples 'queues a webhook request'
+ include_examples 'emits payment.paid'
end
- context 'when transitioning from processing to void' do
+ context 'checkout -> completed' do
+ include_examples 'emits payment.paid'
+ end
+ end
+
+ describe 'payment.voided' do
+ shared_examples 'emits payment.voided' do
+ before { payment.void }
+
+ it_behaves_like 'emitting the event', 'payment.voided'
+ end
+
+ context 'pending -> void' do
+ before { payment.pend }
+
+ include_examples 'emits payment.voided'
+ end
+
+ context 'processing -> void' do
before { payment.started_processing }
- include_examples 'queues a webhook request'
+ include_examples 'emits payment.voided'
end
- context 'when transitioning from completed to void' do
+ context 'completed -> void' do
before { payment.complete }
- include_examples 'queues a webhook request'
+ include_examples 'emits payment.voided'
end
- context 'when transitioning from checkout to void' do
- include_examples 'queues a webhook request'
+ context 'checkout -> void' do
+ include_examples 'emits payment.voided'
+ end
+ end
+
+ describe 'order.paid' do
+ let(:body) { Spree::Api::V2::Platform::OrderSerializer.new(order).serializable_hash.to_json }
+ let(:order) { payment.order }
+ let!(:another_payment) { create(:payment, order: order) }
+
+ context 'order.paid? == true' do
+ context 'processing -> complete' do
+ before do
+ # order.updated_at doesn't coincide without timecop freezing
+ Timecop.freeze do
+ payment.started_processing
+ payment.complete
+ another_payment.started_processing
+ another_payment.complete
+ end
+ end
+
+ it_behaves_like 'emitting the event', 'order.paid'
+ end
+
+ context 'pending -> complete' do
+ before do
+ Timecop.freeze do
+ payment.pend
+ payment.complete
+ another_payment.pend
+ another_payment.complete
+ end
+ end
+
+ it_behaves_like 'emitting the event', 'order.paid'
+ end
+
+ context 'checkout -> complete' do
+ before do
+ Timecop.freeze do
+ payment.complete
+ another_payment.complete
+ end
+ end
+
+ it_behaves_like 'emitting the event', 'order.paid'
+ end
+ end
+
+ context 'order.paid? == false' do
+ shared_examples 'does not emit order.paid' do
+ it { expect(queue_requests).not_to have_received(:call).with(event: 'order.paid', body: body) }
+ end
+
+ before do
+ allow(payment).to receive(:order).and_return(order)
+ allow(order).to receive(:paid?).and_return(false)
+ end
+
+ context 'processing -> complete' do
+ before do
+ Timecop.freeze do
+ payment.started_processing
+ payment.complete
+ end
+ end
+
+ include_examples 'does not emit order.paid'
+ end
+
+ context 'pending -> complete' do
+ before do
+ Timecop.freeze do
+ payment.pend
+ payment.complete
+ end
+ end
+
+ include_examples 'does not emit order.paid'
+ end
+
+ context 'checkout -> complete' do
+ before { Timecop.freeze { payment.complete } }
+
+ include_examples 'does not emit order.paid'
+ end
end
end
end
diff --git a/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb b/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb
index d47385d726..ede417fd5f 100644
--- a/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb
+++ b/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb
@@ -1,8 +1,8 @@
require 'spec_helper'
describe Spree::Shipment do
+ let(:order) { create(:order) }
let(:shipment) { create(:shipment) }
- let(:body) { Spree::Api::V2::Platform::ShipmentSerializer.new(shipment).serializable_hash.to_json }
describe '#after_ship' do
before do
@@ -19,10 +19,36 @@ describe Spree::Shipment do
let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
- it 'emits a shipment.shipped event' do
- shipment.cancel # previous state that allows the object be shipped
- shipment.ship
- expect(queue_requests).to have_received(:call).with(event: 'shipment.shipped', body: body).once
+ context 'emitting shipment.shipped' do
+ let(:body) { Spree::Api::V2::Platform::ShipmentSerializer.new(shipment).serializable_hash.to_json }
+
+ shared_examples 'emits shipment.shipped' do
+ it do
+ expect(queue_requests).to have_received(:call).with(event: 'shipment.shipped', body: body).once
+ end
+ end
+
+ context 'ready -> ship' do
+ let(:shipment) { create(:shipment, order: order) }
+
+ before do
+ order.update(state: 'complete', completed_at: Time.current)
+ shipment.reload
+ shipment.ready
+ shipment.ship
+ end
+
+ include_examples 'emits shipment.shipped'
+ end
+
+ context 'canceled -> ship' do
+ before do
+ shipment.cancel
+ shipment.ship
+ end
+
+ include_examples 'emits shipment.shipped'
+ end
end
context 'emitting order.shipped' do
@@ -30,7 +56,6 @@ describe Spree::Shipment do
order.reload
Spree::Api::V2::Platform::OrderSerializer.new(order).serializable_hash.to_json
end
- let(:order) { create(:order) }
let!(:shipments) do
create_list(
:shipment, 2,
@@ -40,21 +65,49 @@ describe Spree::Shipment do
)
end
- context 'when all order shipments were shipped' do
- it 'emits an order.shipped event' do
- shipments[0].cancel
+ shared_examples 'does not emit order.shipped' do
+ it do
+ expect(queue_requests).not_to have_received(:call).with(event: 'order.shipped', body: body)
+ end
+ end
+
+ context 'ready -> ship' do
+ before do
+ order.update(state: 'complete', completed_at: Time.current)
+ shipments.each(&:reload) # must reload to make shipments order state see it's complete
+ shipments[0].ready
shipments[0].ship
- shipments[1].cancel
- shipments[1].ship
- expect(queue_requests).to have_received(:call).with(event: 'order.shipped', body: body).once
+ end
+
+ context 'with all order shipments shipped' do
+ it 'emits order.shipped' do
+ shipments[1].ready
+ shipments[1].ship
+ expect(queue_requests).to have_received(:call).with(event: 'order.shipped', body: body).once
+ end
+ end
+
+ context 'without all order shipments shipped' do
+ include_examples 'does not emit order.shipped'
end
end
- context 'when not all order shipments were shipped' do
- it 'does not emits an order.shipped event' do
+ context 'canceled -> ship' do
+ before do
shipments[0].cancel
shipments[0].ship
- expect(queue_requests).not_to have_received(:call).with(event: 'order.shipped', body: body)
+ end
+
+ context 'with all order shipments shipped' do
+ it 'emits order.shipped' do
+ shipments[1].cancel
+ shipments[1].ship
+ expect(queue_requests).to have_received(:call).with(event: 'order.shipped', body: body).once
+ end
+ end
+
+ context 'without all order shipments shipped' do
+ include_examples 'does not emit order.shipped'
end
end
end
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index 847b3f2270..4bf1eb33fa 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -398,7 +398,7 @@ module Spree
# Helper methods for checkout steps
def paid?
- payment_state == 'paid' || payment_state == 'credit_owed'
+ payments.valid.completed.size == payments.valid.size && payments.valid.sum(:amount) >= total
end
def available_payment_methods(store = nil)
@@ -488,6 +488,10 @@ module Spree
%w(partial shipped).include?(shipment_state)
end
+ def fully_shipped?
+ shipments.shipped.size == shipments.size
+ end
+
def create_proposed_shipments
all_adjustments.shipping.delete_all
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index 4bf9a1fcd9..9fb1044bac 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -98,6 +98,7 @@ module Spree
event :complete do
transition from: [:processing, :pending, :checkout], to: :completed
end
+ after_transition to: :completed, do: :after_completed
event :void do
transition from: [:pending, :processing, :completed, :checkout], to: :void
end
@@ -204,6 +205,10 @@ module Spree
# this method is prepended in api/ to queue Webhooks requests
end
+ def after_completed
+ # this method is prepended in api/ to queue Webhooks requests
+ end
+
def has_invalid_state?
INVALID_STATES.include?(state)
end
diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rb
index 4cbfc91f2d..b959471ef0 100644
--- a/core/spec/models/spree/order_spec.rb
+++ b/core/spec/models/spree/order_spec.rb
@@ -14,9 +14,9 @@ describe Spree::Order, type: :model do
before { allow(Spree::LegacyUser).to receive_messages(current: create(:user)) }
describe '.scopes' do
- let!(:user) { FactoryBot.create(:user) }
- let!(:completed_order) { FactoryBot.create(:order, user: user, completed_at: Time.current) }
- let!(:incompleted_order) { FactoryBot.create(:order, user: user, completed_at: nil) }
+ let!(:user) { create(:user) }
+ let!(:completed_order) { create(:order, user: user, completed_at: Time.current) }
+ let!(:incompleted_order) { create(:order, user: user, completed_at: nil) }
describe '.complete' do
it { expect(Spree::Order.complete).to include completed_order }
@@ -451,7 +451,7 @@ describe Spree::Order, type: :model do
# Regression tests for #4072
context '#state_changed' do
- let(:order) { FactoryBot.create(:order) }
+ let(:order) { create(:order) }
it 'logs state changes' do
order.update_column(:payment_state, 'balance_due')
@@ -589,14 +589,14 @@ describe Spree::Order, type: :model do
end
describe '#associate_user!' do
- let(:user) { FactoryBot.create(:user_with_addreses) }
+ let(:user) { create(:user_with_addreses) }
let(:email) { user.email }
let(:created_by) { user }
let(:bill_address) { user.bill_address }
let(:ship_address) { user.ship_address }
let(:override_email) { true }
- let(:order) { FactoryBot.build(:order, order_attributes) }
+ let(:order) { build(:order, order_attributes) }
let(:order_attributes) do
{
@@ -661,14 +661,14 @@ describe Spree::Order, type: :model do
context 'when bill_address is set' do
let(:order_attributes) { super().merge(bill_address: bill_address) }
- let(:bill_address) { FactoryBot.build(:address) }
+ let(:bill_address) { build(:address) }
it_behaves_like '#associate_user!'
end
context 'when ship_address is set' do
let(:order_attributes) { super().merge(ship_address: ship_address) }
- let(:ship_address) { FactoryBot.build(:address) }
+ let(:ship_address) { build(:address) }
it_behaves_like '#associate_user!'
end
@@ -686,7 +686,7 @@ describe Spree::Order, type: :model do
end
context 'when the order is persisted' do
- let(:order) { FactoryBot.create(:order, order_attributes) }
+ let(:order) { create(:order, order_attributes) }
it 'associates a user to a persisted order' do
order.associate_user!(user)
@@ -702,7 +702,7 @@ describe Spree::Order, type: :model do
end
it 'does not change any other orders' do
- other = FactoryBot.create(:order)
+ other = create(:order)
order.associate_user!(user)
expect(other.reload.user).not_to eql(user)
end
@@ -775,7 +775,7 @@ describe Spree::Order, type: :model do
end
context '#uneditable?' do
- let(:order) { Spree::Order.create }
+ let(:order) { create(:order) }
it 'returns true when order is completed' do
allow(order).to receive_messages(complete?: true)
@@ -875,7 +875,7 @@ describe Spree::Order, type: :model do
# Regression test for #4923
context 'locking' do
- let(:order) { Spree::Order.create } # need a persisted in order to test locking
+ let(:order) { create(:order) } # need a persisted in order to test locking
it 'can lock' do
expect { order.with_lock {} }.not_to raise_error
@@ -1571,4 +1571,66 @@ describe Spree::Order, type: :model do
end
end
end
+
+ describe '#paid?' do
+ subject { order.paid? }
+
+ let!(:payment_1) { create(:payment, order: order, amount: amount) }
+ let!(:payment_2) { create(:payment, order: order, amount: amount) }
+ let(:amount) { 100 }
+ let(:order) { create(:order, total: total) }
+ let(:total) { 200 }
+
+ before { payment_1.complete }
+
+ context 'when all order valid payments were completed' do
+ before { payment_2.complete }
+
+ context 'when the amount of the valid payments >= the order total' do
+ it { expect(subject).to eq(true) }
+ end
+
+ context 'when the amount of the valid payments < the order total' do
+ let(:total) { 201 }
+
+ it { expect(subject).to eq(false) }
+ end
+ end
+
+ context 'when not all order valid payments were completed' do
+ it { expect(subject).to eq(false) }
+ end
+ end
+
+ describe '#fully_shipped?' do
+ subject { order.fully_shipped? }
+
+ let!(:shipments) do
+ create_list(
+ :shipment, 2,
+ order: order,
+ shipping_methods: [create(:shipping_method)],
+ stock_location: build(:stock_location)
+ )
+ end
+ let(:order) { create(:order) }
+
+ before do
+ shipments[0].cancel
+ shipments[0].ship
+ end
+
+ context 'when all order shipments were shipped' do
+ before do
+ shipments[1].cancel
+ shipments[1].ship
+ end
+
+ it { expect(subject).to eq(true) }
+ end
+
+ context 'when not all order shipments were shipped' do
+ it { expect(subject).to eq(false) }
+ end
+ end
end