gitlab-labkit 0.42.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cefb3ce3a1f0b663c7d4ac1a60d0b4ed3a6ecb8b170efac046f07e5d700a0b66
-  data.tar.gz: 3cb390d7949d332aaa959c03fe1a0d152100067e3822f0832327583972e7ad46
+  metadata.gz: 1fcf883261bb809a67748d4f15c2a520ae392d3d069b5852cc20abf56e428b4e
+  data.tar.gz: ce56f2ec2b2dce0b420d0096ea6b4a48b54a91c350b802a245dcc0cae9219908
 SHA512:
-  metadata.gz: 74ac536ebabf46339787079b5c972c8541a4b3d3bd15a597395b110adb1c20fff19ec8bdb554fcf57fc4a36ecbe39c26369bf5c1f4fadfc309bfc5f96c3cb6ee
-  data.tar.gz: b3fa11140a2d30d29af280f76887afe57fa0b4c94eb4b73112d1dde67dfcf35a59bb1bb24e32827ea3c30cfddeb3ddcedb438923ca2d6199d72fc0b0182dd6fa
+  metadata.gz: 70d57193fc2778250b004df0e39f7f98ff6f1bc5356d601f664b632cd6a7e9b4f2f772b6251406702b5cea84bda6fed02ad29d1ca196f2b29462e4887ded4b6e
+  data.tar.gz: 1cd77a020fe80b311512acf08b433913f0e9a06edce05a10961c018c19a1270c9420b477731cb88d4ceb5b641ee0a6d0ad4c34fc1bee528d2febae1f83a521dd

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: v2.98  # renovate:managed
+    rev: v3.0  # renovate:managed
 
     hooks:
       - id: shellcheck  # Run shellcheck for changed Shell files

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-05-05 15:54:30 UTC using RuboCop version 1.68.0.
+# on 2025-11-17 07:59:08 UTC using RuboCop version 1.71.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -25,7 +25,7 @@ Fips/SHA1:
   Exclude:
     - 'spec/labkit/fips_spec.rb'
 
-# Offense count: 8
+# Offense count: 10
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -56,11 +56,26 @@ Layout/ClassStructure:
   Exclude:
     - 'lib/labkit/tracing/rack_middleware.rb'
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLineAfterMagicComment:
   Exclude:
     - 'lib/labkit/logging/json_logger.rb'
+    - 'spec/support/grpc_service/test_pb.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLines:
+  Exclude:
+    - 'spec/support/grpc_service/test_pb.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'spec/support/grpc_service/test_services_pb.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -144,7 +159,8 @@ Lint/UnexpectedBlockArity:
 
 # Offense count: 41
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/labkit/correlation/grpc/client_interceptor.rb'
@@ -254,7 +270,7 @@ RSpec/LetBeforeExamples:
   Exclude:
     - 'spec/labkit/tracing_spec.rb'
 
-# Offense count: 20
+# Offense count: 31
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 8
@@ -326,7 +342,7 @@ Rails/NegateInclude:
   Exclude:
     - 'spec/labkit/correlation/grpc/client_interceptor_spec.rb'
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Include.
 # Include: **/Rakefile, **/*.rake
@@ -361,6 +377,14 @@ Style/AsciiComments:
   Exclude:
     - 'spec/support/grpc_service/test_service_impl.rb'
 
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: allow_single_line, allow_always, disallow
+Style/EndlessMethod:
+  Exclude:
+    - 'lib/labkit/user_experience_sli/null.rb'
+
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowedVars.
@@ -369,6 +393,15 @@ Style/FetchEnvVar:
     - 'lib/labkit/tracing.rb'
     - 'spec/helpers/stub_env.rb'
 
+# Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/FileNull:
+  Exclude:
+    - 'spec/labkit/logging/json_logger_spec.rb'
+    - 'spec/labkit/middleware/sidekiq/user_experience_sli/client_spec.rb'
+    - 'spec/labkit/middleware/sidekiq/user_experience_sli/server_spec.rb'
+    - 'spec/spec_helper.rb'
+
 # Offense count: 8
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -381,7 +414,7 @@ Style/FrozenStringLiteralComment:
     - 'spec/labkit/tracing/rails/active_support/cache_generate_instrumenter_spec.rb'
     - 'spec/labkit/tracing/rails/active_support/cache_read_instrumenter_spec.rb'
     - 'spec/labkit/tracing/rails/active_support/cache_write_instrumenter_spec.rb'
-    - 'spec/support/grpc_service/test_pb.rb'
+    - 'spec/support/grpc_service/test_services_pb.rb'
     - 'tools/update-changelog.rb'
 
 # Offense count: 2
@@ -397,7 +430,7 @@ Style/GuardClause:
   Exclude:
     - 'lib/labkit/logging/json_logger.rb'
 
-# Offense count: 34
+# Offense count: 33
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
@@ -408,7 +441,6 @@ Style/HashSyntax:
     - 'lib/labkit/tracing/tracing_utils.rb'
     - 'spec/labkit/tracing/rack_middleware_spec.rb'
     - 'spec/labkit/tracing/redis/redis_interceptor_helper_spec.rb'
-    - 'spec/support/grpc_service/test_pb.rb'
     - 'spec/support/tracing/shared_examples.rb'
 
 # Offense count: 1
@@ -459,11 +491,12 @@ Style/RedundantBegin:
   Exclude:
     - 'spec/labkit/net_http_publisher_spec.rb'
 
-# Offense count: 3
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 Style/RedundantConstantBase:
   Exclude:
     - 'spec/labkit/logging/grpc/server_interceptor_spec.rb'
