gitlab-labkit 0.31.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461e2ae3317fcc57f55038742d5e29f45c1b743cf91eb55655f67d35a82e7cc3
-  data.tar.gz: f5793900cd880f16037355f77523062155edd7f49d346be76300340a2952f06f
+  metadata.gz: dc3aec011f3ce5f31f6a44e57b69bee416bcb42410f6f2a888a3a99dfcb51578
+  data.tar.gz: 50516dc7cf61f67ad70d00bcaa7dbec3449b25d9767dc071f84c368d3ad46b47
 SHA512:
-  metadata.gz: 7dba4b73d1ecf26e6d39d21cf9e289e35f9e83a9a9639d8f7cf5da5a7e9c1ae8bf427a9afbfc9e15a9d99fe11c239329b6d72c2f548d1caa58b94b59e1d0274a
-  data.tar.gz: 95a71558f6bedab54d16c63cfb525eaf083dc7dc4f4cfd0bedb2ac14056a9f01df475eca7906e4bfa72f043461f8f67f9dcc7bff9d3b77cbed617e08991018ad
+  metadata.gz: 85ec84e6981c85ae75e002e7ab051b6b8e1573c93d79b97ec2940408868a35f0c2166f842e3cb64fd5699e22fcabbbdea91f80ec4bff1e5df5bf1922b69026e3
+  data.tar.gz: dd57031373d351bad29c65ab6fa6186d90ab0eb12361fe911d790903875df7aaa81425d7c6c6b8fb794f37ca72fcf586a34301feb7d25c3add45a6899e3e8747

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 default:
-  image: ruby:2.7
+  image: ruby:3.1
 
 workflow:
   rules:
@@ -11,19 +11,22 @@ workflow:
     - if: '$CI_COMMIT_TAG'
 
 .test_template: &test_definition
+  image: ruby:${RUBY_VERSION}
   stage: test
   script:
-    - gem install bundler
+    - gem install bundler --no-document
+    - bundle config --local path vendor
     - bundle install
     - bundle exec rake verify build install
-
-test:3.0:
-  image: ruby:3.0
-  <<: *test_definition
-
-test:2.7:
-  image: ruby:2.7
+  cache:
+    key: ${CI_JOB_IMAGE}
+    paths:
+      - vendor/ruby
+ruby:
   <<: *test_definition
+  parallel:
+    matrix:
+      - RUBY_VERSION: ["2.7", "3.0", "3.1", "3.2"]
 
 static-analysis:
   before_script:

data/gitlab-labkit.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "grpc", ">= 1.37" # Be sure to update the "grpc-tools" dev_dependency too
   spec.add_runtime_dependency "jaeger-client", "~> 1.1.0"
   spec.add_runtime_dependency "opentracing", "~> 0.4"
-  spec.add_runtime_dependency "pg_query", "~> 2.1"
+  spec.add_runtime_dependency "pg_query", "~> 4.2.1"
   spec.add_runtime_dependency "redis", ">3.0.0", "<6.0.0"
 
   # Please maintain alphabetical order for dev dependencies
   spec.add_development_dependency "excon", "~> 0.78.1"
-  spec.add_development_dependency "faraday", "~> 1.2.0"
+  spec.add_development_dependency "faraday", "~> 1.0"
   spec.add_development_dependency "gitlab-dangerfiles", "~> 2.11.0"
   spec.add_development_dependency "gitlab-styles", "~> 6.2.0"
   spec.add_development_dependency "grpc-tools", ">= 1.37"
@@ -39,8 +39,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rest-client", "~> 2.1.0"
-  spec.add_development_dependency "rspec", "~> 3.10.0"
-  spec.add_development_dependency "rspec-parameterized", "~> 0.4"
+  spec.add_development_dependency "rspec", "~> 3.12.0"
+  spec.add_development_dependency "rspec-parameterized", "~> 1.0"
   spec.add_development_dependency "rufo", "0.9.0"
   spec.add_development_dependency "sidekiq", ">= 5.2", "< 7"
   spec.add_development_dependency "webrick", "~> 1.7.0"

data/lib/labkit/context.rb

@@ -26,7 +26,6 @@ module Labkit
     LOG_KEY = "meta"
     CORRELATION_ID_KEY = "correlation_id"
     RAW_KEYS = [CORRELATION_ID_KEY].freeze
-    HEADER_PREFIX = "X-Gitlab-"
 
     class << self
       def with_context(attributes = {})
@@ -71,10 +70,6 @@ module Labkit
         @known_log_keys ||= (KNOWN_KEYS.map(&method(:log_key)) + RAW_KEYS).freeze
       end
 
-      def header_name(name)
-        HEADER_PREFIX + log_key(name).titlecase(keep_id_suffix: true).gsub(/\W/, "-")
-      end
-
       private
 
       def contexts
@@ -103,12 +98,6 @@ module Labkit
       data[CORRELATION_ID_KEY]
     end
 
-    def to_headers
-      to_h.except(CORRELATION_ID_KEY).transform_keys do |key|
-        self.class.header_name(key)
-      end
-    end
-
     def get_attribute(attribute)
       raw = call_or_value(data[log_key(attribute)])
 

data/lib/labkit/logging/json_logger.rb

@@ -23,6 +23,15 @@ module Labkit
         ENV.fetch("GITLAB_LOG_LEVEL", fallback)
       end
 
+      def self.exclude_context!
+        @exclude_context = true
+        self
+      end
+
+      def self.exclude_context?
+        !!@exclude_context
+      end
+
       def initialize(path, level: JsonLogger.log_level)
         super
       end
@@ -31,7 +40,12 @@ module Labkit
         data = default_attributes
         data[:severity] = severity
         data[:time] = timestamp.utc.iso8601(3)
-        data[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id
+
+        if self.class.exclude_context?
+          data[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id
+        else
+          data.merge!(Labkit::Context.current.to_h)
+        end
 
         case message
         when String

data/lib/labkit/middleware/rack.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require "action_dispatch"
+require "json"
 
 module Labkit
   module Middleware
+    HEADER = "X-Gitlab-Meta"
+
     # This is a rack middleware to be inserted in GitLab-rails
     # It makes sure that there's always a root context containing the correlation
     # id.
@@ -15,8 +18,12 @@ module Labkit
       end
 
       def call(env)
-        Labkit::Context.with_context(Labkit::Context::CORRELATION_ID_KEY => correlation_id(env)) do
-          @app.call(env)
+        Labkit::Context.with_context(Labkit::Context::CORRELATION_ID_KEY => correlation_id(env)) do |context|
+          status, headers, response = @app.call(env)
+
+          headers[HEADER] = context_to_json(context)
+
+          [status, headers, response]
         end
       end
 
@@ -29,6 +36,14 @@ module Labkit
       def request(env)
         ActionDispatch::Request.new(env)
       end
+
+      def context_to_json(context)
+        context
+          .to_h
+          .transform_keys { |k| k.delete_prefix("meta.") }
+          .merge("version" => "1")
+          .to_json
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.31.1
+  version: 0.33.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -146,14 +146,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: gitlab-dangerfiles
   requirement: !ruby/object:Gem::Requirement
@@ -286,28 +286,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rspec-parameterized
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rufo
   requirement: !ruby/object:Gem::Requirement
@@ -462,7 +462,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Instrumentation for GitLab