karafka-rdkafka 0.28.0-aarch64-linux-gnu → 0.28.1-aarch64-linux-gnu

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ed54b417d876a61e01603aebf12e29ec1b56a3f43cbae330d19aad1222f86d58
4
- data.tar.gz: a4925b7300fc077003ad5a588964902507a77152cc057e48cbf49beee5966522
3
+ metadata.gz: cb6dd6580bf5c14ddceaa2ccd38deaad34cf4e6e81e994c82df73e62fb831f77
4
+ data.tar.gz: c26f74ea68b3c14ace182f7f8b2da1184cceb59d6063b044a7efb3a84a022eef
5
5
  SHA512:
6
- metadata.gz: 5fe6ad75e784238e3781fe85eaff6bf36fdc2f4b7f5128c167a730d48607d17c10312ce3f5b9cac88ab47d0e841e72a3536cd5739bfa6b7a4c7de23934cec59d
7
- data.tar.gz: 78df953bd672fbf55a97ffa3372b1ccd3e2b8cd19d748d18f159ce5f92298101d40896e3e93721841f8d6e5c0e41f96c71f6503bd80df90760024cdfa853bc2e
6
+ metadata.gz: 6b954711968c6acaa5beffa2995a33262bef8e2297b18eb3d9e828dd0be43818bfa5be73a7a20bfe13a8d19ee08ec4436e38e7b63a69948f3b85b7d06843d5db
7
+ data.tar.gz: f2003f4f608143b78dd9caab59a30d2fd96b5ed1a280ea9d1388cb4d5ff386d26655f2b0b3e15ec16b450b7df23118cfae1f1f99f229139e19243cd6bb7f3d5c
data/CHANGELOG.md CHANGED
@@ -1,43 +1,50 @@
1
1
  # Rdkafka Changelog
2
2
 
3
- ## v0.28.0
3
+ ## v0.28.1 (2026-09-04)
4
+ - [Enhancement] Add `Admin#delete_records`, wrapping librdkafka's `DeleteRecords` admin API. Deletes all messages in a partition up to (but not including) a given offset - accepts an integer offset or `:end` to clear all current data. Ported from rdkafka-ruby (#956).
5
+ - [Enhancement] Add `Admin#list_consumer_groups`, wrapping librdkafka's `ListConsumerGroups` admin API. Returns a cluster-wide listing of consumer groups (`group_id`, `is_simple_consumer_group`, state) plus any per-broker errors. Ported from rdkafka-ruby (#955).
6
+ - [Fix] Make `NativeKafka#close` fork-aware so a forked child no longer segfaults on exit. Handles record their creator pid and skip the native teardown in any other process.
7
+ - [Fix] Stabilize the flaky partitions count cache statistics spec.
8
+ - [Fix] Stabilize the `to_native_tpl` leak integration spec against RSS measurement noise.
9
+
10
+ ## v0.28.0 (2026-07-12)
4
11
  - [Enhancement] Bump librdkafka to `2.14.2`. Maintenance release: fixes duplicate groups in `ListConsumerGroups` when multiple brokers return the same group, a data race in timers, and bumps bundled OpenSSL/libcurl/zstd/zlib/cJSON dependencies (several CVEs).
5
12
  - [Enhancement] Add `Consumer#metadata` and `Producer#metadata`, mirroring `Admin#metadata`, so cluster/topic metadata can be fetched from an existing consumer or producer handle without opening a dedicated admin connection.
6
13
  - [Enhancement] Name the failing partition and topic in the `RdkafkaError` raised for per-partition `list_offsets` errors (previously a bare error code), preserving the per-partition context the pre-batching `Consumer#lag` watermark errors carried.
