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 list-position ordering on acts_as_list admin endpoints (#14564)
Damian Legawiec535ccb489b33
diff --git a/spree/api/app/controllers/spree/api/v3/admin/catalogs_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/catalogs_controller.rbindex 9334109b45..a0241b386a 100644--- a/spree/api/app/controllers/spree/api/v3/admin/catalogs_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/catalogs_controller.rb@@ -66,7 +66,7 @@ module Spreeenddef scope- super.for_store(current_store)+ super.orderedenddef collection_includesdiff --git a/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rbindex 5a53200cd1..29030ddff9 100644--- a/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb@@ -28,6 +28,10 @@ module Spree[:rules]end+ def scope+ super.ordered+ end+# Flat params. +rules+ is applied by the model's sync setter# (Spree::Collection#rules=): the full desired rule set, prefixed# +crule_+ ids update, missing ids build, omitted rules are removed —diff --git a/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rbindex 14ba6445f8..f768d100f3 100644--- a/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rb@@ -66,7 +66,7 @@ module Spreeenddef scope- super.for_store(current_store)+ super.orderedenddef collection_includesdiff --git a/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles/origin_groups_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles/origin_groups_controller.rbindex 89c95b0fdc..b9c11ac6bf 100644--- a/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles/origin_groups_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles/origin_groups_controller.rb@@ -42,7 +42,7 @@ module Spreeenddef scope- parent_profile.delivery_origin_groups+ parent_profile.delivery_origin_groups.orderedenddef permitted_paramsdiff --git a/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles_controller.rbindex 51314dde29..6023318e7c 100644--- a/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/delivery_profiles_controller.rb@@ -58,6 +58,10 @@ module SpreeSpree.api.admin_delivery_profile_serializerend+ def scope+ super.order_default+ end+def permitted_paramsparams.permit(*model_additional_permitted_attributes, :name, :default, :position, :kind, stock_location_ids: [])enddiff --git a/spree/api/app/controllers/spree/api/v3/admin/markets_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/markets_controller.rbindex 0abea80fe4..90f451ab5a 100644--- a/spree/api/app/controllers/spree/api/v3/admin/markets_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/markets_controller.rb@@ -27,6 +27,10 @@ module Spree[:market_countries]end+ def scope+ super.ordered+ end+def permitted_paramsnormalize_params(params.permit(diff --git a/spree/api/app/controllers/spree/api/v3/admin/payment_methods_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/payment_methods_controller.rbindex 1ba09bbb4b..6441ca51c3 100644--- a/spree/api/app/controllers/spree/api/v3/admin/payment_methods_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/payment_methods_controller.rb@@ -58,6 +58,10 @@ module Spree)end+ def scope+ super.ordered+ end+# `types` is read-only discovery — maps to the read scope + :show ability.def read_actionssuper + %w[types]diff --git a/spree/api/app/controllers/spree/api/v3/admin/price_lists_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/price_lists_controller.rbindex 080f31ded3..825b6b3239 100644--- a/spree/api/app/controllers/spree/api/v3/admin/price_lists_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/price_lists_controller.rb@@ -110,7 +110,7 @@ module Spreeenddef scope- super.for_store(current_store)+ super.orderedenddef permitted_paramsdiff --git a/spree/api/app/controllers/spree/api/v3/admin/seller_requirements_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/seller_requirements_controller.rbindex a723c5be96..f709caa82f 100644--- a/spree/api/app/controllers/spree/api/v3/admin/seller_requirements_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/seller_requirements_controller.rb@@ -66,6 +66,10 @@ module SpreeSpree.api.admin_seller_requirement_serializerend+ def scope+ super.ordered+ end+# `type` is stripped before assignment by the subclassed-resource# flow, so a saved row's kind can never change — which matters# because its submissions answered the old one.diff --git a/spree/api/app/controllers/spree/api/v3/store/collections_controller.rb b/spree/api/app/controllers/spree/api/v3/store/collections_controller.rbindex db0e1c45fb..3fbfe62e96 100644--- a/spree/api/app/controllers/spree/api/v3/store/collections_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/collections_controller.rb@@ -15,6 +15,10 @@ module SpreeSpree.api.collection_serializerend+ def scope+ super.ordered+ end+# Find by permalink or prefixed ID (SEO-friendly URLs), i18n-scoped with a# fallback to the default locale — mirrors the Categories controller.def find_resourcediff --git a/spree/api/app/controllers/spree/api/v3/store/markets_controller.rb b/spree/api/app/controllers/spree/api/v3/store/markets_controller.rbindex 620d32fc43..ee7377fc81 100644--- a/spree/api/app/controllers/spree/api/v3/store/markets_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/markets_controller.rb@@ -8,7 +8,7 @@ module Spree# GET /api/v3/store/marketsdef index- markets = current_store.markets.includes(:market_countries).order(:position)+ markets = current_store.markets.includes(:market_countries).orderedreturn unless cache_collection(markets)diff --git a/spree/api/spec/controllers/spree/api/v3/admin/catalogs_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/catalogs_controller_spec.rbindex c00e7ca7d6..3ee9215c06 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/catalogs_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/catalogs_controller_spec.rb@@ -180,6 +180,18 @@ RSpec.describe Spree::Api::V3::Admin::CatalogsController, type: :controller doexpect(json_response['data'].map { |row| row['id'] }).not_to include(other.prefixed_id)end++ it 'returns catalogs in list order' do+ create(:catalog, store: store, name: 'Second catalog')+ third = create(:catalog, store: store, name: 'Third catalog')+ third.insert_at(1)+ catalog.insert_at(2)++ get :index, as: :json++ expect(json_response['data'].pluck('name')).to eq(['Third catalog', 'Wholesale', 'Second catalog'])+ expect(json_response['data'].pluck('position')).to eq([1, 2, 3])+ endenddescribe 'POST #create' dodiff --git a/spree/api/spec/controllers/spree/api/v3/admin/collections_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/collections_controller_spec.rbindex 4065e49f9c..d9eb5a139a 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/collections_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/collections_controller_spec.rb@@ -25,6 +25,31 @@ RSpec.describe Spree::Api::V3::Admin::CollectionsController, type: :controller dexpect(ids).not_to include(other_collection.prefixed_id)end+ it 'returns collections in list order' do+ create(:collection, store: store, name: 'Second collection')+ third = create(:collection, store: store, name: 'Third collection')+ third.insert_at(1)+ collection.insert_at(2)++ get :index, as: :json++ expect(json_response['data'].pluck('name')).to eq(['Third collection', 'Summer Sale', 'Second collection'])+ expect(json_response['data'].pluck('position')).to eq([1, 2, 3])+ end++ it 'returns collections in list order when filtered by permalink' do+ create(:collection, store: store, name: 'Second collection', permalink: 'second-sale')+ third = create(:collection, store: store, name: 'Third collection', permalink: 'third-sale')+ third.insert_at(1)+ collection.update!(permalink: 'summer-sale')+ collection.insert_at(2)++ get :index, params: { q: { permalink_cont: 'sale' } }, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['data'].pluck('name')).to eq(['Third collection', 'Summer Sale', 'Second collection'])+ end+it 'exposes the merchandising config + timestamps (admin surface)' doget :index, params: {}, as: :jsondiff --git a/spree/api/spec/controllers/spree/api/v3/admin/commission_rates_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/commission_rates_controller_spec.rbindex 065749f80a..5b7e6d2c67 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/commission_rates_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/commission_rates_controller_spec.rb@@ -24,6 +24,19 @@ RSpec.describe Spree::Api::V3::Admin::CommissionRatesController, type: :controllexpect(row['rules'].first).to include('type' => 'seller_rule', 'label' => 'Seller')end+ it 'returns rates in precedence order' do+ create(:commission_rate, store: store, name: 'Second')+ third = create(:commission_rate, store: store, name: 'Third')+ third.insert_at(1)+ rate.insert_at(2)++ get :index, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['data'].pluck('name')).to eq(['Third', 'Standard', 'Second'])+ expect(json_response['data'].pluck('position')).to eq([1, 2, 3])+ end+it "hides another marketplace's rates" doother = create(:commission_rate, store: create(:store))diff --git a/spree/api/spec/controllers/spree/api/v3/admin/delivery_profiles_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/delivery_profiles_controller_spec.rbnew file mode 100644index 0000000000..0a7a5fa3ca--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/admin/delivery_profiles_controller_spec.rb@@ -0,0 +1,26 @@+# frozen_string_literal: true++require 'spec_helper'++RSpec.describe Spree::Api::V3::Admin::DeliveryProfilesController, type: :controller do+ render_views++ include_context 'API v3 Admin authenticated'++ let!(:default_profile) { store.default_delivery_profile }+ let!(:custom_profile) { create(:delivery_profile, store: store, name: 'Oversized') }++ before { request.headers.merge!(headers) }++ describe 'GET #index' do+ it 'returns delivery profiles with the default first, then by position' do+ custom_profile.insert_at(1)++ get :index, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['data'].first['default']).to be(true)+ expect(json_response['data'].pluck('name')).to eq([default_profile.name, 'Oversized'])+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/admin/markets_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/markets_controller_spec.rbindex 5df4311ac7..aa362899d8 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/markets_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/markets_controller_spec.rb@@ -19,6 +19,21 @@ RSpec.describe Spree::Api::V3::Admin::MarketsController, type: :controller doexpect(ids).to include(market.prefixed_id)expect(ids).not_to include(other_store_market.prefixed_id)end++ it 'returns markets in list order' do+ market.update!(name: 'Anchor market')+ second = create(:market, store: store, name: 'Second market')+ third = create(:market, store: store, name: 'Third market')+ third.insert_at(1)+ market.insert_at(2)++ get :index, as: :json++ rows = json_response['data'].select do |row|+ [third, market, second].map(&:prefixed_id).include?(row['id'])+ end+ expect(rows.pluck('name')).to eq(['Third market', 'Anchor market', 'Second market'])+ endenddescribe 'GET #show' dodiff --git a/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rbindex 85e950fb5e..9469ab954c 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb@@ -18,6 +18,19 @@ RSpec.describe Spree::Api::V3::Admin::PaymentMethodsController, type: :controlleexpect(json_response['data'].map { |pm| pm['id'] }).to include(payment_method.prefixed_id)end+ it 'returns payment methods in list order' do+ create(:check_payment_method, store: store, name: 'Second method')+ third = create(:check_payment_method, store: store, name: 'Third method')+ third.insert_at(1)+ payment_method.insert_at(2)++ get :index, as: :json++ names = json_response['data'].pluck('name')+ expect(names).to eq(['Third method', payment_method.name, 'Second method'])+ expect(json_response['data'].pluck('position')).to eq([1, 2, 3])+ end+context 'when payment method belongs to a different store' dolet!(:other_store) { create(:store) }let!(:other_payment_method) { create(:check_payment_method, store: other_store) }diff --git a/spree/api/spec/controllers/spree/api/v3/admin/price_lists_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/price_lists_controller_spec.rbindex 68eab67758..62611b80e6 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/price_lists_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/price_lists_controller_spec.rb@@ -36,6 +36,21 @@ RSpec.describe Spree::Api::V3::Admin::PriceListsController, type: :controller doendend+ describe 'GET #index' do+ it 'returns price lists in list order' do+ create(:price_list, store: store, name: 'Second list')+ third = create(:price_list, store: store, name: 'Third list')+ third.insert_at(1)+ price_list.insert_at(2)++ get :index, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['data'].pluck('name')).to eq(['Third list', 'Wholesale', 'Second list'])+ expect(json_response['data'].pluck('position')).to eq([1, 2, 3])+ end+ end+describe 'POST #create — one-shot creation' dolet(:customer_group) { create(:customer_group, store: store) }diff --git a/spree/core/app/models/concerns/spree/has_list_position.rb b/spree/core/app/models/concerns/spree/has_list_position.rbnew file mode 100644index 0000000000..5b16b55b6f--- /dev/null+++ b/spree/core/app/models/concerns/spree/has_list_position.rb@@ -0,0 +1,15 @@+# frozen_string_literal: true++module Spree+ # Shared list-position ordering for models using acts_as_list.+ #+ # Position is the merchant-facing precedence; id breaks ties so two rows+ # sharing a position resolve the same way on every read.+ module HasListPosition+ extend ActiveSupport::Concern++ included do+ scope :ordered, -> { order(Arel.sql("#{table_name}.position ASC, #{table_name}.id ASC")) }+ end+ end+enddiff --git a/spree/core/app/models/spree/catalog.rb b/spree/core/app/models/spree/catalog.rbindex 19f2689497..96a5bcad5d 100644--- a/spree/core/app/models/spree/catalog.rb+++ b/spree/core/app/models/spree/catalog.rb@@ -11,6 +11,7 @@ module Spreehas_prefix_id :catinclude Spree::SingleStoreResource+ include Spree::HasListPositioninclude Spree::HasCustomFieldsinclude Spree::Metadata@@ -72,7 +73,7 @@ module Spreeafter_commit -> { Spree::Current.reset_catalog_memos }scope :active, -> { where(active: true) }- scope :by_position, -> { order(position: :asc) }+ scope :by_position, -> { ordered }self.whitelisted_ransackable_attributes = %w[name active]diff --git a/spree/core/app/models/spree/collection.rb b/spree/core/app/models/spree/collection.rbindex 1a386785f4..6bdb4ee85a 100644--- a/spree/core/app/models/spree/collection.rb+++ b/spree/core/app/models/spree/collection.rb@@ -5,6 +5,7 @@ require 'stringex'module Spreeclass Collection < Spree.base_classinclude Spree::SingleStoreResource+ include Spree::HasListPositionhas_prefix_id :colldiff --git a/spree/core/app/models/spree/commission_rate.rb b/spree/core/app/models/spree/commission_rate.rbindex e0a5a4f1e5..613a097307 100644--- a/spree/core/app/models/spree/commission_rate.rb+++ b/spree/core/app/models/spree/commission_rate.rb@@ -34,6 +34,7 @@ module Spreeacts_as_list scope: :store_id, add_new_at: :topinclude Spree::SingleStoreResource+ include Spree::HasListPositioninclude Spree::Metadatainclude Spree::TypedAssociations@@ -96,9 +97,6 @@ module Spree# Scopes#scope :enabled, -> { where(enabled: true) }- # The resolution order, top-down. Ties break on id so two rates sharing a- # position resolve the same way on every read.- scope :ordered, -> { order(position: :asc, id: :asc) }self.whitelisted_ransackable_attributes = %w[name code kind enabled position valuetax_inclusive include_shipping]diff --git a/spree/core/app/models/spree/delivery_origin_group.rb b/spree/core/app/models/spree/delivery_origin_group.rbindex dfa5e27e51..3a2509a5b0 100644--- a/spree/core/app/models/spree/delivery_origin_group.rb+++ b/spree/core/app/models/spree/delivery_origin_group.rb@@ -10,6 +10,8 @@ module Spreeacts_as_list scope: :delivery_profile+ include Spree::HasListPosition+belongs_to :delivery_profile, class_name: 'Spree::DeliveryProfile', inverse_of: :delivery_origin_groupshas_many :delivery_origin_group_locations, class_name: 'Spree::DeliveryOriginGroupLocation',diff --git a/spree/core/app/models/spree/delivery_profile.rb b/spree/core/app/models/spree/delivery_profile.rbindex 02902932ae..6b57aca102 100644--- a/spree/core/app/models/spree/delivery_profile.rb+++ b/spree/core/app/models/spree/delivery_profile.rb@@ -10,6 +10,7 @@ module Spree# docs/plans/6.0-delivery-profiles.md).class DeliveryProfile < Spree.base_classinclude Spree::SingleStoreResource+ include Spree::HasListPositionhas_prefix_id :fpdiff --git a/spree/core/app/models/spree/market.rb b/spree/core/app/models/spree/market.rbindex 8491378752..4deb7c029a 100644--- a/spree/core/app/models/spree/market.rb+++ b/spree/core/app/models/spree/market.rb@@ -3,6 +3,7 @@ module Spreehas_prefix_id :mktinclude Spree::SingleStoreResource+ include Spree::HasListPositionacts_as_paranoidacts_as_list scope: :store_iddiff --git a/spree/core/app/models/spree/order_routing_rule.rb b/spree/core/app/models/spree/order_routing_rule.rbindex 8f7712b1cc..d426178b3c 100644--- a/spree/core/app/models/spree/order_routing_rule.rb+++ b/spree/core/app/models/spree/order_routing_rule.rb@@ -23,6 +23,7 @@ module Spreehas_prefix_id :oruleinclude Spree::SingleStoreResource+ include Spree::HasListPositionbelongs_to :store, class_name: 'Spree::Store'belongs_to :channel, class_name: 'Spree::Channel'@@ -42,7 +43,6 @@ module Spreevalidate :channel_belongs_to_storescope :active, -> { where(active: true) }- scope :ordered, -> { order(:position) }scope :for_channel, ->(channel) { where(channel_id: channel.id) }acts_as_list scope: :channel_iddiff --git a/spree/core/app/models/spree/payment_method.rb b/spree/core/app/models/spree/payment_method.rbindex 65eb8cb6f0..74079431e4 100644--- a/spree/core/app/models/spree/payment_method.rb+++ b/spree/core/app/models/spree/payment_method.rb@@ -9,6 +9,7 @@ module Spreeacts_as_list scope: :store_idinclude Spree::SingleStoreResource+ include Spree::HasListPositioninclude Spree::StorePreferencesinclude Spree::HasCustomFieldsinclude Spree::Metadatadiff --git a/spree/core/app/models/spree/price_list.rb b/spree/core/app/models/spree/price_list.rbindex c9bc2a56ef..39c5056552 100644--- a/spree/core/app/models/spree/price_list.rb+++ b/spree/core/app/models/spree/price_list.rb@@ -6,6 +6,7 @@ module Spreeacts_as_list scope: :store_idinclude Spree::SingleStoreResource+ include Spree::HasListPositionMATCH_POLICIES = %w[all any].freeze@@ -58,7 +59,7 @@ module Spree# actually available — unowned, plus the one the catalog already holds.self.whitelisted_ransackable_attributes = %w[status match_policy starts_at ends_at catalog_id]- scope :by_position, -> { order(position: :asc) }+ scope :by_position, -> { ordered }scope :for_store, ->(store) { where(store: store) }scope :standalone, -> { where(catalog_id: nil) }scope :current, lambda { |timezone = nil|diff --git a/spree/core/app/models/spree/seller_requirement.rb b/spree/core/app/models/spree/seller_requirement.rbindex 7888d678b8..79fdc6a16c 100644--- a/spree/core/app/models/spree/seller_requirement.rb+++ b/spree/core/app/models/spree/seller_requirement.rb@@ -13,6 +13,7 @@ module Spree# {Spree::SellerRequirementSubmission}.class SellerRequirement < Spree.base_classinclude Spree::SingleStoreResource+ include Spree::HasListPositioninclude Spree::PreferenceSchemainclude Spree::Metadatadiff --git a/spree/core/spec/models/concerns/spree/has_list_position_spec.rb b/spree/core/spec/models/concerns/spree/has_list_position_spec.rbnew file mode 100644index 0000000000..37ab73a4a0--- /dev/null+++ b/spree/core/spec/models/concerns/spree/has_list_position_spec.rb@@ -0,0 +1,29 @@+# frozen_string_literal: true++require 'spec_helper'++RSpec.describe Spree::HasListPosition do+ it 'orders by position then id' do+ store = create(:store)+ first = create(:market, store: store, name: 'First')+ second = create(:market, store: store, name: 'Second')+ third = create(:market, store: store, name: 'Third')++ third.insert_at(1)+ first.insert_at(2)++ ordered = store.markets.ordered.where(id: [first.id, second.id, third.id])+ expect(ordered.pluck(:name)).to eq(%w[Third First Second])+ end++ it 'keeps ordering unambiguous when a join is present' do+ store = create(:store)+ first = create(:collection, store: store, name: 'First', permalink: 'first-sale')+ second = create(:collection, store: store, name: 'Second', permalink: 'second-sale')++ first.insert_at(2)++ ordered = store.collections.ordered.ransack(permalink_cont: 'sale').result+ expect(ordered.pluck(:name)).to eq(%w[Second First])+ end+end