karafka-core 2.5.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47aa33db15ba75b9696851ac4f999a52392394336fe12661a1d66158169619ec
-  data.tar.gz: 5ad3131cfe276d534f5a2b3042eb0fb4f09c214a92671ab6f6b9275b060b9fc5
+  metadata.gz: dcd7aa040c5e5025430de4755c6e3de2850f8e697a8222328a304f571d9bd1fc
+  data.tar.gz: b3498c28bf38256e7012a950a51f464d66a503c045227f1dde0e503b6d9550c3
 SHA512:
-  metadata.gz: e82ac91941d6a048c668f78269c2574a44986d4eb0123ba64384027e2ef79c41e5e4f15e7e9402a9e9bc67917f23803af5d7be704e0105e8835df6d326d953c5
-  data.tar.gz: 94b3680f843a482afdc7b9cec4977e8eeb42e87799d6a78aa86830942e16d07cdcb2b9f5fd00e419a0ecb4d0145ef17e2c63c0aad9e13d4b1fbc639dab91cc75
+  metadata.gz: 350399becfcf8a702a9c106cb6f6310dc57255549fbe54cd7bbadae4e1c2c1e13efc53b9d60972c20c2a057775483461f73f60dc2839da964db39de47b7f608d
+  data.tar.gz: 4b94de1f08121280d3321dad105487e7b3e3ddaefe2ba2d4a3dd67a5c2fe3b23cb5588fa707d8ad513346c860749f9389431751b26c1688b19104a585bda4de6

data/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: ci
+name: CI
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -40,7 +40,7 @@ jobs:
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@e34163cd15f4bb403dcd72d98e295997e6a55798 # v1.238.0
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
         with:
           ruby-version: ${{matrix.ruby}}
           bundler: 'latest'
@@ -71,7 +71,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set up Ruby
-        uses: ruby/setup-ruby@e34163cd15f4bb403dcd72d98e295997e6a55798 # v1.238.0
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
         with:
           ruby-version: 3.4
       - name: Install latest bundler

data/.github/workflows/push.yml

@@ -0,0 +1,35 @@
+name: Push Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository_owner == 'karafka'
+    runs-on: ubuntu-latest
+    environment: deployment
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
+        with:
+          bundler-cache: false
+
+      - name: Bundle install
+        run: |
+          bundle install --jobs 4 --retry 3
+
+      - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Karafka Core Changelog
 
+## 2.5.2 (2025-06-11)
+- [Enhancement] Support `#unsubscribe`.
+- [Enhancement] Allow for providing a root scope path for error keys.
+- [Fix] Fix a bug where on no errors the result would be an array instead of a hash.
+- [Fix] Fix spec hanging when Kafka cluster on 9092 is running.
+
+## 2.5.1 (2025-05-23)
+- [Change] Move to trusted-publishers and remove signing since no longer needed.
+
 ## 2.5.0 (2025-05-21)
 - [Change] Set minimum `karafka-rdkafka` on `0.19.2` to support new features.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.5.0)
+    karafka-core (2.5.2)
       karafka-rdkafka (>= 0.19.2, < 0.21.0)
       logger (>= 1.6.0)
 
@@ -22,26 +22,26 @@ GEM
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     ffi (1.17.2-x86_64-linux-musl)
-    karafka-rdkafka (0.19.2)
+    karafka-rdkafka (0.19.5)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     logger (1.7.0)
     mini_portile2 (2.8.9)
-    rake (13.2.1)
-    rspec (3.13.0)
+    rake (13.3.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.4)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.4)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.4)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.3)
+    rspec-support (3.13.4)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/karafka-core.gemspec

@@ -21,11 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.1.0'
 
-  if $PROGRAM_NAME.end_with?('gem')
-    spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
-  end
-
-  spec.cert_chain    = %w[certs/cert.pem]
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   spec.require_paths = %w[lib]
 

data/lib/karafka/core/contractable/contract.rb

@@ -78,18 +78,20 @@ module Karafka
         # Runs the validation
         #
         # @param data [Hash] hash with data we want to validate
+        # @param scope [Array<String>] scope of this contract (if any) or empty array if no parent
+        #   scope is needed if contract starts from root
         # @return [Result] validaton result
-        def call(data)
+        def call(data, scope: [])
           errors = []
 
           self.class.rules.each do |rule|
             case rule.type
             when :required
-              validate_required(data, rule, errors)
+              validate_required(data, rule, errors, scope)
             when :optional
-              validate_optional(data, rule, errors)
+              validate_optional(data, rule, errors, scope)
             when :virtual
-              validate_virtual(data, rule, errors)
+              validate_virtual(data, rule, errors, scope)
             end
           end
 
@@ -98,11 +100,13 @@ module Karafka
 
         # @param data [Hash] data for validation
         # @param error_class [Class] error class that should be used when validation fails
+        # @param scope [Array<String>] scope of this contract (if any) or empty array if no parent
+        #   scope is needed if contract starts from root
         # @return [Boolean] true
         # @raise [StandardError] any error provided in the error_class that inherits from the
         #   standard error
-        def validate!(data, error_class)
-          result = call(data)
+        def validate!(data, error_class, scope: [])
+          result = call(data, scope: scope)
 
           return true if result.success?
 
@@ -117,19 +121,20 @@ module Karafka
         # @param data [Hash] input hash
         # @param rule [Rule] validation rule
         # @param errors [Array] array with errors from previous rules (if any)
-        def validate_required(data, rule, errors)
+        # @param scope [Array<String>]
+        def validate_required(data, rule, errors, scope)
           for_checking = dig(data, rule.path)
 
           # We need to compare `DIG_MISS` against stuff because of the ownership of the `#==`
           # method
           if DIG_MISS == for_checking
-            errors << [rule.path, :missing]
+            errors << [scope + rule.path, :missing]
           else
             result = rule.validator.call(for_checking, data, errors, self)
 
             return if result == true
 
-            errors << [rule.path, result || :format]
+            errors << [scope + rule.path, result || :format]
           end
         end
 
@@ -139,7 +144,8 @@ module Karafka
         # @param data [Hash] input hash
         # @param rule [Rule] validation rule
         # @param errors [Array] array with errors from previous rules (if any)
-        def validate_optional(data, rule, errors)
+        # @param scope [Array<String>]
+        def validate_optional(data, rule, errors, scope)
           for_checking = dig(data, rule.path)
 
           return if DIG_MISS == for_checking
@@ -148,7 +154,7 @@ module Karafka
 
           return if result == true
 
-          errors << [rule.path, result || :format]
+          errors << [scope + rule.path, result || :format]
         end
 
         # Runs validation for rules on virtual fields (aggregates, etc) and adds errors (if any) to
@@ -157,11 +163,18 @@ module Karafka
         # @param data [Hash] input hash
         # @param rule [Rule] validation rule
         # @param errors [Array] array with errors from previous rules (if any)
-        def validate_virtual(data, rule, errors)
+        # @param scope [Array<String>]
+        def validate_virtual(data, rule, errors, scope)
           result = rule.validator.call(data, errors, self)
 
           return if result == true
 
+          if result
+            result.each do |sub_result|
+              sub_result[0] = scope + sub_result[0]
+            end
+          end
+
           errors.push(*result)
         end
 

data/lib/karafka/core/contractable/result.rb

@@ -14,7 +14,7 @@ module Karafka
         def initialize(errors, contract)
           # Short track to skip object allocation for the happy path
           if errors.empty?
-            @errors = errors
+            @errors = {}
             return
           end
 
@@ -41,7 +41,8 @@ module Karafka
 
         private
 
-        # Builds message based on the error messages
+        # Builds message based on the error messages and scope
+        #
         # @param contract [Object] contract for which we build the result
         # @param scope [Symbol] path to the key that has an error
         # @param error_key [Symbol] error key for yaml errors lookup
@@ -49,6 +50,25 @@ module Karafka
         def build_message(contract, scope, error_key)
           messages = contract.class.config.error_messages
 
+          # Split scope into parts for progressive checking
+          scope_parts = scope.to_s.split('.')
+
+          # Try full scope first, then progressively remove from beginning
+          # This allows us to have full path scoped errors but can also be used as a fallback,
+          # when scopes are dynamic. For example 'consumer_group_name.topic_name.name_format'
+          (0..scope_parts.length).each do |i|
+            current_scope_parts = scope_parts[i..]
+
+            key = if current_scope_parts.empty?
+                    error_key.to_s
+                  else
+                    "#{current_scope_parts.join('.')}_#{error_key}"
+                  end
+
+            return messages[key] if messages.key?(key)
+          end
+
+          # If nothing found, raise the original error
           messages.fetch(error_key.to_s) do
             messages.fetch("#{scope}_#{error_key}")
           end

data/lib/karafka/core/monitoring/monitor.rb

@@ -42,6 +42,14 @@ module Karafka
           @notifications_bus.subscribe(*args, &block)
         end
 
+        # Allows for removal of whatever was subscribed
+        #
+        # @param listener_or_block [Object] object that is subscribed whether this is a listener
+        #   instance or a block.
+        def unsubscribe(listener_or_block)
+          @notifications_bus.unsubscribe(listener_or_block)
+        end
+
         # @return [Hash<String, Array>] hash where keys are events and values are arrays with
         #   listeners subscribed to particular events. Since different events may have different
         #   listeners, this is returned that way.

data/lib/karafka/core/monitoring/notifications.rb

@@ -89,6 +89,21 @@ module Karafka
           end
         end
 
+        # Allows for unsubscription from events
+        # This method will remove the listener/block from all events where it's currently subscribed.
+        #
+        # @param listener_or_block [Object] listener object or block to remove from all events
+        #
+        # @example Unsubscribe using listener (removes from all events where it's subscribed)
+        #   unsubscribe(my_listener)
+        def unsubscribe(listener_or_block)
+          @mutex.synchronize do
+            @listeners.each_value do |event_listeners|
+              event_listeners.delete(listener_or_block)
+            end
+          end
+        end
+
         # Allows for code instrumentation
         # Runs the provided code and sends the instrumentation details to all registered listeners
         #

data/lib/karafka/core/version.rb

@@ -4,6 +4,6 @@ module Karafka
   module Core
     # Current Karafka::Core version
     # We follow the versioning schema of given Karafka version
-    VERSION = '2.5.0'
+    VERSION = '2.5.2'
   end
 end

metadata

@@ -1,39 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Maciej Mensfeld
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MRAwDgYDVQQDDAdjb250
-  YWN0MRcwFQYKCZImiZPyLGQBGRYHa2FyYWZrYTESMBAGCgmSJomT8ixkARkWAmlv
-  MB4XDTI0MDgyMzEwMTkyMFoXDTQ5MDgxNzEwMTkyMFowPzEQMA4GA1UEAwwHY29u
-  dGFjdDEXMBUGCgmSJomT8ixkARkWB2thcmFma2ExEjAQBgoJkiaJk/IsZAEZFgJp
-  bzCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAKjLhLjQqUlNayxkXnO+
-  PsmCDs/KFIzhrsYMfLZRZNaWmzV3ujljMOdDjd4snM2X06C41iVdQPWjpe3j8vVe
-  ZXEWR/twSbOP6Eeg8WVH2wCOo0x5i7yhVn4UBLH4JpfEMCbemVcWQ9ry9OMg4WpH
-  Uu4dRwxFV7hzCz3p0QfNLRI4miAxnGWcnlD98IJRjBAksTuR1Llj0vbOrDGsL9ZT
-  JeXP2gdRLd8SqzAFJEWrbeTBCBU7gfSh3oMg5SVDLjaqf7Kz5wC/8bDZydzanOxB
-  T6CDXPsCnllmvTNx2ei2T5rGYJOzJeNTmJLLK6hJWUlAvaQSvCwZRvFJ0tVGLEoS
-  flqSr6uGyyl1eMUsNmsH4BqPEYcAV6P2PKTv2vUR8AP0raDvZ3xL1TKvfRb8xRpo
-  vPopCGlY5XBWEc6QERHfVLTIVsjnls2/Ujj4h8/TSfqqYnaHKefIMLbuD/tquMjD
-  iWQsW2qStBV0T+U7FijKxVfrfqZP7GxQmDAc9o1iiyAa3QIDAQABo3cwdTAJBgNV
-  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU3O4dTXmvE7YpAkszGzR9DdL9
-  sbEwHQYDVR0RBBYwFIESY29udGFjdEBrYXJhZmthLmlvMB0GA1UdEgQWMBSBEmNv
-  bnRhY3RAa2FyYWZrYS5pbzANBgkqhkiG9w0BAQsFAAOCAYEAVKTfoLXn7mqdSxIR
-  eqxcR6Huudg1jes81s1+X0uiRTR3hxxKZ3Y82cPsee9zYWyBrN8TA4KA0WILTru7
-  Ygxvzha0SRPsSiaKLmgOJ+61ebI4+bOORzIJLpD6GxCxu1r7MI4+0r1u1xe0EWi8
-  agkVo1k4Vi8cKMLm6Gl9b3wG9zQBw6fcgKwmpjKiNnOLP+OytzUANrIUJjoq6oal
-  TC+f/Uc0TLaRqUaW/bejxzDWWHoM3SU6aoLPuerglzp9zZVzihXwx3jPLUVKDFpF
-  Rl2lcBDxlpYGueGo0/oNzGJAAy6js8jhtHC9+19PD53vk7wHtFTZ/0ugDQYnwQ+x
-  oml2fAAuVWpTBCgOVFe6XCQpMKopzoxQ1PjKztW2KYxgJdIBX87SnL3aWuBQmhRd
-  i9zWxov0mr44TWegTVeypcWGd/0nxu1+QHVNHJrpqlPBRvwQsUm7fwmRInGpcaB8
-  ap8wNYvryYzrzvzUxIVFBVM5PacgkFqRmolCa8I7tdKQN+R1
-  -----END CERTIFICATE-----
+cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -85,6 +58,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/ci.yml"
+- ".github/workflows/push.yml"
 - ".github/workflows/verify-action-pins.yml"
 - ".gitignore"
 - ".rspec"