7
- - [Enhancement] Add `Consumer#list_offsets`, mirroring `Admin#list_offsets`, so batched offset queries (one `ListOffsets` request carrying all requested partitions, fanned out to the partition leaders by librdkafka) can be issued on an existing consumer handle without opening a dedicated admin connection, and rebuild `Consumer#lag` on top of it: lag is now computed from a single batched end-offsets query instead of one blocking `query_watermark_offsets` broker roundtrip per partition. To receive the results, consumer clients now register the librdkafka background event callback, so librdkafka spawns its internally-managed background thread for consumers as well. `Consumer#lag` keeps its exact pre-batching semantics: it forwards the consumer's configured `isolation.level` to the batched query (librdkafka resolves the per-partition watermark query with that level, so end offsets stay LSO-based for the default `read_committed`), surfaces a timeout of the batched query as an `RdkafkaError` (`timed_out`), and now also raises `ClosedConsumerError` when called on a closed consumer.
8
- - [Enhancement] Extract the admin background-event result handlers into one class per operation under `lib/rdkafka/callbacks/` (`CreateTopicHandler`, `DescribeConfigsHandler`, etc., all subclasses of `Callbacks::BaseHandler`). `Callbacks::BackgroundEventCallback` is now a thin dispatcher that maps the event type to its handler and destroys the event. Purely internal reorganization (`Rdkafka::Callbacks` is private) with no behavior or API change.
9
- - [Enhancement] Expose `replicas` and `isrs` (in-sync replica broker ids) on each partition in topic metadata (`Metadata#topics` partition hashes). The base struct `#to_h` skips FFI pointer members, so these two arrays were dropped entirely and the partition replica assignment was unavailable to callers (e.g. for planning replication-factor changes). `PartitionMetadata#to_h` now dereferences both pointers into arrays of broker ids.
10
- - [Enhancement] Reuse per-thread scratch pointers in `Consumer::Headers.from_native` instead of allocating them for every consumed message. Previously each message paid one native pointer allocation just to check for headers and three more when headers were present; now the scratch pointers are allocated once per thread/fiber and reused, removing all per-message native scratch allocations from the consumer hot path.
11
- - [Enhancement] Remove the unused `DeliveryHandle` `:topic_name` struct field and the per-message allocation that populated it. The delivery callback copied the topic name into a native `FFI::MemoryPointer` on every delivered message, retained for the lifetime of the handle, yet nothing ever read it: the topic is already available via `DeliveryHandle#topic` (a Ruby attribute set during `produce`) and `DeliveryReport#topic_name`, both of which work exactly as before.
12
- - [Fix] Stop `poll_batch`/`poll_batch_nb` from discarding a whole batch when one message fails to build. If building a `Consumer::Message` raised (e.g. a header-read `RdkafkaError`), the exception propagated out of the batch loop and the `ensure` destroyed every remaining message, so all the messages already built in that batch were lost even though their offsets had been stored - permanent silent loss of up to `max_items` messages. A per-message build error is now surfaced inline as an `RdkafkaError` in the returned array (the same way native error events already are), so the rest of the batch is preserved and the failure is visible to the caller. (Single-message `poll`/`poll_nb` still raise as before.)
13
- - [Fix] Add the missing `closed_consumer_check` to `Consumer#position`. Every sibling offset method guards against a closed consumer, but `position` did not: with an explicit `list` it raised `ClosedInnerError` instead of `ClosedConsumerError`, and with no `list` it raised `ClosedConsumerError` naming `assignment` rather than `position`. It now raises a consistent `ClosedConsumerError` for `position`.
14
- - [Fix] Stop leaking the native `rd_kafka_topic_conf_t` in `Producer#set_topic_config` when a per-topic config value is rejected. The conf is built with `rd_kafka_topic_conf_new` and only handed to `rd_kafka_topic_new` afterwards; if `rd_kafka_topic_conf_set` returned a non-`:config_ok` result the method raised before `rd_kafka_topic_new` was ever called, so librdkafka never took ownership of the conf and it leaked (repeatable per produce with an invalid `topic_config:`). The conf is now destroyed before raising. The `rd_kafka_topic_new` path is unchanged: librdkafka frees the conf there on both success and failure, so it is never destroyed by us.
15
- - [Fix] Raise instead of silently dropping a rejected `incremental_alter_configs` entry. `rd_kafka_ConfigResource_add_incremental_config` returns an `rd_kafka_error_t` for an invalid op_type, an empty/nil name, or a nil value on a non-delete op; the result was ignored, so the entry was dropped, the alter request still reported success, and the error object leaked. The error is now surfaced as an `RdkafkaError` (raised before the request is sent) and the native error object is freed.
16
- - [Fix] Let `PartitionsCountCache` adopt a lower partition count once the cached entry has expired. The cache prioritizes higher counts (partition counts only grow during normal operation), but it did so unconditionally: after the TTL expired it fetched the true lower count, discarded it, and re-armed the TTL on the stale higher count - permanently. A topic recreated with fewer partitions then made `produce` (with a partition key) fail with `unknown_partition` for the dropped partitions until process restart. A lower value is now adopted on the first refresh after expiry, while still being ignored within the TTL window so a transient or racy lower read cannot clobber a correct higher count.
17
- - [Fix] Make the `Consumer` GC finalizer close the consumer and destroy its consumer queue, not just the native client. The finalizer used the generic `NativeKafka` one, which went straight to `rd_kafka_destroy` and skipped `rd_kafka_consumer_close` and `rd_kafka_queue_destroy`. A consumer that used `poll_batch` (which takes a consumer-queue reference) and was then garbage-collected without an explicit `close` left that reference dangling, which could make `rd_kafka_destroy` block inside the finalizer (process hang at GC/shutdown) or leak the handle. The consumer now installs its own finalizer that mirrors `#close` (the queue pointer is shared with the finalizer via a holder so it never captures the consumer and prevents collection).
18
- - [Fix] Stop admin operations from leaking when their arguments are rejected. `describe_configs` and `incremental_alter_configs` allocated the background queue and AdminOptions and registered their handle before parsing input, so a missing key raised a `KeyError` out of the building loop that orphaned the handle in the process-global registry forever (and leaked the queue, AdminOptions and any `ConfigResource`s already built); `list_offsets` likewise allocated its native topic-partition list before validating the offset specs. All three now parse and validate input up front, so a bad argument raises with nothing allocated.
19
- - [Fix] Destroy the native topic-partition list in `TopicPartitionList#to_native_tpl` when population fails partway. The list is allocated with `rd_kafka_topic_partition_list_new` and only handed back (for the caller to destroy) on success; if building it raised - e.g. a non-string metadata value or an offset FFI cannot coerce to int64 - the half-built list leaked, since destruction is fully manual (the previous doc comment claiming GC handled it was wrong). It is now destroyed before the error propagates.
20
- - [Fix] Allocate the admin result-count out-parameter as `:size_t` instead of `:int32`. Every librdkafka `rd_kafka_*_result_*(result, size_t *cntp)` accessor writes a full native `size_t` (8 bytes on 64-bit), but the count pointer was a 4-byte `FFI::MemoryPointer.new(:int32)` across the create/delete topic, create partitions, create/delete ACL, describe/incremental-alter configs and config-synonyms paths - a 4-byte heap overflow on every admin result parse (benign on little-endian, where the low word still reads the correct count, but undefined behavior). Now uses `:size_t`, matching the already-correct list-offsets and `get_err_descs` paths.
21
- - [Fix] Destroy admin API background events after processing. librdkafka requires the application to destroy each background event, but `rd_kafka_event_destroy` was never called (nor even bound), so every admin operation leaked its entire result event with all result arrays and strings. Reports are now built inside the callback (copying event-owned memory into Ruby objects) before the event is destroyed, and `DescribeConfigsReport`/`IncrementalAlterConfigsReport` no longer destroy the event-owned ConfigResource array, which also fixes a double free on repeated `wait` calls on the same handle. As part of this, the internal FFI struct fields on admin operation handles (e.g. `handle[:error_string]`, `handle[:result_name]`, `handle[:config_entries]`, `handle[:response_string]`, `handle[:matching_acls]`) were removed; they were never part of the public API (use `handle.wait` and the returned report objects, whose interfaces are unchanged).
22
- - [Fix] Resolve admin operation handles from the event error when an admin operation fails at the operation level (e.g. brokers unreachable, or the client closed with the request in flight). librdkafka delivers such failures as a result event with the error set and an empty results array, but the create topic, delete topic, create partitions, delete groups, create ACL and delete ACL handlers indexed `results[0]` unconditionally. That raised inside the background event callback, so the handle was never unlocked and `wait` blocked until its own timeout and raised `WaitTimeoutError`, discarding the real error. These handlers now check the event error first and resolve the handle with the actual error code (the describe configs, incremental alter configs, describe ACL and list offsets handlers already did).
23
- - [Fix] Stop leaking the native `rd_kafka_conf_t` when client creation fails. `native_config` raised `ConfigError` mid-build (e.g. on an invalid option) without destroying the conf, and `native_kafka` raised `ClientCreationError` on a null `rd_kafka_new` without destroying it either. Both paths now call `rd_kafka_conf_destroy` before re-raising (librdkafka keeps app ownership of the conf on `rd_kafka_new` failure, so this is safe). Multi-KB leak per failed creation, relevant for supervisors retrying client creation on transient SASL/SSL misconfig.
24
- - [Fix] Stop `Metadata` from leaking the native metadata struct (and a topic reference) on every retried fetch. `retry` restarts the `begin` block without running its `ensure`, so each retried attempt reassigned the pointers and only the last attempt's `rd_kafka_metadata` struct was ever destroyed; up to `METADATA_MAX_RETRIES` whole-cluster structs leaked per call (the `leader_not_available` case is routine during topic creation/leader election). Each attempt now frees its own native resources, and a failed fetch that never allocated a struct no longer calls `rd_kafka_metadata_destroy` on a NULL pointer.
25
- - [Fix] Free the librdkafka-allocated string in `Consumer#cluster_id` and `Consumer#member_id` (previously copied via a `:string` binding but never freed) and fix the `rd_kafka_clusterid` arity to pass `timeout_ms`. `Consumer#cluster_id` now accepts a `timeout_ms` (default `Defaults::CONSUMER_CLUSTER_ID_TIMEOUT_MS`).
26
- - [Fix] Guard the message delivery callback so a raising user `delivery_callback` can no longer skip the handle unlock or crash the producer. `DeliveryCallback` invoked the user callback and only then unlocked the handle, with no rescue; if the callback raised, the handle stayed pending (so `wait` blocked until its timeout and raised `WaitTimeoutError` for a message that was actually delivered) and the exception unwound out of the FFI callback on librdkafka's polling thread (`abort_on_exception = true`), taking down the whole process. The user callback is now wrapped so exceptions are logged and swallowed (matching the rebalance callback) and the handle is always unlocked in an `ensure`.
27
- - [Fix] Stop `Producer#produce` from orphaning the delivery handle in the process-global registry when it fails after registering it. The handle was only removed on a non-zero `rd_kafka_producev` return, so any exception between registration and that check (a concurrent `close` making `with_inner` raise `ClosedInnerError`, or a header value whose `#to_s` raises) leaked the handle forever - it survives producer close and accumulates in apps that recreate/close producers. `produce` now removes the handle on any such failure before re-raising.
28
- - [Fix] Attach `rd_kafka_query_watermark_offsets` with `blocking: true` so it releases the GVL during its broker round-trip. It was the only synchronous network call bound without the flag, so `Consumer#query_watermark_offsets` (and `Consumer#lag`, which calls it once per partition) froze every other Ruby thread in the process - including producer polling threads - for up to `timeout_ms`. Matches the neighboring `rd_kafka_offsets_for_times` binding.
29
- - [Fix] Stabilize the flaky `Consumer#lag` "calculates the consumer lag" spec on overloaded CI. The manual `consumer.commit` could raise `no_offset` when the default 5s background auto-commit had already committed the stored offsets, or when the auto offset store had not yet caught up with `poll`. The spec now raises `auto.commit.interval.ms` to 60s (matching the existing `#seek`/pause specs) and lets the offset store settle before committing. Backported from rdkafka-ruby (#912).
30
- - [Fix] Fix the NULL background-queue cleanup branches in `Admin#delete_group`, `Admin#delete_acl` and `Admin#describe_acl`, which referenced undefined local variables (`delete_topic_ptr`/`new_acl_ptr`). When `rd_kafka_queue_get_background` returned NULL, those branches raised a `NameError` instead of the intended `ConfigError` and leaked the already-allocated native request object (the `rd_kafka_DeleteGroup_t` / ACL binding filter), and `delete_group` additionally called the wrong destructor. They now destroy the correct object and raise `ConfigError`.
31
- - [Fix] Forward `broker_message` and `instance_name` through `RdkafkaError.build`. On the `rd_kafka_error_t` pointer path `build` called `build_from_c` without passing either, so a caller-supplied broker message was discarded (falling back to `rd_kafka_err2str`) and the instance name was lost; the `Bindings::Message` path also dropped `instance_name`. Both are now forwarded, and `build_from_c` accepts `instance_name`.
32
- - [Fix] Synchronize `AbstractHandle::REGISTRY` mutations. The handle registry is a plain Hash mutated from producing/consuming threads and the background polling thread (which removes handles from FFI callbacks). That is effectively safe on MRI under the GVL but not on JRuby, where a lost write could leave a handle unregistered (never unlocked, so `wait` times out for a delivered message) or never removed (permanent leak). `register`/`remove` now guard the Hash with a mutex.
33
- - [Fix] Stop the `Metadata` retry loop from clobbering the request timeout and blocking for minutes. Each retry overwrote the per-request timeout with the exponential backoff value, so the first retries ran with a far-too-short request timeout (e.g. 200ms vs the 2,000ms default, near-guaranteeing another timeout) while later ones inflated it to ~100s; the cumulative sleeps alone reached ~204s. The request timeout is now left unchanged across retries, the per-attempt backoff is capped at `Defaults::METADATA_RETRY_BACKOFF_MAX_MS` (1,000ms), and the loop is bounded by a wall-clock budget (`Defaults::METADATA_RETRY_BUDGET_MS`, 5,000ms) after a floor of `Defaults::METADATA_MIN_ATTEMPTS` (3) tries. This keeps a synchronous metadata fetch from blocking for minutes while still giving a slow broker a few attempts: fast-recovering clusters retry quickly within the budget, an unresponsive one fails in ~5s (a bit over if its requests each consume the full timeout), and at least 3 attempts always happen.
34
- - [Fix] Cache the partition count for a missing topic so `produce` with a `partition_key` to a not-yet-created topic no longer runs a blocking metadata query on every message. The `unknown_topic_or_part` result was resolved to `RD_KAFKA_PARTITION_UA` outside the partition-count cache, so nothing was stored and each call performed a fresh synchronous metadata RPC (the promised negative cache did not exist). The miss is now resolved inside the cache block, so it is cached like any other value and reused for the cache TTL.
14
+ - [Enhancement] Add `Consumer#list_offsets`, mirroring `Admin#list_offsets`, so offsets can be queried on an existing consumer handle without a dedicated admin connection, and rebuild `Consumer#lag` on top of it as one batched query instead of a roundtrip per partition.
15
+ - [Enhancement] Extract the admin background-event result handlers into one class per operation under `lib/rdkafka/callbacks/`. Internal reorganization with no API or behavior change.
16
+ - [Enhancement] Expose `replicas` and `isrs` (in-sync replica broker ids) on each partition in topic metadata; both were previously dropped from the `Metadata#topics` partition hashes.
17
+ - [Enhancement] Reuse per-thread scratch pointers in `Consumer::Headers.from_native`, removing the per-message native allocations from the consumer hot path.
18
+ - [Enhancement] Remove the unused `DeliveryHandle` `:topic_name` struct field and its per-message allocation. Use `DeliveryHandle#topic` or `DeliveryReport#topic_name`, both unchanged.
19
+ - [Fix] Stop `poll_batch`/`poll_batch_nb` from discarding a whole batch when one message fails to build. The failure is now surfaced inline as an `RdkafkaError` in the returned array, preserving the rest of the batch.
20
+ - [Fix] Add the missing `closed_consumer_check` to `Consumer#position`, so it raises a consistent `ClosedConsumerError` like every sibling offset method.
21
+ - [Fix] Stop leaking the native `rd_kafka_topic_conf_t` in `Producer#set_topic_config` when a per-topic config value is rejected.
22
+ - [Fix] Raise instead of silently dropping a rejected `incremental_alter_configs` entry, which previously left the alter request reporting success.
23
+ - [Fix] Let `PartitionsCountCache` adopt a lower partition count once the cached entry has expired, so a topic recreated with fewer partitions no longer fails `produce` until process restart.
24
+ - [Fix] Make the `Consumer` GC finalizer close the consumer and destroy its consumer queue, not just the native client, preventing a hang or leak when a consumer is collected without an explicit `close`.
25
+ - [Fix] Stop `describe_configs`, `incremental_alter_configs` and `list_offsets` from leaking handles and native resources when their arguments are rejected; all three now validate input before allocating.
26
+ - [Fix] Destroy the native topic-partition list in `TopicPartitionList#to_native_tpl` when population fails partway, which previously leaked the half-built list.
27
+ - [Fix] Allocate the admin result-count out-parameter as `:size_t` instead of `:int32`, fixing a 4-byte overflow on every admin result parse.
28
+ - [Fix] Destroy admin API background events after processing; they were never destroyed, so every admin operation leaked its whole result event. The internal FFI struct fields on admin handles were removed as part of this - use `handle.wait` and the returned report objects, whose interfaces are unchanged.
29
+ - [Fix] Resolve admin operation handles from the event error when an operation fails at the operation level (e.g. brokers unreachable), instead of blocking until `wait` timed out and discarding the real error.
30
+ - [Fix] Stop leaking the native `rd_kafka_conf_t` when client creation fails, a multi-KB leak per failed attempt for supervisors retrying on transient SASL/SSL misconfiguration.
31
+ - [Fix] Stop `Metadata` from leaking the native metadata struct on every retried fetch; each attempt now frees its own native resources.
32
+ - [Fix] Free the librdkafka-allocated string in `Consumer#cluster_id` and `Consumer#member_id`, and fix the `rd_kafka_clusterid` arity. `Consumer#cluster_id` now accepts a `timeout_ms`.
33
+ - [Fix] Guard the message delivery callback so a raising user `delivery_callback` can no longer leave the handle locked or crash the producer; exceptions are now logged and swallowed.
34
+ - [Fix] Stop `Producer#produce` from orphaning the delivery handle in the process-global registry when it fails after registering it.
35
+ - [Fix] Attach `rd_kafka_query_watermark_offsets` with `blocking: true` so it releases the GVL; it previously froze every other Ruby thread for up to `timeout_ms`.
36
+ - [Fix] Stabilize the flaky `Consumer#lag` spec on overloaded CI. Backported from rdkafka-ruby (#912).
37
+ - [Fix] Fix the NULL background-queue cleanup branches in `Admin#delete_group`, `Admin#delete_acl` and `Admin#describe_acl`, which raised a `NameError` and leaked the native request object instead of raising `ConfigError`.
38
+ - [Fix] Forward `broker_message` and `instance_name` through `RdkafkaError.build`; both were previously discarded on the `rd_kafka_error_t` pointer path.
39
+ - [Fix] Synchronize `AbstractHandle::REGISTRY` mutations with a mutex, which could otherwise lose a write on JRuby and leave a handle unregistered or leaked.
40
+ - [Fix] Stop the `Metadata` retry loop from clobbering the request timeout and blocking for minutes. The request timeout is left unchanged across retries, the backoff is capped, and the loop is bounded by a ~5s wall-clock budget after a floor of 3 attempts.
41
+ - [Fix] Cache the partition count for a missing topic, so `produce` with a `partition_key` to a not-yet-created topic no longer runs a blocking metadata query on every message.
35
42
 
36
43
  ## 0.27.2 (2026-05-21)
37
44
  - [Enhancement] `poll_batch` and `poll_batch_nb` now return error events inline as `RdkafkaError` objects rather than raising on the first error. The return type is `Array<Message, RdkafkaError>` and callers are responsible for handling errors in the result.
38
45
 
39
46
  ## 0.27.1 (2026-05-14)
40
- - [Fix] `poll_nb`, `poll_nb_each`, `poll_batch`, and `poll_batch_nb` now raise `RdkafkaError` with `details` populated (`{topic:, partition:, offset:}`) when a message contains an error (e.g. `:partition_eof`). Previously these methods raised via `RdkafkaError.new(code)`, discarding the native message struct context. They now use `RdkafkaError.validate!(native_message, client_ptr: inner)`, consistent with `poll`.
47
+ - [Fix] `poll_nb`, `poll_nb_each`, `poll_batch` and `poll_batch_nb` now raise `RdkafkaError` with `details` populated (`{topic:, partition:, offset:}`) when a message contains an error, consistent with `poll`.
41
48
 
42
49
  ## 0.27.0 (2026-05-08)
43
50
  - [Feature] Add `Consumer#poll_batch(timeout_ms, max_items:)` and `Consumer#poll_batch_nb(timeout_ms, max_items:)` for batch message polling via `rd_kafka_consume_batch_queue` (from upstream).
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Karafka-Rdkafka
2
2
 
3
- [![Build Status](https://github.com/karafka/karafka-rdkafka/actions/workflows/ci_linux_ubuntu_x86_64_gnu.yml/badge.svg)](https://github.com/karafka/karafka-rdkafka/actions/workflows/ci_linux_x86_64_gnu.yml)
3
+ [![Build Status](https://github.com/karafka/karafka-rdkafka/actions/workflows/ci_linux_ubuntu_x86_64_gnu.yml/badge.svg)](https://github.com/karafka/karafka-rdkafka/actions/workflows/ci_linux_ubuntu_x86_64_gnu.yml)
4
4
  [![Gem Version](https://badge.fury.io/rb/karafka-rdkafka.svg)](https://badge.fury.io/rb/karafka-rdkafka)
5
5
  [![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
6
6
 
@@ -61,14 +61,14 @@ Contributions should generally be made to the upstream [rdkafka-ruby repository]
61
61
 
62
62
  ## Versions
63
63
 
64
- | rdkafka-ruby | librdkafka | patches |
64
+ | karafka-rdkafka | librdkafka | patches |
65
65
  |-|-|-|
66
66
  | 0.28.x (2026-07-12) | 2.14.2 (2026-06-03) | yes |
67
67
  | 0.27.x (2026-05-08) | 2.14.1 (2026-04-15) | yes |
68
68
  | 0.26.x (2026-04-11) | 2.14.0 (2026-04-01) | yes |
69
69
  | 0.25.x (2026-04-02) | 2.13.2 (2026-03-02) | yes |
70
70
  | 0.24.x (2026-02-25) | 2.13.0 (2026-01-05) | yes |
71
- | 0.23.x (2025-11-01) | 2.12.1 (2025-10-16) | yes |
71
+ | 0.23.x (2025-11-01) | 2.12.1 (2025-10-21) | yes |
72
72
  | 0.22.x (2025-09-26) | 2.11.1 (2025-08-18) | yes |
73
73
  | 0.21.x (2025-08-18) | 2.11.0 (2025-07-03) | yes |
74
74
  | 0.20.x (2025-07-17) | 2.8.0 (2025-01-07) | yes |
data/ext/librdkafka.so CHANGED
Binary file
@@ -4,7 +4,8 @@ module Rdkafka
4
4
  class Admin
5
5
  # Report for create ACL operation result
6
6
  class CreateAclReport
7
- # Upon successful creation of Acl RD_KAFKA_RESP_ERR_NO_ERROR - 0 is returned as rdkafka_response
7
+ # Upon successful creation of Acl RD_KAFKA_RESP_ERR_NO_ERROR - 0 is returned as
8
+ # rdkafka_response
8
9
  # @return [Integer]
9
10
  attr_reader :rdkafka_response
10
11
 
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Handle for delete records operation
6
+ class DeleteRecordsHandle < AbstractHandle
7
+ layout :pending, :bool,
8
+ :response, :int
9
+
10
+ # @return [String] the name of the operation
11
+ def operation_name
12
+ "delete records"
13
+ end
14
+
15
+ # @return [DeleteRecordsReport] report prepared by the background event callback, with the
16
+ # post-deletion low-watermark offsets (or per-partition errors)
17
+ def create_result
18
+ prepared_result
19
+ end
20
+
21
+ # Raises an error if the operation failed
22
+ # @raise [RdkafkaError]
23
+ def raise_error
24
+ raise RdkafkaError.new(
25
+ self[:response],
26
+ broker_message: broker_message
27
+ )
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Report for delete records operation result
6
+ class DeleteRecordsReport
7
+ # Per-partition results. Each partition's `offset` is the post-deletion low-watermark (the
8
+ # smallest available offset of all live replicas) and its `err` carries the per-partition
9
+ # error code, if deletion failed for that partition.
10
+ # @return [Rdkafka::Consumer::TopicPartitionList]
11
+ attr_reader :offsets
12
+
13
+ # @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_DeleteRecords_result_t`
14
+ def initialize(result_ptr)
15
+ @offsets = Rdkafka::Consumer::TopicPartitionList.new
16
+
17
+ return if result_ptr.null?
18
+
19
+ native_tpl = Bindings.rd_kafka_DeleteRecords_result_offsets(result_ptr)
20
+
21
+ @offsets = Rdkafka::Consumer::TopicPartitionList.from_native_tpl(native_tpl)
22
+ end
23
+ end
24
+ end
25
+ end
@@ -4,7 +4,8 @@ module Rdkafka
4
4
  class Admin
5
5
  # Report for describe ACL operation result
6
6
  class DescribeAclReport
7
- # acls that exists in the cluster for the resource_type, resource_name and pattern_type filters provided in the request.
7
+ # acls that exists in the cluster for the resource_type, resource_name and pattern_type
8
+ # filters provided in the request.
8
9
  # @return [Rdkafka::Bindings::AclBindingResult] array of matching acls.
9
10
  attr_reader :acls
10
11
 
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Handle for list consumer groups operation
6
+ class ListConsumerGroupsHandle < AbstractHandle
7
+ layout :pending, :bool,
8
+ :response, :int
9
+
10
+ # @return [String] the name of the operation
11
+ def operation_name
12
+ "list consumer groups"
13
+ end
14
+
15
+ # @return [ListConsumerGroupsReport] report prepared by the background event callback, with
16
+ # the listed consumer groups.
17
+ def create_result
18
+ prepared_result
19
+ end
20
+
21
+ # Raises an error if the operation failed
22
+ # @raise [RdkafkaError]
23
+ def raise_error
24
+ raise RdkafkaError.new(
25
+ self[:response],
26
+ broker_message: broker_message
27
+ )
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Report for list consumer groups operation result
6
+ class ListConsumerGroupsReport
7
+ # Consumer groups listed cluster-wide. Each entry is a hash with:
8
+ # - `:group_id` [String] the consumer group id
9
+ # - `:is_simple_consumer_group` [Boolean] `true` for a "simple" consumer group - one that
10
+ # assigns partitions manually (via `assign`) and uses Kafka only for offset storage,
11
+ # rather than joining the group-management protocol and letting Kafka assign partitions
12
+ # and rebalance automatically (`subscribe`). Simple groups have no members from the
13
+ # broker's point of view, so they never rebalance.
14
+ # - `:state` [Integer] the group state as a `Bindings::RD_KAFKA_CONSUMER_GROUP_STATE_*`
15
+ # code, one of: `RD_KAFKA_CONSUMER_GROUP_STATE_UNKNOWN`,
16
+ # `RD_KAFKA_CONSUMER_GROUP_STATE_PREPARING_REBALANCE`,
17
+ # `RD_KAFKA_CONSUMER_GROUP_STATE_COMPLETING_REBALANCE`,
18
+ # `RD_KAFKA_CONSUMER_GROUP_STATE_STABLE`, `RD_KAFKA_CONSUMER_GROUP_STATE_DEAD`,
19
+ # `RD_KAFKA_CONSUMER_GROUP_STATE_EMPTY`
20
+ # - `:state_name` [String] human-readable name of that state (e.g. `"Stable"`, `"Empty"`)
21
+ # @return [Array<Hash>]
22
+ attr_reader :groups
23
+
24
+ # Per-broker errors reported alongside the (partial) group listing. `ListConsumerGroups`
25
+ # fans out to every broker and returns valid groups and errors separately, so a broker
26
+ # being unreachable does not discard the groups the reachable brokers returned.
27
+ # @return [Array<RdkafkaError>]
28
+ attr_reader :errors
29
+
30
+ # @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_ListConsumerGroups_result_t`
31
+ def initialize(result_ptr)
32
+ @groups = []
33
+ @errors = []
34
+
35
+ return if result_ptr.null?
36
+
37
+ extract_groups(result_ptr)
38
+ extract_errors(result_ptr)
39
+ end
40
+
41
+ private
42
+
43
+ # @param result_ptr [FFI::Pointer] pointer to the result
44
+ def extract_groups(result_ptr)
45
+ count_ptr = FFI::MemoryPointer.new(:size_t)
46
+ array_ptr = Bindings.rd_kafka_ListConsumerGroups_result_valid(result_ptr, count_ptr)
47
+
48
+ return if array_ptr.null?
49
+
50
+ array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).each do |listing_ptr|
51
+ state = Bindings.rd_kafka_ConsumerGroupListing_state(listing_ptr)
52
+ group_id_ptr = Bindings.rd_kafka_ConsumerGroupListing_group_id(listing_ptr)
53
+ state_name_ptr = Bindings.rd_kafka_consumer_group_state_name(state)
54
+
55
+ @groups << {
56
+ group_id: group_id_ptr.null? ? nil : group_id_ptr.read_string,
57
+ is_simple_consumer_group:
58
+ Bindings.rd_kafka_ConsumerGroupListing_is_simple_consumer_group(listing_ptr) != 0,
59
+ state: state,
60
+ state_name: state_name_ptr.null? ? nil : state_name_ptr.read_string
61
+ }
62
+ end
63
+ end
64
+
65
+ # @param result_ptr [FFI::Pointer] pointer to the result
66
+ def extract_errors(result_ptr)
67
+ count_ptr = FFI::MemoryPointer.new(:size_t)
68
+ array_ptr = Bindings.rd_kafka_ListConsumerGroups_result_errors(result_ptr, count_ptr)
69
+
70
+ return if array_ptr.null?
71
+
72
+ array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).each do |error_ptr|
73
+ string_ptr = Bindings.rd_kafka_error_string(error_ptr)
74
+
75
+ @errors << RdkafkaError.new(
76
+ Bindings.rd_kafka_error_code(error_ptr),
77
+ broker_message: string_ptr.null? ? nil : string_ptr.read_string
78
+ )
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end
data/lib/rdkafka/admin.rb CHANGED
@@ -108,10 +108,6 @@ module Rdkafka
108
108
  # @return [nil]
109
109
  # @raise [Rdkafka::ClosedAdminError] if called on a closed admin client
110
110
  #
111
- # @note This method holds the inner lock until the queue is empty or `:stop` is returned.
112
- # Other admin operations will wait until this method returns.
113
- # @note This method is thread-safe as it uses @native_kafka.with_inner synchronization
114
- #
115
111
  # @example Drain all pending events
116
112
  # admin.events_poll_nb_each { |_count| }
117
113
  #
@@ -120,6 +116,9 @@ module Rdkafka
120
116
  # admin.events_poll_nb_each do |_count|
121
117
  # :stop if monotonic_now >= deadline
122
118
  # end
119
+ # @note This method holds the inner lock until the queue is empty or `:stop` is returned.
120
+ # Other admin operations will wait until this method returns.
121
+ # @note This method is thread-safe as it uses @native_kafka.with_inner synchronization
123
122
  def events_poll_nb_each
124
123
  closed_admin_check(__method__)
125
124
 
@@ -283,6 +282,172 @@ module Rdkafka
283
282
  delete_groups_handle
284
283
  end
285
284
 
285
+ # Deletes all messages in the given partitions up to (but not including) the given offset.
286
+ #
287
+ # The programmatic equivalent of `kafka-delete-records.sh`. Useful for GDPR/right-to-erasure
288
+ # compliance, clearing out poison messages, or retention cleanup outside of the configured
289
+ # time/size-based retention policy.
290
+ #
291
+ # @param topic_partition_offsets [Hash{String => Array<Hash>}] hash mapping topic names to
292
+ # arrays of partition delete specifications. Each specification is a hash with:
293
+ # - `:partition` [Integer] partition number
294
+ # - `:offset` [Symbol, Integer] delete all messages before this offset (exclusive) - an
295
+ # integer offset, or `:end` to delete all data currently in the partition
296
+ #
297
+ # @return [DeleteRecordsHandle] handle that can be used to wait for the result
298
+ # @raise [RdkafkaError] when deleting records fails
299
+ #
300
+ # @example Delete all messages before offset 100 in one partition, and all data in another
301
+ # report = admin.delete_records(
302
+ # "my_topic" => [
303
+ # { partition: 0, offset: 100 },
304
+ # { partition: 1, offset: :end }
305
+ # ]
306
+ # ).wait(max_wait_timeout_ms: 15_000)
307
+ #
308
+ # report.offsets.to_h
309
+ # # => { "my_topic" => [#<Partition @partition=0, @offset=100, @err=0>, ...] }
310
+ def delete_records(topic_partition_offsets)
311
+ closed_admin_check(__method__)
312
+
313
+ parsed = topic_partition_offsets.flat_map do |topic, partitions|
314
+ partitions.map do |spec|
315
+ offset = spec.fetch(:offset)
316
+
317
+ native_offset = case offset
318
+ when :end then Rdkafka::Bindings::RD_KAFKA_OFFSET_END
319
+ when Integer then offset
320
+ else
321
+ raise ArgumentError, "Unknown offset specification: #{offset.inspect}"
322
+ end
323
+
324
+ [topic, spec.fetch(:partition), native_offset]
325
+ end
326
+ end
327
+
328
+ tpl = Rdkafka::Bindings.rd_kafka_topic_partition_list_new(parsed.size)
329
+
330
+ parsed.each do |topic, partition, native_offset|
331
+ Rdkafka::Bindings.rd_kafka_topic_partition_list_add(tpl, topic, partition)
332
+ Rdkafka::Bindings.rd_kafka_topic_partition_list_set_offset(tpl, topic, partition, native_offset)
333
+ end
334
+
335
+ # rd_kafka_DeleteRecords_new copies the tpl it is given, so it does not need to (and must
336
+ # not) outlive this call - it is destroyed below, independently of the wrapping
337
+ # DeleteRecords_t object.
338
+ delete_records_ptr = Rdkafka::Bindings.rd_kafka_DeleteRecords_new(tpl)
339
+ Rdkafka::Bindings.rd_kafka_topic_partition_list_destroy(tpl)
340
+
341
+ pointer_array = [delete_records_ptr]
342
+ records_array_ptr = FFI::MemoryPointer.new(:pointer)
343
+ records_array_ptr.write_array_of_pointer(pointer_array)
344
+
345
+ # Get a pointer to the queue that our request will be enqueued on
346
+ queue_ptr = @native_kafka.with_inner do |inner|
347
+ Rdkafka::Bindings.rd_kafka_queue_get_background(inner)
348
+ end
349
+ if queue_ptr.null?
350
+ Rdkafka::Bindings.rd_kafka_DeleteRecords_destroy(delete_records_ptr)
351
+ raise Rdkafka::Config::ConfigError.new("rd_kafka_queue_get_background was NULL")
352
+ end
353
+
354
+ # Create and register the handle we will return to the caller
355
+ handle = DeleteRecordsHandle.new
356
+ handle[:pending] = true
357
+ handle[:response] = Rdkafka::Bindings::RD_KAFKA_PARTITION_UA
358
+ DeleteRecordsHandle.register(handle)
359
+
360
+ admin_options_ptr = @native_kafka.with_inner do |inner|
361
+ Rdkafka::Bindings.rd_kafka_AdminOptions_new(inner, Rdkafka::Bindings::RD_KAFKA_ADMIN_OP_DELETERECORDS)
362
+ end
363
+ Rdkafka::Bindings.rd_kafka_AdminOptions_set_opaque(admin_options_ptr, handle.to_ptr)
364
+
365
+ begin
366
+ @native_kafka.with_inner do |inner|
367
+ Rdkafka::Bindings.rd_kafka_DeleteRecords(
368
+ inner,
369
+ records_array_ptr,
370
+ 1,
371
+ admin_options_ptr,
372
+ queue_ptr
373
+ )
374
+ end
375
+ rescue Exception
376
+ DeleteRecordsHandle.remove(handle.to_ptr.address)
377
+ raise
378
+ ensure
379
+ Rdkafka::Bindings.rd_kafka_AdminOptions_destroy(admin_options_ptr)
380
+ Rdkafka::Bindings.rd_kafka_queue_destroy(queue_ptr)
381
+ Rdkafka::Bindings.rd_kafka_DeleteRecords_destroy(delete_records_ptr)
382
+ end
383
+
384
+ handle
385
+ end
386
+
387
+ # Lists consumer groups cluster-wide.
388
+ #
389
+ # librdkafka issues a single `ListConsumerGroups` request that is fanned out to every broker
390
+ # internally, so the result covers all consumer groups in the cluster, not only those
391
+ # coordinated by the connected broker.
392
+ #
393
+ # @return [ListConsumerGroupsHandle] handle that can be used to wait for the result
394
+ # @raise [RdkafkaError] when listing the consumer groups fails
395
+ #
396
+ # @example List every consumer group in the cluster and print its name and attributes
397
+ # report = admin.list_consumer_groups.wait(max_wait_timeout_ms: 15_000)
398
+ #
399
+ # report.groups.each do |group|
400
+ # puts "#{group[:group_id]} - #{group[:state_name]} " \
401
+ # "(simple: #{group[:is_simple_consumer_group]})"
402
+ # end
403
+ #
404
+ # # Any brokers that could not be reached are reported separately
405
+ # report.errors.each { |error| warn "partial listing error: #{error.message}" }
406
+ def list_consumer_groups
407
+ closed_admin_check(__method__)
408
+
409
+ # Get a pointer to the queue that our request will be enqueued on
410
+ queue_ptr = @native_kafka.with_inner do |inner|
411
+ Rdkafka::Bindings.rd_kafka_queue_get_background(inner)
412
+ end
413
+
414
+ if queue_ptr.null?
415
+ raise Rdkafka::Config::ConfigError.new("rd_kafka_queue_get_background was NULL")
416
+ end
417
+
418
+ # Create and register the handle we will return to the caller
419
+ handle = ListConsumerGroupsHandle.new
420
+ handle[:pending] = true
421
+ handle[:response] = Rdkafka::Bindings::RD_KAFKA_PARTITION_UA
422
+ ListConsumerGroupsHandle.register(handle)
423
+
424
+ admin_options_ptr = @native_kafka.with_inner do |inner|
425
+ Rdkafka::Bindings.rd_kafka_AdminOptions_new(
426
+ inner,
427
+ Rdkafka::Bindings::RD_KAFKA_ADMIN_OP_LISTCONSUMERGROUPS
428
+ )
429
+ end
430
+ Rdkafka::Bindings.rd_kafka_AdminOptions_set_opaque(admin_options_ptr, handle.to_ptr)
431
+
432
+ begin
433
+ @native_kafka.with_inner do |inner|
434
+ Rdkafka::Bindings.rd_kafka_ListConsumerGroups(
435
+ inner,
436
+ admin_options_ptr,
437
+ queue_ptr
438
+ )
439
+ end
440
+ rescue Exception
441
+ ListConsumerGroupsHandle.remove(handle.to_ptr.address)
442
+ raise
443
+ ensure
444
+ Rdkafka::Bindings.rd_kafka_AdminOptions_destroy(admin_options_ptr)
445
+ Rdkafka::Bindings.rd_kafka_queue_destroy(queue_ptr)
446
+ end
447
+
448
+ handle
449
+ end
450
+
286
451
  # Deletes the named topic
287
452
  #
288
453
  # @param topic_name [String] name of the topic to delete
@@ -345,7 +510,8 @@ module Rdkafka
345
510
  #
346
511
  # @param topic_name [String] name of the topic
347
512
  # @param partition_count [Integer] how many partitions we want to end up with for given topic
348
- # @return [CreatePartitionsHandle] Create partitions handle that can be used to wait for the result
513
+ # @return [CreatePartitionsHandle] Create partitions handle that can be used to wait for the
514
+ # result
349
515
  # @raise [ConfigError] When the partition count or replication factor are out of valid range
350
516
  # @raise [RdkafkaError] When the topic name is invalid or the topic already exists
351
517
  # @raise [RdkafkaError] When the topic configuration is invalid
@@ -434,7 +600,8 @@ module Rdkafka
434
600
  # @param permission_type [Integer] rd_kafka_AclPermissionType_t value:
435
601
  # - RD_KAFKA_ACL_PERMISSION_TYPE_DENY = 2
436
602
  # - RD_KAFKA_ACL_PERMISSION_TYPE_ALLOW = 3
437
- # @return [CreateAclHandle] Create acl handle that can be used to wait for the result of creating the acl
603
+ # @return [CreateAclHandle] Create acl handle that can be used to wait for the result of
604
+ # creating the acl
438
605
  # @raise [RdkafkaError]
439
606
  def create_acl(resource_type:, resource_name:, resource_pattern_type:, principal:, host:, operation:, permission_type:)
440
607
  closed_admin_check(__method__)
@@ -535,7 +702,8 @@ module Rdkafka
535
702
  # @param permission_type [Integer] rd_kafka_AclPermissionType_t value:
536
703
  # - RD_KAFKA_ACL_PERMISSION_TYPE_DENY = 2
537
704
  # - RD_KAFKA_ACL_PERMISSION_TYPE_ALLOW = 3
538
- # @return [DeleteAclHandle] Delete acl handle that can be used to wait for the result of deleting the acl
705
+ # @return [DeleteAclHandle] Delete acl handle that can be used to wait for the result of
706
+ # deleting the acl
539
707
  # @raise [RdkafkaError]
540
708
  def delete_acl(resource_type:, resource_name:, resource_pattern_type:, principal:, host:, operation:, permission_type:)
541
709
  closed_admin_check(__method__)
@@ -638,7 +806,8 @@ module Rdkafka
638
806
  # @param permission_type [Integer] rd_kafka_AclPermissionType_t value:
639
807
  # - RD_KAFKA_ACL_PERMISSION_TYPE_DENY = 2
640
808
  # - RD_KAFKA_ACL_PERMISSION_TYPE_ALLOW = 3
641
- # @return [DescribeAclHandle] Describe acl handle that can be used to wait for the result of fetching acls
809
+ # @return [DescribeAclHandle] Describe acl handle that can be used to wait for the result of
810
+ # fetching acls
642
811
  # @raise [RdkafkaError]
643
812
  def describe_acl(resource_type:, resource_name:, resource_pattern_type:, principal:, host:, operation:, permission_type:)
644
813
  closed_admin_check(__method__)