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.

Respect `Rails.application.config.filter_parameters` to filter out attributes in the event log subscriber

Damian Legawiec45f7c868511e
diff --git a/core/app/subscribers/spree/event_log_subscriber.rb b/core/app/subscribers/spree/event_log_subscriber.rb
index 4074d8a8e1..3a5151463e 100644
--- a/core/app/subscribers/spree/event_log_subscriber.rb
+++ b/core/app/subscribers/spree/event_log_subscriber.rb
@@ -5,7 +5,8 @@ module Spree
#
# Enabled by default. To disable, set Spree::Config.events_log_enabled = false
#
- # Events are logged at info level.
+ # Events are logged at info level. Sensitive parameters are filtered using
+ # Rails.application.config.filter_parameters.
#
# @example Output
# [Spree Event] order.complete | payload: {"id"=>1} | 0.5ms
@@ -44,11 +45,21 @@ module Spree
return unless spree_event
event_name = spree_event.name
- event_payload = spree_event.payload
+ event_payload = filter_sensitive_params(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
+
+ def filter_sensitive_params(payload)
+ parameter_filter.filter(payload)
+ end
+
+ def parameter_filter
+ @parameter_filter ||= ActiveSupport::ParameterFilter.new(
+ Rails.application.config.filter_parameters
+ )
+ end
end
end
end
diff --git a/core/spec/subscribers/spree/event_log_subscriber_spec.rb b/core/spec/subscribers/spree/event_log_subscriber_spec.rb
new file mode 100644
index 0000000000..624491cbc9
--- /dev/null
+++ b/core/spec/subscribers/spree/event_log_subscriber_spec.rb
@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::EventLogSubscriber do
+ describe '.attach_to_notifications' do
+ after do
+ described_class.detach_from_notifications
+ end
+
+ it 'subscribes to Spree events' do
+ expect(described_class.attached?).to be false
+ described_class.attach_to_notifications
+ expect(described_class.attached?).to be true
+ end
+
+ it 'only attaches once' do
+ described_class.attach_to_notifications
+ expect(ActiveSupport::Notifications).not_to receive(:subscribe)
+ described_class.attach_to_notifications
+ end
+ end
+
+ describe '.detach_from_notifications' do
+ it 'unsubscribes from notifications' do
+ described_class.attach_to_notifications
+ expect(described_class.attached?).to be true
+ described_class.detach_from_notifications
+ expect(described_class.attached?).to be false
+ end
+ end
+
+ describe 'logging events' do
+ before do
+ described_class.attach_to_notifications
+ end
+
+ after do
+ described_class.detach_from_notifications
+ end
+
+ it 'logs events to Rails logger' do
+ event = Spree::Event.new(
+ name: 'order.complete',
+ payload: { 'id' => 1, 'number' => 'R123' },
+ metadata: {}
+ )
+
+ expect(Rails.logger).to receive(:info).with(/\[Spree Event\].*order\.complete/)
+
+ ActiveSupport::Notifications.instrument('order.complete.spree', event: event) {}
+ end
+
+ describe 'filtering sensitive parameters' do
+ it 'filters password from payload' do
+ event = Spree::Event.new(
+ name: 'user.create',
+ payload: { 'id' => 1, 'email' => '[email protected]', 'password' => 'secret123' },
+ metadata: {}
+ )
+
+ expect(Rails.logger).to receive(:info) do |message|
+ expect(message).to include('[Spree Event]')
+ expect(message).to include('user.create')
+ expect(message).to include('[FILTERED]')
+ expect(message).not_to include('secret123')
+ end
+
+ ActiveSupport::Notifications.instrument('user.create.spree', event: event) {}
+ end
+
+ it 'filters credit card number from payload' do
+ event = Spree::Event.new(
+ name: 'payment.create',
+ payload: { 'id' => 1, 'number' => '4111111111111111' },
+ metadata: {}
+ )
+
+ expect(Rails.logger).to receive(:info) do |message|
+ expect(message).to include('[Spree Event]')
+ expect(message).to include('payment.create')
+ expect(message).to include('[FILTERED]')
+ expect(message).not_to include('4111111111111111')
+ end
+
+ ActiveSupport::Notifications.instrument('payment.create.spree', event: event) {}
+ end
+
+ it 'filters verification_value from payload' do
+ event = Spree::Event.new(
+ name: 'payment.create',
+ payload: { 'id' => 1, 'verification_value' => '123' },
+ metadata: {}
+ )
+
+ expect(Rails.logger).to receive(:info) do |message|
+ expect(message).not_to include('"123"')
+ end
+
+ ActiveSupport::Notifications.instrument('payment.create.spree', event: event) {}
+ end
+
+ it 'does not filter non-sensitive data' do
+ event = Spree::Event.new(
+ name: 'order.complete',
+ payload: { 'id' => 42, 'total' => '99.99', 'state' => 'complete' },
+ metadata: {}
+ )
+
+ expect(Rails.logger).to receive(:info) do |message|
+ expect(message).to include('42')
+ expect(message).to include('99.99')
+ expect(message).to include('complete')
+ end
+
+ ActiveSupport::Notifications.instrument('order.complete.spree', event: event) {}
+ end
+ end
+ end
+end