gitlab-labkit 1.1.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bbb89ac1275f06d828f9d9fa4a24e20e33f4a01d201956d4dd8d30e87dd8f5a
-  data.tar.gz: 1d6b24a17f8b2096e34303fba306ea1271146b3245cb5edcb3fabbccd26f1e45
+  metadata.gz: a0cf5e5935ee28f4b6bcc2165d6df81c38006f2b503044563850e744cfb85737
+  data.tar.gz: e5c6137d9430cedfc0984d279d09c9758cdc43e6c25734c91d5b558cf92452e5
 SHA512:
-  metadata.gz: 4950f9c1615b432b5d53ab54a51cca84a10cbf548b434665fdda93a2204f912f172540652df7b634907c61fa88f03f50a1ad9de96e04d2795a59393fe3fdcf93
-  data.tar.gz: a67c2262dd119373431f271779baf8311c5eb47a794a2970e1b4b9dcd28c59a4253ff844654f20a99026f95aabe6538f8fbdc864da29f007cd6c94a99eb427ad
+  metadata.gz: 4fab0460afaf9c9912e0225942395669336232f1de591a638e71715ea198cb9cee3f8c5dd462478fc62d1f3ca1741d7d4561983fb5a01cc6760efea2ed2d9374
+  data.tar.gz: ed6778b22816c5e4b301f12b71b28a97d126f4238b896941674a543631a89b7d0624d0c2b2210918f2621f1a9cf8d4c874f3cb0df0c9e67018dbe5d420ba5330

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

data/lib/labkit/json_schema/ref_resolver.rb

@@ -3,6 +3,7 @@
 require 'net/http'
 require 'uri'
 require 'json'
+require 'active_support/core_ext/module/attribute_accessors'
 
 module Labkit
   module JsonSchema

data/lib/labkit/user_experience_sli/README.md

@@ -50,6 +50,33 @@ This configuration is useful when:
 
 **Note:** The timeout applies to both connection opening and reading operations when fetching remote JSON schema references.
 
+### Feature Category Schema Preloading
+
+When validating user experience SLI definitions, the system validates the `feature_category` field against a remote up to date JSON schema (cached after first request) by default. To avoid HTTP requests at runtime, you can preload the feature category schema from a local file:
+
+```ruby
+Labkit::UserExperienceSli.configure do |config|
+  config.feature_category_schema_path = Rails.root.join('config/feature_categories/schema.json').to_s
+end
+```
+
+JSON schema example:
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": ["source_code_management", "team_planning", "observability"]
+}
+```
+
+The current single source of truth can be found in https://gitlab.com/gitlab-org/gitlab/-/raw/master/config/feature_categories/schema.json.
+
+
+This configuration is useful when:
+- Running in environments without external network access
+- Ensuring consistent validation against a known schema version
+
 ### User Experience Definitions
 
 User Experience SLI definitions will be lazy loaded from the default directory (`config/user_experience_slis`).

data/lib/labkit/user_experience_sli.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require 'labkit/json_schema/ref_resolver'
+require 'labkit/logging/json_logger'
 require 'labkit/user_experience_sli/current'
 require 'labkit/user_experience_sli/error'
 require 'labkit/user_experience_sli/experience'
 require 'labkit/user_experience_sli/null'
 require 'labkit/user_experience_sli/registry'
-require 'labkit/logging/json_logger'
 
 module Labkit
   # Labkit::UserExperienceSli namespace module.
@@ -23,6 +24,33 @@ module Labkit
         @registry_path = File.join("config", "user_experience_slis")
         @ref_resolver_timeout = 2
       end
+
+      def feature_category_schema_path=(path)
+        preload_feature_category_schema(path) if path
+      end
+
+      private
+
+      def preload_feature_category_schema(path)
+        internal_schema = JSON.parse(File.read(Registry::SCHEMA_PATH))
+        ref_url = internal_schema.dig("properties", "feature_category", "$ref")
+        return unless ref_url
+
+        schema = parse_schema_json(read_schema_file(path), path)
+        Labkit::JsonSchema::RefResolver.cache[ref_url] = schema
+      end
+
+      def read_schema_file(path)
+        File.read(path)
+      rescue StandardError => e
+        raise(UserExperienceError, "Failed to read feature category schema file at '#{path}': #{e.message}")
+      end
+
+      def parse_schema_json(content, path)
+        JSON.parse(content)
+      rescue JSON::ParserError => e
+        raise(UserExperienceError, "Failed to parse feature category schema JSON at '#{path}': #{e.message}")
+      end
     end
 
     class << self

metadata

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