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: provider catalogs failing after a code reload in development

Damian Legawiec76368f26eda9
diff --git a/spree/core/lib/spree/core.rb b/spree/core/lib/spree/core.rb
index d42b38ffa2..8560932d53 100644
--- a/spree/core/lib/spree/core.rb
+++ b/spree/core/lib/spree/core.rb
@@ -509,6 +509,28 @@ module Spree
Rails.application.config.spree.delivery_rate_providers = value
end
+ # Re-resolves every provider registry entry by name, in place.
+ #
+ # The registries hold class objects, and in development Zeitwerk reloads
+ # the classes underneath them on each code change. The old objects stay in
+ # the array, and a method on one — `service_catalog`, say — looks its
+ # sibling constants up in a namespace that no longer exists, which is a
+ # NameError on the admin provider catalog until the server restarts.
+ # Swapping each entry for the class currently answering to its name fixes
+ # that; in place, so a gem that appended its provider keeps its entry.
+ # Anonymous classes have no name to resolve and are left alone.
+ #
+ # Run from the engine's to_prepare hook: every reload in development, once
+ # at boot in production.
+ #
+ # @return [void]
+ def self.refresh_provider_registries!
+ [Rails.application.config.spree.delivery_rate_providers,
+ Rails.application.config.spree.fulfillment_providers].compact.each do |registry|
+ registry.map! { |entry| entry.is_a?(Module) && entry.name ? entry.name.constantize : entry }
+ end
+ end
+
# Strategies selectable as a digital asset's source. Core registers the
# uploaded-file default; host apps append providers that resolve a
# deliverable elsewhere (a licensing system, a code pool).
diff --git a/spree/core/lib/spree/core/engine.rb b/spree/core/lib/spree/core/engine.rb
index f152a50236..584879861b 100644
--- a/spree/core/lib/spree/core/engine.rb
+++ b/spree/core/lib/spree/core/engine.rb
@@ -695,6 +695,10 @@ module Spree
Spree::Events.reset!
Spree::Events.activate!
+ # Same stale-class problem as the subscribers above, for the provider
+ # registries the admin catalogs iterate.
+ Spree.refresh_provider_registries!
+
# Re-attach event log subscriber if enabled
if Spree::Config.events_log_enabled
Spree::EventLogSubscriber.attach_to_notifications
diff --git a/spree/core/spec/lib/spree/core_spec.rb b/spree/core/spec/lib/spree/core_spec.rb
index 6800defd74..566f3096ce 100644
--- a/spree/core/spec/lib/spree/core_spec.rb
+++ b/spree/core/spec/lib/spree/core_spec.rb
@@ -144,4 +144,38 @@ describe Spree do
end
end
+ describe '.refresh_provider_registries!' do
+ let(:real) { Spree::DeliveryRateProvider::Internal }
+
+ # After a code reload the registry still holds the unloaded class object:
+ # a different object answering to the real class's name.
+ let(:stale) do
+ Class.new(Spree::DeliveryRateProvider::Base).tap do |klass|
+ klass.define_singleton_method(:name) { 'Spree::DeliveryRateProvider::Internal' }
+ end
+ end
+ let(:anonymous) { Class.new(Spree::DeliveryRateProvider::Base) }
+
+ around do |example|
+ original = Spree.delivery_rate_providers.dup
+ example.run
+ ensure
+ Spree.delivery_rate_providers.replace(original)
+ end
+
+ # In place, because gems append with `Spree.delivery_rate_providers <<`
+ # and must keep their entry across the refresh.
+ it 'swaps a stale entry for the class currently answering to its name, in place' do
+ registry = Spree.delivery_rate_providers
+ registry.map! { |entry| entry == real ? stale : entry }
+ registry << anonymous
+
+ Spree.refresh_provider_registries!
+
+ expect(Spree.delivery_rate_providers).to equal(registry)
+ expect(registry).to include(real)
+ expect(registry).not_to include(stale)
+ expect(registry).to include(anonymous)
+ end
+ end
end