rdkafka 0.30.0-aarch64-linux-gnu → 0.31.0-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.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -2
  3. data/README.md +1 -0
  4. data/docker-compose-ssl.yml +1 -0
  5. data/docker-compose.yml +1 -0
  6. data/ext/librdkafka.so +0 -0
  7. data/lib/rdkafka/admin/describe_cluster_handle.rb +31 -0
  8. data/lib/rdkafka/admin/describe_cluster_report.rb +48 -0
  9. data/lib/rdkafka/admin/describe_consumer_groups_handle.rb +31 -0
  10. data/lib/rdkafka/admin/describe_consumer_groups_report.rb +151 -0
  11. data/lib/rdkafka/admin/describe_result_parsing.rb +47 -0
  12. data/lib/rdkafka/admin/describe_topics_handle.rb +31 -0
  13. data/lib/rdkafka/admin/describe_topics_report.rb +118 -0
  14. data/lib/rdkafka/admin.rb +245 -0
  15. data/lib/rdkafka/bindings/admin/acls.rb +85 -0
  16. data/lib/rdkafka/bindings/admin/configs.rb +37 -0
  17. data/lib/rdkafka/bindings/admin/list_offsets.rb +26 -0
  18. data/lib/rdkafka/bindings/admin.rb +197 -0
  19. data/lib/rdkafka/bindings/callbacks.rb +100 -0
  20. data/lib/rdkafka/bindings/configuration.rb +50 -0
  21. data/lib/rdkafka/bindings/consumer.rb +83 -0
  22. data/lib/rdkafka/bindings/errors.rb +15 -0
  23. data/lib/rdkafka/bindings/handle.rb +16 -0
  24. data/lib/rdkafka/bindings/messages.rb +28 -0
  25. data/lib/rdkafka/bindings/metadata.rb +14 -0
  26. data/lib/rdkafka/bindings/polling.rb +17 -0
  27. data/lib/rdkafka/bindings/producer.rb +77 -0
  28. data/lib/rdkafka/bindings/structs.rb +62 -0
  29. data/lib/rdkafka/bindings.rb +12 -655
  30. data/lib/rdkafka/callbacks/describe_cluster_handler.rb +36 -0
  31. data/lib/rdkafka/callbacks/describe_consumer_groups_handler.rb +36 -0
  32. data/lib/rdkafka/callbacks/describe_topics_handler.rb +36 -0
  33. data/lib/rdkafka/callbacks.rb +10 -1
  34. data/lib/rdkafka/clients.rb +13 -46
  35. data/lib/rdkafka/consumer/message.rb +6 -9
  36. data/lib/rdkafka/producer/delivery_handle.rb +8 -2
  37. data/lib/rdkafka/producer/delivery_report.rb +51 -1
  38. data/lib/rdkafka/version.rb +3 -3
  39. data/lib/rdkafka.rb +10 -0
  40. data/package-lock.json +9 -9
  41. data/rdkafka.gemspec +1 -1
  42. data/renovate.json +3 -0
  43. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5e13458da0b2a5865398fb599a6c647ec4e248cf6084d2126b1940ff2185125c
4
- data.tar.gz: 1839bea67dd286bf132ea896e8eb83aa8747dfce172ac436c04c5e2113fe7c12
3
+ metadata.gz: 50f9195c8025153b9abeed116aef974797c77e6c7e432dff7feee99382337948
4
+ data.tar.gz: c03fb2903a11183acf52191cae90a74189e2aa12ab62bc265829cb8d69919d9b
5
5
  SHA512:
