rails_semantic_logger 4.9.0 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e8365956f97589f4c0a37048a4bd342e6b761b3a954f5d4cfd20178633aee5a
-  data.tar.gz: f9fbd1af99f0a4357d17c76a871b0b474fe825e137c9f0871d3d56fe1a7f34bd
+  metadata.gz: 6944c99a390bc385a4d5a83daea0fc340dbd4dd2913631ae3a812590ec1503e4
+  data.tar.gz: ebb36106bde192de58b716077fc4c1b5c51d474ee9e86e5a93ef4a77fc25d1be
 SHA512:
-  metadata.gz: b52c5f417d64195d36b0f8ebee40c67173dbefed6ab7a59bd399b345ae93f4d3231552adf215f6e4c4354b205a7e76a86604870ef6e4cbd97f165cd3dc43d5aa
-  data.tar.gz: d069e457c98a43778d61c032f47cc57a93f6db8016118528e9b635fe16fff18c7f47c7e98749243f0f2e034189233af9ee60ca336d1aff9eb4572c2587f041ee
+  metadata.gz: 1e1cf6df574f6dd146029407d80d2a4b51e1bfb222dbf511dbc6b540070e8d7432cff0eaf4cf94227b2d5440eb21c2ebab7222db774dd9408ebda613ae0df3bf
+  data.tar.gz: 2da852f09a5417bc91e155f1bb80d9a1c50baa823cd39c46ee2ea7a9ecfa366f95b551c996a3a295d6074424224fd5aaf390c14c7f08b88effdcae31486d3bc4

data/README.md

@@ -21,7 +21,7 @@ SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
 
 ## Supports
 
-For the complete list of supported Ruby and Rails versions, see the [Testing file](https://github.com/reidmorrison/rails_semantic_logger/blob/master/.travis.yml).
+For the complete list of supported Ruby and Rails versions, see the [Testing file](https://github.com/reidmorrison/rails_semantic_logger/blob/master/.github/workflows/ci.yml).
 
 ## Author
 

data/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

data/lib/rails_semantic_logger/active_record/log_subscriber.rb

@@ -198,7 +198,8 @@ module RailsSemanticLogger
         alias bind_values bind_values_v5_0_3
         alias render_bind render_bind_v5_0_3
         alias type_casted_binds type_casted_binds_v5_0_3
-      elsif Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR > 0 # ~> 6.1.0
+      elsif (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR > 0) || # ~> 6.1.0
+            Rails::VERSION::MAJOR == 7
         alias bind_values bind_values_v6_1
         alias render_bind render_bind_v6_1
         alias type_casted_binds type_casted_binds_v5_1_5

data/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
@@ -107,13 +108,13 @@ module RailsSemanticLogger
       Mongo::Logger.logger = SemanticLogger[Mongo] if defined?(Mongo::Logger)
 
       # Replace the Resque Logger
-      Resque.logger        = SemanticLogger[Resque] if defined?(Resque) && Resque.respond_to?(:logger)
+      Resque.logger        = SemanticLogger[Resque] if defined?(Resque) && Resque.respond_to?(:logger=)
 
       # Replace the Sidekiq logger
-      Sidekiq.logger       = SemanticLogger[Sidekiq] if defined?(Sidekiq)
+      Sidekiq.logger       = SemanticLogger[Sidekiq] if defined?(Sidekiq) && Sidekiq.respond_to?(:logger=)
 
       # Replace the Sidetiq logger
-      Sidetiq.logger       = SemanticLogger[Sidetiq] if defined?(Sidetiq)
+      Sidetiq.logger       = SemanticLogger[Sidetiq] if defined?(Sidetiq) && Sidetiq.respond_to?(:logger=)
 
       # Replace the DelayedJob logger
       if defined?(Delayed::Worker)
@@ -198,6 +199,13 @@ module RailsSemanticLogger
           RailsSemanticLogger::ActionController::LogSubscriber,
           :action_controller
         )
+
+        # Action Mailer
+        RailsSemanticLogger.swap_subscriber(
+          ::ActionMailer::LogSubscriber,
+          RailsSemanticLogger::ActionMailer::LogSubscriber,
+          :action_mailer
+        )
       end
 
       #

data/lib/rails_semantic_logger/extensions/rails/server.rb

@@ -5,11 +5,11 @@ module Rails
   class Server
     private
     
-    undef_method :log_to_stdout
+    undef_method :log_to_stdout if method_defined?(:log_to_stdout)
     def log_to_stdout
       wrapped_app # touch the app so the logger is set up
 
-      SemanticLogger.add_appender(io: $stdout, formatter: :color)
+      SemanticLogger.add_appender(io: $stdout, formatter: :color) unless SemanticLogger.appenders.console_output?
     end
   end
 end

data/lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger
-  VERSION = "4.9.0".freeze
+  VERSION = "4.11.0".freeze
 end

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.11.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -63,6 +63,7 @@ files:
 - Rakefile
 - lib/rails_semantic_logger.rb
 - lib/rails_semantic_logger/action_controller/log_subscriber.rb
+- lib/rails_semantic_logger/action_mailer/log_subscriber.rb
 - lib/rails_semantic_logger/action_view/log_subscriber.rb
 - lib/rails_semantic_logger/active_job/log_subscriber.rb
 - lib/rails_semantic_logger/active_record/log_subscriber.rb
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Feature rich logging framework that replaces the Rails logger.