waterdrop 2.8.9 → 2.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d6b4d4ba3d3fe608324d53cf91c1d07278e810369ec9cf140520d9b065a30c1
-  data.tar.gz: b661659c9aa6facfe8eaf2b29eecd809937dbaf2b15557673c257e09f9a0f357
+  metadata.gz: 3dc4cc4d1928a447c4e6c3ab9d268a87c0d3a462b1b9d62685fe51168842c0e1
+  data.tar.gz: b82300c02b3d774aba5a2a354f7b9d0d11f2d08738ccf66348185f1a4bbd1605
 SHA512:
-  metadata.gz: 6d4f5323e204d8c9d8ae2f0d1eea282b1096ed1c28554bb8e46038b08679c554ebae21b9a1c7546a8c2ad5db0ca1876a882318b04aab2b671973a012364e3276
-  data.tar.gz: 2a6b018f76dd052016352af3878d29522ea5a0d1c8fba1edfa453bfd084bdfa2a7e9e20ec57fd0bc8e6de0ea3117b200fd5450bde022a7e233dc5b5461da4455
+  metadata.gz: a2f0d2befaa70b25bf756fdee15757328cfa0d2a642243100ae89421c0b0d65ce7b3b3d94d630f90cf040b7bb3ce2218aaee8200edfdfc96164038fee6d79e9b
+  data.tar.gz: 2b5a2fae3f060435c697024aab1c064342d9919b03304b8c29a1ee25c0d85533a0b43af5184c4dd8ceb5d49377178536ca6b0306af473ed4876dc98f712bf7c1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # WaterDrop changelog
 
+## 2.8.11 (2025-09-27)
+- [Enhancement] Provide fast-track for middleware-less flows (20% faster) for single message, 5000x faster for batches.
+- [Enhancement] Optimize middlewares application by around 20%.
+- [Change] Remove Ruby `3.1` according to the EOL schedule.
+- [Fix] Connection pool timeout parameter now accepts milliseconds instead of seconds for consistency with other WaterDrop timeouts. The default timeout has been changed from `5` seconds to `5000` milliseconds (equivalent value).
+
+## 2.8.10 (2025-09-25)
+- [Enhancement] Add `#close` alias for `WaterDrop::ConnectionPool#shutdown` to align with producer API for consistent interface across both individual producers and connection pools.
+- [Enhancement] Add `WaterDrop.monitor` method as the preferred alias for `WaterDrop.instrumentation` to align with per-producer API naming convention. The `instrumentation` method remains available as a deprecated alias for backward compatibility.
+
 ## 2.8.9 (2025-09-23)
 - [Enhancement] Add connection pool lifecycle events to global instrumentation for improved observability. Events include `connection_pool.created`, `connection_pool.setup`, `connection_pool.shutdown`, `connection_pool.reload`, and `connection_pool.reloaded`.
 - [Enhancement] Add default connection pool transactional direct API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.8.9)
+    waterdrop (2.8.11)
       karafka-core (>= 2.4.9, < 3.0.0)
       karafka-rdkafka (>= 0.20.0)
       zeitwerk (~> 2.3)

data/lib/waterdrop/connection_pool.rb

@@ -47,7 +47,7 @@ module WaterDrop
       # Sets up a global connection pool
       #
       # @param size [Integer] Pool size (default: 5)
-      # @param timeout [Numeric] Connection timeout in seconds (default: 5)
+      # @param timeout [Numeric] Connection timeout in milliseconds (default: 5000)
       # @param producer_config [Proc] Block to configure each producer in the pool
       # @yield [config, index] Block to configure each producer in the pool, receives config and
       #   pool index
@@ -66,7 +66,7 @@ module WaterDrop
       #       'transactional.id': "my-app-#{index}"
       #     }
       #   end
-      def setup(size: 5, timeout: 5, &producer_config)
+      def setup(size: 5, timeout: 5000, &producer_config)
         ensure_connection_pool_gem!
 
         @default_pool = new(size: size, timeout: timeout, &producer_config)
@@ -126,6 +126,11 @@ module WaterDrop
         )
       end
 
+      # Alias for shutdown to align with producer API
+      # WaterDrop producers use #close, so we alias connection pool #shutdown to #close
+      # for API consistency across both individual producers and connection pools
+      alias close shutdown
+
       # Reload the global connection pool
       def reload
         return unless @default_pool
@@ -189,18 +194,18 @@ module WaterDrop
     # Creates a new WaterDrop connection pool
     #
     # @param size [Integer] Pool size (default: 5)
