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.

Simplify `ascend_by_taxons_min_position` scope + pagy fixes (#13465)

Damian Legawieccbadbe27e88a
diff --git a/admin/app/controllers/spree/admin/resource_controller.rb b/admin/app/controllers/spree/admin/resource_controller.rb
index a64a1eade4..d419c13907 100644
--- a/admin/app/controllers/spree/admin/resource_controller.rb
+++ b/admin/app/controllers/spree/admin/resource_controller.rb
@@ -287,17 +287,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
limit = params[:per_page] || Spree::Admin::RuntimeConfig.admin_records_per_page
- sql = result.to_sql
- has_grouping = sql.include?(' HAVING ') || sql.include?(' GROUP BY ')
-
- if has_grouping
- # Use offset paginator with count_over for GROUP BY/HAVING queries
- # count_over uses COUNT(*) OVER () which works with grouped collections
- @pagy, paginated = pagy(:offset, result, limit: limit, count_over: true)
- else
- # Uses countish paginator which is faster as it avoids COUNT queries
- @pagy, paginated = pagy(:countish, result, limit: limit)
- end
+ # Uses countish paginator which is faster as it avoids COUNT queries
+ @pagy, paginated = pagy(:countish, result, limit: limit)
paginated
end
diff --git a/api/app/paginators/spree/api/paginate.rb b/api/app/paginators/spree/api/paginate.rb
index 959ac2bd45..57cda4ff17 100644
--- a/api/app/paginators/spree/api/paginate.rb
+++ b/api/app/paginators/spree/api/paginate.rb
@@ -24,17 +24,8 @@ module Spree
params_hash = @params.respond_to?(:to_unsafe_h) ? @params.to_unsafe_h : @params.to_h
request_hash = { params: params_hash }
- sql = @collection.to_sql
- has_grouping = sql.include?(' HAVING ') || sql.include?(' GROUP BY ')
-
- if has_grouping
- # Use offset paginator with count_over for GROUP BY/HAVING queries
- # count_over uses COUNT(*) OVER () which works with grouped collections
- pagy, records = pagy(:offset, @collection, limit: @per_page, request: request_hash, count_over: true)
- else
- # Uses countish paginator which is faster as it avoids COUNT queries
- pagy, records = pagy(:countish, @collection, limit: @per_page, request: request_hash)
- end
+ # Uses countish paginator which is faster as it avoids COUNT queries
+ pagy, records = pagy(:countish, @collection, limit: @per_page, request: request_hash)
PagyCollection.new(records, pagy)
end
diff --git a/core/app/models/concerns/spree/product_scopes.rb b/core/app/models/concerns/spree/product_scopes.rb
index c387697204..d8550483a8 100644
--- a/core/app/models/concerns/spree/product_scopes.rb
+++ b/core/app/models/concerns/spree/product_scopes.rb
@@ -135,16 +135,13 @@ module Spree
end
add_search_scope :ascend_by_taxons_min_position do |taxon_ids|
+ min_position_sql = "MIN(#{Classification.table_name}.position)"
+
joins(:classifications).
where(Classification.table_name => { taxon_id: taxon_ids }).
- select(
- [
- "#{Product.table_name}.*",
- "MIN(#{Classification.table_name}.position) AS min_position"
- ].join(', ')
- ).
- group(:id).
- order(min_position: :asc)
+ select("#{Product.table_name}.*", "#{min_position_sql} AS min_taxon_position").
+ group("#{Product.table_name}.id").
+ order(Arel.sql("#{min_position_sql} ASC"))
end
# a scope that finds all products having property specified by name, object or id
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 48b55a1f34..a5fae93be8 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -112,6 +112,7 @@ module Spree
has_many :line_items, through: :variants_including_master
has_many :orders, through: :line_items
+ has_many :completed_orders, -> { reorder(nil).distinct.complete }, through: :line_items, source: :order
has_many :variant_images, -> { order(:position) }, source: :images, through: :variants_including_master
has_many :variant_images_without_master, -> { order(:position) }, source: :images, through: :variants
@@ -209,14 +210,15 @@ module Spree
}
scope :by_best_selling, lambda { |order_direction = :desc|
+ order_dir = order_direction == :desc ? 'DESC' : 'ASC'
+ completed_orders_count_sql = "COUNT(DISTINCT CASE WHEN #{Spree::Order.table_name}.completed_at IS NOT NULL THEN #{Spree::Order.table_name}.id END)"
+ completed_orders_total_sql = "COALESCE(SUM(CASE WHEN #{Spree::Order.table_name}.completed_at IS NOT NULL THEN (#{Spree::LineItem.table_name}.price * #{Spree::LineItem.table_name}.quantity) END), 0)"
+
left_joins(variants_including_master: { line_items: :order }).
- select(
- "#{Spree::Product.table_name}.*",
- "COUNT(DISTINCT CASE WHEN #{Spree::Order.table_name}.completed_at IS NOT NULL THEN #{Spree::Order.table_name}.id END) AS completed_orders_count",
- "COALESCE(SUM(CASE WHEN #{Spree::Order.table_name}.completed_at IS NOT NULL THEN (#{Spree::LineItem.table_name}.price * #{Spree::LineItem.table_name}.quantity) END), 0) AS completed_orders_total"
- ).
+ select("#{Spree::Product.table_name}.*", "#{completed_orders_count_sql} AS completed_orders_count", "#{completed_orders_total_sql} AS completed_orders_total").
group("#{Spree::Product.table_name}.id").
- order(completed_orders_count: order_direction, completed_orders_total: order_direction)
+ order(Arel.sql("#{completed_orders_count_sql} #{order_dir}")).
+ order(Arel.sql("#{completed_orders_total_sql} #{order_dir}"))
}
attr_accessor :option_values_hash
diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rb
index 0f69046276..0b604b2f89 100644
--- a/core/spec/models/spree/product_spec.rb
+++ b/core/spec/models/spree/product_spec.rb
@@ -1343,18 +1343,6 @@ describe Spree::Product, type: :model do
products = described_class.where(id: test_product_ids).by_best_selling(:asc)
expect(products.map(&:name)).to eq(['Product 4', 'Product 3', 'Product 1', 'Product 2'])
end
-
- it 'includes completed_orders_count attribute' do
- products = described_class.where(id: test_product_ids).by_best_selling
- product_2_result = products.find { |p| p.id == product_2.id }
- expect(product_2_result.completed_orders_count).to eq(3)
- end
-
- it 'includes completed_orders_total attribute' do
- products = described_class.where(id: test_product_ids).by_best_selling
- product_1_result = products.find { |p| p.id == product_1.id }
- expect(product_1_result.completed_orders_total).to be > 0
- end
end
context 'with incomplete orders' do
@@ -1375,8 +1363,8 @@ describe Spree::Product, type: :model do
product_1_result = products.find { |p| p.id == product_1.id }
product_2_result = products.find { |p| p.id == product_2.id }
- expect(product_1_result.completed_orders_count).to eq(2)
- expect(product_2_result.completed_orders_count).to eq(1)
+ expect(product_1_result.completed_orders.count).to eq(2)
+ expect(product_2_result.completed_orders.count).to eq(1)
end
end
@@ -1399,7 +1387,7 @@ describe Spree::Product, type: :model do
product_1_result = products.find { |p| p.id == product_1.id }
product_2_result = products.find { |p| p.id == product_2.id }
- expect(product_2_result.completed_orders_total).to be > product_1_result.completed_orders_total
+ expect(product_2_result.completed_orders.sum(:total)).to be > product_1_result.completed_orders.sum(:total)
end
end
@@ -1429,13 +1417,15 @@ describe Spree::Product, type: :model do
product_2_result = products.find { |p| p.id == product_2.id }
# Both have 1 completed order
- expect(product_1_result.completed_orders_count).to eq(1)
- expect(product_2_result.completed_orders_count).to eq(1)
+ expect(product_1_result.completed_orders.count).to eq(1)
+ expect(product_2_result.completed_orders.count).to eq(1)
- # Product 1 should have total of $250 (50*2 + 50*3)
- # Product 2 should have total of $200 (100*2)
- expect(product_1_result.completed_orders_total).to eq(250)
- expect(product_2_result.completed_orders_total).to eq(200)
+ # Product 1 should have line item total of $250 (50*2 + 50*3)
+ # Product 2 should have line item total of $200 (100*2)
+ product_1_line_item_total = product_1_result.line_items.joins(:order).merge(Spree::Order.complete).sum('spree_line_items.price * spree_line_items.quantity')
+ product_2_line_item_total = product_2_result.line_items.joins(:order).merge(Spree::Order.complete).sum('spree_line_items.price * spree_line_items.quantity')
+ expect(product_1_line_item_total).to eq(250)
+ expect(product_2_line_item_total).to eq(200)
# Product 1 should be ranked higher due to higher total
expect(products.first.name).to eq('Product 1')
@@ -1471,12 +1461,14 @@ describe Spree::Product, type: :model do
product_2_result = products.find { |p| p.id == product_2.id }
# Verify counts
- expect(product_1_result.completed_orders_count).to eq(2)
- expect(product_2_result.completed_orders_count).to eq(1)
+ expect(product_1_result.completed_orders.count).to eq(2)
+ expect(product_2_result.completed_orders.count).to eq(1)
- # Verify totals
- expect(product_1_result.completed_orders_total).to eq(250)
- expect(product_2_result.completed_orders_total).to eq(400)
+ # Verify line item totals
+ product_1_line_item_total = product_1_result.line_items.joins(:order).merge(Spree::Order.complete).sum('spree_line_items.price * spree_line_items.quantity')
+ product_2_line_item_total = product_2_result.line_items.joins(:order).merge(Spree::Order.complete).sum('spree_line_items.price * spree_line_items.quantity')
+ expect(product_1_line_item_total).to eq(250)
+ expect(product_2_line_item_total).to eq(400)
# Product 1 should rank first because it has more orders (2 vs 1)
# even though Product 2 has a higher total ($400 vs $250)
@@ -1490,7 +1482,7 @@ describe Spree::Product, type: :model do
products = described_class.where(id: test_product_ids).by_best_selling
expect(products.length).to eq(4)
# All products should be included, those without orders have count = 0
- products.select { |p| p.completed_orders_count.zero? }.each do |product|
+ products.select { |p| p.completed_orders.none? }.each do |product|
expect(test_product_ids).to include(product.id)
end
end
@@ -1523,18 +1515,18 @@ describe Spree::Product, type: :model do
product_4_result = products.find { |p| p.id == product_4.id }
# Product 2 has pending orders but no completed orders - count should be 0
- expect(product_2_result.completed_orders_count).to eq(0)
- expect(product_2_result.completed_orders_total).to eq(0)
+ expect(product_2_result.completed_orders.count).to eq(0)
+ expect(product_2_result.completed_orders.sum(:total)).to eq(0)
# Product 1 has 2 completed orders
- expect(product_1_result.completed_orders_count).to eq(2)
+ expect(product_1_result.completed_orders.count).to eq(2)
# Product 3 has 1 completed order (pending orders not counted)
- expect(product_3_result.completed_orders_count).to eq(1)
+ expect(product_3_result.completed_orders.count).to eq(1)
# Product 4 has no orders at all - count should be 0
- expect(product_4_result.completed_orders_count).to eq(0)
- expect(product_4_result.completed_orders_total).to eq(0)
+ expect(product_4_result.completed_orders.count).to eq(0)
+ expect(product_4_result.completed_orders.sum(:total)).to eq(0)
end
it 'orders products correctly with pending orders included' do
diff --git a/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb b/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb
index 804a31279f..f0879d5ae4 100644
--- a/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb
+++ b/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb
@@ -13,18 +13,8 @@ module Spree
if Spree::Storefront::Config[:use_kaminari_pagination]
collection.page(params[:page]).per(limit)
else
- sql = collection.to_sql
- has_grouping = sql.include?(' HAVING ') || sql.include?(' GROUP BY ')
-
- if has_grouping
- # Use offset paginator with count_over for GROUP BY/HAVING queries
- # count_over uses COUNT(*) OVER () which works with grouped collections
- @pagy, records = pagy(:offset, collection, limit: limit, count_over: true)
- else
- # Uses countish paginator which is faster as it avoids COUNT queries
- @pagy, records = pagy(:countish, collection, limit: limit)
- end
-
+ # Uses countish paginator which is faster as it avoids COUNT queries
+ @pagy, records = pagy(:countish, collection, limit: limit)
records
end
end
diff --git a/storefront/app/views/spree/products/index.html.erb b/storefront/app/views/spree/products/index.html.erb
index dff4db8358..870fcb00f5 100644
--- a/storefront/app/views/spree/products/index.html.erb
+++ b/storefront/app/views/spree/products/index.html.erb
@@ -1 +1 @@
-<%= render_page(current_page, products: storefront_products.records, sort: products_sort) %>
+<%= render_page(current_page, products: storefront_products, sort: products_sort) %>
diff --git a/storefront/app/views/spree/search/show.html.erb b/storefront/app/views/spree/search/show.html.erb
index 806a432269..e3fc9ea816 100644
--- a/storefront/app/views/spree/search/show.html.erb
+++ b/storefront/app/views/spree/search/show.html.erb
@@ -1,6 +1,6 @@
<%= render_page(
current_page,
- products: storefront_products.records,
+ products: storefront_products,
query: query,
sort: products_sort
) %>
diff --git a/storefront/app/views/spree/shared/_load_more_products.turbo_stream.erb b/storefront/app/views/spree/shared/_load_more_products.turbo_stream.erb
index 6e09bb4139..647bdc4646 100644
--- a/storefront/app/views/spree/shared/_load_more_products.turbo_stream.erb
+++ b/storefront/app/views/spree/shared/_load_more_products.turbo_stream.erb
@@ -3,5 +3,5 @@
<% end %>
<%= turbo_stream.append "products" do %>
- <%= render 'spree/shared/products', products: storefront_products.records %>
+ <%= render 'spree/shared/products', products: storefront_products %>
<% end %>
diff --git a/storefront/app/views/spree/shared/_product_listing_page.html.erb b/storefront/app/views/spree/shared/_product_listing_page.html.erb
index 23f2ba9b94..536456f362 100644
--- a/storefront/app/views/spree/shared/_product_listing_page.html.erb
+++ b/storefront/app/views/spree/shared/_product_listing_page.html.erb
@@ -1,11 +1,11 @@
<% if turbo_frame_request? && current_theme_preview.nil? %>
- <%= render 'spree/page_sections/product_grid', products: storefront_products.records, section: current_page.sections.find_by(type: 'Spree::PageSections::ProductGrid') %>
+ <%= render 'spree/page_sections/product_grid', products: storefront_products, section: current_page.sections.find_by(type: 'Spree::PageSections::ProductGrid') %>
<% else %>
<%= render_page(
current_page,
taxon: @taxon,
collection: @collection,
- products: storefront_products.records,
+ products: storefront_products,
) %>
<% end %>