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 metafield parent lookup to survive Zeitwerk code reloads (#14006)

Damian Legawiecc435905101c1
diff --git a/spree/api/app/controllers/spree/api/v3/admin/custom_fields_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/custom_fields_controller.rb
index 7e04fb57b3..a8b62ba757 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/custom_fields_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/custom_fields_controller.rb
@@ -78,14 +78,14 @@ module Spree
ParentLookup = Struct.new(:klass, :value, :segment)
- # `Spree.user_class.model_name.element` is `'user'`, but the route
- # segment is `customer_id` — alias here so both resolve to user_class.
+ # Stores class names (not class objects) so the map survives dev-mode
+ # code reloads — `enabled_resources` is captured at boot and its
+ # class references go stale. Aliases `'customer'` because the route
+ # uses `customer_id` while user_class.model_name.element is `'user'`.
def parent_route_map
@parent_route_map ||= Spree.metafields.enabled_resources.each_with_object({}) do |klass, m|
- m[klass.model_name.element.to_s] = klass
- end.tap do |map|
- map['customer'] = Spree.user_class if Spree.metafields.enabled_resources.include?(Spree.user_class)
- end
+ m[klass.model_name.element.to_s] = klass.name
+ end.merge('customer' => Spree.user_class.name)
end
# Returns the first segment whose `<segment>_id` is present in params,
@@ -97,8 +97,8 @@ module Spree
match = parent_route_map.find { |segment, _| params[:"#{segment}_id"].present? }
@parent_lookup =
if match
- segment, klass = match
- ParentLookup.new(klass, params[:"#{segment}_id"], segment)
+ segment, klass_name = match
+ ParentLookup.new(klass_name.constantize, params[:"#{segment}_id"], segment)
end
end
end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/custom_fields_polymorphic_parent_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/custom_fields_polymorphic_parent_spec.rb
index b639c4bb1a..164bb43c00 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/custom_fields_polymorphic_parent_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/custom_fields_polymorphic_parent_spec.rb
@@ -48,4 +48,31 @@ RSpec.describe Spree::Api::V3::Admin::CustomFieldsController, type: :controller
definition_trait: :for_variant,
param_key: :variant_id
end
+
+ # Simulates the dev-mode class-reload condition where
+ # `enabled_resources.include?(Spree.user_class)` returns false because the
+ # cached class reference goes stale after Zeitwerk reloads. The customer
+ # route must still resolve in that case.
+ describe 'when enabled_resources does not contain Spree.user_class' do
+ let!(:parent) { create(:user) }
+ let!(:definition) { create(:metafield_definition, :for_user) }
+ let!(:custom_field) do
+ create(:metafield, resource: parent, metafield_definition: definition,
+ type: definition.metafield_type, value: 'value-for-parent')
+ end
+
+ before do
+ @original_resources = Rails.application.config.spree.metafields.enabled_resources
+ Rails.application.config.spree.metafields.enabled_resources = @original_resources - [Spree.user_class]
+ end
+
+ after { Rails.application.config.spree.metafields.enabled_resources = @original_resources }
+
+ it 'returns the customer\'s custom fields' do
+ get :index, params: { customer_id: parent.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].map { |cf| cf['value'] }).to include('value-for-parent')
+ end
+ end
end