lograge 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a5c4ad171a2f28dcf7271eac87818900fac9c3f3a1cac94f3a15c7b0df90ba
-  data.tar.gz: b9ea79a6aff265e3e0c12a52b5e62ec05a4fe4cac8df1c1de9868ddccca0c278
+  metadata.gz: 7417503c9af3927cc3291f8030b9cc506d42d8756538dc656218d5a2249f977d
+  data.tar.gz: a09ba47fcf99837649481b588b7eb1d90714a7ef3e454d18e09b1b3d894bbfb4
 SHA512:
-  metadata.gz: 5d39e78da6b73c9926721a7f121ed4a6697e3b89cc8e018d0d7d622ab205ea50374cf4b3390cea348bee12af380fe1c9985b1a26fb8b454df26cbb9b66da29ec
-  data.tar.gz: bbaacef289d4d2a0c710c186faeb6c0deca4d161d2ccbdb792c9ba3b0253e26e075f5de7a56b143bc37becb70d8f8abea0834278075b049a66e6269dfda7a9b3
+  metadata.gz: b171ecf0bba8e016a819606cfd579cf96b4e790b95ff0a6aba75d1ba3e1a3b180f12ef279bade671d09e1f0aca9090d61ef8bb051674ec60255f58c95492ca7e
+  data.tar.gz: 7e537bde3728955c50e6a142c43d126fafeb69ded6d7a8b9ce18410e311be49a166924ba5090f5a7279b156b0b028e9f113616d39c953fc0f39c2cfd9180dd4a

data/lib/lograge/formatters/cee.rb

@@ -4,7 +4,7 @@ module Lograge
   module Formatters
     class Cee
       def call(data)
-        "@cee: #{JSON.dump(data)}"
+        "@cee: #{Helpers::SafeJson.dump(data)}"
       end
     end
   end

data/lib/lograge/formatters/helpers/safe_json.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Lograge
+  module Formatters
+    module Helpers
+      # Serializes log data to JSON without dropping the whole log event when
+      # the data cannot be generated as-is. Newer versions of the json gem are
+      # stricter about their input:
+      #
+      # * json 3.1 rejects non-ASCII ASCII-8BIT (binary) strings, which are
+      #   common in exception messages and HTTP response bodies.
+      # * json 3.0 rejects hashes with keys that serialize to the same name,
+      #   such as +:status+ and <tt>"status"</tt>.
+      #
+      # Strings that are invalid UTF-8 have always been rejected.
+      #
+      # The data is only normalized after the first attempt fails, so well
+      # formed events are serialized exactly as before and pay no extra cost.
+      module SafeJson
+        # ArgumentError is included because, on TruffleRuby, json 3's pure-Ruby
+        # generator serializes objects such as Symbols and Times through
+        # ActiveSupport's encoder, which before Rails 8.1 passes the
+        # +quirks_mode+ option that json 3 no longer accepts. Normalizing turns
+        # those objects into plain strings, which avoids that code path.
+        GENERATION_ERRORS = [::JSON::GeneratorError, ::EncodingError, ::ArgumentError].freeze
+
+        module_function
+
+        def dump(data)
+          ::JSON.dump(data)
+        rescue *GENERATION_ERRORS
+          ::JSON.dump(normalize(data))
+        end
+
+        # Returns a copy of +value+ that the json gem can always generate:
+        #
+        # * every hash key is a UTF-8 string. When two keys serialize to the same
+        #   name, the first key keeps its position and the later value wins,
+        #   which matches how the log subscriber merges custom options.
+        # * every string and symbol becomes a valid UTF-8 string. Bytes that
+        #   cannot be converted are replaced with U+FFFD.
+        # * other objects are kept if they can be generated on their own, and
+        #   are otherwise replaced by their normalized +to_s+ (for example an
+        #   exception whose message holds binary bytes).
+        def normalize(value)
+          case value
+          when Hash then normalize_hash(value)
+          when Array then value.map { |element| normalize(element) }
+          when String then to_utf8(value)
+          when Symbol then to_utf8(value.to_s)
+          when Numeric, true, false, nil then value
+          else normalize_object(value)
+          end
+        end
+
+        def normalize_hash(hash)
+          hash.each_with_object({}) do |(key, value), normalized|
+            normalized[to_utf8(key.to_s)] = normalize(value)
+          end
+        end
+
+        def normalize_object(object)
+          ::JSON.dump(object)
+          object
+        rescue *GENERATION_ERRORS
+          to_utf8(object.to_s)
+        end
+
+        def to_utf8(string)
+          encoding = string.encoding
+          if encoding == Encoding::UTF_8
+            string.valid_encoding? ? string : string.scrub
+          elsif encoding == Encoding::BINARY || encoding.dummy?
+            # Binary strings carry no encoding information, and dummy encodings
+            # (such as UTF-7) have no converter. Treat them as UTF-8 on a
+            # best-effort basis so valid multibyte sequences survive.
+            string.dup.force_encoding(Encoding::UTF_8).scrub
+          else
+            string.encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lograge/formatters/json.rb

@@ -5,7 +5,7 @@ module Lograge
   module Formatters
     class Json
       def call(data)
-        ::JSON.dump(data)
+        Helpers::SafeJson.dump(data)
       end
     end
   end

data/lib/lograge/formatters/ltsv.rb

