WIP - add ActionMailerSubscriber

Author: solnic

sentry-rails/lib/sentry/rails/log_subscribers/action_mailer_subscriber.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "sentry/rails/log_subscriber"
+
+module Sentry
+  module Rails
+    module LogSubscribers
+      # LogSubscriber for ActionMailer events that captures email delivery
+      # and processing events using Sentry's structured logging system.
+      #
+      # This subscriber captures deliver.action_mailer and process.action_mailer events
+      # and formats them with relevant email information while respecting PII settings.
+      #
+      # @example Usage
+      #   # Enable structured logging for ActionMailer
+      #   Sentry.init do |config|
+      #     config.enable_logs = true
+      #     config.rails.structured_logging = true
+      #     config.rails.structured_logging.attach_to = [:action_mailer]
+      #   end
+      class ActionMailerSubscriber < Sentry::Rails::LogSubscriber
+        # Handle deliver.action_mailer events
+        #
+        # @param event [ActiveSupport::Notifications::Event] The email delivery event
+        def deliver(event)
+          return if excluded_event?(event)
+
+          payload = event.payload
+          mailer = payload[:mailer]
+          duration = duration_ms(event)
+
+          # Prepare structured attributes
+          attributes = {
+            mailer: mailer,
+            duration_ms: duration,
+            perform_deliveries: payload[:perform_deliveries]
+          }
+
+          # Add delivery method if available
+          attributes[:delivery_method] = payload[:delivery_method] if payload[:delivery_method]
+
+          # Add date if available
+          attributes[:date] = payload[:date].to_s if payload[:date]
+
+          # Only include email details if PII is allowed
+          if Sentry.configuration.send_default_pii
+            # Note: We're being very conservative here and not including
+            # to, from, subject, or body to avoid PII leakage
+            # Users can customize this behavior by extending the subscriber
+            attributes[:message_id] = payload[:message_id] if payload[:message_id]
+          end
+
+          message = "Email delivered via #{mailer}"
+
+          # Log the structured event
+          log_structured_event(
+            message: message,
+            level: :info,
+            attributes: attributes
+          )
+        end
+
+        # Handle process.action_mailer events
+        #
+        # @param event [ActiveSupport::Notifications::Event] The email processing event
+        def process(event)
+          return if excluded_event?(event)
+
+          payload = event.payload
+          mailer = payload[:mailer]
+          action = payload[:action]
+          duration = duration_ms(event)
+
+          # Prepare structured attributes
+          attributes = {
+            mailer: mailer,
+            action: action,
+            duration_ms: duration
+          }
+
+          # Add parameters if PII is allowed and they exist
+          if Sentry.configuration.send_default_pii && payload[:params]
+            # Filter sensitive parameters
+            filtered_params = filter_sensitive_params(payload[:params])
+            attributes[:params] = filtered_params unless filtered_params.empty?
+          end
+
+          message = "#{mailer}##{action}"
+
+          # Log the structured event
+          log_structured_event(
+            message: message,
+            level: :info,
+            attributes: attributes
+          )
+        end
+
+        private
+
+        # Filter sensitive parameters from mailer params
+        #
+        # @param params [Hash] Mailer parameters
+        # @return [Hash] Filtered parameters
+        def filter_sensitive_params(params)
+          return {} unless params.is_a?(Hash)
+
+          # Email-specific sensitive parameter names to exclude
+          sensitive_keys = %w[
+            password token secret api_key
+            email_address to from cc bcc
+            subject body content message
+            personal_data user_data
+          ]
+
+          params.reject do |key, _value|
+            key_str = key.to_s.downcase
+            sensitive_keys.any? { |sensitive| key_str.include?(sensitive) }
+          end
+        end
+      end
+    end
+  end
+end