-    # @param timeout [Numeric] Connection timeout in seconds (default: 5)
+    # @param timeout [Numeric] Connection timeout in milliseconds (default: 5000)
     # @param producer_config [Proc] Block to configure each producer in the pool
     # @yield [config, index] Block to configure each producer in the pool, receives config and
     #   pool index
-    def initialize(size: 5, timeout: 5, &producer_config)
+    def initialize(size: 5, timeout: 5000, &producer_config)
       self.class.send(:ensure_connection_pool_gem!)
 
       @producer_config = producer_config
       @pool_index = 0
       @pool_mutex = Mutex.new
 
-      @pool = ::ConnectionPool.new(size: size, timeout: timeout) do
+      @pool = ::ConnectionPool.new(size: size, timeout: timeout / 1000.0) do
         producer_index = @pool_mutex.synchronize { @pool_index += 1 }
 
         WaterDrop::Producer.new do |config|
@@ -244,6 +249,11 @@ module WaterDrop
       )
     end
 
+    # Alias for shutdown to align with producer API
+    # WaterDrop producers use #close, so we alias connection pool #shutdown to #close
+    # for API consistency across both individual producers and connection pools
+    alias close shutdown
+
     # Reload all connections in the pool
     # Useful for configuration changes or error recovery
     def reload

data/lib/waterdrop/middleware.rb

@@ -6,6 +6,7 @@ module WaterDrop
     def initialize
       @mutex = Mutex.new
       @steps = []
+      @count = 0
     end
 
     # Runs middleware on a single message prior to validation
@@ -16,6 +17,8 @@ module WaterDrop
     # @note You need to decide yourself whether you don't use the message hash data anywhere else
     #   and you want to save on memory by modifying it in place or do you want to do a deep copy
     def run(message)
+      return message if @count.zero?
+
       @steps.each do |step|
         message = step.call(message)
       end
@@ -24,10 +27,18 @@ module WaterDrop
     end
 
     # @param messages [Array<Hash>] messages on which we want to run middlewares
-    # @return [Array<Hash>] transformed messages
+    # @return [Array<Hash>] transformed messages or same messages if no transformation
     def run_many(messages)
-      messages.map do |message|
-        run(message)
+      # Skip middleware processing entirely if no middleware steps are configured
+      return messages if @count.zero?
+
+      # Use each_with_object to avoid creating intermediate arrays for large batches
+      messages.each_with_object([]) do |message, result|
+        @steps.each do |step|
+          message = step.call(message)
+        end
+
+        result << message
       end
     end
 
@@ -36,6 +47,7 @@ module WaterDrop
     def prepend(step)
       @mutex.synchronize do
         @steps.prepend step
+        @count = @steps.size
       end
     end
 
@@ -44,6 +56,7 @@ module WaterDrop
     def append(step)
       @mutex.synchronize do
         @steps.append step
+        @count = @steps.size
       end
     end
   end

data/lib/waterdrop/version.rb

@@ -3,5 +3,5 @@
 # WaterDrop library
 module WaterDrop
   # Current WaterDrop version
-  VERSION = '2.8.9'
+  VERSION = '2.8.11'
 end

data/lib/waterdrop.rb

@@ -17,7 +17,7 @@ module WaterDrop
       Pathname.new(File.expand_path('..', __dir__))
     end
 
-    # @return [WaterDrop::Instrumentation::ClassMonitor] global instrumentation monitor for
+    # @return [WaterDrop::Instrumentation::ClassMonitor] global monitor for
     #   class-level event subscriptions. This allows external libraries to subscribe to WaterDrop
     #   lifecycle events without needing producer instance references.
     #
@@ -25,13 +25,16 @@ module WaterDrop
     #   instance events
     #
     # @example Subscribe to producer creation events
-    #   WaterDrop.instrumentation.subscribe('producer.created') do |event|
+    #   WaterDrop.monitor.subscribe('producer.created') do |event|
     #     producer = event[:producer]
     #     # Configure producer or add middleware
     #   end
-    def instrumentation
+    def monitor
       @instrumentation ||= Instrumentation::ClassMonitor.new
     end
+
+    # @deprecated Use #monitor instead. This method is provided for backward compatibility only.
+    alias instrumentation monitor
   end
 end
 

data/waterdrop.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'karafka-rdkafka', '>= 0.20.0'
   spec.add_dependency 'zeitwerk', '~> 2.3'
 
-  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   spec.executables   = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 2.8.9
+  version: 2.8.11
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="