+    - 'spec/support/grpc_service/test_pb.rb'
 
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
@@ -491,6 +524,12 @@ Style/RedundantReturn:
   Exclude:
     - 'lib/labkit/tracing/jaeger_factory.rb'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantStringEscape:
+  Exclude:
+    - 'spec/support/grpc_service/test_pb.rb'
+
 # Offense count: 3
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Mode.
@@ -519,7 +558,7 @@ Style/SymbolLiteral:
     - 'lib/labkit/tracing/tracing_utils.rb'
     - 'spec/support/tracing/shared_examples.rb'
 
-# Offense count: 39
+# Offense count: 42
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleForMultiline.
 # SupportedStylesForMultiline: comma, consistent_comma, no_comma
@@ -545,16 +584,16 @@ Style/TrailingCommaInArrayLiteral:
     - 'spec/labkit/tracing/rails/active_support/cache_generate_instrumenter_spec.rb'
     - 'spec/labkit/tracing/rails/active_support/cache_write_instrumenter_spec.rb'
 
-# Offense count: 84
+# Offense count: 85
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleForMultiline.
 # SupportedStylesForMultiline: comma, consistent_comma, no_comma
 Style/TrailingCommaInHashLiteral:
   Enabled: false
 
-# Offense count: 68
+# Offense count: 75
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 294
+  Max: 567

data/Rakefile

@@ -18,7 +18,13 @@ end
 desc "Generate test protobuf stubs"
 task :gen_test_proto do
   system "grpc_tools_ruby_protoc --ruby_out=. --grpc_out=. spec/support/grpc_service/test.proto"
-  Rufo::Command.run(["spec/support/grpc_service/test_pb.rb", "spec/support/grpc_service/test_services_pb.rb"])
+
+  # Fix require statement to use require_relative for test environment.
+  # This is a workaround for https://github.com/grpc/grpc/issues/29027.
+  services_file = "spec/support/grpc_service/test_services_pb.rb"
+  content = File.read(services_file)
+  content.gsub!(%r{^require ['"]spec/support/grpc_service/test_pb['"]$}, "require_relative 'test_pb'")
+  File.write(services_file, content)
 end
 
 task :fix => ["rubocop:autocorrect"]

data/gitlab-labkit.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   # Please maintain alphabetical order for dependencies
   spec.add_runtime_dependency "actionpack", ">= 5.0.0", "< 8.1.0"
   spec.add_runtime_dependency "activesupport", ">= 5.0.0", "< 8.1.0"
-  spec.add_runtime_dependency "grpc", ">= 1.62" # Be sure to update the "grpc-tools" dev_dependency too
-  spec.add_runtime_dependency "google-protobuf", "~> 3" # Keep the major version to 3 until we update the `grpc` gem
+  spec.add_runtime_dependency "grpc", ">= 1.75" # Be sure to update the "grpc-tools" dev_dependency too
+  spec.add_runtime_dependency "google-protobuf", ">= 3.25", "< 5.0"
   spec.add_runtime_dependency "jaeger-client", "~> 1.1.0"
   spec.add_runtime_dependency 'json-schema', '~> 5.1'
   spec.add_runtime_dependency "opentracing", "~> 0.4"
@@ -35,8 +35,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "excon", "~> 0.78.1"
   spec.add_development_dependency "faraday", "~> 1.10.3"
   spec.add_development_dependency "gitlab-dangerfiles", "~> 2.11.0"
-  spec.add_development_dependency "gitlab-styles", "~> 13.0.2"
-  spec.add_development_dependency "grpc-tools", ">= 1.62"
+  spec.add_development_dependency "gitlab-styles", "~> 13.1"
+  spec.add_development_dependency "grpc-tools", ">= 1.75"
   spec.add_development_dependency "httparty", "~> 0.22.0"
   spec.add_development_dependency "httpclient", "~> 2.9.0"
   spec.add_development_dependency "irb", "~> 1.15.2"

data/lib/labkit/fields.rb

@@ -18,24 +18,37 @@ module Labkit
   #   data[Labkit::Fields::GL_USER_ID] = user.id
   #   ...
   #
+  # Labkit (Go): https://gitlab.com/gitlab-org/labkit/-/tree/master/fields?ref_type=heads
+  #
+  # For Engineers Looking to add fields:
+  #
+  # These fields are derived from the Go Labkit variant. Please ensure that you've made the
+  # respective changes in that repository prior to including the fields in this package.
+  #
+  # Please see the handbook page for more information
+  # https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/observability_field_standardisation/
   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
     # emissions.
     CORRELATION_ID = "correlation_id"
 
-    # We'll need to add the rest of the top
-    # level fields here:
-    # [endpoint_id, duration_s, status_code]
-
-    # gl_user_id - integer
+    # GitLabUserID - an integer field that
+    # captures the user's numeric ID for logging purposes.
     GL_USER_ID = "gl_user_id"
 
-    # gl_user_name - string
+    # GitLabUserName - a string field that
+    # captures the user's username for logging purposes.
     GL_USER_NAME = "gl_user_name"
+
+    # New fields being added to this section should have
+    # the appropriate doc comments added above. These
+    # should clearly indicate what the intended use of the
+    # field is and should be replicated across the labkit
+    # variations.
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.42.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Newdigate
@@ -55,28 +55,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.25'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.25'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: jaeger-client
   requirement: !ruby/object:Gem::Requirement
@@ -221,28 +227,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.2
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.2
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement