karafka-rdkafka 0.17.1.beta1 → 0.17.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 192d225abdb3819438f2da32dde41f7940666ee105f51f315ab55cf670e8c3b9
-  data.tar.gz: bc393b0baa8f62980b9acf4d8d993f63cc1f07f9e3c8da54bceb8a76b387849b
+  metadata.gz: f9321c1841f24770f9e375013312c710058066384cdeef25a8e25d5b29d2b869
+  data.tar.gz: 944cd7539a70a2ed8400340e10a3705b34a0aec51d25a666def0f575069027de
 SHA512:
-  metadata.gz: 82476a66a8ae78150ee80122df8d31925afb31ba06bc9cd0467ebf2fa09fcacaaa69f0262e9ff75447461871c29c3db9026cc3adda505cd9b0fe9dd8741f3336
-  data.tar.gz: 86fca73dcffd68a5197276a01cf6366ef4f0ba702656e78209e8666534f76a1bb3f05f5e624f812ed6576255545093b810603be267f2a7653e7005ea42c1ddc0
+  metadata.gz: 04ae1810964a9ae6d96b402c1c52b8a6e506c8d4f7ff97299f5a35f79ce66a5f415aab2156ec037da1fce2e71b4302e72f1c7509acd6358fb52c2c360a0417c1
+  data.tar.gz: aef4f2144adfe02b54c449cfbdf84eabf8f50aab5df180a7afadb7aa7daa22b243ba00f8ce0686daa7da53441b5b0f81d450204f86cf941011014a0d76146edd

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Rdkafka Changelog
 
-## 0.17.1 (Unreleased)
+## 0.17.2 (2024-08-07)
+- [Enhancement] Support returning `#details` for errors that do have topic/partition related extra info.
+
+## 0.17.1 (2024-08-01)
 - [Enhancement] Support ability to release patches to librdkafka.
 - [Patch] Patch cooperative-sticky assignments in librdkafka.
 
@@ -9,6 +12,7 @@
 
 ## 0.16.1 (2024-07-10)
 - [Feature] Add `#seek_by` to be able to seek for a message by topic, partition and offset (zinahia)
+- [Change] Remove old producer timeout API warnings.
 - [Fix] Switch to local release of librdkafka to mitigate its unavailability.
 
 ## 0.16.0 (2024-06-17)

data/README.md

@@ -161,13 +161,14 @@ bundle exec rake produce_messages
 
 ## Versions
 
-| rdkafka-ruby | librdkafka |
-|-|-|
-| 0.17.0 (Unreleased) | 2.5.0 (2024-07-10) |
-| 0.16.0 (2024-06-13) | 2.4.0 (2024-05-07) |
-| 0.15.0 (2023-12-03) | 2.3.0 (2023-10-25) |
-| 0.14.0 (2023-11-21) | 2.2.0 (2023-07-12) |
-| 0.13.0 (2023-07-24) | 2.0.2 (2023-01-20) |
-| 0.12.0 (2022-06-17) | 1.9.0 (2022-06-16) |
-| 0.11.0 (2021-11-17) | 1.8.2 (2021-10-18) |
-| 0.10.0 (2021-09-07) | 1.5.0 (2020-07-20) |
+| rdkafka-ruby | librdkafka | patches |
+|-|-|-|
+| 0.17.0 (2024-08-01) | 2.5.0 (2024-07-10) | yes |
+| 0.17.0 (2024-07-21) | 2.5.0 (2024-07-10) | no  |
+| 0.16.0 (2024-06-13) | 2.4.0 (2024-05-07) | no  |
+| 0.15.0 (2023-12-03) | 2.3.0 (2023-10-25) | no  |
+| 0.14.0 (2023-11-21) | 2.2.0 (2023-07-12) | no  |
+| 0.13.0 (2023-07-24) | 2.0.2 (2023-01-20) | no  |
+| 0.12.0 (2022-06-17) | 1.9.0 (2022-06-16) | no  |
+| 0.11.0 (2021-11-17) | 1.8.2 (2021-10-18) | no  |
+| 0.10.0 (2021-09-07) | 1.5.0 (2020-07-20) | no  |

data/lib/rdkafka/abstract_handle.rb

@@ -16,9 +16,6 @@ module Rdkafka
     REGISTRY = {}
     # Default wait timeout is 31 years
     MAX_WAIT_TIMEOUT_FOREVER = 10_000_000_000
