contextual_logger 1.2.0.colin.6 → 1.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e69ef52ab71f4f66d8f0d933f9ac6e74b5f2d8c218cd7b5865086f1ae00a6ff
-  data.tar.gz: e7245b4c4074d6f112730ed3b89b681b21a12042b96d03e751329f1a8f302363
+  metadata.gz: d5ee8cad9d62ca2d8aeec81f2626b56b4aa6b1db2c6b626518a4708d590ddb4c
+  data.tar.gz: 71be08f271be68de04f942abfa301a2a5ec54be54d0399bb01db8bcf52a07037
 SHA512:
-  metadata.gz: 7ced2de731f75eef24afa7d327c0947299202a92f904df2a424af43c3520de8cfdcc8b21d1967a198f17cb6510fe3406449e969077f9bcb0b8b173dfe94d6a52
-  data.tar.gz: 36e6d8e0e7c44e9444bd8907700b3072aa4f8f3767c2b7937dc5d59a747acfeb33c1943a8a4ed65a68ba5851ca16c5164daf948d2390b6bec19472721cefb21c
+  metadata.gz: 2b455d41a46223ea9c6e2583a7d03d81940743215c4eb1dd5977d6ffc8f8ffcb618ce27a3b975fed211987b592e0cfdbc1e691ceef155641764c5d8938da0679
+  data.tar.gz: 6600b357b1dc7b25ee8e746f17280a7e74ac184b38a03340f48e835659259135321a0c0ff0d7c387a7b06b9804b82ad63f8b76a911790a6fb5c2f99a61c0cfdc

data/lib/contextual_logger/context/handler.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  module Context
+    class Handler
+      THREAD_CONTEXT_NAMESPACE = 'ContextualLoggerCurrentLoggingContext'
+
+      attr_reader :previous_context, :context
+
+      def self.current_context
+        Thread.current[THREAD_CONTEXT_NAMESPACE] || {}
+      end
+
+      def initialize(context, previous_context: nil)
+        @previous_context = previous_context || self.class.current_context
+        @context = context
+      end
+
+      def set!
+        Thread.current[THREAD_CONTEXT_NAMESPACE] = context
+      end
+
+      def reset!
+        Thread.current[THREAD_CONTEXT_NAMESPACE] = previous_context
+      end
+    end
+  end
+end

data/lib/contextual_logger/logger_with_context.rb

@@ -6,13 +6,6 @@ module ContextualLogger
   # A logger that deep_merges additional context and then delegates to the given logger.
   # Keeps it own log level (called override_level) that may be set independently of the logger it delegates to.
   # If override_level is non-nil, it takes precedence; if it is nil (the default), then it delegates to the logger.
-  #
-  # Context Precedence:
-  # 1. inline **context passed to the logger method
-  # 2. `with_context` overrides on this LoggerWithContext object
-  # 3. context passed to this LoggerWithContext constructor
-  # 4. `with_context` overrides on the logger passed to this constructor
-  # 5. `global_context` set on the logger passed to this constructor
   class LoggerWithContext
     include LoggerMixin
 
@@ -23,13 +16,7 @@ module ContextualLogger
       @logger = logger
       self.level = level
       @context = normalize_context(context)
-    end
-
-    # TODO: It's a (small) bug that the global_context is memoized at this point. There's a chance that the @logger.current_context
-    # changes after this because of an enclosing @logger.with_context block. If that happens, we'll miss that extra context.
-    # The tradeoff is that we don't want to keep calling deep_merge.
-    def global_context
-      @global_context ||= @logger.current_context.deep_merge(@context) # this will include any with_context overrides on the `logger`
+      @merged_context_cache = {}  # so we don't have to merge every time
     end
 
     def level
@@ -42,10 +29,10 @@ module ContextualLogger
 
     def write_entry_to_log(severity, timestamp, progname, message, context:)
       merged_context =
-        if context.any?
-          current_context.deep_merge(context)
+        if @merged_context_cache.size >= 1000 # keep this cache memory use finite
+          @merged_context_cache[context] || @context.deep_merge(context)
         else
-          current_context
+          @merged_context_cache[context] ||= @context.deep_merge(context)
         end
 
       @logger.write_entry_to_log(severity, timestamp, progname, message, context: merged_context)

data/lib/contextual_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextualLogger
-  VERSION = '1.2.0.colin.6'
+  VERSION = '1.2.0.pre.1'
 end

data/lib/contextual_logger.rb

@@ -4,9 +4,7 @@ require 'active_support'
 require 'active_support/core_ext/module/delegation'
 require 'json'
 require_relative './contextual_logger/redactor'
-require_relative './contextual_logger/context'
-require_relative './contextual_logger/context_handler'
-require_relative './contextual_logger/global_context_lock_message'
+require_relative './contextual_logger/context/handler'
 
 module ContextualLogger
   LOG_LEVEL_NAMES_TO_SEVERITY =
@@ -44,37 +42,16 @@ module ContextualLogger
     end
   end
 
-  # Context Precedence when this is mixed into a logger:
-  # 1. inline **context passed to the logger method
-  # 2. `with_context` overrides on the logger object
-  # 3. `global_context` set on the logger passed to this constructor
   module LoggerMixin
-    include Context
-
     delegate :register_secret, :register_secret_regex, to: :redactor
 
-    def global_context
-      @global_context ||= Context::EMPTY_CONTEXT
-    end
-
     def global_context=(context)
