1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
//! Share-group offsets (KIP-932, KIP-1226): describe, alter, delete.
use std::collections::{BTreeMap, HashMap};
use crate::consumer::TopicPartition;
use crate::error::{KrafkaError, Result};
use crate::protocol::{
AlterShareGroupOffsetsRequest, AlterShareGroupOffsetsRequestPartition,
AlterShareGroupOffsetsRequestTopic, AlterShareGroupOffsetsResponse, ApiKey,
DeleteShareGroupOffsetsRequest, DeleteShareGroupOffsetsResponse,
DescribeShareGroupOffsetsRequest, DescribeShareGroupOffsetsRequestGroup,
DescribeShareGroupOffsetsRequestTopic, DescribeShareGroupOffsetsResponse, versions,
};
use super::driver::{Mode, Target, answer, exchange, negotiate};
use super::{AdminClient, validate_topics};
/// One share partition's offset state.
#[non_exhaustive]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SharePartitionOffset {
/// Share-partition start offset: the earliest offset the group may still
/// deliver.
pub start_offset: i64,
/// Leader epoch of the partition.
pub leader_epoch: i32,
/// Share-partition lag; `None` when the coordinator does not report it
/// (`DescribeShareGroupOffsets` v0, Kafka 4.2 and earlier).
pub lag: Option<i64>,
}
admin_options! {
/// Options for [`AdminClient::describe_share_group_offsets`].
DescribeShareGroupOffsetsOptions {}
optional {
/// Only these partitions. Default: every partition the group holds
/// state for.
partitions: Vec<TopicPartition>,
}
}
admin_options! {
/// Options for [`AdminClient::alter_share_group_offsets`].
AlterShareGroupOffsetsOptions {}
}
admin_options! {
/// Options for [`AdminClient::delete_share_group_offsets`].
DeleteShareGroupOffsetsOptions {}
}
impl AdminClient {
/// Read a share group's share-partition start offsets from its
/// coordinator. Returns a result per partition.
///
/// # Errors
///
/// A group-level broker error keeps its code; also a closed client or an
/// invalid topic name.
pub async fn describe_share_group_offsets(
&self,
group_id: impl Into<String>,
options: DescribeShareGroupOffsetsOptions,
) -> Result<HashMap<TopicPartition, Result<SharePartitionOffset>>> {
let group_id = group_id.into();
if let Some(partitions) = &options.partitions {
validate_topics(partitions.iter().map(|tp| tp.topic.as_str()))?;
}
let call = self.call("DescribeShareGroupOffsets", Mode::Read, options.timeout)?;
let topics = options.partitions.as_ref().map(|partitions| {
let mut topics: BTreeMap<String, Vec<i32>> = BTreeMap::new();
for tp in partitions {
topics
.entry(tp.topic.clone())
.or_default()
.push(tp.partition);
}
topics
.into_iter()
.map(
|(topic_name, partitions)| DescribeShareGroupOffsetsRequestTopic {
topic_name,
partitions,
},
)
.collect::<Vec<_>>()
});
let group = &group_id;
let topics = &topics;
call.single(
Target::GroupCoordinator(group_id.clone()),
|conn| async move {
let request = DescribeShareGroupOffsetsRequest {
groups: vec![DescribeShareGroupOffsetsRequestGroup {
group_id: group.clone(),
topics: topics.clone(),
}],
};
let version = negotiate(
&conn,
ApiKey::DescribeShareGroupOffsets,
versions::DESCRIBE_SHARE_GROUP_OFFSETS_MIN,
versions::DESCRIBE_SHARE_GROUP_OFFSETS_MAX,
)?;
let response: DescribeShareGroupOffsetsResponse =
exchange(&conn, ApiKey::DescribeShareGroupOffsets, version, &request).await?;
let group = response.groups.into_iter().next().ok_or_else(|| {
KrafkaError::protocol_kind(
crate::error::ProtocolErrorKind::Malformed,
"DescribeShareGroupOffsets returned no group",
)
})?;
answer(group.error_code, group.error_message)?;
// `lag` exists from v1; below, the field holds a -1 sentinel.
let lag_supported = version >= 1;
Ok(group
.topics
.into_iter()
.flat_map(|t| {
let name = t.topic_name;
t.partitions.into_iter().map(move |p| {
(
TopicPartition::new(name.clone(), p.partition_index),
answer(p.error_code, p.error_message).map(|()| {
SharePartitionOffset {
start_offset: p.start_offset,
leader_epoch: p.leader_epoch,
lag: (lag_supported && p.lag >= 0).then_some(p.lag),
}
}),
)
})
})
.collect())
},
)
.await
}
/// Set a share group's share-partition start offsets at its coordinator.
/// The group must be empty. Returns a result per partition; a group-level
/// error such as `NON_EMPTY_GROUP` applies to every partition.
///
/// # Errors
///
/// The call fails for a closed client or an invalid topic name.
pub async fn alter_share_group_offsets(
&self,
group_id: impl Into<String>,
offsets: impl IntoIterator<Item = (TopicPartition, i64)>,
options: AlterShareGroupOffsetsOptions,
) -> Result<HashMap<TopicPartition, Result<()>>> {
let group_id = group_id.into();
let offsets: HashMap<TopicPartition, i64> = offsets.into_iter().collect();
validate_topics(offsets.keys().map(|tp| tp.topic.as_str()))?;
let call = self.call("AlterShareGroupOffsets", Mode::Write, options.timeout)?;
let group = &group_id;
let offsets_ref = &offsets;
Ok(call
.fan_out(
offsets.keys().cloned().collect(),
|_| Target::GroupCoordinator(group_id.clone()),
|conn, partitions| async move {
let mut topics: BTreeMap<String, Vec<AlterShareGroupOffsetsRequestPartition>> =
BTreeMap::new();
for tp in &partitions {
topics.entry(tp.topic.clone()).or_default().push(
AlterShareGroupOffsetsRequestPartition {
partition_index: tp.partition,
start_offset: offsets_ref[tp],
},
);
}
let request = AlterShareGroupOffsetsRequest {
group_id: group.clone(),
topics: topics
.into_iter()
.map(
|(topic_name, partitions)| AlterShareGroupOffsetsRequestTopic {
topic_name,
partitions,
},
)
.collect(),
};
let version = negotiate(
&conn,
ApiKey::AlterShareGroupOffsets,
versions::ALTER_SHARE_GROUP_OFFSETS_MIN,
versions::ALTER_SHARE_GROUP_OFFSETS_MAX,
)?;
let response: AlterShareGroupOffsetsResponse =
exchange(&conn, ApiKey::AlterShareGroupOffsets, version, &request).await?;
if let Err(e) = answer(response.error_code, response.error_message) {
return Ok(partitions
.into_iter()
.map(|tp| (tp, Err(e.clone())))
.collect());
}
Ok(response
.responses
.into_iter()
.flat_map(|t| {
let name = t.topic_name;
t.partitions.into_iter().map(move |p| {
(
TopicPartition::new(name.clone(), p.partition_index),
answer(p.error_code, p.error_message),
)
})
})
.collect())
},
)
.await)
}
/// Delete a share group's offset state for whole topics at its
/// coordinator. The group must be empty. Returns a result per topic; a
/// group-level error applies to every topic.
///
/// # Errors
///
/// The call fails for a closed client or an invalid topic name.
pub async fn delete_share_group_offsets<I, S>(
&self,
group_id: impl Into<String>,
topics: I,
options: DeleteShareGroupOffsetsOptions,
) -> Result<HashMap<String, Result<()>>>
where
I: IntoIterator<Item = S>,
S: AsRef<str>,
{
let group_id = group_id.into();
let mut topics: Vec<String> = topics.into_iter().map(|s| s.as_ref().to_string()).collect();
validate_topics(topics.iter().map(String::as_str))?;
topics.sort_unstable();
topics.dedup();
let call = self.call("DeleteShareGroupOffsets", Mode::Write, options.timeout)?;
let group = &group_id;
Ok(call
.fan_out(
topics,
|_| Target::GroupCoordinator(group_id.clone()),
|conn, topics| async move {
let request = DeleteShareGroupOffsetsRequest {
group_id: group.clone(),
topics: topics.clone(),
};
let version = negotiate(
&conn,
ApiKey::DeleteShareGroupOffsets,
versions::DELETE_SHARE_GROUP_OFFSETS_MIN,
versions::DELETE_SHARE_GROUP_OFFSETS_MAX,
)?;
let response: DeleteShareGroupOffsetsResponse =
exchange(&conn, ApiKey::DeleteShareGroupOffsets, version, &request).await?;
if let Err(e) = answer(response.error_code, response.error_message) {
return Ok(topics.into_iter().map(|t| (t, Err(e.clone()))).collect());
}
Ok(response
.responses
.into_iter()
.map(|t| (t.topic_name, answer(t.error_code, t.error_message)))
.collect())
},
)
.await)
}
}