gitlab-labkit 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43d394fdecdc0275e1ddab3a28ae7824f907e21637c4d06b3cc183a801df9377
-  data.tar.gz: 18632e75c51ec22c6b78079c59476f736b3b3b298c7988fbf4a49c9505c4d05e
+  metadata.gz: 88d5f5a7cd756153b8c69edbf0a887b0d7fbd98c0eab2828c3150cc2fafa1fac
+  data.tar.gz: 0bf07e6f00b14c3a31ba3dab3b3bbd7cd72af81b61dd66992e9d9ef6bd73d6da
 SHA512:
-  metadata.gz: d56453b6af992b51da987bec68fd990fefc808b68be96702c3b4274ae609a773139b39bb5609032ed9148a7427976bd64ea0566fa0c8354582e4d4d4135d481e
-  data.tar.gz: f8d71107b36351983b8a1da70b9a43624b2eb73e000b37fd45cad03606749c84a2da0282d1e02cd7f5a1b687e2e030717fc1770f2671d05175a7cd4d9eb9bad1
+  metadata.gz: 737e6ee6b0fc00f716cf3aba4f94bd02c65c01dc5436ca8a4b99ce64ce092efe8bd39af8fe7d6d68ce5e8c2dcd1ba7c991d49b4c0c742c17a4e4ea1d48e50f1b
+  data.tar.gz: 17db3fe540d65f81193adfc8f86d9e984761b76b17f639bad7cd73df46206035690b1c3466bc8d54c26b7c7a3f043c6158edb657137c67b9318098b0eae61f48

data/doc/FIELD_STANDARDIZATION.md

@@ -18,7 +18,8 @@ For the architectural decision and rationale, see
 
 Offense
 : A unique combination of file path, deprecated field, and logger class.
-  Multiple log calls in the same file using the same deprecated field count as
+  Multiple log calls in the same file using the same deprecated field or multiple
+  log calls originating from the application context count as
   one offense.
   An offense exists until the deprecated field is entirely removed from the
   file.

data/lib/labkit/logging/field_validator/log_interceptor.rb

@@ -15,6 +15,15 @@ module Labkit
           %r{/.*logger\.rb$}
         ].freeze
 
+        DEFAULT_CONTEXT_CALLSITE = "Labkit::Context"
+
+        # Placeholder logger_class used when an offense originates from the Labkit
+        # context. The same context fields appear in every logger that runs within
+        # the context, so collapsing across loggers prevents one offense per
+        # logger x deprecated_field combination, and prevents new offenses being
+        # raised whenever a developer adds a new logger class.
+        ANY_LOGGER = "*"
+
         class << self
           def register_wrapper_pattern(pattern)
             wrapper_patterns << pattern
@@ -33,6 +42,31 @@ module Labkit
           def combined_ignore_pattern
             @combined_ignore_pattern ||= Regexp.union(IGNORE_PATHS + wrapper_patterns)
           end
+
+          # The callsite name used for offenses originating from the Labkit context
+          # (e.g. ApplicationContext) rather than from the log caller directly.
+          # Override this in your application to point to the actual context provider file:
+          #   Labkit::Logging::FieldValidator::LogInterceptor.context_callsite =
+          #     "lib/gitlab/application_context.rb"
+          def context_callsite
+            @context_callsite || DEFAULT_CONTEXT_CALLSITE
+          end
+
+          attr_writer :context_callsite
+
+          def reset_context_callsite!
+            @context_callsite = nil
+          end
+
+          # The context prefix that Labkit::Context applies to every field it
+          # stores (see Labkit::Context::LOG_KEY). Any deprecated field with
+          # this prefix is by convention a context field, owned by whichever
+          # provider populates the context (e.g. ApplicationContext), even
+          # when a particular log call happens to pass it directly. Lazily
+          # built so the constant is not referenced at load time.
+          def context_field_prefix
+            @context_field_prefix ||= "#{::Labkit::Context::LOG_KEY}."
+          end
         end
 
         def format_data(severity, timestamp, progname, message)
@@ -46,6 +80,13 @@ module Labkit
 
           logger_class = self.class.name || 'AnonymousLogger'
 
+          # Keys the caller explicitly passed in the log message. Any deprecated field
+          # present in `data` but absent here arrived via Labkit::Context (e.g.
+          # ApplicationContext) and should be attributed to the context callsite rather
+          # than the individual log call site.
+          direct_keys = message.is_a?(Hash) ? message.transform_keys(&:to_s).keys.to_set : Set.new
+          context_prefix = LogInterceptor.context_field_prefix
+
           deprecated_lookup = Labkit::Fields::Deprecated.all
           if data.is_a?(Hash)
             data.each_key do |key|
@@ -53,11 +94,19 @@ module Labkit
               standard_field = deprecated_lookup[key_str]
               next unless standard_field
 
-              Registry.instance.record_offense(callsite_path, location.lineno, key_str, standard_field, logger_class)
+              # context_prefix is the Labkit::Context namespace. The field is conceptually
+              # context-owned even if the caller happens to pass it directly. Otherwise
+              # use direct-vs-context based on whether the caller actually included it.
+              if direct_keys.include?(key_str) && !key_str.start_with?(context_prefix)
+                Registry.instance.record_offense(callsite_path, location.lineno, key_str, standard_field, logger_class)
+              else
+                Registry.instance.record_offense(LogInterceptor.context_callsite, 0, key_str, standard_field, ANY_LOGGER)
+              end
             end
           end
 
           Registry.instance.check_for_removed_offenses(callsite_path, data, logger_class)
+          Registry.instance.check_for_removed_offenses(LogInterceptor.context_callsite, data, ANY_LOGGER)
 
           data
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Andrew Newdigate