@@ -96,7 +70,7 @@ files:
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
-- certs/cert.pem
+- Rakefile
 - config/locales/errors.yml
 - karafka-core.gemspec
 - lib/karafka-core.rb
@@ -148,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Karafka ecosystem core modules
 test_files: []

data/certs/cert.pem

@@ -1,26 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MRAwDgYDVQQDDAdjb250
-YWN0MRcwFQYKCZImiZPyLGQBGRYHa2FyYWZrYTESMBAGCgmSJomT8ixkARkWAmlv
-MB4XDTI0MDgyMzEwMTkyMFoXDTQ5MDgxNzEwMTkyMFowPzEQMA4GA1UEAwwHY29u
-dGFjdDEXMBUGCgmSJomT8ixkARkWB2thcmFma2ExEjAQBgoJkiaJk/IsZAEZFgJp
-bzCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAKjLhLjQqUlNayxkXnO+
-PsmCDs/KFIzhrsYMfLZRZNaWmzV3ujljMOdDjd4snM2X06C41iVdQPWjpe3j8vVe
-ZXEWR/twSbOP6Eeg8WVH2wCOo0x5i7yhVn4UBLH4JpfEMCbemVcWQ9ry9OMg4WpH
-Uu4dRwxFV7hzCz3p0QfNLRI4miAxnGWcnlD98IJRjBAksTuR1Llj0vbOrDGsL9ZT
-JeXP2gdRLd8SqzAFJEWrbeTBCBU7gfSh3oMg5SVDLjaqf7Kz5wC/8bDZydzanOxB
-T6CDXPsCnllmvTNx2ei2T5rGYJOzJeNTmJLLK6hJWUlAvaQSvCwZRvFJ0tVGLEoS
-flqSr6uGyyl1eMUsNmsH4BqPEYcAV6P2PKTv2vUR8AP0raDvZ3xL1TKvfRb8xRpo
-vPopCGlY5XBWEc6QERHfVLTIVsjnls2/Ujj4h8/TSfqqYnaHKefIMLbuD/tquMjD
-iWQsW2qStBV0T+U7FijKxVfrfqZP7GxQmDAc9o1iiyAa3QIDAQABo3cwdTAJBgNV
-HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU3O4dTXmvE7YpAkszGzR9DdL9
-sbEwHQYDVR0RBBYwFIESY29udGFjdEBrYXJhZmthLmlvMB0GA1UdEgQWMBSBEmNv
-bnRhY3RAa2FyYWZrYS5pbzANBgkqhkiG9w0BAQsFAAOCAYEAVKTfoLXn7mqdSxIR
-eqxcR6Huudg1jes81s1+X0uiRTR3hxxKZ3Y82cPsee9zYWyBrN8TA4KA0WILTru7
-Ygxvzha0SRPsSiaKLmgOJ+61ebI4+bOORzIJLpD6GxCxu1r7MI4+0r1u1xe0EWi8
-agkVo1k4Vi8cKMLm6Gl9b3wG9zQBw6fcgKwmpjKiNnOLP+OytzUANrIUJjoq6oal
-TC+f/Uc0TLaRqUaW/bejxzDWWHoM3SU6aoLPuerglzp9zZVzihXwx3jPLUVKDFpF
-Rl2lcBDxlpYGueGo0/oNzGJAAy6js8jhtHC9+19PD53vk7wHtFTZ/0ugDQYnwQ+x
-oml2fAAuVWpTBCgOVFe6XCQpMKopzoxQ1PjKztW2KYxgJdIBX87SnL3aWuBQmhRd
-i9zWxov0mr44TWegTVeypcWGd/0nxu1+QHVNHJrpqlPBRvwQsUm7fwmRInGpcaB8
-ap8wNYvryYzrzvzUxIVFBVM5PacgkFqRmolCa8I7tdKQN+R1
------END CERTIFICATE-----

metadata.gz.sig

@@ -1,2 +0,0 @@
-��h���^�UDM�$K6�M^i!��c�(Y�/����/� e?=����Iohr�e�.���M���]T9�p�un�*.6��7j�A,o]i�0n.c�/��oe���Lq�6��<�+^�.(~>?��������_Du����m�%{K�}�b���QҊ[
-I�q���"�ۦ���I3�����۳�ɣ��M�!U�Hχ�� �g�
�&�n_�|�}�E�,��~W3���N��r9/&K�5E��g�R