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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Surface skipped cart items through the cart warnings array
Damian Legawiecc9327c0cdfd3
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.rbindex 1d95d801d3..cf7e897aaa 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@@ -40,15 +40,9 @@ module Spreeend# Render the cart as JSON using the cart serializer.- # @param warnings [Array<Spree::Carts::ItemWarning>] items a batch- # upsert did not apply. Present only when something was dropped, so- # a client that ignores the key sees an unchanged payload.- def render_cart(status: :ok, warnings: [])+ def render_cart(status: :ok)@cart = @cart.remove_out_of_stock_items!- payload = Spree.api.cart_serializer.new(@cart, params: serializer_params).to_h- payload[:warnings] = warnings.map(&:to_h) if warnings.present?-- render json: payload, status: status+ render json: Spree.api.cart_serializer.new(@cart, params: serializer_params).to_h, status: statusend# Render the order as JSON using the order serializer (for complete action).diff --git a/spree/api/app/controllers/spree/api/v3/store/carts/items_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts/items_controller.rbindex 8b85140a9e..0de99f6c63 100644--- a/spree/api/app/controllers/spree/api/v3/store/carts/items_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/carts/items_controller.rb@@ -33,24 +33,28 @@ module Spreewith_order_lock do@line_item = @cart.line_items.find_by_prefix_id!(params[:id])- @line_item.metadata = @line_item.metadata.merge(permitted_params[:metadata].to_h) if permitted_params[:metadata].present?-if permitted_params[:quantity].present?- workflow = Spree.cart_upsert_items_workflow.new- result = workflow.call(+ result = Spree.cart_upsert_items_workflow.call(cart: @cart,- items: [{ variant_id: @line_item.variant_id, quantity: permitted_params[:quantity] }]+ items: [{+ variant_id: @line_item.variant_id,+ quantity: permitted_params[:quantity],+ metadata: permitted_params[:metadata]+ }])if result.success?- render_cart(warnings: workflow.warnings)+ render_cartelserender_result_error(result)end- elsif @line_item.changed?- @line_item.save!- render_cartelse+ # Metadata-only edit — no quantity change, so no item rules+ # to run and nothing for the cart to recalculate.+ if permitted_params[:metadata].present?+ @line_item.update!(metadata: @line_item.metadata.merge(permitted_params[:metadata].to_h))+ end+render_cartendend@@ -61,14 +65,13 @@ module Spreewith_order_lock do@line_item = @cart.line_items.find_by_prefix_id!(params[:id])- workflow = Spree.cart_upsert_items_workflow.new- result = workflow.call(+ result = Spree.cart_upsert_items_workflow.call(cart: @cart,items: [{ variant_id: @line_item.variant_id, quantity: 0 }])if result.success?- render_cart(warnings: workflow.warnings)+ render_cartelserender_result_error(result)enddiff --git a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rbindex ba5e190618..1dfca9e147 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@@ -30,8 +30,7 @@ module Spree# Creates a new shopping cart (order)# Can be created by guests or authenticated customersdef create- service = Spree::Carts::Create.new- result = service.call(+ result = Spree::Carts::Create.call(params: permitted_params.merge(user: current_user,store: current_store,@@ -43,7 +42,7 @@ module Spreeif result.success?@cart = result.value- render_cart(status: :created, warnings: service.item_warnings)+ render_cart(status: :created)elserender_service_error(result.error.to_s)end@@ -56,14 +55,13 @@ module Spreefind_cart!with_order_lock do- service = Spree::Carts::Update.new- result = service.call(+ result = Spree::Carts::Update.call(cart: @cart,params: permitted_params)if result.success?- render_cart(warnings: service.item_warnings)+ render_cartelserender_service_error(result.error, code: ERROR_CODES[:validation_error])enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rbindex 6adb31c50c..de2e162737 100644--- a/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb@@ -155,4 +155,49 @@ RSpec.describe Spree::Api::V3::Store::Carts::ItemsController, type: :controllerendendend++ describe 'a validate hook vetoing an item' do+ let!(:line_item) { create(:line_item, order: order, variant: variant, quantity: 1) }++ after { Spree.hooks.clear! }++ # Every non-increment mutation runs the same hook, so one handler covers+ # the quantity editor and the remove button alike.+ it 'reports a rejected quantity change as a warning and leaves the item alone' do+ Spree.hooks.register('carts.upsert_items.validate') do |flow|+ flow.errors.add(:quantity, :purchase_limit_exceeded, message: 'at most 3 per item')+ flow.reject!+ end++ patch :update, params: { cart_id: order.prefixed_id, id: line_item.prefixed_id, quantity: 9 }++ expect(response).to have_http_status(:ok)+ expect(line_item.reload.quantity).to eq(1)++ warning = json_response['warnings'].sole+ expect(warning['code']).to eq('purchase_limit_exceeded')+ expect(warning['message']).to eq('Quantity at most 3 per item')+ expect(warning['variant_id']).to eq(variant.prefixed_id)+ end++ it 'can veto a removal' do+ Spree.hooks.register('carts.upsert_items.validate') { |flow| flow.reject!('this item is required') }++ expect do+ delete :destroy, params: { cart_id: order.prefixed_id, id: line_item.prefixed_id }+ end.not_to change(Spree::LineItem, :count)++ expect(response).to have_http_status(:ok)+ expect(json_response['warnings'].sole['message']).to eq('this item is required')+ end++ # A cart nobody vetoed reports nothing — warnings are the exception.+ it 'reports no warnings when everything applied' do+ patch :update, params: { cart_id: order.prefixed_id, id: line_item.prefixed_id, quantity: 2 }++ expect(response).to have_http_status(:ok)+ expect(json_response['warnings']).to be_empty+ expect(line_item.reload.quantity).to eq(2)+ end+ endenddiff --git a/spree/core/app/models/spree/carts/item_warning.rb b/spree/core/app/models/spree/carts/item_warning.rbindex b9662bc6d0..d48239a171 100644--- a/spree/core/app/models/spree/carts/item_warning.rb+++ b/spree/core/app/models/spree/carts/item_warning.rb@@ -12,8 +12,16 @@ module Spreeattribute :message, :stringattr_accessor :variant+ # Same shape as the out-of-stock warnings the cart already carries, so+ # a client reads one warnings array rather than two vocabularies.+ # item_index is the batch position, present only for batch upserts.def to_h- { item_index: item_index, variant_id: variant&.prefixed_id, code: code, message: message }+ {+ code: code,+ message: message,+ variant_id: variant&.prefixed_id,+ item_index: item_index+ }.compactendendenddiff --git a/spree/core/app/services/spree/carts/create.rb b/spree/core/app/services/spree/carts/create.rbindex 4848d70d1b..a845db051b 100644--- a/spree/core/app/services/spree/carts/create.rb+++ b/spree/core/app/services/spree/carts/create.rb@@ -19,26 +19,22 @@ module Spree# Delegate all attribute/address/item processing to Carts::Updateif @params.present?- update = Spree::Carts::Update.new- result = update.call(cart: cart, params: @params)+ result = Spree::Carts::Update.call(cart: cart, params: @params)return result if result.failure?-- @item_warnings = update.item_warningsend- success(cart.reload)+ # Items skipped during creation are reported on the cart, and reload+ # would drop them — same carry-across as Carts::Update#try_advance.+ warnings = cart.warnings+ cart.reload+ cart.warnings |= warnings if warnings.present?++ success(cart)rescue ActiveRecord::RecordNotFoundraiserescue StandardError => efailure(nil, e.message)end-- # Items the batch did not apply — see Spree::Carts::Update#item_warnings.- #- # @return [Array<Spree::Carts::ItemWarning>]- def item_warnings- @item_warnings ||= []- endendendenddiff --git a/spree/core/app/services/spree/carts/update.rb b/spree/core/app/services/spree/carts/update.rbindex fab33f412d..9afdeb05f9 100644--- a/spree/core/app/services/spree/carts/update.rb+++ b/spree/core/app/services/spree/carts/update.rb@@ -31,15 +31,6 @@ module Spreefailure(cart, e.message)end- # Items the batch did not apply (vetoed by a :validate handler, or- # unavailable in the cart's currency). The update still succeeds — the- # caller surfaces these so the customer learns what was dropped.- #- # @return [Array<Spree::Carts::ItemWarning>]- def item_warnings- @item_warnings ||= []- end-privateattr_reader :cart, :params@@ -124,12 +115,9 @@ module Spreedef process_itemsreturn unless params[:items].is_a?(Array)- workflow = Spree.cart_upsert_items_workflow.new- result = workflow.call(cart: cart, items: params[:items])+ result = Spree.cart_upsert_items_workflow.call(cart: cart, items: params[:items])raise StandardError, result.error.to_s if result.failure?-- @item_warnings = workflow.warningsend# Legacy `before_transition to: :address` parity: once a signed-indiff --git a/spree/core/app/workflows/spree/carts/upsert_items.rb b/spree/core/app/workflows/spree/carts/upsert_items.rbindex d99a16aee4..e44b64c897 100644--- a/spree/core/app/workflows/spree/carts/upsert_items.rb+++ b/spree/core/app/workflows/spree/carts/upsert_items.rb@@ -44,7 +44,14 @@ module Spreerun_hooks :after_items_upsertedend- success(cart.reload)+ # Warnings ride on the cart itself — the same channel the+ # out-of-stock sweep uses — so they reach the serializer without+ # every caller forwarding them by hand. Set after the reload, which+ # would otherwise drop them.+ cart.reload+ cart.warnings |= warnings.map(&:to_h) if warnings.any?++ success(cart)endprivate