6
- metadata.gz: 16b1a1096b42ff842dc9ebc20cda49678af64271a2552f63c3f01f85417e9c1884ee40a872de9ca76a930ac1e9480c50fbf10f31e992441abdf12c6fdbc34026
7
- data.tar.gz: 79ec42c9962284cf42cf033165b1acbf7aa646e1a54f1b2b8677311f8cf26991c7b0b472c1cb98f2c193a8c83ab01a11f7781db6681d07e4c4b80510c9a5cd75
6
+ metadata.gz: fb85bd66574e527a5236b065362b78be86f3523ea96cb6c8e1b55b86f7d7f913bce62abdf2d6510c578d27baa0b9dacbb80c940bacc34b1954a8e1c5bfd5f459
7
+ data.tar.gz: 509b190f874ac1413bfc5e4b36b3768b44abc6e0405ba0e11a7b0f0d18756759c9368d75a18c07a5057163718f7d3e5f465262fcabd51d72359e6435c20ad9b6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Rdkafka Changelog
2
2
 
3
+ ## 0.31.0 (2026-10-09)
4
+ - **[EOL]** Drop Ruby 3.2 support; require Ruby 3.3+.
5
+ - [Feature] Add `status`, `latency` and `broker_id` to `Producer::DeliveryReport`, with `#persisted?`, `#possibly_persisted?` and `#not_persisted?`, so a failed delivery tells whether a retry may duplicate the message.
6
+ - [Feature] Add `Admin#describe_cluster` to get the cluster id, controller and broker nodes (with racks) without a full metadata request.
7
+ - [Feature] Add `Admin#describe_topics` to get topic ids, partition leaders and replicas, and per-topic errors. Both methods can also return the operations the client is authorized to perform.
8
+ - [Feature] Add `Admin#describe_consumer_groups` to read the state, type, coordinator, authorized operations and members (with their current and target partition assignments) of consumer groups.
9
+ - [Enhancement] Bump librdkafka to `2.15.1` for OpenSSL and libcurl security fixes. It changes how IPv6 addresses are formatted and validated against broker certificates.
10
+ - [Enhancement] Bump the bundled OpenSSL to `3.5.9` (LTS) for its security fixes.
11
+ - [Enhancement] Read each pointer field once in `Message#initialize`, saving 3 allocations per consumed message.
12
+ - [Change] Build the precompiled `macos_arm64` library on macOS 26 with the minimum macOS pinned to 14.0, instead of inheriting it from the build host.
13
+ - [Change] Build the precompiled `aarch64-linux-musl` gem on Alpine `3.24` (was `3.23`), matching `x86_64-linux-musl`.
14
+ - [Maintenance] Split `lib/rdkafka/bindings.rb` into per-area files under `lib/rdkafka/bindings/`. `Rdkafka::Bindings` is unchanged.
15
+
3
16
  ## 0.30.0 (2026-09-25)
4
17
  - [Feature] Add `Admin#alter_consumer_group_offsets` and `Admin#delete_consumer_group_offsets` to set or clear a consumer group's committed offsets from the admin client.
5
18
  - [Enhancement] Bump the bundled zlib to `1.3.2`.
@@ -11,7 +24,7 @@
11
24
  - [Fix] Honor the `isolation_level:` argument to `Admin#list_offsets`, which was silently ignored.
12
25
  - [Fix] Return correct results for every item of a multi-item topic, partition, group or ACL admin request, not just the first.
13
26
  - [Maintenance] Fix a use-after-free in the multi-item admin integration test that read result-name pointers after librdkafka had destroyed the background event, which made it flaky on newer glibc (e.g. Debian trixie).
14
- - [Maintenance] Stabilize consumer specs on slow CI runners: wait longer for a partition assignment, raise the `TestTopics.create` admin timeout (a timeout there also tripped the leaked-handle guard), and let the long-running consumption spec drain its backlog instead of stopping at a fixed 60s.
27
+ - [Maintenance] Stabilize consumer specs on slow CI runners: wait longer for a partition assignment, raise the `TestTopics.create` admin timeout and drop the fixed 60s limit of the long-running consumption spec.
15
28
  - [Maintenance] Raise the `TestTopics.create` admin timeout to 30s so a loaded CI runner no longer hits `create topic timed out` (which also tripped the leaked-handle guard).
