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: Sorting by name failed in a non-default language (#14928)

Łukasz Adamczykb17b6d0cdf2b
diff --git a/spree/api/app/controllers/spree/api/v3/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/resource_controller.rb
index 640cb1854e..db28e85304 100644
--- a/spree/api/app/controllers/spree/api/v3/resource_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/resource_controller.rb
@@ -268,6 +268,7 @@ module Spree
preload_associations_lazily.
ransack(ransack_params, auth_object: ransack_auth_object)
result = @search.result(distinct: collection_distinct?)
+ result = result.with_translation_fallback_order if model_class.include?(Spree::TranslatableResource)
pagy_options = { limit: limit, page: page }
result = apply_collection_sort(result)
@pagy, @collection = pagy(result, **pagy_options)
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/categories_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/categories_controller_spec.rb
index 50b36273c8..6208a651de 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/categories_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/categories_controller_spec.rb
@@ -21,6 +21,24 @@ RSpec.describe Spree::Api::V3::Admin::CategoriesController, type: :controller do
expect(response).to have_http_status(:ok)
expect(json_response['data'].map { |c| c['id'] }).to include(category.prefixed_id)
end
+
+ context 'sorted by name in a non-default locale' do
+ let!(:bags) { create(:category, name: 'Bags', store: store) }
+ let!(:accessories) { create(:category, name: 'Zubehoer', store: store) }
+
+ before do
+ Mobility.with_locale(:de) { accessories.update!(name: 'Accessoires') }
+ allow(controller).to receive(:current_locale).and_return('de')
+ end
+
+ it 'sorts by the translation, falling back to the base name' do
+ ids = [category, bags, accessories].map(&:prefixed_id)
+ get :index, params: { sort: 'name', q: { id_in: ids } }, as: :json
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].pluck('id')).to eq([accessories, bags, category].map(&:prefixed_id))
+ end
+ end
end
describe 'GET #show' do
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/products_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/products_controller_spec.rb
index b428f9e470..7c48249b2a 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/products_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/products_controller_spec.rb
@@ -271,6 +271,23 @@ RSpec.describe Spree::Api::V3::Admin::ProductsController, type: :controller do
expect(names).to eq(names.sort.reverse)
end
+ context 'by name in a non-default locale' do
+ let!(:translated_product) { create(:product, name: 'Zulu Product') }
+
+ before do
+ create(:product_translation, translated_model: translated_product, locale: 'de', name: 'Aal')
+ allow(controller).to receive(:current_locale).and_return('de')
+ end
+
+ it 'sorts filtered products by the translation, falling back to the base name' do
+ ids = [product, second_product, translated_product].map(&:prefixed_id)
+ get :index, params: { sort: 'name', q: { id_in: ids } }, as: :json
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].pluck('id')).to eq([translated_product, second_product, product].map(&:prefixed_id))
+ end
+ end
+
context 'by price' do
let!(:cheap_product) do
create(:product, name: 'Cheap').tap do |p|
diff --git a/spree/core/app/models/concerns/spree/translatable_resource.rb b/spree/core/app/models/concerns/spree/translatable_resource.rb
index 99751fa73f..2db0a1489d 100644
--- a/spree/core/app/models/concerns/spree/translatable_resource.rb
+++ b/spree/core/app/models/concerns/spree/translatable_resource.rb
@@ -85,6 +85,40 @@ module Spree
def arel_table_alias
Arel::Table.new(translation_table_alias)
end
+
+ # Sorts translated fields by the translation, or by the default-language
+ # value in the base column when the translation is missing or empty.
+ # Ransack sorts them by the translation alone, which leaves untranslated
+ # records unordered. On a DISTINCT relation the value is selected as
+ # well, because PostgreSQL rejects an ORDER BY the select list lacks.
+ #
+ # @return [ActiveRecord::Relation]
+ def with_translation_fallback_order
+ relation = all
+ return relation unless relation.order_values.any? { |node| translated_ordering?(node) }
+
+ relation = relation.select(arel_table[Arel.star]) if relation.distinct_value && relation.select_values.empty?
+ orders = relation.order_values.map do |node|
+ next node unless translated_ordering?(node)
+
+ value = Arel::Nodes::NamedFunction.new('COALESCE', [
+ Arel::Nodes::NamedFunction.new('NULLIF', [node.expr, Arel::Nodes.build_quoted('')]),
+ arel_table[node.expr.name]
+ ])
+ relation = relation.select(Arel::Nodes::As.new(value, Arel.sql('translated_sort'))) if relation.distinct_value
+ node.class.new(value)
+ end
+
+ relation.reorder(orders)
+ end
+
+ private
+
+ def translated_ordering?(node)
+ node.is_a?(Arel::Nodes::Ordering) &&
+ node.expr.is_a?(Mobility::Plugins::Arel::Attribute) &&
+ self <= node.expr.backend_class.model_class
+ end
end
def get_field_with_locale(locale, field_name, fallback: false)
diff --git a/spree/core/app/models/spree/search_provider/database.rb b/spree/core/app/models/spree/search_provider/database.rb
index e8e04ab33f..2c825df65e 100644
--- a/spree/core/app/models/spree/search_provider/database.rb
+++ b/spree/core/app/models/spree/search_provider/database.rb
@@ -135,7 +135,7 @@ module Spree
end
}.join(',')
- scope.ransack({ s: ransack_sort }, auth_object: @audience).result
+ scope.ransack({ s: ransack_sort }, auth_object: @audience).result.with_translation_fallback_order
end
end
diff --git a/spree/core/spec/models/spree/concerns/translatable_resource_spec.rb b/spree/core/spec/models/spree/concerns/translatable_resource_spec.rb
index 52de61a14a..43ee59ca58 100644
--- a/spree/core/spec/models/spree/concerns/translatable_resource_spec.rb
+++ b/spree/core/spec/models/spree/concerns/translatable_resource_spec.rb
@@ -77,6 +77,41 @@ RSpec.describe Spree::TranslatableResource, type: :model do
end
end
+ describe '.with_translation_fallback_order' do
+ let!(:alpha) { create(:product, name: 'Alpha', store: store) }
+ let!(:bravo) { create(:product, name: 'Bravo', store: store) }
+ let!(:charlie) { create(:product, name: 'Charlie', store: store) }
+
+ before do
+ create(:product_translation, translated_model: charlie, locale: 'de', name: 'Anton')
+ create(:product_translation, translated_model: bravo, locale: 'de', name: '')
+ end
+
+ def sorted(direction, distinct: true)
+ Spree::Product.where(id: [alpha, bravo, charlie]).
+ ransack(s: "name #{direction}").result(distinct: distinct).
+ with_translation_fallback_order
+ end
+
+ it 'sorts by the translation, falling back to the base name when it is missing or blank' do
+ Mobility.with_locale(:de) do
+ expect(sorted(:asc).to_a).to eq([alpha, charlie, bravo])
+ expect(sorted(:desc).to_a).to eq([bravo, charlie, alpha])
+ end
+ end
+
+ it 'sorts and counts a relation without DISTINCT' do
+ Mobility.with_locale(:de) do
+ expect(sorted(:asc, distinct: false).to_a).to eq([alpha, charlie, bravo])
+ expect(sorted(:asc, distinct: false).count(:all)).to eq(3)
+ end
+ end
+
+ it 'leaves a sort in the content locale on the base column' do
+ Mobility.with_locale(:en) { expect(sorted(:asc).to_a).to eq([alpha, bravo, charlie]) }
+ end
+ end
+
describe '.translatable_rich_text_fields' do
it 'returns the fields a model declares as rich text' do
expect(Spree::Product.translatable_rich_text_fields).to eq(%i[description])
diff --git a/spree/core/spec/models/spree/search_provider/database_spec.rb b/spree/core/spec/models/spree/search_provider/database_spec.rb
index d971521c9f..ffc383d699 100644
--- a/spree/core/spec/models/spree/search_provider/database_spec.rb
+++ b/spree/core/spec/models/spree/search_provider/database_spec.rb
@@ -91,6 +91,23 @@ module Spree
end
end
+ context 'with a name sort in a non-default locale' do
+ let(:category) { create(:category, name: 'Clothing') }
+
+ before do
+ create(:product_translation, translated_model: product_2, locale: 'de', name: 'Anzug')
+ [product_1, product_2, product_3].each { |product| product.categories << category }
+ end
+
+ it 'sorts filtered products by the translation, falling back to the base name' do
+ products = Mobility.with_locale(:de) do
+ provider.search_and_filter(scope: scope, filters: { 'in_category' => category.prefixed_id }, sort: 'name').products.to_a
+ end
+
+ expect(products).to eq([product_2, product_3, product_1])
+ end
+ end
+
context 'with custom price sort' do
subject(:result) { provider.search_and_filter(scope: scope, sort: 'price') }