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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Added event logging
Damian Legawiec2a11ff2ed697
diff --git a/core/app/subscribers/spree/event_log_subscriber.rb b/core/app/subscribers/spree/event_log_subscriber.rbnew file mode 100644index 0000000000..4074d8a8e1--- /dev/null+++ b/core/app/subscribers/spree/event_log_subscriber.rb@@ -0,0 +1,54 @@+# frozen_string_literal: true++module Spree+ # Logs all Spree events to Rails logger.+ #+ # Enabled by default. To disable, set Spree::Config.events_log_enabled = false+ #+ # Events are logged at info level.+ #+ # @example Output+ # [Spree Event] order.complete | payload: {"id"=>1} | 0.5ms+ #+ class EventLogSubscriber+ NAMESPACE = 'spree'++ class << self+ def attach_to_notifications+ return if @attached++ @subscription = ActiveSupport::Notifications.subscribe(/\.#{NAMESPACE}$/) do |name, start, finish, id, payload|+ log_event(name, start, finish, payload)+ end++ @attached = true+ Rails.logger.info "[Spree Events] Event logging enabled"+ end++ def detach_from_notifications+ return unless @attached++ ActiveSupport::Notifications.unsubscribe(@subscription) if @subscription+ @subscription = nil+ @attached = false+ end++ def attached?+ @attached || false+ end++ private++ def log_event(name, start, finish, payload)+ spree_event = payload[:event]+ return unless spree_event++ event_name = spree_event.name+ event_payload = spree_event.payload+ duration = ((finish - start) * 1000).round(2)++ Rails.logger.info " \e[36m[Spree Event]\e[0m \e[1m#{event_name}\e[0m | payload: #{event_payload.inspect} | #{duration}ms"+ end+ end+ end+enddiff --git a/core/lib/spree/core/configuration.rb b/core/lib/spree/core/configuration.rbindex da24a4b0b6..0063136463 100644--- a/core/lib/spree/core/configuration.rb+++ b/core/lib/spree/core/configuration.rb@@ -42,6 +42,7 @@ module Spreepreference :credit_to_new_allocation, :boolean, default: falsepreference :disable_sku_validation, :boolean, default: false # when turned off disables the built-in SKU uniqueness validationpreference :disable_store_presence_validation, :boolean, default: false # when turned off disables Store presence validation for Products and Payment Methods+ preference :events_log_enabled, :boolean, default: true # Log all Spree events to Rails loggerpreference :expedited_exchanges, :boolean, default: false # NOTE this requires payment profiles to be supported on your gateway of choice as well as a delayed job handler to be configured with activejob. kicks off an exchange shipment upon return authorization save. charge customer if they do not return items within timely manner.preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being chargedpreference :geocode_addresses, :boolean, default: truediff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rbindex d764607261..59041272ff 100644--- a/core/lib/spree/core/engine.rb+++ b/core/lib/spree/core/engine.rb@@ -305,6 +305,11 @@ module SpreeRails.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+ endendinitializer 'spree.promo.register.promotions.actions' do |app|