lograge 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61fb6a597eb84cb10c97a1155d5dc983811c159fecdc00625db65fb46b3cf693
-  data.tar.gz: da3bfa1e8eaa35ad80caa7c743f826e7560fc8961c19f5fe342cde8fb0a830cf
+  metadata.gz: 7417503c9af3927cc3291f8030b9cc506d42d8756538dc656218d5a2249f977d
+  data.tar.gz: a09ba47fcf99837649481b588b7eb1d90714a7ef3e454d18e09b1b3d894bbfb4
 SHA512:
-  metadata.gz: 6fe3ff2a303961c236c2407edfd585ffcffe2c5026453d497a95d731a81769e92e5814fcfbaa5c4d2e442b2b8112d597874ca4c64f9045ec8c0415acc223db60
-  data.tar.gz: 537eae531458214b65cc3776e959a6c592bfcef17803421335d52b63b021172c62bf1f2da2b9218a4b47f1a2a00dca3945a3b3e5e7fd324744aa7be6427aaeee
+  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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lograge
-  VERSION = '0.15.1'
+  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'
@@ -115,7 +116,27 @@ 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' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Mathias Meyer
@@ -207,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
@@ -246,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: []