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: let stores unregister the default returns eligibility validator (#14694)

Damian Legawiec7d52cc5a9eb0
diff --git a/docs/developer/upgrades/5.6-to-6.0.mdx b/docs/developer/upgrades/5.6-to-6.0.mdx
index 8c06eef1aa..a39bb00ddb 100644
--- a/docs/developer/upgrades/5.6-to-6.0.mdx
+++ b/docs/developer/upgrades/5.6-to-6.0.mdx
@@ -323,13 +323,15 @@ Replace it by swapping the handler:
```ruby
# config/initializers/spree.rb
-Rails.application.config.after_initialize do
- Spree.hooks.unregister('returns.create.validate', 'Spree::Returns::EligibilityValidator')
- Spree.hooks.register('returns.create.validate', 'MyStore::ReturnPolicy')
-end
+Spree.hooks.unregister('returns.create.validate', 'Spree::Returns::EligibilityValidator')
+Spree.hooks.register('returns.create.validate', 'MyStore::ReturnPolicy')
+
+# The same validator guards exchanges — swap it there too if your policy should cover them:
+Spree.hooks.unregister('exchanges.create.validate', 'Spree::Returns::EligibilityValidator')
+Spree.hooks.register('exchanges.create.validate', 'MyStore::ReturnPolicy')
```
-Wrap the swap in `after_initialize`: core registers the default validator after your initializers load, so an `unregister` at the top level of an initializer would run too early and do nothing.
+Core registers the default validator before your initializers load, so the swap works at the top level of an initializer.
A handler receives the workflow (so it can read `order`, `items`, `created_by`, `order.market`) and calls `workflow.reject!(message)` to veto. Every one of the fifteen transitions has a leading `validate` hook, so the same seam gates approving, receiving and refunding.
diff --git a/spree/core/lib/spree/core/engine.rb b/spree/core/lib/spree/core/engine.rb
index 29c0a2873f..eb2cac7707 100644
--- a/spree/core/lib/spree/core/engine.rb
+++ b/spree/core/lib/spree/core/engine.rb
@@ -135,6 +135,14 @@ module Spree
app.config.spree.line_item_comparison_hooks = Set.new
end
+ # The one eligibility rule core ships: a per-market return window,
+ # bypassed by staff. Registered before application initializers so a
+ # store can unregister it in its own initializer.
+ initializer 'spree.returns.register_eligibility_validator', before: :load_config_initializers do
+ Spree.hooks.register('returns.create.validate', 'Spree::Returns::EligibilityValidator')
+ Spree.hooks.register('exchanges.create.validate', 'Spree::Returns::EligibilityValidator')
+ end
+
initializer 'spree.register.payment_methods', after: 'acts_as_list.insert_into_active_record' do |app|
end
@@ -691,14 +699,6 @@ module Spree
end
end
- # The one eligibility rule core ships: a per-market return window,
- # bypassed by staff. Registered after application initializers so a
- # store can unregister it in its own initializer.
- initializer 'spree.returns.register_eligibility_validator', after: :load_config_initializers do
- Spree.hooks.register('returns.create.validate', 'Spree::Returns::EligibilityValidator')
- Spree.hooks.register('exchanges.create.validate', 'Spree::Returns::EligibilityValidator')
- end
-
# A hook registered against a key no workflow declares would never fire
# and never say so. Checking after eager load turns that typo into a
# boot failure. Skipped when eager loading is off (development,
diff --git a/spree/core/spec/lib/spree/core/engine_spec.rb b/spree/core/spec/lib/spree/core/engine_spec.rb
new file mode 100644
index 0000000000..d9ee5c797d
--- /dev/null
+++ b/spree/core/spec/lib/spree/core/engine_spec.rb
@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Core::Engine do
+ describe "'spree.returns.register_eligibility_validator' initializer" do
+ let(:initializer) { described_class.instance.initializers.find { |i| i.name == 'spree.returns.register_eligibility_validator' } }
+ let(:boot_order) { Rails.application.initializers.tsort_each.to_a }
+
+ before do
+ Spree.hooks.unregister('returns.create.validate', 'Spree::Returns::EligibilityValidator')
+ Spree.hooks.unregister('exchanges.create.validate', 'Spree::Returns::EligibilityValidator')
+ end
+
+ after { initializer.run(Rails.application) }
+
+ # A store swaps the default rule by unregistering it in its own
+ # config/initializers file, which only sticks if core registered first.
+ it 'runs before the application loads its config/initializers' do
+ application_initializers = boot_order.index do |i|
+ i.name == :load_config_initializers && i.context_class == Rails.application.class
+ end
+
+ expect(boot_order.index { |i| i.name == initializer.name }).to be < application_initializers
+ end
+
+ it 'registers the validator on the returns and exchanges create hooks, without duplicating it when run again' do
+ 2.times { initializer.run(Rails.application) }
+
+ expect(Spree.hooks.for('returns.create.validate').map(&:class)).to eq([Spree::Returns::EligibilityValidator])
+ expect(Spree.hooks.for('exchanges.create.validate').map(&:class)).to eq([Spree::Returns::EligibilityValidator])
+ end
+ end
+end