gitlab-labkit 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bbb89ac1275f06d828f9d9fa4a24e20e33f4a01d201956d4dd8d30e87dd8f5a
-  data.tar.gz: 1d6b24a17f8b2096e34303fba306ea1271146b3245cb5edcb3fabbccd26f1e45
+  metadata.gz: 8cad3a0a83a80e9fac360086b222165e87138784589c0097c2da798e9f97e10a
+  data.tar.gz: 2b18c29e1fd8f7e90768593957a144498ac80af3bb215f3b0145d77507ff9847
 SHA512:
-  metadata.gz: 4950f9c1615b432b5d53ab54a51cca84a10cbf548b434665fdda93a2204f912f172540652df7b634907c61fa88f03f50a1ad9de96e04d2795a59393fe3fdcf93
-  data.tar.gz: a67c2262dd119373431f271779baf8311c5eb47a794a2970e1b4b9dcd28c59a4253ff844654f20a99026f95aabe6538f8fbdc864da29f007cd6c94a99eb427ad
+  metadata.gz: 3578c97ad20f26e43d9fd377a04f06bc4f6cad1b13469dee2a921a15b82230f10d70d9e01665ab930fb1240f6a5629898147cf5426c54f8698640d047afd7b02
+  data.tar.gz: 0fb39ba59dadbc0a1b8be0e2c7f00bf19850b1cb12058410d29ff2977b689b7dd1f25e1da5e65f5ae5543a6fda7f249a37275f1994371c717988d7da92dfae61

data/lib/labkit/fields.rb

@@ -5,7 +5,7 @@ module Labkit
   # Fields is intended to be a SSOT for all of the common field names that
   # we emit via any observability we add to our systems.
   #
-  # These fields should span multiple services. This is
+  # These fields should span multiple services.
   #
   # The goal of this package is to reduce the likelihood for typos or
   # subtly different naming conventions. This will help to ensure we
@@ -30,7 +30,6 @@ module Labkit
   module Fields
     # correlation_id - string
     #
-    # correlation_id - string
     # This field is used to correlate
     # the logs emitted by all of our systems.
     # This should be present in all log line
@@ -50,5 +49,53 @@ module Labkit
     # should clearly indicate what the intended use of the
     # field is and should be replicated across the labkit
     # variations.
+
+    # Get the constant name for a field value
+    # @param field_value [String] The field value (e.g., "gl_user_id")
+    # @return [String, nil] The constant name (e.g., "GL_USER_ID") or nil if not found
+    def self.constant_name_for(field_value)
+      constants(false).find do |const_name|
+        next if const_name == :Deprecated
+
+        const_get(const_name) == field_value
+      end&.to_s
+    end
+
+    module Deprecated
+      # This module tracks deprecated field names and maps them to their
+      # standard replacements. These mappings are used by the field scanner
+      # to identify and track usage of deprecated fields in the codebase.
+
+      MAPPINGS = {
+        Fields::GL_USER_ID => %w[user_id userid],
+      }.freeze
+
+      class << self
+        # Get all deprecated fields as a lookup hash
+        #
+        # @return [Hash{String => String}] Hash mapping deprecated field names to standard field names
+        def all
+          @all ||= MAPPINGS.each_with_object({}) do |(key, values), result|
+            values.each { |v| result[v] = key }
+          end
+        end
+
+        # Check if a field is deprecated
+        #
+        # @param field_name [String, Symbol] The field name to check
+        # @return [Boolean] true if the field is deprecated
+        def deprecated?(field_name)
+          all.key?(field_name.to_s)
+        end
+
+        # Get the standard field for a deprecated field
+        #
+        # @param deprecated_field [String, Symbol] The deprecated field name
+        # @return [String, nil] The standard field name, or nil if not found
+        def standard_field_for(deprecated_field)
+          all[deprecated_field.to_s]
+        end
+      end
+    end
   end
 end

metadata

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