Merge pull request reidmorrison#168 from houseninjadojo/master

feat: action mailer

Author: reidmorrison

lib/rails_semantic_logger.rb

@@ -6,6 +6,9 @@ module RailsSemanticLogger
   module ActionController
     autoload :LogSubscriber, "rails_semantic_logger/action_controller/log_subscriber"
   end
+  module ActionMailer
+    autoload :LogSubscriber, "rails_semantic_logger/action_mailer/log_subscriber"
+  end
   module ActionView
     autoload :LogSubscriber, "rails_semantic_logger/action_view/log_subscriber"
   end

lib/rails_semantic_logger/action_mailer/log_subscriber.rb

@@ -0,0 +1,135 @@
+require "active_support/log_subscriber"
+require "action_mailer"
+
+module RailsSemanticLogger
+  module ActionMailer
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      def deliver(event)
+        ex = event.payload[:exception_object]
+        message_id = event.payload[:message_id]
+        duration = event.duration.round(1)
+        if ex
+         log_with_formatter event: event, log_duration: true, level: :error do |fmt|
+            {
+              message: "Error delivering mail #{message_id} (#{duration}ms)",
+              exception: ex
+            }
+          end
+        else
+          message = begin
+          if event.payload[:perform_deliveries]
+              "Delivered mail #{message_id} (#{duration}ms)"
+            else
+              "Skipped delivery of mail #{message_id} as `perform_deliveries` is false"
+            end
+          end
+          log_with_formatter event: event, log_duration: true do |fmt|
+            { message: message }
+          end
+        end
+      end
+
+      # An email was generated.
+      def process(event)
+        mailer   = event.payload[:mailer]
+        action   = event.payload[:action]
+        duration = event.duration.round(1)
+        log_with_formatter event: event do |fmt|
+          { message: "#{mailer}##{action}: processed outbound mail in #{duration}ms" }
+        end
+      end
+
+      private
+
+      class EventFormatter
+        def initialize(event:, log_duration: false)
+          @event = event
+          @log_duration = log_duration
+        end
+
+        def mailer
+          event.payload[:mailer]
+        end
+
+        def payload
+          {}.tap do |h|
+            h[:event_name]         = event.name
+            h[:mailer]             = mailer
+            h[:action]             = action
+            h[:message_id]         = event.payload[:message_id]
+            h[:perform_deliveries] = event.payload[:perform_deliveries]
+            h[:subject]            = event.payload[:subject]
+            h[:to]                 = event.payload[:to]
+            h[:from]               = event.payload[:from]
+            h[:bcc]                = event.payload[:bcc]
+            h[:cc]                 = event.payload[:cc]
+            h[:date]               = date
+            h[:duration]           = event.duration.round(2) if log_duration?
+            h[:args]               = formatted_args
+          end
+        end
+
+        def date
+          if event.payload[:date].respond_to?(:to_time)
+            event.payload[:date].to_time.utc
+          elsif event.payload[:date].is_a?(String)
+            Time.parse(date).utc
+          else
+            nil
+          end
+        end
+
+        private
+
+        attr_reader :event
+
+        def mailer
+          event.payload[:mailer]
+        end
+
+        def action
+          event.payload[:action]
+        end
+
+        def formatted_args
+          if defined?(mailer.contantize.log_arguments?) && !mailer.contantize.log_arguments?
+            ""
+          else
+            JSON.pretty_generate(event.payload[:args].map { |arg| format(arg) }) if event.payload[:args].present?
+          end
+        end
+
+        def format(arg)
+          case arg
+          when Hash
+            arg.transform_values { |value| format(value) }
+          when Array
+            arg.map { |value| format(value) }
+          when GlobalID::Identification
+            begin
+              arg.to_global_id
+            rescue StandardError
+              arg
+            end
+          else
+            arg
+          end
+        end
+
+        def log_duration?
+          @log_duration
+        end
+      end
+
+      def log_with_formatter(level: :info, **kw_args)
+        fmt = EventFormatter.new(**kw_args)
+        msg = yield fmt
+        logger.public_send(level, **msg, payload: fmt.payload)
+      end
+
+      def logger
+        ::ActionMailer::Base.logger
+      end
+    end
+  end
+end

lib/rails_semantic_logger/engine.rb

@@ -1,6 +1,7 @@
 require "rails"
 require "action_controller/log_subscriber"
 require "action_view/log_subscriber"
+require "action_mailer/log_subscriber"
 require "rails_semantic_logger/options"
 
 module RailsSemanticLogger
@@ -198,6 +199,13 @@ class Engine < ::Rails::Engine
           RailsSemanticLogger::ActionController::LogSubscriber,
           :action_controller
         )
+
+        # Action Mailer
+        RailsSemanticLogger.swap_subscriber(
+          ::ActionMailer::LogSubscriber,
+          RailsSemanticLogger::ActionMailer::LogSubscriber,
+          :action_mailer
+        )
       end
 
       #

test/action_mailer_test.rb

@@ -0,0 +1,86 @@
+require_relative "test_helper"
+
+class ActionMailerTest < Minitest::Test
+  class MyMailer < ActionMailer::Base
+    def some_email(to:, from:, subject:)
+      mail(to: to, from: from, subject: subject, body: "Hello")
+    end
+  end
+
+  describe "ActionMailer" do
+    before do
+      ::ActionMailer::Base.delivery_method = :test
+      @mock_logger = MockLogger.new
+      @appender    = SemanticLogger.add_appender(logger: @mock_logger, formatter: :raw)
+    end
+
+    after do
+      SemanticLogger.remove_appender(@appender)
+    end
+
+    describe "#deliver" do
+      it "sets the ActionMailer logger" do
+        assert_kind_of SemanticLogger::Logger, MyMailer.logger
+      end
+
+      it "sends the email" do
+        MyMailer.some_email(to: '[email protected]', from: '[email protected]', subject: 'test').deliver_now
+      end
+    end
+
+    describe "Logging::LogSubscriber" do
+      before do
+        skip "Older rails does not support ActiveSupport::Notification" unless defined?(ActiveSupport::Notifications)
+      end
+
+      let(:subscriber) { RailsSemanticLogger::ActionMailer::LogSubscriber.new }
+
+      let(:event) do
+        ActiveSupport::Notifications::Event.new event_name,
+                                                5.seconds.ago,
+                                                Time.zone.now,
+                                                SecureRandom.uuid,
+                                                payload
+      end
+
+      let(:payload) do
+        {
+          mailer: 'MyMailer',
+          action: :some_email,
+        }
+      end
+
+      let(:event_name) { "deliver.action_mailer" }
+
+      let(:mailer) do
+        MyMailer.some_email(to: '[email protected]', from: '[email protected]', subject: 'test')
+      end
+
+      %i[deliver process].each do |method|
+        describe "##{method}" do
+          specify do
+            assert ActionMailer::Base.logger.info
+            subscriber.public_send(method, event)
+          end
+        end
+      end
+
+      describe "ActiveJob::Logging::LogSubscriber::EventFormatter" do
+        let(:formatter) do
+          RailsSemanticLogger::ActionMailer::LogSubscriber::EventFormatter.new(event: event, log_duration: true)
+        end
+
+        let(:event_name) { "deliver.action_mailer" }
+
+        describe "#payload" do
+          specify do
+            assert_equal(formatter.payload[:event_name], "deliver.action_mailer")
+            assert_equal(formatter.payload[:mailer], "MyMailer")
+            assert_equal(formatter.payload[:action], :some_email)
+            assert_kind_of(Float, formatter.payload[:duration])
+          end
+        end
+      end
+    end
+  end
+end