karafka-core 2.4.0 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c68e914027164cf77e87f6f656884f09d74f5162660d312a9ecb4927ec0805f
-  data.tar.gz: c24bbec6e2570430dfeeb0d3733a777b052b5ec6a68eacdd912751b7422940f6
+  metadata.gz: 3b5320e4ddb995e3c944e8ad2f2b31649ef455a4f9af3653c7e9c2c8bd793bec
+  data.tar.gz: c0817e7374a1f37c9fcd9595b78d20b83213a08676b5ec97903cccf886bead03
 SHA512:
-  metadata.gz: f710f79bb3da9b12cd9f830417c2eff56ad05e5bb165945c5deadb09479a2f3647b96319c2ccd40ce185886a8df727a4df63bcfc7f65cf416d811998f09b9c94
-  data.tar.gz: ad855f6b8c600b95e573e9a5a989470785b2ce01008fa1b98211d2ae4b74bdf52baa4e1c7ceece366464bdecd7a69867311bb50a71d9e8ac46888a126f558d00
+  metadata.gz: 922644dda424831e922a4cb3647fdb4fa598d8a79d5d01f10e11a14ab84a362a66640d4d4025de6df565f03f1a2f6537ded6b0f8d27b9c2d36bb9ba91218153d
+  data.tar.gz: cbcdbf0848a9a5c88e61fd3703aedd636a47ccfa6e2172f18a51f3d7d9540469730f0ac20972e2947ded1e888509523f85b87b31caa2cd76a333b713772c2111

data/.github/workflows/ci.yml

@@ -18,6 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.4.0-preview1'
           - '3.3'
           - '3.2'
           - '3.1'

data/.ruby-version

@@ -1 +1 @@
-3.3.1
+3.3.3

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Karafka core changelog
 