-    # Deprecation message for wait_timeout argument in wait method
-    WAIT_TIMEOUT_DEPRECATION_MESSAGE = "The 'wait_timeout' argument is deprecated and will be removed in future versions without replacement. " \
-      "We don't rely on it's value anymore. Please refactor your code to remove references to it."
 
     private_constant :MAX_WAIT_TIMEOUT_FOREVER
 
@@ -59,16 +56,13 @@ module Rdkafka
     #
     # @param max_wait_timeout [Numeric, nil] Amount of time to wait before timing out.
     #   If this is nil we will wait forever
-    # @param wait_timeout [nil] deprecated
     # @param raise_response_error [Boolean] should we raise error when waiting finishes
     #
     # @return [Object] Operation-specific result
     #
     # @raise [RdkafkaError] When the operation failed
     # @raise [WaitTimeoutError] When the timeout has been reached and the handle is still pending
-    def wait(max_wait_timeout: 60, wait_timeout: nil, raise_response_error: true)
-      Kernel.warn(WAIT_TIMEOUT_DEPRECATION_MESSAGE) unless wait_timeout.nil?
-
+    def wait(max_wait_timeout: 60, raise_response_error: true)
       timeout = max_wait_timeout ? monotonic_now + max_wait_timeout : MAX_WAIT_TIMEOUT_FOREVER
 
       @mutex.synchronize do

data/lib/rdkafka/error.rb

@@ -6,6 +6,9 @@ module Rdkafka
 
   # Error returned by the underlying rdkafka library.
   class RdkafkaError < BaseError
+    # Empty hash for details default allocation
+    EMPTY_HASH = {}.freeze
+
     # The underlying raw error response
     # @return [Integer]
     attr_reader :rdkafka_response
@@ -18,6 +21,10 @@ module Rdkafka
     # @return [String]
     attr_reader :broker_message
 
+    # Optional details hash specific to a given error or empty hash if none or not supported
+    # @return [Hash]
+    attr_reader :details
+
     class << self
       def build_from_c(response_ptr, message_prefix = nil, broker_message: nil)
         code = Rdkafka::Bindings.rd_kafka_error_code(response_ptr)
@@ -54,7 +61,21 @@ module Rdkafka
             message_prefix ||= response_ptr_or_code[:payload].read_string(response_ptr_or_code[:len])
           end
 
-          new(response_ptr_or_code[:err], message_prefix, broker_message: broker_message)
+          details = if response_ptr_or_code[:rkt].null?
+                      EMPTY_HASH
+                    else
+                      {
+                        partition: response_ptr_or_code[:partition],
+                        offset: response_ptr_or_code[:offset],
+                        topic: Bindings.rd_kafka_topic_name(response_ptr_or_code[:rkt])
+                      }.freeze
+                    end
+          new(
+            response_ptr_or_code[:err],
+            message_prefix,
+            broker_message: broker_message,
+            details: details
+          )
         else
           build_from_c(response_ptr_or_code, message_prefix)
         end
@@ -73,7 +94,8 @@ module Rdkafka
       broker_message: nil,
       fatal: false,
       retryable: false,
-      abortable: false
+      abortable: false,
+      details: EMPTY_HASH
     )
       raise TypeError.new("Response has to be an integer") unless response.is_a? Integer
       @rdkafka_response = response
@@ -82,6 +104,7 @@ module Rdkafka
       @fatal = fatal
       @retryable = retryable
       @abortable = abortable
+      @details = details
     end
 
     # This error's code, for example `:partition_eof`, `:msg_size_too_large`.

data/lib/rdkafka/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rdkafka
-  VERSION = "0.17.1.beta1"
+  VERSION = "0.17.2.rc1"
   LIBRDKAFKA_VERSION = "2.5.0"
   LIBRDKAFKA_SOURCE_SHA256 = "3dc62de731fd516dfb1032861d9a580d4d0b5b0856beb0f185d06df8e6c26259"
 end

data/spec/rdkafka/abstract_handle_spec.rb

@@ -80,7 +80,6 @@ describe Rdkafka::AbstractHandle do
       let(:pending_handle) { true }
 
       it "should wait until the timeout and then raise an error" do
-        expect(Kernel).not_to receive(:warn)
         expect {
           subject.wait(max_wait_timeout: 0.1)
         }.to raise_error Rdkafka::AbstractHandle::WaitTimeoutError, /test_operation/
