lumberjack 1.2.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10f2db93994b2941a8684c4fd933f07fc2d0067afdcfa3798f4ba3b5cc34b354
-  data.tar.gz: e6413b5b475b1c05ffcc17662e4f553af8e6d47d79e961a5802d0d875a413f9e
+  metadata.gz: afea02bfb6a11fe77b13b77958097461cc546672f0059cf4a9e5cbb81445a97d
+  data.tar.gz: d94096a3de319ebce142ca5264b15f62f067dd5dfeaf2a1184a886dfc6a16b80
 SHA512:
-  metadata.gz: 809fc20f5cb8cc7d704f5a5e6878f321285953c8c79139fbd9892fa6c954b645b6bdcc0ce0e0265e18b29974fd864a96fdd735a424f57bd1224653759b139fd8
-  data.tar.gz: c7cf6e570fe6a1cbba068905ad860c26ad375b5f413d449c8f77f84c4ad81b139585ef2917aa2328dac2b80e0a3f962895a5efb8c5b988a14605e59ccf6eafbc
+  metadata.gz: '09250cd1360e5b0a2fcddc4f37504020adfcdcae809edf853c9580f34b1c63a0a834fe4fccb26b6b60b1a03eca2c736deaeeedd6ef5c59ed889be2eeff4ac65e'
+  data.tar.gz: 0e9c83f1df927ec79d906aaaecfd0a5326217f71b23e537cd4a75232a3a7c0c1f38aee6517ceb3baac09337eeb8fdd72737cfeb31d52c000775e46e8f13c4231

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 1.2.5
+
+* Fix logic with recursive reference guard in StructuredFormatter so it only suppresses Enumerable references.
+* Add support for bang methods (error!) for setting the log level.
+
+## 1.2.4
+
+* Enhance ActiveSupport::TaggedLogging support so code that Lumberjack loggers can be wrapped with a tagged logger.
+
+## 1.2.3
+
+* Fix structured formatter so no-recursive, duplicate references are allowed.
+
+## 1.2.2
+
+* Prevent infinite loops in the structured formatter where objects have backreferences to each other.
+
+## 1.2.1
+
+* Prevent infinite loops where logging a statement triggers the logger.
+
 ## 1.2.0
 
 * Enable compatibility with ActiveSupport::TaggedLogger by calling `tagged_logger!` on a logger.

data/README.md

@@ -85,13 +85,13 @@ logger.info("no requests") # Will not include the `request_id` tag
 
 Tag keys are always converted to strings. Tags are inherited so that message tags take precedence over block tags which take precedence over global tags.
 
-#### Compatibility with ActiveSupport::TaggedLogger
+#### Compatibility with ActiveSupport::TaggedLogging
 
-`Lumberjack::Logger` version 1.1.2 or greater is compatible with `ActiveSupport::TaggedLogger`. This is so that other code that expect to have a logger that responds to the `tagged` method will work. Any tags added with the `tagged` method will be appended to an array in the the "tagged" tag. However, if a tagged value has a colon or equals sign in it, it will be parsed to a name value pair.
+`Lumberjack::Logger` version 1.1.2 or greater is compatible with `ActiveSupport::TaggedLogging`. This is so that other code that expect to have a logger that responds to the `tagged` method will work. Any tags added with the `tagged` method will be appended to an array in the the "tagged" tag.
 
 ```ruby
-logger.tagged("foo", "bar=1", "baz:2", "other") do
-  logger.info("here") # will include tags: {"tagged" => ["foo", "other"], "bar" => "1", "baz" => "2"}
+logger.tagged("foo", "bar=1", "other") do
+  logger.info("here") # will include tags: {"tagged" => ["foo", "bar=1", "other"]}
 end
 ```
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.2.5

data/lib/lumberjack.rb

@@ -19,6 +19,7 @@ module Lumberjack
   require_relative "lumberjack/tags.rb"
   require_relative "lumberjack/tag_formatter.rb"
   require_relative "lumberjack/tagged_logger_support.rb"
+  require_relative "lumberjack/tagged_logging.rb"
   require_relative "lumberjack/template.rb"
   require_relative "lumberjack/rack.rb"
 

data/lib/lumberjack/formatter/structured_formatter.rb

@@ -6,26 +6,58 @@ module Lumberjack
   class Formatter
     # Dereference arrays and hashes and recursively call formatters on each element.
     class StructuredFormatter
+      class RecusiveReferenceError < StandardError
+      end
+
       def initialize(formatter = nil)
         @formatter = formatter
       end
 
       def call(obj)
+        call_with_references(obj, Set.new)
+      end
+
+      private
+
+      def call_with_references(obj, references)
         if obj.is_a?(Hash)
-          hash = {}
-          references ||= Set.new
-          obj.each do |name, value|
-            hash[name.to_s] = call(value)
+          with_object_reference(obj, references) do
+            hash = {}
+            obj.each do |name, value|
+              value = call_with_references(value, references)
+              hash[name.to_s] = value unless value.is_a?(RecusiveReferenceError)
+            end
+            hash
           end
-          hash
         elsif obj.is_a?(Enumerable) && obj.respond_to?(:size) && obj.size != Float::INFINITY
-          obj.collect { |element| call(element) }
+          with_object_reference(obj, references) do
+            array = []
+            obj.each do |value|
+              value = call_with_references(value, references)
+              array << value unless value.is_a?(RecusiveReferenceError)
+            end
+            array
+          end
         elsif @formatter
           @formatter.format(obj)
         else
           obj
         end
       end
