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.

feat(core): scope and sort product search by collection

Łukasz Adamczyk3ba72ae5f29f
diff --git a/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb b/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb
index 16df648b96..28ee1c25fb 100644
--- a/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/products/filters_controller.rb
@@ -11,7 +11,7 @@ module Spree
result = search_provider.filters(
scope: filters_scope,
query: search_query,
- filters: (search_filters || {}).merge('_category' => category)
+ filters: (search_filters || {}).merge('_category' => category, '_collection' => collection)
)
{
@@ -40,6 +40,7 @@ module Spree
current_currency,
current_locale,
category&.cache_key_with_version,
+ collection&.cache_key_with_version,
search_query,
search_filters&.sort_by(&:first)&.to_json,
max_updated,
@@ -55,6 +56,7 @@ module Spree
# included).
scope = current_store.products.available(Time.current, current_currency, include_preorderable: true)
scope = scope.in_category(category) if category.present?
+ scope = scope.in_collection(collection) if collection.present?
scope.accessible_by(current_ability, :show)
end
@@ -62,6 +64,11 @@ module Spree
category_id = params[:category_id]
@category ||= category_id.present? ? current_store.categories.find_by_param(category_id) : nil
end
+
+ def collection
+ collection_id = params[:collection_id]
+ @collection ||= collection_id.present? ? current_store.collections.find_by_param(collection_id) : nil
+ end
end
end
end
diff --git a/spree/api/app/services/spree/api/v3/filters_aggregator.rb b/spree/api/app/services/spree/api/v3/filters_aggregator.rb
index 6ad833f00d..3a5f2432d9 100644
--- a/spree/api/app/services/spree/api/v3/filters_aggregator.rb
+++ b/spree/api/app/services/spree/api/v3/filters_aggregator.rb
@@ -4,13 +4,15 @@ module Spree
class FiltersAggregator
# @param scope [ActiveRecord::Relation] Base product scope (fully filtered, including option values)
# @param currency [String] Currency for price range
- # @param category [Spree::Category, nil] Optional category for default_sort and category filtering context
+ # @param category [Spree::Category, nil] Optional category — drives the child-category facet only (NOT default_sort)
+ # @param sort_order [String, nil] Optional grouping sort_order (space format, e.g. a collection's 'price asc') that drives default_sort
# @param option_value_ids [Array<String>] Currently selected option value prefixed IDs (for disjunctive facet counts)
# @param scope_before_options [ActiveRecord::Relation] Scope before option value filters (for disjunctive counts)
- def initialize(scope:, currency:, category: nil, option_value_ids: [], scope_before_options: nil)
+ def initialize(scope:, currency:, category: nil, sort_order: nil, option_value_ids: [], scope_before_options: nil)
@scope = scope
@currency = currency
@category = category
+ @sort_order = sort_order
@option_value_ids = option_value_ids
@scope_before_options = scope_before_options || scope
end
@@ -19,7 +21,7 @@ module Spree
{
filters: build_filters,
sort_options: sort_options,
- default_sort: to_api_sort(@category&.sort_order || 'manual'),
+ default_sort: to_api_sort(@sort_order || 'manual'),
total_count: @scope.distinct.count
}
end
diff --git a/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb
index e50b38ffd2..b870e9c96f 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb
@@ -124,11 +124,29 @@ RSpec.describe Spree::Api::V3::Store::Products::FiltersController, type: :contro
expect(category_options.map { |t| t['name'] }).to include('Shirts', 'Pants')
end
- it 'returns default_sort from category' do
+ it 'defaults a category to manual sort (category does not drive default_sort in 6.0)' do
taxon.update!(sort_order: 'price asc')
get :index, params: { category_id: taxon.prefixed_id }
+ expect(json_response['default_sort']).to eq('manual')
+ end
+ end
+
+ context 'with collection_id parameter' do
+ let!(:collection) { create(:collection, store: store, sort_order: 'price asc') }
+
+ before { Spree::ProductCollection.create!(collection: collection, product: product1) }
+
+ it 'scopes filters to the collection' do
+ get :index, params: { collection_id: collection.prefixed_id }
+
+ expect(json_response['total_count']).to eq(1)
+ end
+
+ it 'returns default_sort from the collection' do
+ get :index, params: { collection_id: collection.prefixed_id }
+
expect(json_response['default_sort']).to eq('price')
end
end
diff --git a/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb b/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb
index 2af98ea29e..6e99799278 100644
--- a/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb
+++ b/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb
@@ -37,28 +37,34 @@ RSpec.describe Spree::Api::V3::FiltersAggregator do
end
describe 'sort options' do
+ def default_sort_for(sort_order)
+ described_class.new(scope: scope, currency: currency, sort_order: sort_order).call[:default_sort]
+ end
+
it 'returns sort_options in API format' do
sort_ids = result[:sort_options].map { |s| s[:id] }
expect(sort_ids).to eq(%w[manual best_selling price -price -available_on available_on name -name])
end
- it 'converts ascending internal format to field name' do
- taxon.update!(sort_order: 'price asc')
- expect(result[:default_sort]).to eq('price')
+ it 'converts an ascending sort_order to a field name' do
+ expect(default_sort_for('price asc')).to eq('price')
end
- it 'converts descending internal format to -field' do
- taxon.update!(sort_order: 'available_on desc')
- expect(result[:default_sort]).to eq('-available_on')
+ it 'converts a descending sort_order to a -field' do
+ expect(default_sort_for('available_on desc')).to eq('-available_on')
end
- it 'passes through values without direction unchanged' do
- taxon.update!(sort_order: 'best_selling')
- expect(result[:default_sort]).to eq('best_selling')
+ it 'passes a directionless sort_order through unchanged' do
+ expect(default_sort_for('best_selling')).to eq('best_selling')
end
- it 'returns manual as default_sort when no taxon' do
- aggregator = described_class.new(scope: scope, currency: currency, category: nil)
+ it 'defaults to manual with no sort_order' do
+ expect(default_sort_for(nil)).to eq('manual')
+ end
+
+ it "ignores the category's own sort_order (category does not drive default_sort in 6.0)" do
+ taxon.update!(sort_order: 'price asc')
+ aggregator = described_class.new(scope: scope, currency: currency, category: taxon)
expect(aggregator.call[:default_sort]).to eq('manual')
end
end
diff --git a/spree/core/app/models/spree/search_provider/database.rb b/spree/core/app/models/spree/search_provider/database.rb
index 0535e4ce5f..49deeb7dd8 100644
--- a/spree/core/app/models/spree/search_provider/database.rb
+++ b/spree/core/app/models/spree/search_provider/database.rb
@@ -33,6 +33,7 @@ module Spree
def filters(scope:, query: nil, filters: {})
filters = filters.is_a?(Hash) ? filters.dup : {}
category = filters.delete('_category') || filters.delete(:_category)
+ collection = filters.delete('_collection') || filters.delete(:_collection)
option_value_ids = Array(filters.delete('with_option_value_ids') || filters.delete(:with_option_value_ids))
# Apply text search + ransack filters (without option values)
@@ -45,7 +46,7 @@ module Spree
scope_before_options
end
- filter_facets = build_facets(scope_with_options, category: category, option_value_ids: option_value_ids, scope_before_options: scope_before_options)
+ filter_facets = build_facets(scope_with_options, category: category, sort_order: collection&.sort_order, option_value_ids: option_value_ids, scope_before_options: scope_before_options)
FiltersResult.new(
filters: filter_facets[:filters],
@@ -73,13 +74,14 @@ module Spree
Pagy::Offset.new(count: count, page: page, limit: limit)
end
- def build_facets(scope, category: nil, option_value_ids: [], scope_before_options: nil)
+ def build_facets(scope, category: nil, sort_order: nil, option_value_ids: [], scope_before_options: nil)
return { filters: [], sort_options: available_sort_options, default_sort: 'manual', total_count: scope.distinct.count } unless defined?(Spree::Api::V3::FiltersAggregator)
Spree::Api::V3::FiltersAggregator.new(
scope: scope,
currency: currency,
category: category,
+ sort_order: sort_order,
option_value_ids: option_value_ids,
scope_before_options: scope_before_options || scope
).call
@@ -89,7 +91,7 @@ module Spree
return {} if filters.blank?
filters = filters.to_unsafe_h if filters.respond_to?(:to_unsafe_h)
- filters.except('search', :search, '_category', :_category, 'with_option_value_ids', :with_option_value_ids)
+ filters.except('search', :search, '_category', :_category, '_collection', :_collection, 'with_option_value_ids', :with_option_value_ids)
end
def apply_sort(scope, sort)
diff --git a/spree/core/app/models/spree/search_provider/meilisearch.rb b/spree/core/app/models/spree/search_provider/meilisearch.rb
index ffe76bd0ec..ae3ce6022a 100644
--- a/spree/core/app/models/spree/search_provider/meilisearch.rb
+++ b/spree/core/app/models/spree/search_provider/meilisearch.rb
@@ -46,13 +46,16 @@ module Spree
end
def filters(scope:, query: nil, filters: {})
+ collection = filters.is_a?(Hash) ? (filters['_collection'] || filters[:_collection]) : nil
+ default_sort = collection ? to_api_sort(collection.sort_order) : 'manual'
+
ms_result, facet_distribution = execute_search(query: query, filters: filters, sort: nil, page: 1, limit: 0, return_facets: true)
unless ms_result
return FiltersResult.new(
filters: [],
sort_options: available_sort_options.map { |id| { id: id } },
- default_sort: 'manual',
+ default_sort: default_sort,
total_count: 0
)
end
@@ -60,7 +63,7 @@ module Spree
FiltersResult.new(
filters: build_facet_response(facet_distribution),
sort_options: available_sort_options.map { |id| { id: id } },
- default_sort: 'manual',
+ default_sort: default_sort,
total_count: ms_result['estimatedTotalHits'] || 0
)
end
@@ -244,7 +247,7 @@ module Spree
end
def filterable_attributes
- %w[product_id status in_stock preorder store_ids channel_ids locale currency available_on discontinue_on price category_ids tags option_value_ids]
+ %w[product_id status in_stock preorder store_ids channel_ids locale currency available_on discontinue_on price category_ids collection_ids tags option_value_ids]
end
def sortable_attributes
@@ -259,6 +262,14 @@ module Spree
%w[price -price name -name -available_on available_on best_selling]
end
+ # Converts internal sort format ('price asc') to API format ('price', '-price').
+ def to_api_sort(sort_value)
+ return sort_value unless sort_value.to_s.include?(' ')
+
+ field, direction = sort_value.split(' ', 2)
+ direction == 'desc' ? "-#{field}" : field
+ end
+
# Build Meilisearch filter conditions from API params.
# Combines system scoping (always applied) with user-facing filters.
def build_filters(filters)
@@ -328,6 +339,8 @@ module Spree
when 'in_categories'
parts = Array(value).filter_map { |id| "category_ids = '#{sanitize_prefixed_id(id)}'" if valid_prefixed_id?(id) }
parts.length > 1 ? "(#{parts.join(' OR ')})" : parts.first
+ when 'in_collection'
+ "collection_ids = '#{sanitize_prefixed_id(value)}'" if valid_prefixed_id?(value)
when 'with_option_value_ids'
# Handled by grouped option conditions in search_and_filter — skip here
nil
diff --git a/spree/core/app/presenters/spree/search_provider/product_presenter.rb b/spree/core/app/presenters/spree/search_provider/product_presenter.rb
index c1c5884cb1..a771b5ce03 100644
--- a/spree/core/app/presenters/spree/search_provider/product_presenter.rb
+++ b/spree/core/app/presenters/spree/search_provider/product_presenter.rb
@@ -66,6 +66,7 @@ module Spree
discontinue_on: product.discontinue_on&.to_i || 0,
category_ids: category_ids_with_ancestors,
category_names: product.taxons.map { |t| translated(t, :name, fallback_locale) },
+ collection_ids: product.collections.map(&:prefixed_id),
option_type_ids: product.option_types.map(&:prefixed_id),
option_type_names: product.option_types.map { |ot| translated(ot, :presentation, fallback_locale) },
option_value_ids: variant_option_value_ids,
diff --git a/spree/core/spec/presenters/spree/search_provider/product_presenter_spec.rb b/spree/core/spec/presenters/spree/search_provider/product_presenter_spec.rb
index 3ff3a630c8..b4689c2977 100644
--- a/spree/core/spec/presenters/spree/search_provider/product_presenter_spec.rb
+++ b/spree/core/spec/presenters/spree/search_provider/product_presenter_spec.rb
@@ -82,6 +82,18 @@ module Spree
end
end
+ context 'with collections' do
+ let(:collection) { create(:collection, store: store) }
+
+ before { Spree::ProductCollection.create!(collection: collection, product: product) }
+
+ it 'indexes collection_ids as flat prefixed IDs (no ancestors)' do
+ doc = documents.first
+ expect(doc[:collection_ids]).to eq([collection.prefixed_id])
+ expect(doc[:collection_ids].first).to start_with('coll_')
+ end
+ end
+
context 'with multiple markets' do
let!(:us_market) { create(:market, store: store, name: 'US', currency: 'USD', default_locale: 'en') }
let!(:eu_market) { create(:market, store: store, name: 'EU', currency: 'EUR', default_locale: 'de', supported_locales: 'de,fr') }