@@ -32,10 +32,10 @@ module Lograge
       def escape(string)
         value = string.is_a?(String) ? string.dup : string.to_s
 
-        value.gsub!('\\', '\\\\')
-        value.gsub!('\n', '\\n')
-        value.gsub!('\r', '\\r')
-        value.gsub!('\t', '\\t')
+        value.gsub!('\\') { '\\\\' }
+        value.gsub!("\n", '\\n')
+        value.gsub!("\r", '\\r')
+        value.gsub!("\t", '\\t')
 
         value
       end

data/lib/lograge/log_subscribers/base.rb

@@ -33,7 +33,7 @@ module Lograge
         data.merge!(extract_runtimes(event, payload))
         data.merge!(extract_location)
         data.merge!(extract_unpermitted_params)
-        data.merge!(custom_options(event))
+        merge_options(data, custom_options(event))
       end
 
       %i[initial_data extract_status extract_runtimes
@@ -70,7 +70,27 @@ module Lograge
 
       def custom_options(event)
         options = Lograge.custom_options(event) || {}
-        options.merge event.payload[:custom_payload] || {}
+        merge_options(options.dup, event.payload[:custom_payload] || {})
+      end
+
+      # Merges +options+ into +data+. A String key overrides an existing Symbol
+      # key of the same name (and vice versa) instead of being added alongside
+      # it, so the two never end up serialized as duplicate keys.
+      def merge_options(data, options)
+        options.each do |key, value|
+          data[existing_key(data, key)] = value
+        end
+        data
+      end
+
+      def existing_key(data, key)
+        return key if data.key?(key)
+
+        counterpart = case key
+                      when Symbol then key.to_s
+                      when String then key.to_sym
+                      end
+        counterpart && data.key?(counterpart) ? counterpart : key
       end
 
       def before_format(data, payload)

data/lib/lograge/silent_logger.rb

@@ -5,9 +5,7 @@ require 'delegate'
 module Lograge
   class SilentLogger < SimpleDelegator
     %i[debug info warn error fatal unknown].each do |method_name|
-      # rubocop:disable Lint/EmptyBlock
       define_method(method_name) { |*_args| }
-      # rubocop:enable Lint/EmptyBlock
     end
   end
 end

data/lib/lograge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lograge
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/lib/lograge.rb

@@ -3,6 +3,7 @@
 require 'logger'
 require 'lograge/version'
 require 'lograge/formatters/helpers/method_and_path'
+require 'lograge/formatters/helpers/safe_json'
 require 'lograge/formatters/cee'
 require 'lograge/formatters/json'
 require 'lograge/formatters/graylog2'
@@ -22,7 +23,6 @@ require 'active_support'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 
-# rubocop:disable Metrics/ModuleLength
 module Lograge
   module_function
 
@@ -116,17 +116,46 @@ module Lograge
         unsubscribe(:action_controller, subscriber)
       end
     end
+
+    remove_event_reporter_log_subscriptions
+  end
+
+  # Rails 8.2+ framework log subscribers inherit from
+  # ActiveSupport::EventReporter::LogSubscriber and are subscribed to
+  # ActiveSupport.event_reporter instead of ActiveSupport::Notifications.
+  def remove_event_reporter_log_subscriptions
+    rails_event_reporter_log_subscriber_classes.each do |klass|
+      ActiveSupport.event_reporter.unsubscribe(klass)
+    end
   end
 
+  def rails_event_reporter_log_subscriber_classes
+    return [] unless defined?(ActiveSupport::EventReporter::LogSubscriber)
+
+    [ActionController::LogSubscriber, ActionView::LogSubscriber].select do |klass|
+      klass < ActiveSupport::EventReporter::LogSubscriber
+    end
+  end
+  private_class_method :remove_event_reporter_log_subscriptions, :rails_event_reporter_log_subscriber_classes
+
   def unsubscribe(component, subscriber)
     events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
     events.each do |event|
       Lograge.notification_listeners_for("#{event}.#{component}").each do |listener|
-        ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate') == subscriber
+        ActiveSupport::Notifications.unsubscribe listener if rails_log_subscriber?(listener, subscriber)
       end
     end
   end
 
+  def rails_log_subscriber?(listener, subscriber)
+    delegate = listener.instance_variable_get('@delegate')
+    return true if delegate == subscriber
+
+    # Rails 7.1+ attaches a separate ActionView::LogSubscriber::Start listener
+    # alongside ActionView::LogSubscriber to log the start of template rendering.
+    defined?(ActionView::LogSubscriber::Start) && delegate.is_a?(ActionView::LogSubscriber::Start)
+  end
+
   def setup(app)
     self.application = app
     disable_rack_cache_verbose_output
@@ -241,6 +270,5 @@ module Lograge
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength
 
 require 'lograge/railtie' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Mathias Meyer
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +207,7 @@ files:
 - lib/lograge/formatters/cee.rb
 - lib/lograge/formatters/graylog2.rb
 - lib/lograge/formatters/helpers/method_and_path.rb
+- lib/lograge/formatters/helpers/safe_json.rb
 - lib/lograge/formatters/json.rb
 - lib/lograge/formatters/key_value.rb
 - lib/lograge/formatters/key_value_deep.rb
@@ -218,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.14
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tame Rails' multi-line logging into a single line per request
 test_files: []