16
29
 
17
30
  ## 0.29.2 (2026-09-11)
@@ -89,7 +102,7 @@
89
102
  - [Feature] Support `rd_kafka_ListOffsets` admin API for querying partition offsets by specification (earliest, latest, max_timestamp, or by timestamp) without requiring a consumer group (#613).
90
103
  - [Enhancement] Use native ARM64 runners instead of QEMU emulation for Alpine musl aarch64 builds, improving build performance and reliability.
91
104
  - [Enhancement] Enable parallel compilation (`make -j$(nproc)`) for ARM64 Alpine musl builds.
92
- - [Enhancement] Add file descriptor API for fiber scheduler integration. Expose `enable_queue_io_events` and `enable_background_queue_io_events` on `Consumer`, `Producer`, and `Admin` to enable non-blocking monitoring with select/poll/epoll for integration with Ruby fiber schedulers (Falcon, Async) and custom event loops.
105
+ - [Enhancement] Add `enable_queue_io_events` and `enable_background_queue_io_events` to `Consumer`, `Producer` and `Admin` for non-blocking file descriptor monitoring with fiber schedulers (Falcon, Async) and custom event loops.
93
106
  - [Enhancement] Add non-blocking poll methods (`poll_nb`, `events_poll_nb`) on `Consumer` that skip GVL release for efficient fiber scheduler integration when using `poll(0)`.
94
107
  - [Enhancement] Add `events_poll_nb_each` method on `Producer`, `Consumer`, and `Admin` for polling events in a single GVL/mutex session. Yields count after each iteration, caller returns `:stop` to break.
95
108
  - [Enhancement] Add `poll_nb_each` method on `Consumer` for non-blocking message polling with proper resource cleanup, yielding each message and supporting early termination via `:stop` return value.
data/README.md CHANGED
@@ -163,6 +163,7 @@ bundle exec rake produce_messages
163
163
 
164
164
  | rdkafka-ruby | librdkafka | patches |
165
165
  |-|-|-|
166
+ | 0.31.x (2026-10-09) | 2.15.1 (2026-09-09) | yes |
166
167
  | 0.30.x (2026-09-25) | 2.15.0 (2026-06-30) | yes |
167
168
  | 0.29.x (2026-07-10) | 2.14.2 (2026-06-03) | yes |
168
169
  | 0.28.x (2026-06-03) | 2.14.1 (2026-04-15) | yes |
@@ -17,6 +17,7 @@ services:
17
17
  KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT,SSL:SSL
18
18
  KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://127.0.0.1:9092,SSL://127.0.0.1:9093
19
19
  KAFKA_BROKER_ID: 1
20
+ KAFKA_BROKER_RACK: rack-1
20
21
  KAFKA_CONTROLLER_QUORUM_VOTERS: 1@127.0.0.1:9094
21
22
  ALLOW_PLAINTEXT_LISTENER: 'yes'
22
23
  KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'false'
data/docker-compose.yml CHANGED
@@ -16,6 +16,7 @@ services:
16
16
  KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT
17
17
  KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://127.0.0.1:9092
18
18
  KAFKA_BROKER_ID: 1
19
+ KAFKA_BROKER_RACK: rack-1
19
20
  KAFKA_CONTROLLER_QUORUM_VOTERS: 1@127.0.0.1:9093
20
21
  ALLOW_PLAINTEXT_LISTENER: 'yes'
21
22
  KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'false'
data/ext/librdkafka.so CHANGED
Binary file
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Handle for describe cluster operation
6
+ class DescribeClusterHandle < AbstractHandle
7
+ layout :pending, :bool,
8
+ :response, :int
9
+
10
+ # @return [String] the name of the operation
11
+ def operation_name
12
+ "describe cluster"
13
+ end
14
+
15
+ # @return [DescribeClusterReport] report prepared by the background event callback, with
16
+ # the cluster id, controller and broker nodes.
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,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Report for describe cluster operation result
6
+ class DescribeClusterReport
7
+ include DescribeResultParsing
8
+
9
+ # @return [String, nil] the cluster id
10
+ attr_reader :cluster_id
11
+
12
+ # The current controller node, as a hash with `:id` [Integer], `:host` [String],
13
+ # `:port` [Integer] and `:rack` [String, nil]
14
+ # @return [Hash, nil]
15
+ attr_reader :controller
16
+
17
+ # Broker nodes of the cluster, each in the same shape as {#controller}
18
+ # @return [Array<Hash>]
19
+ attr_reader :nodes
20
+
21
+ # Operations the client is authorized to perform on the cluster, as
22
+ # `Bindings::RD_KAFKA_ACL_OPERATION_*` codes. `nil` unless requested with
23
+ # `include_authorized_operations: true`.
24
+ # @return [Array<Integer>, nil]
25
+ attr_reader :authorized_operations
26
+
27
+ # @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_DescribeCluster_result_t`
28
+ def initialize(result_ptr)
29
+ @nodes = []
30
+
31
+ return if result_ptr.null?
32
+
33
+ cluster_id_ptr = Bindings.rd_kafka_DescribeCluster_result_cluster_id(result_ptr)
34
+ @cluster_id = cluster_id_ptr.null? ? nil : cluster_id_ptr.read_string
35
+ @controller = extract_node(Bindings.rd_kafka_DescribeCluster_result_controller(result_ptr))
36
+
37
+ count_ptr = FFI::MemoryPointer.new(:size_t)
38
+ @nodes = extract_nodes(Bindings.rd_kafka_DescribeCluster_result_nodes(result_ptr, count_ptr), count_ptr)
39
+
40
+ count_ptr = FFI::MemoryPointer.new(:size_t)
41
+ @authorized_operations = extract_authorized_operations(
42
+ Bindings.rd_kafka_DescribeCluster_result_authorized_operations(result_ptr, count_ptr),
43
+ count_ptr
44
+ )
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Handle for describe consumer groups operation
6
+ class DescribeConsumerGroupsHandle < AbstractHandle
7
+ layout :pending, :bool,
8
+ :response, :int
9
+
10
+ # @return [String] the name of the operation
11
+ def operation_name
12
+ "describe consumer groups"
13
+ end
14
+
15
+ # @return [DescribeConsumerGroupsReport] report prepared by the background event callback,
16
+ # with the described 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,151 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Report for describe consumer groups operation result
6
+ class DescribeConsumerGroupsReport
7
+ include DescribeResultParsing
8
+
9
+ # Described consumer groups, one per requested group id. Each entry is a hash with:
10
+ # - `:group_id` [String] the consumer group id
11
+ # - `:error` [RdkafkaError, nil] error describing this group, or `nil` on success. The
12
+ # other fields are not meaningful when it is set.
13
+ # - `:is_simple_consumer_group` [Boolean] `true` for a group that assigns partitions
14
+ # manually and uses Kafka only for offset storage
15
+ # - `:state` [Integer] the group state as a `Bindings::RD_KAFKA_CONSUMER_GROUP_STATE_*`
16
+ # code. A group id the cluster does not know is reported as
17
+ # `RD_KAFKA_CONSUMER_GROUP_STATE_DEAD` with no members.
18
+ # - `:state_name` [String] human-readable name of that state (e.g. `"Stable"`, `"Empty"`)
19
+ # - `:type` [Integer] the group protocol type as a
20
+ # `Bindings::RD_KAFKA_CONSUMER_GROUP_TYPE_*` code, one of:
21
+ # `RD_KAFKA_CONSUMER_GROUP_TYPE_CLASSIC`,
22
+ # `RD_KAFKA_CONSUMER_GROUP_TYPE_CONSUMER` (KIP-848),
23
+ # `RD_KAFKA_CONSUMER_GROUP_TYPE_UNKNOWN`
24
+ # - `:type_name` [String] human-readable name of that type (e.g. `"Classic"`, `"Consumer"`)
25
+ # - `:partition_assignor` [String, nil] partition assignor in use (e.g. `"range"`)
26
+ # - `:coordinator` [Hash, nil] the group coordinator broker as
27
+ # `{ id:, host:, port:, rack: }`
28
+ # - `:authorized_operations` [Array<Integer>, nil] ACL operations the client may perform on
29
+ # the group, as `Bindings::RD_KAFKA_ACL_OPERATION_*` codes. `nil` unless requested with
30
+ # `include_authorized_operations: true`.
31
+ # - `:members` [Array<Hash>] current group members, each with:
32
+ # - `:member_id` [String] the member (consumer) id
33
+ # - `:client_id` [String] the member's `client.id`
34
+ # - `:group_instance_id` [String, nil] the static membership instance id, if any
35
+ # - `:host` [String] the host the member connects from
36
+ # - `:assignment` [Hash{String => Array<Integer>}] assigned partitions, by topic
37
+ # - `:target_assignment` [Hash{String => Array<Integer>}, nil] partitions the member is
38
+ # moving to during a rebalance, by topic. Only `consumer` (KIP-848) groups have it;
39
+ # `nil` for `classic` groups.
40
+ # @return [Array<Hash>]
41
+ attr_reader :groups
42
+
43
+ # @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_DescribeConsumerGroups_result_t`
44
+ def initialize(result_ptr)
45
+ @groups = []
46
+
47
+ return if result_ptr.null?
48
+
49
+ count_ptr = FFI::MemoryPointer.new(:size_t)
50
+ array_ptr = Bindings.rd_kafka_DescribeConsumerGroups_result_groups(result_ptr, count_ptr)
51
+
52
+ return if array_ptr.null?
53
+
54
+ array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).each do |group_ptr|
55
+ @groups << build_group(group_ptr)
56
+ end
57
+ end
58
+
59
+ private
60
+
61
+ # @param group_ptr [FFI::Pointer] pointer to the `rd_kafka_ConsumerGroupDescription_t`
62
+ # @return [Hash]
63
+ def build_group(group_ptr)
64
+ state = Bindings.rd_kafka_ConsumerGroupDescription_state(group_ptr)
65
+ type = Bindings.rd_kafka_ConsumerGroupDescription_type(group_ptr)
66
+
67
+ {
68
+ group_id: read_string(Bindings.rd_kafka_ConsumerGroupDescription_group_id(group_ptr)),
69
+ error: build_error(Bindings.rd_kafka_ConsumerGroupDescription_error(group_ptr)),
70
+ is_simple_consumer_group:
71
+ Bindings.rd_kafka_ConsumerGroupDescription_is_simple_consumer_group(group_ptr) != 0,
72
+ state: state,
73
+ state_name: read_string(Bindings.rd_kafka_consumer_group_state_name(state)),
74
+ type: type,
75
+ type_name: read_string(Bindings.rd_kafka_consumer_group_type_name(type)),
76
+ partition_assignor:
77
+ read_string(Bindings.rd_kafka_ConsumerGroupDescription_partition_assignor(group_ptr)),
78
+ coordinator: extract_node(Bindings.rd_kafka_ConsumerGroupDescription_coordinator(group_ptr)),
79
+ authorized_operations: build_authorized_operations(group_ptr),
80
+ members: Array.new(Bindings.rd_kafka_ConsumerGroupDescription_member_count(group_ptr)) do |index|
81
+ build_member(Bindings.rd_kafka_ConsumerGroupDescription_member(group_ptr, index))
82
+ end
83
+ }
84
+ end
85
+
86
+ # @param member_ptr [FFI::Pointer] pointer to the `rd_kafka_MemberDescription_t`
87
+ # @return [Hash]
88
+ def build_member(member_ptr)
89
+ {
90
+ member_id: read_string(Bindings.rd_kafka_MemberDescription_consumer_id(member_ptr)),
91
+ client_id: read_string(Bindings.rd_kafka_MemberDescription_client_id(member_ptr)),
92
+ group_instance_id: read_string(Bindings.rd_kafka_MemberDescription_group_instance_id(member_ptr)),
93
+ host: read_string(Bindings.rd_kafka_MemberDescription_host(member_ptr)),
94
+ assignment: build_assignment(Bindings.rd_kafka_MemberDescription_assignment(member_ptr)),
95
+ target_assignment: build_target_assignment(member_ptr)
96
+ }
97
+ end
98
+
99
+ # @param assignment_ptr [FFI::Pointer] pointer to the `rd_kafka_MemberAssignment_t`
100
+ # @return [Hash{String => Array<Integer>}]
101
+ def build_assignment(assignment_ptr)
102
+ return {} if assignment_ptr.null?
103
+
104
+ tpl_ptr = Bindings.rd_kafka_MemberAssignment_partitions(assignment_ptr)
105
+
106
+ return {} if tpl_ptr.null?
107
+
108
+ Consumer::TopicPartitionList
109
+ .from_native_tpl(tpl_ptr)
110
+ .to_h
111
+ .transform_values { |partitions| (partitions || []).map(&:partition) }
112
+ end
113
+
114
+ # @param member_ptr [FFI::Pointer] pointer to the `rd_kafka_MemberDescription_t`
115
+ # @return [Hash{String => Array<Integer>}, nil]
116
+ def build_target_assignment(member_ptr)
117
+ assignment_ptr = Bindings.rd_kafka_MemberDescription_target_assignment(member_ptr)
118
+
119
+ assignment_ptr.null? ? nil : build_assignment(assignment_ptr)
120
+ end
121
+
122
+ # @param group_ptr [FFI::Pointer] pointer to the `rd_kafka_ConsumerGroupDescription_t`
123
+ # @return [Array<Integer>, nil]
124
+ def build_authorized_operations(group_ptr)
125
+ count_ptr = FFI::MemoryPointer.new(:size_t)
126
+
127
+ extract_authorized_operations(
128
+ Bindings.rd_kafka_ConsumerGroupDescription_authorized_operations(group_ptr, count_ptr),
129
+ count_ptr
130
+ )
131
+ end
132
+
133
+ # @param error_ptr [FFI::Pointer] pointer to the `rd_kafka_error_t`
134
+ # @return [RdkafkaError, nil]
135
+ def build_error(error_ptr)
136
+ return nil if error_ptr.null?
137
+
138
+ RdkafkaError.new(
139
+ Bindings.rd_kafka_error_code(error_ptr),
140
+ broker_message: read_string(Bindings.rd_kafka_error_string(error_ptr))
141
+ )
142
+ end
143
+
144
+ # @param ptr [FFI::Pointer] pointer to a C string
145
+ # @return [String, nil]
146
+ def read_string(ptr)
147
+ ptr.null? ? nil : ptr.read_string
148
+ end
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Helpers shared by the describe-topics and describe-cluster reports to copy nodes and
6
+ # authorized operations out of event-owned memory.
7
+ # @private
8
+ module DescribeResultParsing
9
+ private
10
+
11
+ # @param node_ptr [FFI::Pointer] pointer to a `rd_kafka_Node_t`
12
+ # @return [Hash, nil] node with `:id`, `:host`, `:port` and `:rack` or nil when NULL
13
+ def extract_node(node_ptr)
14
+ return nil if node_ptr.null?
15
+
16
+ host_ptr = Bindings.rd_kafka_Node_host(node_ptr)
17
+ rack_ptr = Bindings.rd_kafka_Node_rack(node_ptr)
18
+
19
+ {
20
+ id: Bindings.rd_kafka_Node_id(node_ptr),
21
+ host: host_ptr.null? ? nil : host_ptr.read_string,
22
+ port: Bindings.rd_kafka_Node_port(node_ptr),
23
+ rack: rack_ptr.null? ? nil : rack_ptr.read_string
24
+ }
25
+ end
26
+
27
+ # @param array_ptr [FFI::Pointer] pointer to a `rd_kafka_Node_t*` array
28
+ # @param count_ptr [FFI::MemoryPointer] size_t holding the array length
29
+ # @return [Array<Hash>] nodes as returned by {#extract_node}
30
+ def extract_nodes(array_ptr, count_ptr)
31
+ return [] if array_ptr.null?
32
+
33
+ array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).map { |node_ptr| extract_node(node_ptr) }
34
+ end
35
+
36
+ # @param array_ptr [FFI::Pointer] pointer to a `rd_kafka_AclOperation_t` array
37
+ # @param count_ptr [FFI::MemoryPointer] size_t holding the array length
38
+ # @return [Array<Integer>, nil] `Bindings::RD_KAFKA_ACL_OPERATION_*` codes or nil when the
39
+ # authorized operations were not requested
40
+ def extract_authorized_operations(array_ptr, count_ptr)
41
+ return nil if array_ptr.null?
42
+
43
+ array_ptr.read_array_of_int(count_ptr.read(:size_t))
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Handle for describe topics operation
6
+ class DescribeTopicsHandle < AbstractHandle
7
+ layout :pending, :bool,
8
+ :response, :int
9
+
10
+ # @return [String] the name of the operation
11
+ def operation_name
12
+ "describe topics"
13
+ end
14
+
15
+ # @return [DescribeTopicsReport] report prepared by the background event callback, with
16
+ # the described topics.
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,118 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rdkafka
4
+ class Admin
5
+ # Report for describe topics operation result
6
+ class DescribeTopicsReport
7
+ include DescribeResultParsing
8
+
9
+ # Described topics, one per requested topic name. Each entry is a hash with:
10
+ # - `:name` [String] the topic name
11
+ # - `:topic_id` [String, nil] the topic id (KIP-516), base64 encoded, or `nil` when the
12
+ # topic could not be described
13
+ # - `:is_internal` [Boolean] whether the topic is internal (e.g. `__consumer_offsets`)
14
+ # - `:partitions` [Array<Hash>] each with `:partition` [Integer], `:leader` [Hash, nil] and
15
+ # `:replicas` / `:isr` [Array<Hash>]; nodes have `:id`, `:host`, `:port` and `:rack`
16
+ # - `:authorized_operations` [Array<Integer>, nil] `Bindings::RD_KAFKA_ACL_OPERATION_*`
17
+ # codes, `nil` unless requested with `include_authorized_operations: true`
18
+ # - `:error` [RdkafkaError, nil] per-topic error (e.g. `unknown_topic_or_part`), `nil`
19
+ # on success
20
+ # @return [Array<Hash>]
21
+ attr_reader :topics
22
+
23
+ # @param result_ptr [FFI::Pointer] pointer to the `rd_kafka_DescribeTopics_result_t`
24
+ def initialize(result_ptr)
25
+ @topics = []
26
+
27
+ return if result_ptr.null?
28
+
29
+ count_ptr = FFI::MemoryPointer.new(:size_t)
30
+ array_ptr = Bindings.rd_kafka_DescribeTopics_result_topics(result_ptr, count_ptr)
31
+
32
+ return if array_ptr.null?
33
+
34
+ array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).each do |topic_ptr|
35
+ @topics << extract_topic(topic_ptr)
36
+ end
37
+ end
38
+
39
+ private
40
+
41
+ # @param topic_ptr [FFI::Pointer] pointer to a `rd_kafka_TopicDescription_t`
42
+ # @return [Hash]
43
+ def extract_topic(topic_ptr)
44
+ name_ptr = Bindings.rd_kafka_TopicDescription_name(topic_ptr)
45
+ operations_count_ptr = FFI::MemoryPointer.new(:size_t)
46
+
47
+ {
48
+ name: name_ptr.null? ? nil : name_ptr.read_string,
49
+ topic_id: extract_topic_id(topic_ptr),
50
+ is_internal: Bindings.rd_kafka_TopicDescription_is_internal(topic_ptr) != 0,
51
+ partitions: extract_partitions(topic_ptr),
52
+ authorized_operations: extract_authorized_operations(
53
+ Bindings.rd_kafka_TopicDescription_authorized_operations(topic_ptr, operations_count_ptr),
54
+ operations_count_ptr
55
+ ),
56
+ error: extract_error(topic_ptr)
57
+ }
58
+ end
59
+
60
+ # librdkafka reports the zero UUID for a topic it could not describe
61
+ # @param topic_ptr [FFI::Pointer] pointer to a `rd_kafka_TopicDescription_t`
62
+ # @return [String, nil]
63
+ def extract_topic_id(topic_ptr)
64
+ uuid_ptr = Bindings.rd_kafka_TopicDescription_topic_id(topic_ptr)
65
+
66
+ return nil if uuid_ptr.null?
67
+ return nil if Bindings.rd_kafka_Uuid_most_significant_bits(uuid_ptr).zero? &&
68
+ Bindings.rd_kafka_Uuid_least_significant_bits(uuid_ptr).zero?
69
+
70
+ string_ptr = Bindings.rd_kafka_Uuid_base64str(uuid_ptr)
71
+ string_ptr.null? ? nil : string_ptr.read_string
72
+ end
73
+
74
+ # @param topic_ptr [FFI::Pointer] pointer to a `rd_kafka_TopicDescription_t`
75
+ # @return [Array<Hash>]
76
+ def extract_partitions(topic_ptr)
77
+ count_ptr = FFI::MemoryPointer.new(:size_t)
78
+ array_ptr = Bindings.rd_kafka_TopicDescription_partitions(topic_ptr, count_ptr)
79
+
80
+ return [] if array_ptr.null?
81
+
82
+ array_ptr.read_array_of_pointer(count_ptr.read(:size_t)).map do |partition_ptr|
83
+ replicas_count_ptr = FFI::MemoryPointer.new(:size_t)
84
+ isr_count_ptr = FFI::MemoryPointer.new(:size_t)
85
+
86
+ {
87
+ partition: Bindings.rd_kafka_TopicPartitionInfo_partition(partition_ptr),
88
+ leader: extract_node(Bindings.rd_kafka_TopicPartitionInfo_leader(partition_ptr)),
89
+ replicas: extract_nodes(
90
+ Bindings.rd_kafka_TopicPartitionInfo_replicas(partition_ptr, replicas_count_ptr),
91
+ replicas_count_ptr
92
+ ),
93
+ isr: extract_nodes(
94
+ Bindings.rd_kafka_TopicPartitionInfo_isr(partition_ptr, isr_count_ptr),
95
+ isr_count_ptr
96
+ )
97
+ }
98
+ end
99
+ end
100
+
101
+ # The error is owned by the result, so it is copied and not destroyed here.
102
+ # @param topic_ptr [FFI::Pointer] pointer to a `rd_kafka_TopicDescription_t`
103
+ # @return [RdkafkaError, nil]
104
+ def extract_error(topic_ptr)
105
+ error_ptr = Bindings.rd_kafka_TopicDescription_error(topic_ptr)
106
+
107
+ return nil if error_ptr.null?
108
+
109
+ code = Bindings.rd_kafka_error_code(error_ptr)
110
+
111
+ return nil if code == Bindings::RD_KAFKA_RESP_ERR_NO_ERROR
112
+
113
+ string_ptr = Bindings.rd_kafka_error_string(error_ptr)
114
+ RdkafkaError.new(code, broker_message: string_ptr.null? ? nil : string_ptr.read_string)
115
+ end
116
+ end
117
+ end
118
+ end