+
+      def with_object_reference(obj, references)
+        if obj.is_a?(Enumerable)
+          return RecusiveReferenceError.new if references.include?(obj.object_id)
+          references << obj.object_id
+          begin
+            yield
+          ensure
+            references.delete(obj.object_id)
+          end
+        else
+          yield
+        end
+      end
     end
   end
 end

data/lib/lumberjack/logger.rb

@@ -156,32 +156,37 @@ module Lumberjack
     #   logger.add_entry(:warn, "Request took a long time")
     #   logger.add_entry(Logger::DEBUG){"Start processing with options #{options.inspect}"}
     def add_entry(severity, message, progname = nil, tags = nil)
-      severity = Severity.label_to_level(severity) unless severity.is_a?(Integer)
-
-      return true unless device && severity && severity >= level
-
-      time = Time.now
-      message = message.call if message.is_a?(Proc)
-      message = formatter.format(message)
-      progname ||= self.progname
-
-      current_tags = self.tags
-      tags = nil unless tags.is_a?(Hash)
-      if current_tags.empty?
-        tags = Tags.stringify_keys(tags) unless tags.nil?
-      else
-        if tags.nil?
-          tags = current_tags.dup
+      begin        
+        severity = Severity.label_to_level(severity) unless severity.is_a?(Integer)
+        return true unless device && severity && severity >= level
+        
+        return true if Thread.current[:lumberjack_logging]
+        Thread.current[:lumberjack_logging] = true
+
+        time = Time.now
+        message = message.call if message.is_a?(Proc)
+        message = formatter.format(message)
+        progname ||= self.progname
+
+        current_tags = self.tags
+        tags = nil unless tags.is_a?(Hash)
+        if current_tags.empty?
+          tags = Tags.stringify_keys(tags) unless tags.nil?
         else
-          tags = current_tags.merge(Tags.stringify_keys(tags))
+          if tags.nil?
+            tags = current_tags.dup
+          else
+            tags = current_tags.merge(Tags.stringify_keys(tags))
+          end
         end
-      end
-      tags = Tags.expand_runtime_values(tags)
-      tags = tag_formatter.format(tags) if tag_formatter
-
-      entry = LogEntry.new(time, severity, message, progname, $$, tags)
-      write_to_device(entry)
+        tags = Tags.expand_runtime_values(tags)
+        tags = tag_formatter.format(tags) if tag_formatter
 
+        entry = LogEntry.new(time, severity, message, progname, $$, tags)
+        write_to_device(entry)
+      ensure
+        Thread.current[:lumberjack_logging] = nil
+      end
       true
     end
 
@@ -232,6 +237,11 @@ module Lumberjack
     def fatal?
       level <= FATAL
     end
+    
+    # Set the log level to fatal.
+    def fatal!
+      self.level = FATAL
+    end
 
     # Log an +ERROR+ message. The message can be passed in either the +message+ argument or in a block.
     def error(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
@@ -242,6 +252,11 @@ module Lumberjack
     def error?
       level <= ERROR
     end
+    
+    # Set the log level to error.
+    def error!
+      self.level = ERROR
+    end
 
     # Log a +WARN+ message. The message can be passed in either the +message+ argument or in a block.
     def warn(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
@@ -252,6 +267,11 @@ module Lumberjack
     def warn?
       level <= WARN
     end
+    
+    # Set the log level to warn.
+    def warn!
+      self.level = WARN
+    end
 
     # Log an +INFO+ message. The message can be passed in either the +message+ argument or in a block.
     def info(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
@@ -262,6 +282,11 @@ module Lumberjack
     def info?
       level <= INFO
     end
+    
+    # Set the log level to info.
+    def info!
+      self.level = INFO
+    end
 
     # Log a +DEBUG+ message. The message can be passed in either the +message+ argument or in a block.
     def debug(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
@@ -272,6 +297,11 @@ module Lumberjack
     def debug?
       level <= DEBUG
     end
+    
+    # Set the log level to debug.
+    def debug!
+      self.level = DEBUG
+    end
 
     # Log a message when the severity is not known. Unknown messages will always appear in the log.
     # The message can be passed in either the +message+ argument or in a block.

data/lib/lumberjack/tagged_logging.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lumberjack
+  # Monkey patch for ActiveSupport::TaggedLogger so it doesn't blow up when
+  # a Lumberjack logger is trying to be wrapped. This module will be automatically
+  # included in ActiveSupport::TaggedLogger if activesupport is already loaded.
+  module TaggedLogging
+    class << self
+      def included(base)
+        base.singleton_class.send(:prepend, ClassMethods)
+      end
+    end
+    
+    module ClassMethods
+      def new(logger)
+        if logger.is_a?(Lumberjack::Logger)
+          logger = logger.tagged_logger! unless logger.respond_to?(:tagged)
+          logger
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+if defined?(ActiveSupport::TaggedLogging)
+  ActiveSupport::TaggedLogging.include(Lumberjack::TaggedLogging)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.5
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -106,6 +106,7 @@ files:
 - lib/lumberjack/severity.rb
 - lib/lumberjack/tag_formatter.rb
 - lib/lumberjack/tagged_logger_support.rb
+- lib/lumberjack/tagged_logging.rb
 - lib/lumberjack/tags.rb
 - lib/lumberjack/template.rb
 - lumberjack.gemspec