@@ -90,22 +89,15 @@ describe Rdkafka::AbstractHandle do
     context 'when pending_handle false' do
       let(:pending_handle) { false }
 
-      it 'should show a deprecation warning when wait_timeout is set' do
-        expect(Kernel).to receive(:warn).with(Rdkafka::AbstractHandle::WAIT_TIMEOUT_DEPRECATION_MESSAGE)
-        subject.wait(wait_timeout: 0.1)
-      end
-
       context "without error" do
         let(:result) { 1 }
 
         it "should return a result" do
-          expect(Kernel).not_to receive(:warn)
           wait_result = subject.wait
           expect(wait_result).to eq(result)
         end
 
         it "should wait without a timeout" do
-          expect(Kernel).not_to receive(:warn)
           wait_result = subject.wait(max_wait_timeout: nil)
           expect(wait_result).to eq(result)
         end
@@ -115,7 +107,6 @@ describe Rdkafka::AbstractHandle do
         let(:response) { 20 }
 
         it "should raise an rdkafka error" do
-          expect(Kernel).not_to receive(:warn)
           expect {
             subject.wait
           }.to raise_error Rdkafka::RdkafkaError

data/spec/rdkafka/consumer_spec.rb

@@ -1467,4 +1467,39 @@ describe Rdkafka::Consumer do
       end
     end
   end
+
+  describe "when reaching eof on a topic and eof reporting enabled" do
+    let(:consumer) { rdkafka_consumer_config(:"enable.partition.eof" => true).consumer }
+
+    it "should return proper details" do
+      (0..2).each do |i|
+        producer.produce(
+          topic:     "consume_test_topic",
+          key:       "key lag #{i}",
+          partition: i
+        ).wait
+      end
+
+      # Consume to the end
+      consumer.subscribe("consume_test_topic")
+      eof_count = 0
+      eof_error = nil
+
+      loop do
+        begin
+          consumer.poll(100)
+        rescue Rdkafka::RdkafkaError => error
+          if error.is_partition_eof?
+            eof_error = error
+          end
+          break if eof_error
+        end
+      end
+
+      expect(eof_error.code).to eq(:partition_eof)
+      expect(eof_error.details[:topic]).to eq('consume_test_topic')
+      expect(eof_error.details[:partition]).to be_a(Integer)
+      expect(eof_error.details[:offset]).to be_a(Integer)
+    end
+  end
 end

data/spec/rdkafka/error_spec.rb

@@ -11,6 +11,12 @@ describe Rdkafka::RdkafkaError do
     expect(Rdkafka::RdkafkaError.new(10, "message prefix").message_prefix).to eq "message prefix"
   end
 
+  it "should have empty frozen details by default" do
+    error = Rdkafka::RdkafkaError.new(10, "message prefix")
+    expect(error.details).to eq({})
+    expect(error.details).to be_frozen
+  end
+
   it "should create an error with a broker message" do
     expect(Rdkafka::RdkafkaError.new(10, broker_message: "broker message").broker_message).to eq "broker message"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-rdkafka
 version: !ruby/object:Gem::Version
-  version: 0.17.1.beta1
+  version: 0.17.2.rc1
 platform: ruby
 authors:
 - Thijs Cadier
@@ -36,7 +36,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi

metadata.gz.sig

@@ -1,2 +1,4 @@
-�Y3�&���ikAVt���2�ON׿�����������H[U�ǡ���R�홥̈;�0�@7x�}Վٚ��\Xi�?J")��1��vxI�}�궕��5��ڬ��D�M�h�]����*³�}��k
-�C�+���DO��9���sO��K��{nk��ڤ
+68�E�Y��|�).cx�d��ͱL�E>�3���°et9�cU
+@�zn2t�w��H�����T#�����p��9�
+j�
+eצ�Zv�B�L���7f���.�d&��=��1��3�
f�P���y�4[$��7��34pW�������l������n��It���Rg���8�K�5N�İ��f����8é���0���B��������e��e��R����ic9�Le͉w��A�x��c�ˆ�J�)��^���F�PB�#F[�iI[�zrp1�2�CaW-am�BW���d6��s^X�'侠�~�TZ5R1
OP�26���_Ki��p����}�j��T(	��C-)8j�g8