gitlab-labkit 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c872947164d25ef7f75203c6195fe04bbc8c9002639d59fadf10672d47201862
-  data.tar.gz: d0308016fd538669e466d2e499aa283d47e82bb4d53bd530c07bce74162b16b4
+  metadata.gz: 809ee7b1894b9ff60755556cb95f69d9dca501297077e5eb1ddadac9d5d2b492
+  data.tar.gz: 48d5598c40eefcd144ed435f0e0fafa7a2e1dffa305830e6f7bf1a4ce5e71d1e
 SHA512:
-  metadata.gz: e6cb4000c77a3ebe764b61e0d536db95dbe3c79378a1d95744747e7eff2509cb435561eba2963ae83107eea37364f5515e3a64bd9491c799c2b9508c9293c793
-  data.tar.gz: 64cc36f40cb6140b09fc54d873a102098a7fe05b2e967960317c782dc53b224c513fe676e6435dae48b6b0fc33e9e95dd8f32f10230900dea809bbef8bdd03e0
+  metadata.gz: 7081e60adc3b7d3929b83949710758c6af3ed04dca87337006637d7c4a1f90e6261c817bf0eae1a2ca5644763b25ee9896f06ff440670fadd1e675a64effec29
+  data.tar.gz: eb903367e7296978188ca66f9affb82a543ee9342938934f8ea817f49bb7a843920e570279d03d727ae68d2cb8f73d3627b3c62715d806bac2c2f337a668e965

data/.gitlab-ci.yml

@@ -19,13 +19,13 @@ include:
   # It includes standard checks, gitlab-scanners, validations and release processes
   # common to all projects using this template library.
   # see https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/templates/standard.md
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/standard-build@v4.22
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/standard-build@v4.36
 
   # Runs rspec tests and rubocop on the project
   # see https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/templates/ruby.md
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/ruby-build@v4.22
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/ruby-build@v4.36
 
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/danger@v4.22
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/danger@v4.36
 
 # Attach a redis service to the rspec job from common-ci-tasks/ruby-build.
 # GitLab merges keys when a local job has the same name as an included one,

data/.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
   # Documentation available at
   # https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/docs/pre-commit.md
   - repo: https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks
-    rev: v4.22  # renovate:managed
+    rev: v4.36  # renovate:managed
 
     hooks:
       - id: shellcheck  # Run shellcheck for changed Shell files

data/lib/labkit/fields.rb

@@ -192,7 +192,7 @@ module Labkit
 
       MAPPINGS = {
         Fields::CORRELATION_ID => %w[tags.correlation_id],
-        Fields::GL_USER_ID => %w[user_id userid extra.user_id extra.current_user_id meta.user_id],
+        Fields::GL_USER_ID => %w[user_id userid extra.user_id extra.current_user_id meta.user_id gitlab_user_id],
         Fields::GL_USER_NAME => %w[username extra.user meta.user],
         Fields::ERROR_MESSAGE => %w[error err error.message exception.message graphql_errors],
         Fields::HTTP_STATUS_CODE => %w[status_code extra.status status_text http_status],

data/lib/labkit/rate_limit/identifier.rb

@@ -6,6 +6,9 @@ module Labkit
     # describe the caller (e.g. user, ip, endpoint).
     # Endpoint values are normalised at construction time (query string stripped).
     class Identifier
+      InvalidKeyError = Class.new(ArgumentError)
+      DuplicateNormalizedKeyError = Class.new(InvalidKeyError)
+
       # Normalize an endpoint value: strip query string.
       def self.normalize_endpoint(value)
         return value unless value.is_a?(String)
@@ -16,7 +19,29 @@ module Labkit
       attr_reader :attributes
 
       def initialize(attributes = {})
-        normalised = attributes.transform_keys(&:to_sym)
+        normalised = {}
+        original_keys = {}
+
+        attributes.each do |key, value|
+          unless key.respond_to?(:to_sym)
+            # Reject keys such as nil, 42, and [] instead of leaking NoMethodError;
+            # identifiers must have a canonical symbol key for matching and serialization.
+            raise InvalidKeyError, "Identifier key #{key.inspect} must respond to #to_sym"
+          end
+
+          normalised_key = key.to_sym
+          if normalised.key?(normalised_key)
+            # Reject { user: 1, "user" => 2 } (and its reverse order): silently
+            # choosing a value would make the rate-limit bucket insertion-order dependent.
+            raise DuplicateNormalizedKeyError,
+              "Identifier keys normalize to the same key #{normalised_key.inspect}: " \
+                "#{original_keys[normalised_key].inspect} and #{key.inspect}"
+          end
+
+          original_keys[normalised_key] = key
+          normalised[normalised_key] = value
+        end
+
         normalised[:endpoint] = self.class.normalize_endpoint(normalised[:endpoint]) if normalised.key?(:endpoint)
         @attributes = normalised.freeze
       end

metadata

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