-      if (global_context_lock_message = ::ContextualLogger.global_context_lock_message)
-        raise ::ContextualLogger::GlobalContextIsLocked, global_context_lock_message
-      end
-      @global_context = context.freeze
+      Context::Handler.new(context).set!
     end
 
-    def current_context
-      current_context_override || global_context
-    end
-
-    # TODO: Deprecate current_context_for_thread in v2.0.
-    alias current_context_for_thread current_context
-
-    def with_context(stacked_context)
-      context_handler = ContextHandler.new(self, current_context_override)
-      self.current_context_override = deep_merge_with_current_context(stacked_context)
-
+    def with_context(context)
+      context_handler = Context::Handler.new(current_context_for_thread.deep_merge(context))
+      context_handler.set!
       if block_given?
         begin
           yield
@@ -82,11 +59,15 @@ module ContextualLogger
           context_handler.reset!
         end
       else
-        # If no block given, return context handler to the caller so they can call reset! themselves.
+        # If no block given, the context handler is returned to the caller so they can handle reset! themselves.
         context_handler
       end
     end
 
+    def current_context_for_thread
+      Context::Handler.current_context
+    end
+
     # In the methods generated below, we assume that presence of context means new code that is
     # aware of ContextualLogger...and that that code never uses progname.
     # This is important because we only get 3 args total (not including &block) passed to `add`,
@@ -121,7 +102,7 @@ module ContextualLogger
 
     # Note that this interface needs to stay compatible with the underlying ::Logger#add interface,
     # which is: def add(severity, message = nil, progname = nil)
-    def add(arg_severity, arg1 = nil, arg2 = nil, **context)   # Ruby will prefer to match hashes to last argument because of **
+    def add(arg_severity, arg1 = nil, arg2 = nil, **context)   # Ruby will prefer to match hashes up to last ** argument
       severity = arg_severity || UNKNOWN
       if log_level_enabled?(severity)
         if arg1.nil?
@@ -136,7 +117,7 @@ module ContextualLogger
           message = arg1
           progname = arg2 || @progname
         end
-        write_entry_to_log(severity, Time.now, progname, message, context: deep_merge_with_current_context(context))
+        write_entry_to_log(severity, Time.now, progname, message, context: current_context_for_thread.deep_merge(context))
       end
 
       true
@@ -160,7 +141,7 @@ module ContextualLogger
       normalized_message = ContextualLogger.normalize_message(message)
       normalized_progname = ContextualLogger.normalize_message(progname) unless progname.nil?
       if @formatter
-        @formatter.call(severity, timestamp, normalized_progname, { message: normalized_message, **context })
+        @formatter.call(severity, timestamp, normalized_progname, { message: normalized_message }.merge!(context))
       else
         "#{basic_json_log_entry(severity, timestamp, normalized_progname, normalized_message, context: context)}\n"
       end
@@ -170,20 +151,12 @@ module ContextualLogger
       message_hash = {
         message: normalized_progname ? "#{normalized_progname}: #{normalized_message}" : normalized_message,
         severity:  severity,
-        timestamp: timestamp,
-        **context
+        timestamp: timestamp
       }
       message_hash[:progname] = normalized_progname if normalized_progname
 
-      message_hash.to_json
-    end
-
-    def deep_merge_with_current_context(stacked_context)
-      if stacked_context.any?
-        current_context.deep_merge(stacked_context)
-      else
-        current_context
-      end
+      # merge! is faster and OK here since message_hash is still local only to this method
+      message_hash.merge!(context).to_json
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contextual_logger
 version: !ruby/object:Gem::Version
-  version: 1.2.0.colin.6
+  version: 1.2.0.pre.1
 platform: ruby
 authors:
 - James Ebentier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,9 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/contextual_logger.rb
-- lib/contextual_logger/context.rb
-- lib/contextual_logger/context_handler.rb
-- lib/contextual_logger/global_context_lock_message.rb
+- lib/contextual_logger/context/handler.rb
 - lib/contextual_logger/logger_with_context.rb
 - lib/contextual_logger/overrides/active_support/tagged_logging/formatter.rb
 - lib/contextual_logger/redactor.rb

data/lib/contextual_logger/context.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module ContextualLogger
-  module Context
-    EMPTY_CONTEXT = {}.freeze
-
-    def thread_context_key_for_logger_instance
-      # We include the object_id here to make these thread/fiber locals unique per logger instance.
-      @thread_context_key_for_logger_instance ||= "ContextualLogger::Context.context_for_#{object_id}".to_sym
-    end
-
-    def current_context_override
-      Thread.current[thread_context_key_for_logger_instance]
-    end
-
-    def current_context_override=(context_override)
-      ContextualLogger.global_context_lock_message ||= "ContextualLogger::Context.current_context_override set for #{self.class.name} #{object_id}: #{context_override.inspect}"
-      Thread.current[thread_context_key_for_logger_instance] = context_override.freeze
-    end
-  end
-end

data/lib/contextual_logger/context_handler.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ContextualLogger
-  class ContextHandler
-    def initialize(instance, previous_context_override)
-      @instance = instance
-      @previous_context_override = previous_context_override
-    end
-
-    def reset!
-      @instance.current_context_override = @previous_context_override
-    end
-  end
-end

data/lib/contextual_logger/global_context_lock_message.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module ContextualLogger
-  class << self
-    attr_accessor :global_context_lock_message # nil or a string indicating what locked the global context
-  end
-
-  class GlobalContextIsLocked < StandardError
-  end
-end