+## 2.4.3 (2024-06-18)
+- [Fix] Use `Object` instead of `BasicObject` for rule result comparison because of Time mismatch with BasicObject.
+
+## 2.4.2 (2024-06-17)
+- [Enhancement] Allow `karafka-rdkafka` `0.16.x` to be used since API compatible.
+
+## 2.4.1 (2024-06-17)
+- [Enhancement] Provide fast-track for events without subscriptions to save on allocations.
+- [Enhancement] Save memory allocation on each contract rule validation execution.
+- [Enhancement] Save one allocation per `float_now` + 2-3x performance by using the Posix clock instead of `Time.now.utc.to_f`.
+- [Enhancement] Use direct `float_millisecond` precision in `monotonic_now` not to multiply by 1000 (allocations and CPU savings).
+- [Enhancement] Save one array allocation on one instrumentation.
+- [Enhancement] Allow clearing one event type (dorner).
+
 ## 2.4.0 (2024-04-26)
 - **[Breaking]** Drop Ruby `2.7` support.
 - [Enhancement] Provide necessary alterations for custom oauth token callbacks to operate.

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.4.0)
-      karafka-rdkafka (>= 0.15.0, < 0.16.0)
+    karafka-core (2.4.3)
+      karafka-rdkafka (>= 0.15.0, < 0.17.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -18,24 +18,25 @@ GEM
       mutex_m
       tzinfo (~> 2.0)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     docile (1.4.0)
     drb (2.2.1)
     factory_bot (6.4.6)
       activesupport (>= 5.0.0)
-    ffi (1.16.3)
-    i18n (1.14.4)
+    ffi (1.17.0)
+    ffi (1.17.0-x86_64-linux-gnu)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    karafka-rdkafka (0.15.0)
+    karafka-rdkafka (0.15.1)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
-    mini_portile2 (2.8.6)
-    minitest (5.22.3)
+    mini_portile2 (2.8.7)
+    minitest (5.23.1)
     mutex_m (0.2.0)
     rake (13.2.1)
     rspec (3.13.0)
@@ -44,10 +45,10 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
@@ -72,4 +73,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.5.9
+   2.5.13

data/config/locales/errors.yml

@@ -8,3 +8,4 @@ en:
     config:
       missing: needs to be present
       id_format: needs to be a String
+      test_format: needs to be nil

data/karafka-core.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.description = 'A toolset of small support modules used throughout the Karafka ecosystem'
   spec.licenses    = %w[MIT]
 
-  spec.add_dependency 'karafka-rdkafka', '>= 0.15.0', '< 0.16.0'
+  spec.add_dependency 'karafka-rdkafka', '>= 0.15.0', '< 0.17.0'
 
   spec.required_ruby_version = '>= 3.0.0'
 

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

@@ -9,6 +9,13 @@ module Karafka
       class Contract
         extend Core::Configurable
 
+        # Constant representing a miss during dig
+        # We use it as a result value not to return an array with found object and a state to
+        # prevent additional array allocation
+        DIG_MISS = Object.new
+
+        private_constant :DIG_MISS
+
         # Yaml based error messages data
         setting(:error_messages)
 
@@ -75,7 +82,7 @@ module Karafka
         def call(data)
           errors = []
 
-          self.class.rules.map do |rule|
+          self.class.rules.each do |rule|
             case rule.type
             when :required
               validate_required(data, rule, errors)
@@ -113,14 +120,16 @@ module Karafka
         def validate_required(data, rule, errors)
           for_checking = dig(data, rule.path)
 
-          if for_checking.first == :match
-            result = rule.validator.call(for_checking.last, data, errors, self)
+          # We need to compare `DIG_MISS` against stuff because of the ownership of the `#==`
+          # method
+          if DIG_MISS == for_checking
+            errors << [rule.path, :missing]
+          else
+            result = rule.validator.call(for_checking, data, errors, self)
 
             return if result == true
 
             errors << [rule.path, result || :format]
-          else
-            errors << [rule.path, :missing]
           end
         end
 
@@ -133,9 +142,9 @@ module Karafka
         def validate_optional(data, rule, errors)
           for_checking = dig(data, rule.path)
 
-          return unless for_checking.first == :match
+          return if DIG_MISS == for_checking
 
-          result = rule.validator.call(for_checking.last, data, errors, self)
+          result = rule.validator.call(for_checking, data, errors, self)
 
           return if result == true
 
@@ -156,28 +165,23 @@ module Karafka
           errors.push(*result)
         end
 
-        # Tries to dig for a given key in a hash and returns it with indication whether or not it was
-        # possible to find it (dig returns nil and we don't know if it wasn't the digged key value)
+        # Tries to dig for a given key in a hash and returns it with indication whether or not it
+        # was possible to find it (dig returns nil and we don't know if it wasn't the digged key
+        # value)
         #
         # @param data [Hash]
         # @param keys [Array<Symbol>]
-        # @return [Array<Symbol, Object>] array where the first element is `:match` or `:miss` and
-        #   the digged value or nil if not found
+        # @return [DIG_MISS, Object] found element or DIGG_MISS indicating that not found
         def dig(data, keys)
           current = data
-          result = :match
 
           keys.each do |nesting|
-            unless current.key?(nesting)
-              result = :miss
-
-              break
-            end
+            return DIG_MISS unless current.key?(nesting)
 
             current = current[nesting]
           end
 
-          [result, current]
+          current
         end
       end
     end

data/lib/karafka/core/helpers/time.rb

@@ -6,14 +6,21 @@ module Karafka
     module Helpers
       # Time related methods used across Karafka
       module Time
-        # @return [Float] current monotonic time in milliseconds
-        def monotonic_now
-          ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) * 1_000
+        if RUBY_VERSION >= '3.2'
+          # @return [Float] current monotonic time in milliseconds
+          def monotonic_now
+            ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, :float_millisecond)
+          end
+        else
+          # @return [Float] current monotonic time in milliseconds
+          def monotonic_now
+            ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) * 1_000
+          end
         end
 
         # @return [Float] current time in float
         def float_now
