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.

Move `publishes_lifecycle_events` directly into models (#13416)

Damian Legawiec5a92cfbcc99b
diff --git a/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb b/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb
index 296f333a08..5409ab8ba2 100644
--- a/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb
+++ b/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb
@@ -3,16 +3,49 @@
module Spree
module Admin
module WebhookEndpointsHelper
+ # Models that have publishes_lifecycle_events enabled
+ # These models publish created/updated/deleted events
+ EVENTABLE_MODELS = %w[
+ asset
+ customer_return
+ digital
+ digital_link
+ export
+ gift_card
+ gift_card_batch
+ import
+ line_item
+ newsletter_subscriber
+ order
+ payment
+ post
+ post_category
+ price
+ product
+ promotion
+ refund
+ report
+ return_authorization
+ shipment
+ stock_item
+ stock_movement
+ stock_transfer
+ store_credit
+ user
+ variant
+ wished_item
+ wishlist
+ ].freeze
+
def available_webhook_events
@available_webhook_events ||= begin
events = []
# Add lifecycle events from eventable models
- Spree.eventable_models.each do |model_class|
- base_name = model_class.name.demodulize.underscore
- events << "#{base_name}.created"
- events << "#{base_name}.updated"
- events << "#{base_name}.deleted"
+ EVENTABLE_MODELS.each do |model_name|
+ events << "#{model_name}.created"
+ events << "#{model_name}.updated"
+ events << "#{model_name}.deleted"
end
# Add custom events
diff --git a/core/app/models/spree/asset.rb b/core/app/models/spree/asset.rb
index 14ff43e1f4..78179b2987 100644
--- a/core/app/models/spree/asset.rb
+++ b/core/app/models/spree/asset.rb
@@ -4,6 +4,8 @@ module Spree
include Spree::Metafields
include Spree::Metadata
+ publishes_lifecycle_events
+
EXTERNAL_URL_METAFIELD_KEY = 'external.url'
belongs_to :viewable, polymorphic: true, touch: true
diff --git a/core/app/models/spree/customer_return.rb b/core/app/models/spree/customer_return.rb
index 9b670c06d5..77d9f40460 100644
--- a/core/app/models/spree/customer_return.rb
+++ b/core/app/models/spree/customer_return.rb
@@ -5,6 +5,8 @@ module Spree
include Spree::Metafields
include Spree::Metadata
+ publishes_lifecycle_events
+
belongs_to :stock_location
belongs_to :store, class_name: 'Spree::Store', inverse_of: :customer_returns
diff --git a/core/app/models/spree/digital.rb b/core/app/models/spree/digital.rb
index 3abc99dcef..5041c14440 100644
--- a/core/app/models/spree/digital.rb
+++ b/core/app/models/spree/digital.rb
@@ -1,5 +1,7 @@
module Spree
class Digital < Spree.base_class
+ publishes_lifecycle_events
+
belongs_to :variant
has_many :digital_links, dependent: :destroy
diff --git a/core/app/models/spree/digital_link.rb b/core/app/models/spree/digital_link.rb
index 53cf35dae4..b994d9ee16 100644
--- a/core/app/models/spree/digital_link.rb
+++ b/core/app/models/spree/digital_link.rb
@@ -1,5 +1,7 @@
module Spree
class DigitalLink < Spree.base_class
+ publishes_lifecycle_events
+
if Rails::VERSION::STRING >= '7.1.0'
has_secure_token on: :save
else
diff --git a/core/app/models/spree/export.rb b/core/app/models/spree/export.rb
index 1b3a3160f1..d738c91a84 100644
--- a/core/app/models/spree/export.rb
+++ b/core/app/models/spree/export.rb
@@ -11,6 +11,8 @@ module Spree
include Spree::Core::NumberGenerator.new(prefix: 'EF')
+ publishes_lifecycle_events
+
# Set event prefix for all Export subclasses
# This ensures Spree::Exports::Products publishes 'export.create' not 'products.create'
self.event_prefix = 'export'
diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rb
index 92f372c45d..dc9b7fef53 100644
--- a/core/app/models/spree/gift_card.rb
+++ b/core/app/models/spree/gift_card.rb
@@ -5,6 +5,8 @@ module Spree
include Spree::Metafields
include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
+ publishes_lifecycle_events
+
#
# State machine
#
diff --git a/core/app/models/spree/gift_card_batch.rb b/core/app/models/spree/gift_card_batch.rb
index 6e9cf07b16..3ee3ef9e86 100644
--- a/core/app/models/spree/gift_card_batch.rb
+++ b/core/app/models/spree/gift_card_batch.rb
@@ -3,6 +3,8 @@ module Spree
extend DisplayMoney
include Spree::SingleStoreResource
+ publishes_lifecycle_events
+
#
# Associations
#
diff --git a/core/app/models/spree/import.rb b/core/app/models/spree/import.rb
index 5ada787eff..2b3123e7b3 100644
--- a/core/app/models/spree/import.rb
+++ b/core/app/models/spree/import.rb
@@ -7,6 +7,8 @@ module Spree
include Spree::Core::NumberGenerator.new(prefix: 'IM')
+ publishes_lifecycle_events
+
# Set event prefix for all Import subclasses
# This ensures Spree::Imports::Products publishes 'import.create' not 'products.create'
self.event_prefix = 'import'
diff --git a/core/app/models/spree/line_item.rb b/core/app/models/spree/line_item.rb
index 29766c783f..06da051819 100644
--- a/core/app/models/spree/line_item.rb
+++ b/core/app/models/spree/line_item.rb
@@ -3,6 +3,8 @@ module Spree
include Spree::Metafields
include Spree::Metadata
+ publishes_lifecycle_events
+
attribute :quantity, :integer, default: 1
before_validation :ensure_valid_quantity
diff --git a/core/app/models/spree/newsletter_subscriber.rb b/core/app/models/spree/newsletter_subscriber.rb
index 6b29faa03a..fb124d1ba0 100644
--- a/core/app/models/spree/newsletter_subscriber.rb
+++ b/core/app/models/spree/newsletter_subscriber.rb
@@ -5,6 +5,8 @@ module Spree
include Spree::NewsletterSubscriber::Emails
include Spree::Metafields
+ publishes_lifecycle_events
+
has_secure_token :verification_token
#
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index b9da2bff6d..6c76bc06a0 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -28,6 +28,8 @@ module Spree
include Spree::NumberIdentifier
include Spree::NumberAsParam
include Spree::SingleStoreResource
+
+ publishes_lifecycle_events
include Spree::MemoizedData
include Spree::Metafields
include Spree::Metadata
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index 22a00068e6..3c4f80681c 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -17,6 +17,8 @@ module Spree
include Spree::Payment::Webhooks
include Spree::Payment::CustomEvents
+ publishes_lifecycle_events
+
NON_RISKY_AVS_CODES = ['B', 'D', 'H', 'J', 'M', 'Q', 'T', 'V', 'X', 'Y'].freeze
RISKY_AVS_CODES = ['A', 'C', 'E', 'F', 'G', 'I', 'K', 'L', 'N', 'O', 'P', 'R', 'S', 'U', 'W', 'Z'].freeze
INVALID_STATES = %w(failed invalid void).freeze
diff --git a/core/app/models/spree/post.rb b/core/app/models/spree/post.rb
index 315210d4b9..7d854f3762 100644
--- a/core/app/models/spree/post.rb
+++ b/core/app/models/spree/post.rb
@@ -4,6 +4,8 @@ module Spree
include Spree::Metafields
extend FriendlyId
+ publishes_lifecycle_events
+
friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id deleted?]
acts_as_paranoid
acts_as_taggable_on :tags
diff --git a/core/app/models/spree/post_category.rb b/core/app/models/spree/post_category.rb
index a7c8a7a8a4..c53a196142 100644
--- a/core/app/models/spree/post_category.rb
+++ b/core/app/models/spree/post_category.rb
@@ -4,6 +4,8 @@ module Spree
include Spree::Metafields
extend FriendlyId
+ publishes_lifecycle_events
+
friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id]
#
diff --git a/core/app/models/spree/price.rb b/core/app/models/spree/price.rb
index 2f4ac41289..6b522a4259 100644
--- a/core/app/models/spree/price.rb
+++ b/core/app/models/spree/price.rb
@@ -2,6 +2,8 @@ module Spree
class Price < Spree.base_class
include Spree::VatPriceCalculation
+ publishes_lifecycle_events
+
acts_as_paranoid
MAXIMUM_AMOUNT = BigDecimal('99_999_999.99')
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 13b785a7ce..2136128008 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -36,6 +36,8 @@ module Spree
include Spree::VendorConcern
end
+ publishes_lifecycle_events
+
MEMOIZED_METHODS = %w[total_on_hand taxonomy_ids taxon_and_ancestors category
default_variant_id tax_category default_variant
default_image secondary_image
diff --git a/core/app/models/spree/promotion.rb b/core/app/models/spree/promotion.rb
index 5cd5848928..e05a29484d 100644
--- a/core/app/models/spree/promotion.rb
+++ b/core/app/models/spree/promotion.rb
@@ -7,6 +7,8 @@ module Spree
include Spree::Security::Promotions
end
+ publishes_lifecycle_events
+
MATCH_POLICIES = %w(all any)
UNACTIVATABLE_ORDER_STATES = ['complete', 'awaiting_return', 'returned']
diff --git a/core/app/models/spree/refund.rb b/core/app/models/spree/refund.rb
index 18404fce7d..5f40bdc9d5 100644
--- a/core/app/models/spree/refund.rb
+++ b/core/app/models/spree/refund.rb
@@ -6,6 +6,8 @@ module Spree
include Spree::Security::Refunds
end
+ publishes_lifecycle_events
+
with_options inverse_of: :refunds do
belongs_to :payment
belongs_to :reimbursement, optional: true
diff --git a/core/app/models/spree/report.rb b/core/app/models/spree/report.rb
index 7cb4736f07..359200ff5e 100644
--- a/core/app/models/spree/report.rb
+++ b/core/app/models/spree/report.rb
@@ -3,6 +3,8 @@ module Spree
include Spree::SingleStoreResource
include Spree::VendorConcern if defined?(Spree::VendorConcern)
+ publishes_lifecycle_events
+
# Set event prefix for all Report subclasses
# This ensures Spree::Reports::SalesTotal publishes 'report.create' not 'sales_total.create'
self.event_prefix = 'report'
diff --git a/core/app/models/spree/return_authorization.rb b/core/app/models/spree/return_authorization.rb
index a3e9dd1d46..718637ad9b 100644
--- a/core/app/models/spree/return_authorization.rb
+++ b/core/app/models/spree/return_authorization.rb
@@ -3,6 +3,8 @@ module Spree
include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
include Spree::NumberIdentifier
+ publishes_lifecycle_events
+
belongs_to :order, class_name: 'Spree::Order', inverse_of: :return_authorizations
has_many :return_items, inverse_of: :return_authorization, dependent: :destroy
diff --git a/core/app/models/spree/shipment.rb b/core/app/models/spree/shipment.rb
index a48fc7e4b2..67a2be84d2 100644
--- a/core/app/models/spree/shipment.rb
+++ b/core/app/models/spree/shipment.rb
@@ -17,6 +17,8 @@ module Spree
include Spree::Shipment::Webhooks
include Spree::Shipment::CustomEvents
+ publishes_lifecycle_events
+
with_options inverse_of: :shipments do
belongs_to :address, class_name: 'Spree::Address'
belongs_to :order, class_name: 'Spree::Order', touch: true
diff --git a/core/app/models/spree/stock_item.rb b/core/app/models/spree/stock_item.rb
index c65544824a..257d76c2cd 100644
--- a/core/app/models/spree/stock_item.rb
+++ b/core/app/models/spree/stock_item.rb
@@ -6,6 +6,8 @@ module Spree
include Spree::Metadata
include Spree::StockItem::Webhooks
+ publishes_lifecycle_events
+
with_options inverse_of: :stock_items do
belongs_to :stock_location, class_name: 'Spree::StockLocation'
belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
diff --git a/core/app/models/spree/stock_movement.rb b/core/app/models/spree/stock_movement.rb
index dfd5b9bfe8..83078a880d 100644
--- a/core/app/models/spree/stock_movement.rb
+++ b/core/app/models/spree/stock_movement.rb
@@ -8,6 +8,8 @@ module Spree
include Spree::StockMovement::Webhooks
include Spree::StockMovement::CustomEvents
+ publishes_lifecycle_events
+
belongs_to :stock_item, class_name: 'Spree::StockItem', inverse_of: :stock_movements
belongs_to :originator, polymorphic: true
diff --git a/core/app/models/spree/stock_transfer.rb b/core/app/models/spree/stock_transfer.rb
index 78b7cf22b3..37694d8790 100644
--- a/core/app/models/spree/stock_transfer.rb
+++ b/core/app/models/spree/stock_transfer.rb
@@ -6,6 +6,8 @@ module Spree
include Spree::Metafields
include Spree::Metadata
+ publishes_lifecycle_events
+
has_many :stock_movements, as: :originator
accepts_nested_attributes_for :stock_movements, reject_if: proc { |attributes|
attributes[:quantity] = attributes[:quantity].to_i
diff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rb
index 1d5f701bd9..1038841ebd 100644
--- a/core/app/models/spree/store_credit.rb
+++ b/core/app/models/spree/store_credit.rb
@@ -4,6 +4,8 @@ module Spree
include Spree::Metafields
include Spree::Metadata
+ publishes_lifecycle_events
+
acts_as_paranoid
VOID_ACTION = 'void'.freeze
diff --git a/core/app/models/spree/variant.rb b/core/app/models/spree/variant.rb
index 5dcfd03b09..b0d076dbfb 100644
--- a/core/app/models/spree/variant.rb
+++ b/core/app/models/spree/variant.rb
@@ -8,6 +8,8 @@ module Spree
include Spree::Metadata
include Spree::Variant::Webhooks
+ publishes_lifecycle_events
+
MEMOIZED_METHODS = %w(purchasable in_stock on_sale backorderable tax_category options_text compare_at_price)
DIMENSION_UNITS = %w[mm cm in ft]
diff --git a/core/app/models/spree/wished_item.rb b/core/app/models/spree/wished_item.rb
index 24165c012b..01814e1626 100644
--- a/core/app/models/spree/wished_item.rb
+++ b/core/app/models/spree/wished_item.rb
@@ -3,6 +3,8 @@ module Spree
extend DisplayMoney
money_methods :total, :price
+ publishes_lifecycle_events
+
belongs_to :variant, class_name: 'Spree::Variant'
belongs_to :wishlist, class_name: 'Spree::Wishlist'
diff --git a/core/app/models/spree/wishlist.rb b/core/app/models/spree/wishlist.rb
index 3f021012a6..63ac90516f 100644
--- a/core/app/models/spree/wishlist.rb
+++ b/core/app/models/spree/wishlist.rb
@@ -2,6 +2,8 @@ module Spree
class Wishlist < Spree.base_class
include Spree::SingleStoreResource
+ publishes_lifecycle_events
+
if Rails::VERSION::STRING >= '7.1.0'
has_secure_token on: :save
else
diff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rb
index 5b8e57f733..b0f14d07a6 100644
--- a/core/lib/spree/core.rb
+++ b/core/lib/spree/core.rb
@@ -306,17 +306,6 @@ module Spree
Rails.application.config.spree.integrations = value
end
- # Models that automatically emit lifecycle events (create, update, destroy)
- # @example Adding a custom model to emit events
- # Spree.eventable_models << MyCustomModel
- def self.eventable_models
- Rails.application.config.spree.eventable_models
- end
-
- def self.eventable_models=(value)
- Rails.application.config.spree.eventable_models = value
- end
-
# Event subscribers that handle lifecycle and custom events
# @example Adding a custom subscriber
# Spree.subscribers << MyApp::OrderNotificationSubscriber
diff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rb
index 9b1cfbe876..cae1396a7e 100644
--- a/core/lib/spree/core/engine.rb
+++ b/core/lib/spree/core/engine.rb
@@ -28,7 +28,6 @@ module Spree
:analytics_events,
:analytics_event_handlers,
:integrations,
- :eventable_models,
:subscribers)
SpreeCalculators = Struct.new(:shipping_methods, :tax_rates, :promotion_actions_create_adjustments, :promotion_actions_create_item_adjustments)
PromoEnvironment = Struct.new(:rules, :actions)
@@ -276,44 +275,6 @@ module Spree
Spree::Addresses::PhoneValidator
]
- # Models that automatically emit lifecycle events (create, update, destroy)
- # Developers can add/remove models from this list in their initializers
- Rails.application.config.spree.eventable_models = [
- Spree::Asset,
- Spree::CustomerReturn,
- Spree::Digital,
- Spree::DigitalLink,
- Spree::Export,
- Spree::GiftCard,
- Spree::GiftCardBatch,
- Spree::Import,
- Spree::LineItem,
- Spree::NewsletterSubscriber,
- Spree::Order,
- Spree::Payment,
- Spree::Post,
- Spree::PostCategory,
- Spree::Price,
- Spree::Product,
- Spree::Promotion,
- Spree::Refund,
- Spree::Report,
- Spree::ReturnAuthorization,
- Spree::Shipment,
- Spree::StockItem,
- Spree::StockMovement,
- Spree::StockTransfer,
- Spree::StoreCredit,
- Spree::Variant,
- Spree::WishedItem,
- Spree::Wishlist
- ]
-
- # Enable lifecycle events for configured models
- Rails.application.config.spree.eventable_models.each do |model|
- model.publishes_lifecycle_events if model.respond_to?(:publishes_lifecycle_events)
- end
-
# Attach event log subscriber if enabled
if Spree::Config.events_log_enabled
Spree::EventLogSubscriber.attach_to_notifications
@@ -386,24 +347,6 @@ module Spree
Rails.configuration.cache_classes ? require(c) : load(c)
end
- # Re-enable lifecycle events for configured models after code reload
- # This is needed because after_commit callbacks are lost when classes are reloaded
- # We must resolve the constants fresh because Zeitwerk creates new class objects
- Rails.application.config.spree.eventable_models&.each do |model|
- # Resolve the model constant fresh to handle code reload
- resolved_model = begin
- model.is_a?(String) ? model.constantize : model.name.constantize
- rescue NameError
- nil
- end
-
- next unless resolved_model
-
- # Reset lifecycle_events_enabled so callbacks can be re-registered
- resolved_model.lifecycle_events_enabled = false if resolved_model.respond_to?(:lifecycle_events_enabled=)
- resolved_model.publishes_lifecycle_events if resolved_model.respond_to?(:publishes_lifecycle_events)
- end
-
# Reset and re-activate event subscribers on code reload
# activate! will register all subscribers from Spree.subscribers
# Note: resolve_subscriber in register_subscribers! handles stale class references