sentry-rails/spec/sentry/rails/log_subscribers/action_mailer_subscriber_spec.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "sentry/rails/log_subscribers/action_mailer_subscriber"
+
+RSpec.describe Sentry::Rails::LogSubscribers::ActionMailerSubscriber do
+  before do
+    make_basic_app do |config|
+      config.enable_logs = true
+      config.rails.structured_logging.enabled = true
+      config.rails.structured_logging.attach_to = [:action_mailer]
+    end
+  end
+
+  describe "integration with ActiveSupport::Notifications" do
+    it "logs deliver events when emails are sent" do
+      sentry_transport.events.clear
+      sentry_transport.envelopes.clear
+
+      ActiveSupport::Notifications.instrument("deliver.action_mailer",
+        mailer: "UserMailer",
+        perform_deliveries: true,
+        delivery_method: :test,
+        date: Time.current,
+        message_id: "[email protected]"
+      ) do
+        sleep(0.01)
+      end
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_event = sentry_logs.find { |log| log[:body] == "Email delivered via UserMailer" }
+      expect(log_event).not_to be_nil
+      expect(log_event[:level]).to eq("info")
+      expect(log_event[:attributes][:mailer][:value]).to eq("UserMailer")
+      expect(log_event[:attributes][:duration_ms][:value]).to be > 0
+      expect(log_event[:attributes][:perform_deliveries][:value]).to be true
+      expect(log_event[:attributes][:delivery_method][:value]).to eq(:test)
+      expect(log_event[:attributes][:date]).to be_present
+    end
+
+    it "logs process events when mailer actions are processed" do
+      sentry_transport.events.clear
+      sentry_transport.envelopes.clear
+
+      ActiveSupport::Notifications.instrument("process.action_mailer",
+        mailer: "UserMailer",
+        action: "welcome_email",
+        params: { user_id: 123, name: "John Doe" }
+      ) do
+        sleep(0.01)
+      end
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_event = sentry_logs.find { |log| log[:body] == "UserMailer#welcome_email" }
+      expect(log_event).not_to be_nil
+      expect(log_event[:level]).to eq("info")
+      expect(log_event[:attributes][:mailer][:value]).to eq("UserMailer")
+      expect(log_event[:attributes][:action][:value]).to eq("welcome_email")
+      expect(log_event[:attributes][:duration_ms][:value]).to be > 0
+    end
+
+    it "includes delivery method when available" do
+      sentry_transport.events.clear
+      sentry_transport.envelopes.clear
+
+      ActiveSupport::Notifications.instrument("deliver.action_mailer",
+        mailer: "NotificationMailer",
+        perform_deliveries: true,
+        delivery_method: :smtp
+      )
+
+      Sentry.get_current_client.log_event_buffer.flush
+
+      expect(sentry_logs).not_to be_empty
+
+      log_event = sentry_logs.find { |log| log[:body] == "Email delivered via NotificationMailer" }
+      expect(log_event).not_to be_nil
+      expect(log_event[:attributes][:delivery_method][:value]).to eq(:smtp)
+    end
+
+    context "when send_default_pii is enabled" do
+      before do
+        Sentry.configuration.send_default_pii = true
+      end
+
+      after do
+        Sentry.configuration.send_default_pii = false
+      end
+
+      it "includes message_id for deliver events" do
+        sentry_transport.events.clear
+        sentry_transport.envelopes.clear
+
+        ActiveSupport::Notifications.instrument("deliver.action_mailer",
+          mailer: "UserMailer",
+          perform_deliveries: true,
+          message_id: "[email protected]"
+        )
+
+        Sentry.get_current_client.log_event_buffer.flush
+
+        expect(sentry_logs).not_to be_empty
+
+        log_event = sentry_logs.find { |log| log[:body] == "Email delivered via UserMailer" }
+        expect(log_event).not_to be_nil
+        expect(log_event[:attributes][:message_id][:value]).to eq("[email protected]")
+      end
+
+      it "includes filtered parameters for process events" do
+        sentry_transport.events.clear
+        sentry_transport.envelopes.clear
+
+        ActiveSupport::Notifications.instrument("process.action_mailer",
+          mailer: "UserMailer",
+          action: "welcome_email",
+          params: {
+            user_id: 123,
+            safe_param: "value",
+            password: "secret",
+            email_address: "[email protected]",
+            subject: "Welcome!",
+            api_key: "secret-key"
+          }
+        )
+
+        Sentry.get_current_client.log_event_buffer.flush
+
+        expect(sentry_logs).not_to be_empty
+
+        log_event = sentry_logs.find { |log| log[:body] == "UserMailer#welcome_email" }
+        expect(log_event).not_to be_nil
+        expect(log_event[:attributes][:params]).to be_present
+
+        params = log_event[:attributes][:params][:value]
+        expect(params).to include(user_id: 123, safe_param: "value")
+        expect(params).not_to have_key(:password)
+        expect(params).not_to have_key(:email_address)
+        expect(params).not_to have_key(:subject)
+        expect(params).not_to have_key(:api_key)
+      end
+    end
+
+    context "when send_default_pii is disabled" do
+      it "does not include message_id for deliver events" do
+        sentry_transport.events.clear
+        sentry_transport.envelopes.clear
+
+        ActiveSupport::Notifications.instrument("deliver.action_mailer",
+          mailer: "UserMailer",
+          perform_deliveries: true,
+          message_id: "[email protected]"
+        )
+
+        Sentry.get_current_client.log_event_buffer.flush
+
+        expect(sentry_logs).not_to be_empty
+
+        log_event = sentry_logs.find { |log| log[:body] == "Email delivered via UserMailer" }
+        expect(log_event).not_to be_nil
+        expect(log_event[:attributes]).not_to have_key(:message_id)
+      end
+
+      it "does not include parameters for process events" do
+        sentry_transport.events.clear
+        sentry_transport.envelopes.clear
+
+        ActiveSupport::Notifications.instrument("process.action_mailer",
+          mailer: "UserMailer",
+          action: "welcome_email",
+          params: { user_id: 123, name: "John Doe" }
+        )
+
+        Sentry.get_current_client.log_event_buffer.flush
+
+        expect(sentry_logs).not_to be_empty
+
+        log_event = sentry_logs.find { |log| log[:body] == "UserMailer#welcome_email" }
+        expect(log_event).not_to be_nil
+        expect(log_event[:attributes]).not_to have_key(:params)
+      end
+    end
+
+    it "excludes events starting with !" do
+      subscriber = described_class.new
+      event = double("event", name: "!connection.action_mailer", payload: {})
+      expect(subscriber.send(:excluded_event?, event)).to be true
+    end
+  end
+
+  describe "when logging is disabled" do
+    before do
+      make_basic_app do |config|
+        config.enable_logs = false
+        config.rails.structured_logging.enabled = true
+        config.rails.structured_logging.attach_to = [:action_mailer]
+      end
+    end
+
+    it "does not log events when logging is disabled" do
+      initial_log_count = sentry_logs.count
+
+      ActiveSupport::Notifications.instrument("deliver.action_mailer",
+        mailer: "UserMailer",
+        perform_deliveries: true
+      )
+
+      if Sentry.get_current_client&.log_event_buffer
+        Sentry.get_current_client.log_event_buffer.flush
+      end
+
+      expect(sentry_logs.count).to eq(initial_log_count)
+    end
+  end
+end