contextual_logger 1.2.0.colin.3 → 1.2.0.colin.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd0747cf5faa06b9907d60198830c374f83f226df121efa9a0b7049315f9132
-  data.tar.gz: 808bbac948431f55a8f4a07532884f3ed310a63652c536512aa5dd435454c6fb
+  metadata.gz: c4b2dc21d1f78b3b6a4a70a782e717eb607ace39fbb085f68fe5c5fee1086e9e
+  data.tar.gz: 17422f6d289ab064d5b212b057870da7c6e283cf24fcf3d419874caf2621b923
 SHA512:
-  metadata.gz: f3607fbfd8f6ddbc8b3b29943fd4787c16509997262b2d3ae309d41471d013da89ef76585d804775721ce1ac9fe75260a9eaf356ffee1cacc9bf2fc65ed4b273
-  data.tar.gz: 3e929c9f55c3bd12a1b65ba3e5135c1e56f5dc87b1597b3a6da9adfcc038f47bd0b8e2a01f9b6d294bfca549d681bef8a9cf67482771e6e4d0aa1db6d86e137b
+  metadata.gz: 15ff319daf3bcd7c4fd6a9c815cdfc394af288749c52c583fb522d571915fb1fe4bc888a9db8ff0040e4d509a37c9027610aa41a3fa59bcec46dfb551045bd81
+  data.tar.gz: 4a7ebd9b1b4f37a950d8cbea6b87ad797264701b87e349246c1bce4edfb0743ed3557c827545665a8c84a37c43c4062aeefced0b76880e558084278093bc26fb

data/lib/contextual_logger/context.rb

@@ -2,17 +2,20 @@
 
 module ContextualLogger
   module Context
-    def thread_context_for_logger_instance
+    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_for_logger_instance ||= "ContextualLogger::Context.context_for_#{object_id}".to_sym
+      @thread_context_key_for_logger_instance ||= "ContextualLogger::Context.context_for_#{object_id}".to_sym
     end
 
     def current_context_override
-      Thread.current[thread_context_for_logger_instance]
+      ContextualLogger.global_context_lock_message ||= "ContextualLogger::Context.current_context_override set for #{self.class.name} #{object_id}"
+      Thread.current[thread_context_key_for_logger_instance]
     end
 
     def current_context_override=(context_override)
-      Thread.current[thread_context_for_logger_instance] = context_override.freeze
+      Thread.current[thread_context_key_for_logger_instance] = context_override.freeze
     end
   end
 end

data/lib/contextual_logger/global_context_lock_message.rb

@@ -0,0 +1,11 @@
+# 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

data/lib/contextual_logger/logger_with_context.rb

@@ -6,6 +6,13 @@ 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
 
@@ -16,11 +23,13 @@ module ContextualLogger
       @logger = logger
       self.level = level
       @context = normalize_context(context)
-      @merged_context_cache = {}  # so we don't have to merge every time
     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
-      @logger.global_context
+      @global_context ||= @logger.current_context.deep_merge(@context) # this will include any with_context overrides on the `logger`
     end
 
     def level
@@ -33,10 +42,10 @@ module ContextualLogger
 
     def write_entry_to_log(severity, timestamp, progname, message, context:)
       merged_context =
-        if @merged_context_cache.size >= 1000 # keep this cache memory use finite
-          @merged_context_cache[context] || @context.deep_merge(context)
+        if context.any?
+          current_context.deep_merge(context)
         else
-          @merged_context_cache[context] ||= @context.deep_merge(context)
+          current_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.3'
+  VERSION = '1.2.0.colin.5'
 end

data/lib/contextual_logger.rb

@@ -6,6 +6,7 @@ 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'
 
 module ContextualLogger
   LOG_LEVEL_NAMES_TO_SEVERITY =
@@ -43,16 +44,23 @@ 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 ||= {}.freeze
+      @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
     end
 
@@ -60,18 +68,22 @@ module ContextualLogger
       current_context_override || global_context
     end
 
-    def with_context(context)
-      previous_context_override = current_context_override
-      self.current_context_override = current_context.deep_merge(context)
+    # 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, self.current_context_override)
+      self.current_context_override = deep_merge_with_current_context(stacked_context)
+
       if block_given?
         begin
           yield
         ensure
-          self.current_context_override = previous_context_override
+          context_handler.reset!
         end
       else
         # If no block given, return context handler to the caller so they can call reset! themselves.
-        ContextHandler.new(self, previous_context_override)
+        context_handler
       end
     end
 
@@ -109,7 +121,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 up to last ** argument
+    def add(arg_severity, arg1 = nil, arg2 = nil, **context)   # Ruby will prefer to match hashes to last argument because of **
       severity = arg_severity || UNKNOWN
       if log_level_enabled?(severity)
         if arg1.nil?
@@ -124,7 +136,7 @@ module ContextualLogger
           message = arg1
           progname = arg2 || @progname
         end
-        write_entry_to_log(severity, Time.now, progname, message, context: current_context.deep_merge(context))
+        write_entry_to_log(severity, Time.now, progname, message, context: deep_merge_with_current_context(context))
       end
 
       true
@@ -148,7 +160,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 }.merge!(context))
+        @formatter.call(severity, timestamp, normalized_progname, { message: normalized_message, **context })
       else
         "#{basic_json_log_entry(severity, timestamp, normalized_progname, normalized_message, context: context)}\n"
       end
@@ -158,12 +170,20 @@ module ContextualLogger
       message_hash = {
         message: normalized_progname ? "#{normalized_progname}: #{normalized_message}" : normalized_message,
         severity:  severity,
-        timestamp: timestamp
+        timestamp: timestamp,
+        **context
       }
       message_hash[:progname] = normalized_progname if normalized_progname
 
-      # merge! is faster and OK here since message_hash is still local only to this method
-      message_hash.merge!(context).to_json
+      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
     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.3
+  version: 1.2.0.colin.5
 platform: ruby
 authors:
 - James Ebentier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -47,6 +47,7 @@ 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/logger_with_context.rb
 - lib/contextual_logger/overrides/active_support/tagged_logging/formatter.rb
 - lib/contextual_logger/redactor.rb