waterdrop 2.7.3 → 2.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e99f22e3b3099cad3e459f171d7d43ab537fd62c50593997c3297846eb124a
-  data.tar.gz: 9583295a925fe82e6ca6a6899e0d37f644d0a30cc2a2359289d84ea78ab7e0ec
+  metadata.gz: 7829f5c177154b491525c3895e2f12c27c6d58b8e43d47130caf6ee44dc5de2f
+  data.tar.gz: bb92b727e921030a5933735f8f1e0e01727fb8e91bc607b1c0adb74031b4881f
 SHA512:
-  metadata.gz: 017dd6f279e40d9c2d338e8ea2763fcab70e3ec99c0f229a1fb5c7037765d8f5a00c0dfe2d2ab932623b6b735ca27d9bd3ca3a8f012dd5aff33952f5eaa2b355
-  data.tar.gz: 6ff18fdd690e8e3f2341e2fa90a28b0972421559e5600c2c1c17b77d31d9882ed0476a3f2f7e6c33844f0b2a71aceb0b7f63bd8e6f8689084a41b6cfc09b6525
+  metadata.gz: c7ed272bc46e9f7ea1e398c66588c730f1ca0f7427e7f215d4c89285498e6ccefc1c4af709a1c17f29382e7cc75ebdee403aef865661b8fefdacd164f95acf25
+  data.tar.gz: 99d9dcd114f67d272e0d2650ee2bd9aa0b480e9d850fb9f0f32813e02a90603b435b021a27faab09a411f3dea438c9307b14bd12e349289bf977c1b984805604

data/.ruby-version

@@ -1 +1 @@
-3.3.2
+3.3.3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # WaterDrop changelog
 
+## 2.7.4 (2024-07-04)
+- [Maintenance] Alias `WaterDrop::Errors::AbortTransaction` with `WaterDrop::AbortTransaction`.
+- [Maintenance] Lower the precision reporting to 100 microseconds in the logger listener.
+- [Fix] Consumer consuming error: Local: Erroneous state (state) post break flow in transaction.
+- [Change] Require 'karafka-core' `>= 2.4.3`
+
 ## 2.7.3 (2024-06-09)
 - [Enhancement] Introduce `reload_on_transaction_fatal_error` to reload the librdkafka after transactional failures
 - [Enhancement] Flush on fatal transactional errors.

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.7.3)
-      karafka-core (>= 2.4.0, < 3.0.0)
+    waterdrop (2.7.4)
+      karafka-core (>= 2.4.3, < 3.0.0)
       karafka-rdkafka (>= 0.15.1)
       zeitwerk (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -22,24 +22,24 @@ GEM
     base64 (0.2.0)
     bigdecimal (3.1.8)
     byebug (11.1.3)
-    concurrent-ruby (1.3.1)
+    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)
+    ffi (1.17.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    karafka-core (2.4.0)
-      karafka-rdkafka (>= 0.15.0, < 0.16.0)
-    karafka-rdkafka (0.15.1)
+    karafka-core (2.4.3)
+      karafka-rdkafka (>= 0.15.0, < 0.17.0)
+    karafka-rdkafka (0.16.0)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.7)
-    minitest (5.23.1)
+    minitest (5.24.0)
     mutex_m (0.2.0)
     ostruct (0.6.0)
     rake (13.2.1)
@@ -49,7 +49,7 @@ 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.1)
@@ -64,7 +64,7 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.6.15)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   ruby
@@ -79,4 +79,4 @@ DEPENDENCIES
   waterdrop!
 
 BUNDLED WITH
-   2.5.11
+   2.5.14

data/lib/waterdrop/errors.rb

@@ -60,4 +60,8 @@ module WaterDrop
       end
     end
   end
+
+  # Alias so we can have a nicer API to abort transactions
+  # This makes referencing easier
+  AbortTransaction = Errors::AbortTransaction
 end

data/lib/waterdrop/instrumentation/logger_listener.rb

@@ -193,7 +193,7 @@ module WaterDrop
       # @param log_message [String] message we want to publish
       def info(event, log_message)
         if event.payload.key?(:time)
-          @logger.info("[#{event[:producer_id]}] #{log_message} took #{event[:time]} ms")
+          @logger.info("[#{event[:producer_id]}] #{log_message} took #{event[:time].round(2)} ms")
         else
           @logger.info("[#{event[:producer_id]}] #{log_message}")
         end

data/lib/waterdrop/producer/transactions.rb

@@ -35,7 +35,8 @@ module WaterDrop
       # with a transaction. One transaction per single dispatch and for `produce_many` it will be
       # a single transaction wrapping all messages dispatches (not one per message).
       #
-      # @return Block result
+      # @param block [Proc] block of code that should run
+      # @return Block result or `nil` in case of early break/return
       #
       # @example Simple transaction
       #   producer.transaction do
@@ -54,7 +55,7 @@ module WaterDrop
       #             end
       #
       #   handler.wait
-      def transaction
+      def transaction(&block)
         # This will safely allow us to support one operation transactions so a transactional
         # producer can work without the transactional block if needed
         return yield if @transaction_mutex.owned?
@@ -65,13 +66,7 @@ module WaterDrop
               transactional_instrument(:started) { client.begin_transaction }
             end
 
-            result = nil
-            commit = false
-
-            catch(:abort) do
-              result = yield
-              commit = true
-            end
+            result, commit = transactional_execute(&block)
 
             commit || raise(WaterDrop::Errors::AbortTransaction)
 
@@ -82,15 +77,12 @@ module WaterDrop
             result
           # We need to handle any interrupt including critical in order not to have the transaction
           # running. This will also handle things like `IRB::Abort`
-          #
-          # rubocop:disable Lint/RescueException
           rescue Exception => e
             # This code is a bit tricky. We have an error and when it happens we try to rollback
             # the transaction. However we may end up in a state where transaction aborting itself
             # produces error. In such case we also want to handle it as fatal and reload client.
             # This is why we catch this here
             begin
-              # rubocop:enable Lint/RescueException
               with_transactional_error_handling(:abort) do
                 transactional_instrument(:aborted) do
                   client.abort_transaction
@@ -176,6 +168,27 @@ module WaterDrop
         transactional? ? transaction(&block) : yield
       end
 
+      # Executes the requested code in a transaction with error handling and ensures, that upon
+      # early break we rollback the transaction instead of having it dangling and causing an issue
+      # where transactional producer would end up in an error state.
+      def transactional_execute
+        result = nil
+        commit = false
+
+        catch(:abort) do
+          result = yield
+          commit = true
+        end
+
+        [result, commit]
+      rescue Exception => e
+        errored = true
+
+        raise e
+      ensure
+        return [result, commit] unless errored
+      end
+
       # Instruments the transactional operation with producer id
       #
       # @param key [Symbol] transaction operation key

data/lib/waterdrop/version.rb

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

data/waterdrop.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.license       = 'MIT'
 
-  spec.add_dependency 'karafka-core', '>= 2.4.0', '< 3.0.0'
+  spec.add_dependency 'karafka-core', '>= 2.4.3', '< 3.0.0'
   spec.add_dependency 'karafka-rdkafka', '>= 0.15.1'
   spec.add_dependency 'zeitwerk', '~> 2.3'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 2.7.3
+  version: 2.7.4
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-06-09 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka-core
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.4.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -53,7 +53,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.4.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -168,7 +168,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: Kafka messaging made easy!