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.

Fix: A refund vanishing from net sales on a multi-line order

Damian Legawiec01dc36ec535a
diff --git a/spree/core/lib/spree/reporting/default_vocabulary.rb b/spree/core/lib/spree/reporting/default_vocabulary.rb
index 32bf9da231..ba03bfb471 100644
--- a/spree/core/lib/spree/reporting/default_vocabulary.rb
+++ b/spree/core/lib/spree/reporting/default_vocabulary.rb
@@ -17,11 +17,23 @@ module Spree
SQL
# A refund is issued against the order, not a line, so it is apportioned
- # by the line's share of the order's pre-tax value.
+ # by the line's share of the order's pre-tax value. The denominator is
+ # summed over the order's own lines rather than read from item_total:
+ # item_total is priced before discounts, so on a discounted order the
+ # shares would not add up to one and part of the refund would vanish.
+ # The `* 1.0` forces real division: SQLite divides two integer-valued
+ # decimals as integers, which silently rounds every share to zero.
LINE_ITEM_REFUNDS_SUBQUERY = <<~SQL.squish.freeze
SUM(
COALESCE((SELECT SUM(r.amount) FROM %{refunds} r WHERE r.order_id = %{orders}.id), 0)
- * CASE WHEN %{orders}.item_total > 0 THEN %{line_items}.pre_tax_amount / %{orders}.item_total ELSE 0 END
+ * CASE
+ WHEN COALESCE((SELECT SUM(sibling.pre_tax_amount) FROM %{line_items} sibling
+ WHERE sibling.order_id = %{orders}.id), 0) > 0
+ THEN (%{line_items}.pre_tax_amount * 1.0)
+ / (SELECT SUM(sibling.pre_tax_amount) FROM %{line_items} sibling
+ WHERE sibling.order_id = %{orders}.id)
+ ELSE 0
+ END
)
SQL
diff --git a/spree/core/spec/lib/spree/reporting/query_spec.rb b/spree/core/spec/lib/spree/reporting/query_spec.rb
index 2b4d0d66a6..3efae9a0e7 100644
--- a/spree/core/spec/lib/spree/reporting/query_spec.rb
+++ b/spree/core/spec/lib/spree/reporting/query_spec.rb
@@ -163,6 +163,17 @@ RSpec.describe Spree::Reporting::Query do
expect(after_refund.totals[:net_sales][:value]).to be < before_refund.totals[:net_sales][:value]
end
+ it 'apportions a refund across every line so net sales drops by the whole amount' do
+ create(:line_item, order: order, price: 30, quantity: 1)
+ order.line_items.each { |line| line.update_columns(pre_tax_amount: line.price * line.quantity) }
+ before_refund = run(metrics: %w[net_sales])
+
+ create(:refund, amount: 12, payment: create(:payment, order: order, amount: order.total), order: order)
+
+ after_refund = run(metrics: %w[net_sales])
+ expect(after_refund.totals[:net_sales][:value]).to eq((before_refund.totals[:net_sales][:value] - 12).round(2))
+ end
+
it 'counts an order once however many refunds it carries' do
payment = create(:payment, order: order, amount: order.total)
2.times { create(:refund, amount: 4, payment: payment, order: order) }