karafka-core 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01592d62e014e631fffd3ae9477c8979e2df94ce3958b068d6ab5a79755e69aa'
-  data.tar.gz: 65ce9e27480ec280e3b9f568ba09bf74e64298c7c14e796872a8f8bc40dd2541
+  metadata.gz: dcd7aa040c5e5025430de4755c6e3de2850f8e697a8222328a304f571d9bd1fc
+  data.tar.gz: b3498c28bf38256e7012a950a51f464d66a503c045227f1dde0e503b6d9550c3
 SHA512:
-  metadata.gz: f785c2934587b78e42226b798bfa3023f4ed6985bb5e2048920fd5173df3e920f367c15a66e160d257c4d01c8265d7125ccfdcd3022ff1bc73685b6dcee0dde2
-  data.tar.gz: 7f38ce66ec1e49c993e207e1b3967637d99f04c6e62b1c852fb5788fb4348ff6942a8c59c2d23d4735e982db2a4a820773653f292edc2ce022aef61b2cf6abb1
+  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@1a0ff446f5856bdfec298b61a09727c860d9d480 # v1.240.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@1a0ff446f5856bdfec298b61a09727c860d9d480 # v1.240.0
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
         with:
           ruby-version: 3.4
       - name: Install latest bundler

data/.github/workflows/push.yml

@@ -24,7 +24,7 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@1a0ff446f5856bdfec298b61a09727c860d9d480 # v1.240.0
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
         with:
           bundler-cache: false
 
@@ -32,5 +32,4 @@ jobs:
         run: |
           bundle install --jobs 4 --retry 3
 
-      # Release
-      - uses: rubygems/release-gem@9e85cb11501bebc2ae661c1500176316d3987059 # v1
+      - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.5.1)
+    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/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.1'
+    VERSION = '2.5.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Maciej Mensfeld