-          ::Time.now.utc.to_f
+          ::Process.clock_gettime(::Process::CLOCK_REALTIME)
         end
       end
     end

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

@@ -22,7 +22,7 @@ module Karafka
         private_constant :EMPTY_HASH
 
         def initialize
-          @listeners = Hash.new { |hash, key| hash[key] = [] }
+          @listeners = {}
           @mutex = Mutex.new
           # This allows us to optimize the method calling lookups
           @events_methods_map = {}
@@ -33,15 +33,20 @@ module Karafka
         # @param event_id [String] event id
         def register_event(event_id)
           @mutex.synchronize do
-            @listeners[event_id]
+            @listeners[event_id] = []
             @events_methods_map[event_id] = :"on_#{event_id.to_s.tr('.', '_')}"
           end
         end
 
-        # Clears all the subscribed listeners
-        def clear
+        # Clears all the subscribed listeners. If given an event, only clear listeners for the given
+        # event type.
+        # @param event_id [String] the key of the event to clear listeners for.
+        def clear(event_id = nil)
           @mutex.synchronize do
-            @listeners.each_value(&:clear)
+            return @listeners.each_value(&:clear) unless event_id
+            return @listeners[event_id].clear if @listeners.key?(event_id)
+
+            raise(EventNotRegistered, "#{event_id} not registered!")
           end
         end
 
@@ -84,25 +89,42 @@ module Karafka
         #
         # @param event_id [String] id of the event
         # @param payload [Hash] payload for the instrumentation
-        # @param block [Proc] instrumented code
+        # @yield [Proc] instrumented code
         # @return [Object] whatever the provided block (if any) returns
         #
         # @example Instrument some code
         #   instrument('sleeping') do
         #     sleep(1)
         #   end
-        def instrument(event_id, payload = EMPTY_HASH, &block)
-          # Allow for instrumentation of only events we registered
-          raise EventNotRegistered, event_id unless @listeners.key?(event_id)
-
-          result, time = measure_time_taken(&block) if block_given?
+        def instrument(event_id, payload = EMPTY_HASH)
+          assigned_listeners = @listeners[event_id]
+
+          # Allow for instrumentation of only events we registered. If listeners array does not
+          # exist, it means the event was not registered.
+          raise EventNotRegistered, event_id unless assigned_listeners
+
+          if block_given?
+            # No point in instrumentation when no one is listening
+            # Since the outcome will be ignored, we may as well save on allocations
+            # There are many events that happen often like (`message.acknowledged`) that most
+            # users do not subscribe to. Such check prevents us from publishing events that would
+            # not be used at all saving on time measurements and objects allocations
+            return yield if assigned_listeners.empty?
+
+            start = monotonic_now
+            result = yield
+            time = monotonic_now - start
+          elsif assigned_listeners.empty?
+            # Skip measuring or doing anything if no one listening
+            return
+          end
 
           event = Event.new(
             event_id,
             time ? payload.merge(time: time) : payload
           )
 
-          @listeners[event_id].each do |listener|
+          assigned_listeners.each do |listener|
             if listener.is_a?(Proc)
               listener.call(event)
             else
@@ -112,16 +134,6 @@ module Karafka
 
           result
         end
-
-        private
-
-        # Measures time taken to execute a given block and returns it together with the result of
-        # the block execution
-        def measure_time_taken
-          start = monotonic_now
-          result = yield
-          [result, monotonic_now - start]
-        end
       end
     end
   end

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.4.0'
+    VERSION = '2.4.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.3
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-04-26 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka-rdkafka
@@ -46,7 +46,7 @@ dependencies:
         version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -56,7 +56,7 @@ dependencies:
         version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 description: A toolset of small support modules used throughout the Karafka ecosystem
 email:
 - contact@karafka.io
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Karafka ecosystem core modules