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
Fix price refusal error codes on admin order line items (V-3559) (#14553)
Damian Legawiec0adcd245d313
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb b/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rbindex e0e706426f..421fe3332a 100644--- a/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb+++ b/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb@@ -47,6 +47,8 @@ module Spreevariant_not_found: 'variant_not_found',insufficient_stock: 'insufficient_stock',invalid_quantity: 'invalid_quantity',+ invalid_price: 'invalid_price',+ price_override_not_allowed: 'price_override_not_allowed',# Validation errorsvalidation_error: 'validation_error',@@ -127,6 +129,22 @@ module Spree)end+ # Maps symbolic line-item rejections onto the API error-code vocabulary.+ #+ # @param errors [ActiveModel::Errors, Object] structured rejection from a workflow+ # @param default [String] fallback when no recognized symbol is present+ # @return [String] a value from {ERROR_CODES}+ def infer_line_item_error_code(errors, default:)+ return default unless errors.is_a?(ActiveModel::Errors)++ base_symbols = (errors.details[:base] || []).pluck(:error)+ return ERROR_CODES[:price_override_not_allowed] if base_symbols.include?(:price_override_not_allowed)+ return ERROR_CODES[:invalid_price] if base_symbols.include?(:invalid_price)+ return ERROR_CODES[:invalid_quantity] if base_symbols.include?(:quantity_rule_violated)++ default+ end+# Convenience method for service result errorsdef render_service_error(error, code: ERROR_CODES[:processing_error], status: :unprocessable_content)if error.is_a?(ActiveModel::Errors)diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/items_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/items_controller.rbindex 8500cd5deb..696b38fdbb 100644--- a/spree/api/app/controllers/spree/api/v3/admin/orders/items_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/items_controller.rb@@ -18,7 +18,7 @@ module Spreeif result.success?render json: serialize_resource(result.value), status: :createdelse- render_service_error(result.error, code: ERROR_CODES[:insufficient_stock])+ render_order_item_error(result, default_code: ERROR_CODES[:insufficient_stock])endendend@@ -37,7 +37,7 @@ module Spreeif result.success?render json: serialize_resource(@resource.reload)else- render_service_error(result.error, code: ERROR_CODES[:invalid_quantity])+ render_order_item_error(result, default_code: ERROR_CODES[:invalid_quantity])endendend@@ -88,6 +88,18 @@ module Spreedef variant@variant ||= current_store.variants.find_by_prefix_id!(permitted_params[:variant_id])end++ # Renders a failed add/update with a code inferred from symbolic errors.+ #+ # @param result [Spree::ServiceModule::Result] failed service outcome+ # @param default_code [String] fallback when the error carries no symbol+ def render_order_item_error(result, default_code:)+ error = result.error+ errors = error.respond_to?(:value) ? error.value : error+ code = infer_line_item_error_code(errors, default: default_code)++ render_service_error(error, code: code)+ endendendenddiff --git a/spree/api/spec/controllers/spree/api/v3/admin/orders/items_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/orders/items_controller_spec.rbindex 106861522e..93fd4c9879 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/orders/items_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/orders/items_controller_spec.rb@@ -97,6 +97,47 @@ RSpec.describe Spree::Api::V3::Admin::Orders::ItemsController, type: :controllerexpect(line_item.price_source).to eq('manual')expect(json_response['price_source']).to eq('manual')end++ context 'with an unusable price' do+ subject do+ post :create, params: { order_id: order.prefixed_id, variant_id: variant.prefixed_id, quantity: 1, price: 'NaN' }, as: :json+ end++ it 'refuses with the invalid_price code' do+ subject++ expect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('invalid_price')+ end+ end++ context 'with a price on a placed order' do+ before { order.update_columns(status: 'placed', completed_at: Time.current) }++ subject do+ post :create, params: { order_id: order.prefixed_id, variant_id: variant.prefixed_id, quantity: 1, price: '7.20' }, as: :json+ end++ it 'refuses with the price_override_not_allowed code' do+ subject++ expect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('price_override_not_allowed')+ end++ context 'with a non-numeric price' do+ subject do+ post :create, params: { order_id: order.prefixed_id, variant_id: variant.prefixed_id, quantity: 1, price: 'NaN' }, as: :json+ end++ it 'still refuses with price_override_not_allowed' do+ subject++ expect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('price_override_not_allowed')+ end+ end+ endenddescribe 'PATCH #update' do@@ -159,12 +200,23 @@ RSpec.describe Spree::Api::V3::Admin::Orders::ItemsController, type: :controllersubjectexpect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('price_override_not_allowed')expect(response.body).to include('placed order')expect(line_item.reload.price_source).to be_nilend++ context 'with a non-numeric price' do+ subject { patch :update, params: { order_id: order.prefixed_id, id: line_item.prefixed_id, price: 'NaN' }, as: :json }++ it 'still refuses with price_override_not_allowed' do+ subject++ expect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('price_override_not_allowed')+ end+ endend- # A 422 whose message is blank leaves the dashboard with nothing to show.context 'with an unusable price' dosubject { patch :update, params: { order_id: order.prefixed_id, id: line_item.prefixed_id, price: 'NaN' }, as: :json }@@ -172,10 +224,22 @@ RSpec.describe Spree::Api::V3::Admin::Orders::ItemsController, type: :controllersubjectexpect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('invalid_price')expect(response.body).to include('non-negative number')expect(line_item.reload.price_source).to be_nilendend++ context 'with a negative price' do+ subject { patch :update, params: { order_id: order.prefixed_id, id: line_item.prefixed_id, price: '-1' }, as: :json }++ it 'refuses with the invalid_price code' do+ subject++ expect(response).to have_http_status(:unprocessable_entity)+ expect(json_response['error']['code']).to eq('invalid_price')+ end+ endenddescribe 'DELETE #destroy' dodiff --git a/spree/core/app/services/spree/orders/update_item.rb b/spree/core/app/services/spree/orders/update_item.rbindex 20c0f897aa..878af7fa05 100644--- a/spree/core/app/services/spree/orders/update_item.rb+++ b/spree/core/app/services/spree/orders/update_item.rb@@ -21,7 +21,7 @@ module Spreeprice_provided = !price.equal?(PRICE_NOT_PROVIDED)if price_provided && order.completed?- return reject_price(line_item, Spree.t('cart_line_item.price_override_not_allowed'))+ return reject_price(line_item, :price_override_not_allowed, Spree.t('cart_line_item.price_override_not_allowed'))endattributes = {}@@ -30,7 +30,7 @@ module Spreeif price_provided && !price.nil?manual_price = parse_manual_price(price)- return reject_price(line_item, Spree.t('cart_line_item.invalid_price')) if manual_price.nil?+ return reject_price(line_item, :invalid_price, Spree.t('cart_line_item.invalid_price')) if manual_price.nil?attributes[:price] = manual_priceattributes[:price_source] = Spree::LineItem::MANUAL_PRICE_SOURCE@@ -58,8 +58,13 @@ module Spree# failure(record, message) drops the message when the record responds to# +errors+; :base rather than :price so Rails does not prefix the# attribute name onto it.- def reject_price(line_item, message)- line_item.errors.add(:base, message)+ #+ # @param line_item [Spree::LineItem]+ # @param code [Symbol] symbolic rejection carried in +details++ # @param message [String] human-readable explanation+ # @return [Spree::ServiceModule::Result]+ def reject_price(line_item, code, message)+ line_item.errors.add(:base, code, message: message)failure(line_item)enddiff --git a/spree/core/app/workflows/spree/carts/add_item.rb b/spree/core/app/workflows/spree/carts/add_item.rbindex 8bca73f97a..dbabacbe29 100644--- a/spree/core/app/workflows/spree/carts/add_item.rb+++ b/spree/core/app/workflows/spree/carts/add_item.rb@@ -60,13 +60,22 @@ module Spree# finite? is not redundant: BigDecimal parses "NaN" and "Infinity" and# neither is negative. reject! rather than failure(cart, message), which# would drop the message.+ #+ # @return [Spree::ServiceModule::Result, nil] failure when the price is refuseddef parse_manual_price- reject!(Spree.t('cart_line_item.price_override_not_allowed'), cart) if cart.completed?+ if cart.completed?+ errors.add(:base, :price_override_not_allowed, message: Spree.t('cart_line_item.price_override_not_allowed'))+ return failure(cart, errors)+ end@manual_price = BigDecimal(price.to_s)- reject!(Spree.t('cart_line_item.invalid_price'), cart) if @manual_price.negative? || !@manual_price.finite?+ if @manual_price.negative? || !@manual_price.finite?+ errors.add(:base, :invalid_price, message: Spree.t('cart_line_item.invalid_price'))+ return failure(cart, errors)+ endrescue ArgumentError- reject!(Spree.t('cart_line_item.invalid_price'), cart)+ errors.add(:base, :invalid_price, message: Spree.t('cart_line_item.invalid_price'))+ failure(cart, errors)end# Checked against the quantity the line will END UP at, not thediff --git a/spree/core/app/workflows/spree/carts/upsert_items.rb b/spree/core/app/workflows/spree/carts/upsert_items.rbindex 7ebf026ea3..ed3038798a 100644--- a/spree/core/app/workflows/spree/carts/upsert_items.rb+++ b/spree/core/app/workflows/spree/carts/upsert_items.rb@@ -107,20 +107,34 @@ module Spree# Price overrides are pre-placement only. reject! rather than# failure(cart, message), which would drop the message.if cart.completed? && @resolved_items.any?(&:price_provided)- reject!(Spree.t('cart_line_item.price_override_not_allowed'), cart)+ errors.add(:base, :price_override_not_allowed, message: Spree.t('cart_line_item.price_override_not_allowed'))+ reject!(nil, cart)endend# Never coerced — "12,50".to_d is 12, a mispriced order. finite? is not# redundant: BigDecimal parses "NaN"/"Infinity" and neither is negative.+ #+ # @param value [Object] raw price from the request+ # @return [BigDecimal, nil] parsed amount, or nil for an explicit revertdef parse_manual_price(value)return nil if value.nil?+ if cart.completed?+ errors.add(:base, :price_override_not_allowed, message: Spree.t('cart_line_item.price_override_not_allowed'))+ reject!(nil, cart)+ end+parsed = BigDecimal(value.to_s)- reject!(Spree.t('cart_line_item.invalid_price'), cart) if parsed.negative? || !parsed.finite?+ if parsed.negative? || !parsed.finite?+ errors.add(:base, :invalid_price, message: Spree.t('cart_line_item.invalid_price'))+ reject!(nil, cart)+ end+parsedrescue ArgumentError- reject!(Spree.t('cart_line_item.invalid_price'), cart)+ errors.add(:base, :invalid_price, message: Spree.t('cart_line_item.invalid_price'))+ reject!(nil, cart)end# Only external inventory is asked here: Spree's own records are alreadydiff --git a/spree/core/spec/workflows/spree/orders/upsert_items_spec.rb b/spree/core/spec/workflows/spree/orders/upsert_items_spec.rbindex 996f83d6e1..5b1b5fba05 100644--- a/spree/core/spec/workflows/spree/orders/upsert_items_spec.rb+++ b/spree/core/spec/workflows/spree/orders/upsert_items_spec.rb@@ -361,6 +361,16 @@ module Spreeit 'refuses the price override — placed-order money edits are fees and discounts' doexpect(subject).to be_failureexpect(line_item.reload.price_source).to be_nil+ expect(subject.error.value.details[:base].first[:error]).to eq(:price_override_not_allowed)+ end++ context 'with a non-numeric price' do+ let(:items) { [{ variant_id: variant.prefixed_id, quantity: 2, price: 'NaN' }] }++ it 'refuses with price_override_not_allowed rather than invalid_price' do+ expect(subject).to be_failure+ expect(subject.error.value.details[:base].first[:error]).to eq(:price_override_not_allowed)+ endendendend