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.

Changed store provisioning, seeds and sample data to publish no events (#14956)

Damian Legawiecdf741e929135
diff --git a/spree/core/app/models/concerns/spree/publishable.rb b/spree/core/app/models/concerns/spree/publishable.rb
index 6b838b6b40..d89be318e8 100644
--- a/spree/core/app/models/concerns/spree/publishable.rb
+++ b/spree/core/app/models/concerns/spree/publishable.rb
@@ -91,9 +91,14 @@ module Spree
end
if events.include?(:delete)
- before_destroy :capture_pre_destroy_payload, if: :should_publish_events?
+ before_destroy :capture_pre_destroy_payload, if: :lifecycle_publishing_enabled?
after_commit :publish_delete_event, on: :destroy, if: :should_publish_events?
end
+
+ after_save :note_lifecycle_write
+ after_destroy :note_lifecycle_destroy
+ after_commit :close_lifecycle_write
+ after_rollback :close_lifecycle_write
end
# A subclass publishes its lifecycle events under its own prefix, which may
@@ -308,9 +313,50 @@ module Spree
end
def should_publish_events?
+ !silenced_lifecycle_write? && lifecycle_publishing_enabled?
+ end
+
+ def lifecycle_publishing_enabled?
self.class.publish_events && Spree::Events.lifecycle_enabled?
end
+ # Lifecycle events publish at commit, which can come after the block that
+ # silenced the write ended — a default record created in its parent's
+ # `after_create` commits together with the parent. Each write records
+ # whether events were on, so a record written only while they were off
+ # stays silent at commit; one written with them on still publishes.
+ #
+ # The marker is read, never cleared, at commit: Rails may check several
+ # commit callbacks for one commit (a soft delete is also an update), and
+ # the order commit callbacks run in is the host app's setting. A commit or
+ # rollback only closes it, and the next write starts a fresh one.
+ def note_lifecycle_write
+ reopen_lifecycle_write
+ @_spree_lifecycle_write_enabled ||= Spree::Events.lifecycle_enabled?
+ end
+
+ # A destroy commits as the delete event alone, so an earlier update made
+ # with events on must not carry it through.
+ def note_lifecycle_destroy
+ reopen_lifecycle_write
+ @_spree_lifecycle_write_enabled = Spree::Events.lifecycle_enabled?
+ end
+
+ def silenced_lifecycle_write?
+ @_spree_lifecycle_write_enabled == false
+ end
+
+ def close_lifecycle_write
+ @_spree_lifecycle_write_closed = true
+ end
+
+ def reopen_lifecycle_write
+ return unless @_spree_lifecycle_write_closed
+
+ @_spree_lifecycle_write_closed = false
+ @_spree_lifecycle_write_enabled = nil
+ end
+
# True when this commit was caused only by `touch` — no real save ran
# (`after_update` fires for saves, never for touches). Flags reset every
# commit so a later genuine update publishes normally.
diff --git a/spree/core/app/models/concerns/spree/stores/channels.rb b/spree/core/app/models/concerns/spree/stores/channels.rb
index 150cc9f424..5ecbef1800 100644
--- a/spree/core/app/models/concerns/spree/stores/channels.rb
+++ b/spree/core/app/models/concerns/spree/stores/channels.rb
@@ -13,7 +13,9 @@ module Spree
def ensure_default_channel
return if default_channel
- channels.create!(name: 'Online Store', code: Spree::Channel::DEFAULT_CODE)
+ Spree::Events.disable do
+ channels.create!(name: 'Online Store', code: Spree::Channel::DEFAULT_CODE)
+ end
end
end
end
diff --git a/spree/core/app/models/spree/store.rb b/spree/core/app/models/spree/store.rb
index 2052586ca8..e814aa37cb 100644
--- a/spree/core/app/models/spree/store.rb
+++ b/spree/core/app/models/spree/store.rb
@@ -729,7 +729,9 @@ module Spree
# Products without a profile fall back to this one, so it must exist
# from the store's first moment.
def create_default_delivery_profile
- Spree::DeliveryProfiles::Shipping.create!(store: self, name: 'General', default: true)
+ Spree::Events.disable do
+ Spree::DeliveryProfiles::Shipping.create!(store: self, name: 'General', default: true)
+ end
end
def create_default_policies
diff --git a/spree/core/app/services/spree/stores/provision_defaults.rb b/spree/core/app/services/spree/stores/provision_defaults.rb
index 851500163c..0f8281a45e 100644
--- a/spree/core/app/services/spree/stores/provision_defaults.rb
+++ b/spree/core/app/services/spree/stores/provision_defaults.rb
@@ -31,13 +31,17 @@ module Spree
@currency = resolve_currency(currency, country)
@locale = resolve_locale(locale, country)
- ApplicationRecord.transaction do
- update_default_market
- provision_stock_location
- provision_delivery_zones
- provision_package_type
- provision_pickup
- restate_seeded_calculators
+ # Defaults are bookkeeping, not merchant actions — webhooks and
+ # subscribers should not hear about each zone and method created here.
+ Spree::Events.disable do
+ ApplicationRecord.transaction do
+ update_default_market
+ provision_stock_location
+ provision_delivery_zones
+ provision_package_type
+ provision_pickup
+ restate_seeded_calculators
+ end
end
store.reload
diff --git a/spree/core/lib/tasks/seller_sample_data.rake b/spree/core/lib/tasks/seller_sample_data.rake
index 9a1ab2e358..e6b27924c4 100644
--- a/spree/core/lib/tasks/seller_sample_data.rake
+++ b/spree/core/lib/tasks/seller_sample_data.rake
@@ -10,132 +10,134 @@ namespace :spree do
abort "spree:sellers:sample_data is for development and test only (RAILS_ENV=#{Rails.env})."
end
- store = Spree::Store.default || Spree::Store.first
- abort 'No store found — run db:seed first.' if store.nil?
-
- email = ENV.fetch('SELLER_EMAIL', '[email protected]')
- password = ENV.fetch('SELLER_PASSWORD', 'spree123')
-
- seller_name = ENV.fetch('SELLER_NAME', 'Bright Sparks')
- seller = Spree::Seller.find_by(name: seller_name, store: store)
-
- # Through the workflow, so the sample seller gets the stock location a
- # real one does — without it their returns have nowhere to go and the
- # checklist can never be finished.
- if seller.nil?
- result = Spree.seller_create_workflow.call(
- store: store, attributes: { name: seller_name, status: 'approved' }
- )
- abort "Could not create the sample seller: #{result.value.errors.full_messages.to_sentence}" unless result.success?
+ Spree::Events.disable do
+ store = Spree::Store.default || Spree::Store.first
+ abort 'No store found — run db:seed first.' if store.nil?
+
+ email = ENV.fetch('SELLER_EMAIL', '[email protected]')
+ password = ENV.fetch('SELLER_PASSWORD', 'spree123')
+
+ seller_name = ENV.fetch('SELLER_NAME', 'Bright Sparks')
+ seller = Spree::Seller.find_by(name: seller_name, store: store)
+
+ # Through the workflow, so the sample seller gets the stock location a
+ # real one does — without it their returns have nowhere to go and the
+ # checklist can never be finished.
+ if seller.nil?
+ result = Spree.seller_create_workflow.call(
+ store: store, attributes: { name: seller_name, status: 'approved' }
+ )
+ abort "Could not create the sample seller: #{result.value.errors.full_messages.to_sentence}" unless result.success?
- seller = result.value
- end
+ seller = result.value
+ end
- owner = Spree.admin_user_class.find_by(email: email)
-
- # An existing account keeps its own password. Re-running the task then
- # tells you to use the credentials you already have, rather than silently
- # changing them underneath you.
- if owner
- puts "Reusing existing user #{email} — password unchanged."
- else
- owner = Spree.admin_user_class.create!(
- email: email, password: password, first_name: 'Ada', last_name: 'Lovelace'
- )
- end
+ owner = Spree.admin_user_class.find_by(email: email)
- seller.add_user(owner)
+ # An existing account keeps its own password. Re-running the task then
+ # tells you to use the credentials you already have, rather than silently
+ # changing them underneath you.
+ if owner
+ puts "Reusing existing user #{email} — password unchanged."
+ else
+ owner = Spree.admin_user_class.create!(
+ email: email, password: password, first_name: 'Ada', last_name: 'Lovelace'
+ )
+ end
- # One outstanding offer, so the panel's pending-invitations card has
- # something to show without having to send an email first.
- invitee = ENV.fetch('SELLER_INVITEE', '[email protected]')
- unless seller.invitations.pending.exists?(email: invitee)
- seller.invitations.create!(email: invitee, role: seller.default_user_role, inviter: owner)
- end
+ seller.add_user(owner)
- # A checklist to work through, so the panel's onboarding page and its
- # nav counter have something to show. Skipped when the marketplace
- # already defines its own.
- if store.seller_requirements.none?
- Spree::SellerRequirements::AcceptTerms.create!(store: store, position: 1, active: true, required: true)
- Spree::SellerRequirements::BillingAddress.create!(store: store, position: 2, active: true, required: true)
- Spree::SellerRequirements::ReturnsAddress.create!(store: store, position: 3, active: true, required: true)
- Spree::SellerRequirements::Attestation.create!(
- store: store, position: 4, active: true, required: true,
- name: 'Confirm you can ship within two working days'
- )
- Spree::SellerRequirements::OperatorReview.create!(
- store: store, position: 5, active: true, required: false,
- name: 'Marketplace background check'
- )
- end
+ # One outstanding offer, so the panel's pending-invitations card has
+ # something to show without having to send an email first.
+ invitee = ENV.fetch('SELLER_INVITEE', '[email protected]')
+ unless seller.invitations.pending.exists?(email: invitee)
+ seller.invitations.create!(email: invitee, role: seller.default_user_role, inviter: owner)
+ end
- # A fund ledger to read: a settled payout with the sales it covered, one
- # still owed, and a sale not yet swept into either. Written directly
- # rather than through fulfilment and the payout sweep — reaching those
- # would mean placing and shipping real orders, which is a different
- # task's job, and the screens under test read these rows either way.
- provider = Spree::PayoutProvider::System.provider_key
- currency = store.default_currency
-
- if seller.seller_transfers.none?
- # Each earning hangs off an order, because that is what a seller
- # clicks through to from their ledger.
- sample_orders = 5.times.map do |index|
- Spree::Order.create!(
- store: store, seller: seller, currency: currency,
- email: "sample-buyer-#{index + 1}@example.com",
- status: 'placed', completed_at: (index + 1).weeks.ago,
- total: 100 + (index * 25), item_total: 100 + (index * 25)
+ # A checklist to work through, so the panel's onboarding page and its
+ # nav counter have something to show. Skipped when the marketplace
+ # already defines its own.
+ if store.seller_requirements.none?
+ Spree::SellerRequirements::AcceptTerms.create!(store: store, position: 1, active: true, required: true)
+ Spree::SellerRequirements::BillingAddress.create!(store: store, position: 2, active: true, required: true)
+ Spree::SellerRequirements::ReturnsAddress.create!(store: store, position: 3, active: true, required: true)
+ Spree::SellerRequirements::Attestation.create!(
+ store: store, position: 4, active: true, required: true,
+ name: 'Confirm you can ship within two working days'
+ )
+ Spree::SellerRequirements::OperatorReview.create!(
+ store: store, position: 5, active: true, required: false,
+ name: 'Marketplace background check'
)
end
- settled = seller.seller_payouts.create!(
- store: store, amount: 0, currency: currency, provider: provider, status: 'completed',
- reference: 'BACS-SAMPLE-001',
- period_start: 6.weeks.ago, period_end: 4.weeks.ago
- )
- owed = seller.seller_payouts.create!(
- store: store, amount: 0, currency: currency, provider: provider, status: 'pending',
- period_start: 3.weeks.ago, period_end: 1.week.ago
- )
-
- # Two settled, two owed, one still unswept — so the balance is a real
- # subtraction rather than a single number, and the payouts queue has
- # both a completed row and one to mark paid.
- [[settled, 0], [settled, 1], [owed, 2], [owed, 3], [nil, 4]].each do |payout, index|
- order = sample_orders[index]
+ # A fund ledger to read: a settled payout with the sales it covered, one
+ # still owed, and a sale not yet swept into either. Written directly
+ # rather than through fulfilment and the payout sweep — reaching those
+ # would mean placing and shipping real orders, which is a different
+ # task's job, and the screens under test read these rows either way.
+ provider = Spree::PayoutProvider::System.provider_key
+ currency = store.default_currency
+
+ if seller.seller_transfers.none?
+ # Each earning hangs off an order, because that is what a seller
+ # clicks through to from their ledger.
+ sample_orders = 5.times.map do |index|
+ Spree::Order.create!(
+ store: store, seller: seller, currency: currency,
+ email: "sample-buyer-#{index + 1}@example.com",
+ status: 'placed', completed_at: (index + 1).weeks.ago,
+ total: 100 + (index * 25), item_total: 100 + (index * 25)
+ )
+ end
+
+ settled = seller.seller_payouts.create!(
+ store: store, amount: 0, currency: currency, provider: provider, status: 'completed',
+ reference: 'BACS-SAMPLE-001',
+ period_start: 6.weeks.ago, period_end: 4.weeks.ago
+ )
+ owed = seller.seller_payouts.create!(
+ store: store, amount: 0, currency: currency, provider: provider, status: 'pending',
+ period_start: 3.weeks.ago, period_end: 1.week.ago
+ )
+
+ # Two settled, two owed, one still unswept — so the balance is a real
+ # subtraction rather than a single number, and the payouts queue has
+ # both a completed row and one to mark paid.
+ [[settled, 0], [settled, 1], [owed, 2], [owed, 3], [nil, 4]].each do |payout, index|
+ order = sample_orders[index]
+ seller.seller_transfers.create!(
+ store: store, order: order, payout: payout,
+ amount: Spree::Money::Rounding.to_currency(order.total * BigDecimal('0.85'), currency), currency: currency,
+ kind: 'earning', provider: provider, status: 'completed',
+ created_at: order.completed_at
+ )
+ end
+
+ # A refund on the newest settled sale, so the reversal row and the
+ # negative amount both appear on the earnings screens.
+ original = seller.seller_transfers.earnings.order(:created_at).last
seller.seller_transfers.create!(
- store: store, order: order, payout: payout,
- amount: Spree::Money::Rounding.to_currency(order.total * BigDecimal('0.85'), currency), currency: currency,
- kind: 'earning', provider: provider, status: 'completed',
- created_at: order.completed_at
+ store: store, order: original.order, reversed_from: original,
+ amount: -Spree::Money::Rounding.to_currency(original.amount / 2, currency), currency: currency,
+ kind: 'refund_reversal', provider: provider, status: 'completed'
)
- end
- # A refund on the newest settled sale, so the reversal row and the
- # negative amount both appear on the earnings screens.
- original = seller.seller_transfers.earnings.order(:created_at).last
- seller.seller_transfers.create!(
- store: store, order: original.order, reversed_from: original,
- amount: -Spree::Money::Rounding.to_currency(original.amount / 2, currency), currency: currency,
- kind: 'refund_reversal', provider: provider, status: 'completed'
- )
-
- # Each settlement is worth exactly what it claimed.
- [settled, owed].each { |payout| payout.update!(amount: payout.transfers.sum(:amount)) }
- end
+ # Each settlement is worth exactly what it claimed.
+ [settled, owed].each { |payout| payout.update!(amount: payout.transfers.sum(:amount)) }
+ end
- progress = Spree::Sellers::Requirements.new(seller.reload).progress
- balances = seller.balances
+ progress = Spree::Sellers::Requirements.new(seller.reload).progress
+ balances = seller.balances
- puts "Seller: #{seller.name} (#{seller.prefixed_id}, #{seller.status})"
- puts "Checklist: #{progress[:done]}/#{progress[:total]} done"
- puts "Sign in: #{email}"
- puts "Pending: #{seller.invitations.pending.pluck(:email).join(', ')}"
- puts "Ledger: #{seller.seller_transfers.count} earning(s), #{seller.seller_payouts.count} payout(s)"
- balances.each do |balance|
- puts "Balance: #{balance.display_balance} owed (#{balance.display_earned} earned, #{balance.display_paid} paid)"
+ puts "Seller: #{seller.name} (#{seller.prefixed_id}, #{seller.status})"
+ puts "Checklist: #{progress[:done]}/#{progress[:total]} done"
+ puts "Sign in: #{email}"
+ puts "Pending: #{seller.invitations.pending.pluck(:email).join(', ')}"
+ puts "Ledger: #{seller.seller_transfers.count} earning(s), #{seller.seller_payouts.count} payout(s)"
+ balances.each do |balance|
+ puts "Balance: #{balance.display_balance} owed (#{balance.display_earned} earned, #{balance.display_paid} paid)"
+ end
end
end
end
diff --git a/spree/core/spec/models/concerns/spree/publishable_spec.rb b/spree/core/spec/models/concerns/spree/publishable_spec.rb
index e62303dff6..e7fe42ce11 100644
--- a/spree/core/spec/models/concerns/spree/publishable_spec.rb
+++ b/spree/core/spec/models/concerns/spree/publishable_spec.rb
@@ -333,6 +333,61 @@ RSpec.describe Spree::Publishable, events: true do
expect(explicit_received).to be true
end
end
+
+ # A default record created in its parent's after_create commits with the
+ # parent, after the block that silenced it has ended.
+ context 'when the silenced write commits after the block ends' do
+ let!(:product) { create(:product) }
+
+ it 'does not publish for a record written only while events were off' do
+ received = false
+ Spree::Events.subscribe('product.updated', async: false) { received = true }
+ Spree::Events.activate!
+
+ ApplicationRecord.transaction do
+ Spree::Events.disable { product.update!(name: 'Renamed') }
+ end
+
+ expect(received).to be false
+ end
+
+ it 'publishes when the same transaction also wrote it with events on' do
+ received = false
+ Spree::Events.subscribe('product.updated', async: false) { received = true }
+ Spree::Events.activate!
+
+ ApplicationRecord.transaction do
+ Spree::Events.disable { product.update!(name: 'Renamed') }
+ product.update!(name: 'Renamed again')
+ end
+
+ expect(received).to be true
+ end
+
+ it 'does not publish a silenced destroy after an update made with events on' do
+ received = false
+ Spree::Events.subscribe('product.deleted', async: false) { received = true }
+ Spree::Events.activate!
+
+ ApplicationRecord.transaction do
+ product.update!(name: 'Renamed')
+ Spree::Events.disable { product.destroy! }
+ end
+
+ expect(received).to be false
+ end
+
+ it 'publishes a later write made with events on' do
+ received = false
+ Spree::Events.subscribe('product.updated', async: false) { received = true }
+ Spree::Events.activate!
+
+ Spree::Events.disable { product.update!(name: 'Renamed') }
+ product.update!(name: 'Renamed again')
+
+ expect(received).to be true
+ end
+ end
end
describe '.event_prefix' do
diff --git a/spree/core/spec/models/spree/store_spec.rb b/spree/core/spec/models/spree/store_spec.rb
index ac37b50f11..0945905d0e 100644
--- a/spree/core/spec/models/spree/store_spec.rb
+++ b/spree/core/spec/models/spree/store_spec.rb
@@ -187,6 +187,24 @@ describe Spree::Store, type: :model, without_global_store: true do
end
end
+ describe 'default records', :events do
+ it 'are created without publishing events' do
+ published = []
+ allow(Spree::Events).to receive(:publish).and_wrap_original do |original, name, *rest|
+ published << name
+ original.call(name, *rest)
+ end
+
+ store = create(:store)
+
+ expect(store.policies).to be_present
+ expect(store.default_channel).to be_present
+ expect(store.default_delivery_profile).to be_present
+ expect(store.default_market).to be_present
+ expect(published).to be_empty
+ end
+ end
+
describe '#default_channel' do
let(:store) { create(:store) }
diff --git a/spree/core/spec/services/spree/stores/provision_defaults_spec.rb b/spree/core/spec/services/spree/stores/provision_defaults_spec.rb
index ff6359f64e..abd66dca2e 100644
--- a/spree/core/spec/services/spree/stores/provision_defaults_spec.rb
+++ b/spree/core/spec/services/spree/stores/provision_defaults_spec.rb
@@ -296,6 +296,22 @@ RSpec.describe Spree::Stores::ProvisionDefaults do
end
end
+ describe 'events', :events do
+ it 'provisions without publishing events' do
+ store
+ published = []
+ allow(Spree::Events).to receive(:publish).and_wrap_original do |original, name, *rest|
+ published << name
+ original.call(name, *rest)
+ end
+
+ subject
+
+ expect(store.delivery_methods).to be_present
+ expect(published).to be_empty
+ end
+ end
+
describe 'running twice' do
it 'is idempotent' do
subject