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.

Exclude completed carts from store cart resolution

Damian Legawiecfbb01b933b1c
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/cart_resolvable.rb b/spree/api/app/controllers/concerns/spree/api/v3/cart_resolvable.rb
index d318b90b54..39db20d08f 100644
--- a/spree/api/app/controllers/concerns/spree/api/v3/cart_resolvable.rb
+++ b/spree/api/app/controllers/concerns/spree/api/v3/cart_resolvable.rb
@@ -7,23 +7,32 @@ module Spree
protected
# Find cart by prefixed ID and authorize access via CanCanCan.
- # @return [Spree::Order]
- def find_cart
- cart_id = params[:cart_id] || params[:id]
- @cart = current_store.carts.find_by_prefix_id!(cart_id)
+ # Completed carts are not carts anymore — they 404 unless the caller
+ # opts in (idempotent completion, payment-session confirm races).
+ # @return [Spree::Cart]
+ def find_cart(include_completed: false)
+ @cart = resolve_cart(include_completed: include_completed)
authorize!(:show, @cart, cart_token)
@cart
end
- # Find the cart and authorize it for update.
- # @return [Spree::Order]
- def find_cart!
- cart_id = params[:cart_id] || params[:id]
- @cart = current_store.carts.find_by_prefix_id!(cart_id)
- authorize!(:update, @cart, cart_token)
+ # Find the cart and authorize it for update. A completed cart resolves
+ # only for opted-in flows, where mutation is impossible — :show is the
+ # right check there (the ability denies :update once completed).
+ # @return [Spree::Cart]
+ def find_cart!(include_completed: false)
+ @cart = resolve_cart(include_completed: include_completed)
+ authorize!(@cart.completed? ? :show : :update, @cart, cart_token)
@cart
end
+ def resolve_cart(include_completed:)
+ cart_id = params[:cart_id] || params[:id]
+ scope = current_store.carts
+ scope = scope.incomplete unless include_completed
+ scope.find_by_prefix_id!(cart_id)
+ end
+
# Render the cart as JSON using the cart serializer.
def render_cart(status: :ok)
@cart = @cart.remove_out_of_stock_items!
diff --git a/spree/api/app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb
index d687357a41..039f5e54a6 100644
--- a/spree/api/app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb
@@ -100,9 +100,18 @@ module Spree
def serialize_resource(resource)
serializer_class.new(resource, params: serializer_params).to_h
end
+
+ protected
+
+ # Payment confirmation races cart completion (a webhook can finish
+ # checkout before the customer returns) — completed carts must
+ # still resolve here.
+ def find_cart!
+ super(include_completed: true)
+ end
end
end
end
end
end
-end
+end
\ No newline at end of file
diff --git a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb
index 1570485c8f..2c3e49257a 100644
--- a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb
@@ -107,7 +107,7 @@ module Spree
# Idempotent: if the cart is already completed, falls back to the
# orders scope and returns the completed order.
def complete
- find_cart!
+ find_cart!(include_completed: true)
if @cart.guest_checkout_disallowed?
return render_authentication_required('api.errors.guest_checkout_not_allowed', 'You must be signed in to complete checkout')
@@ -125,6 +125,10 @@ module Spree
)
end
rescue ActiveRecord::RecordNotFound
+ # Gateway-race retry with the ORDER id: the webhook completed the
+ # cart and the client re-posts with the id it got back. Foreign
+ # prefixes never decode against carts, so this only fires for
+ # order_ ids (or genuinely unknown ids, which 404 below).
@cart = current_store.orders.complete.find_by_prefix_id!(params[:id])
authorize!(:show, @cart, cart_token)
@@ -147,7 +151,7 @@ module Spree
# Explicit by-ID lookups (show/update) stay cross-channel so a shared
# checkout can load any cart the caller is authorized for.
def scope
- current_store.carts.where(customer: current_user, channel: current_channel).order(updated_at: :desc)
+ current_store.carts.incomplete.where(customer: current_user, channel: current_channel).order(updated_at: :desc)
end
private
@@ -186,7 +190,7 @@ module Spree
# Find incomplete cart for associate action.
# Only finds guest carts (no user) or carts already owned by current user (idempotent).
def find_cart_for_association
- current_store.carts.where(customer: [nil, current_user]).find_by_prefix_id!(params[:id])
+ current_store.carts.incomplete.where(customer: [nil, current_user]).find_by_prefix_id!(params[:id])
end
# Claiming a cart requires presenting its token, even when the caller
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/payment_sessions_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/payment_sessions_controller_spec.rb
index dc0f293aeb..6028a3ce57 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts/payment_sessions_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/payment_sessions_controller_spec.rb
@@ -158,6 +158,15 @@ RSpec.describe Spree::Api::V3::Store::Carts::PaymentSessionsController, type: :c
expect(response).to have_http_status(:ok)
expect(json_response['status']).to eq('completed')
end
+
+ it 'still resolves when a webhook already completed the cart' do
+ order.update_columns(completed_at: Time.current)
+
+ patch :complete, params: { cart_id: order.prefixed_id, id: payment_session.to_param, session_result: 'success' }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['status']).to eq('completed')
+ end
end
end
end
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb
index 2bb2890ada..1c62c4c1b0 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb
@@ -35,6 +35,15 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
expect(numbers).to include(user_cart1.number, user_cart2.number)
end
+ it 'excludes completed carts — a signed-in customer never re-adopts a finished checkout' do
+ user_cart2.update_columns(completed_at: Time.current)
+
+ get :index
+
+ numbers = json_response['data'].map { |c| c['number'] }
+ expect(numbers).to eq([user_cart1.number])
+ end
+
it 'scopes carts to the request channel — other channels never leak into a surface' do
wholesale = create(:channel, store: store, code: 'wholesale')
wholesale_cart = create(:cart, customer: user, store: store, channel: wholesale)
@@ -370,6 +379,23 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
end
end
+ context 'with a completed cart' do
+ let(:cart) { create(:cart_with_line_items, store: store) }
+
+ before do
+ cart.update_columns(completed_at: Time.current)
+ request.headers['x-spree-token'] = cart.token
+ end
+
+ # The storefront contract: a completed cart is not a cart anymore —
+ # 404 tells the client to drop its stale cart cookie.
+ it 'returns not found' do
+ get :show, params: { id: cart.prefixed_id }
+
+ expect(response).to have_http_status(:not_found)
+ end
+ end
+
context 'without authentication' do
it 'returns not found for nonexistent cart' do
get :show, params: { id: 'cart_nonexistent' }