gitlab-labkit 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cad3a0a83a80e9fac360086b222165e87138784589c0097c2da798e9f97e10a
-  data.tar.gz: 2b18c29e1fd8f7e90768593957a144498ac80af3bb215f3b0145d77507ff9847
+  metadata.gz: a0cf5e5935ee28f4b6bcc2165d6df81c38006f2b503044563850e744cfb85737
+  data.tar.gz: e5c6137d9430cedfc0984d279d09c9758cdc43e6c25734c91d5b558cf92452e5
 SHA512:
-  metadata.gz: 3578c97ad20f26e43d9fd377a04f06bc4f6cad1b13469dee2a921a15b82230f10d70d9e01665ab930fb1240f6a5629898147cf5426c54f8698640d047afd7b02
-  data.tar.gz: 0fb39ba59dadbc0a1b8be0e2c7f00bf19850b1cb12058410d29ff2977b689b7dd1f25e1da5e65f5ae5543a6fda7f249a37275f1994371c717988d7da92dfae61
+  metadata.gz: 4fab0460afaf9c9912e0225942395669336232f1de591a638e71715ea198cb9cee3f8c5dd462478fc62d1f3ca1741d7d4561983fb5a01cc6760efea2ed2d9374
+  data.tar.gz: ed6778b22816c5e4b301f12b71b28a97d126f4238b896941674a543631a89b7d0624d0c2b2210918f2621f1a9cf8d4c874f3cb0df0c9e67018dbe5d420ba5330

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.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Newdigate