krabka-client-admin 0.7.1

Operator-side admin client for Krabka clusters
Documentation
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
//! KIP-853 metadata-quorum administration: `DescribeQuorum`, `AddRaftVoter`
//! and `RemoveRaftVoter`, as Kafka's `Admin.describeMetadataQuorum`,
//! `addRaftVoter` and `removeRaftVoter`.

use std::collections::BTreeSet;

use krabka_protocol::{
    owned::{
        add_raft_voter_request::{AddRaftVoterRequest, Listener},
        describe_quorum_request::{
            DescribeQuorumRequest, PartitionData as RequestPartition, TopicData as RequestTopic,
        },
        remove_raft_voter_request::RemoveRaftVoterRequest,
    },
    primitives::uuid::Uuid as ProtoUuid,
};

use crate::{AdminClient, AdminError, NOT_CONTROLLER, kafka_error_name, retry::ControllerRetry};

const CLUSTER_METADATA_TOPIC: &str = "__cluster_metadata";

/// One listener endpoint of a voter, as Kafka's `RaftVoterEndpoint`.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct RaftVoterEndpoint {
    listener: String,
    host: String,
    port: u16,
}

impl RaftVoterEndpoint {
    /// An endpoint of `listener` at `host:port`.
    ///
    /// # Errors
    /// Returns [`AdminError::InvalidArgument`] when `listener` is empty, has
    /// leading or trailing whitespace, or is not in upper case, as Kafka's
    /// `RaftVoterEndpoint` constructor refuses it.
    pub fn new(
        listener: impl Into<String>,
        host: impl Into<String>,
        port: u16,
    ) -> Result<Self, AdminError> {
        let listener = listener.into();
        if listener.trim() != listener {
            return Err(AdminError::InvalidArgument(format!(
                "listener {listener:?}: leading or trailing whitespace is not allowed"
            )));
        }
        if listener.is_empty() {
            return Err(AdminError::InvalidArgument(
                "listener: empty string is not allowed".to_owned(),
            ));
        }
        if listener.to_uppercase() != listener {
            return Err(AdminError::InvalidArgument(format!(
                "listener {listener:?}: string must be UPPERCASE"
            )));
        }
        Ok(Self {
            listener,
            host: host.into(),
            port,
        })
    }

    /// The listener name.
    #[must_use]
    pub fn listener(&self) -> &str {
        &self.listener
    }

    /// The advertised host.
    #[must_use]
    pub fn host(&self) -> &str {
        &self.host
    }

    /// The advertised port.
    #[must_use]
    pub const fn port(&self) -> u16 {
        self.port
    }
}

/// The `AddRaftVoter` request of one voter, as Kafka's `addRaftVoter`
/// `createRequest` builds it. Each endpoint appears once, as Kafka takes a
/// `Set`. `ack_when_committed` keeps its schema default, `true`, which
/// Kafka's client does not change.
fn add_raft_voter_request(
    cluster_id: Option<&str>,
    voter_id: i32,
    voter_directory_id: uuid::Uuid,
    endpoints: &[RaftVoterEndpoint],
    timeout_ms: i32,
) -> AddRaftVoterRequest {
    let mut seen = BTreeSet::new();
    AddRaftVoterRequest {
        cluster_id: cluster_id.map(str::to_owned),
        timeout_ms,
        voter_id,
        voter_directory_id: ProtoUuid(*voter_directory_id.as_bytes()),
        listeners: endpoints
            .iter()
            .filter(|endpoint| seen.insert(*endpoint))
            .map(|endpoint| Listener {
                name: endpoint.listener.clone(),
                host: endpoint.host.clone(),
                port: endpoint.port,
                ..Default::default()
            })
            .collect(),
        ..Default::default()
    }
}

/// The `RemoveRaftVoter` request of one voter, as Kafka's `removeRaftVoter`
/// `createRequest` builds it: the cluster ID as the caller gave it, or null.
fn remove_raft_voter_request(
    cluster_id: Option<&str>,
    voter_id: i32,
    voter_directory_id: uuid::Uuid,
) -> RemoveRaftVoterRequest {
    RemoveRaftVoterRequest {
        cluster_id: cluster_id.map(str::to_owned),
        voter_id,
        voter_directory_id: ProtoUuid(*voter_directory_id.as_bytes()),
        ..Default::default()
    }
}

/// `Ok` for code 0, and the broker error of `api` for any other code.
fn voter_result(api: &'static str, code: i16, message: Option<String>) -> Result<(), AdminError> {
    if code == 0 {
        Ok(())
    } else {
        Err(broker_error(api, code, message))
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct QuorumReplica {
    pub node_id: i32,
    pub directory_id: uuid::Uuid,
    pub log_end_offset: i64,
    pub last_fetch_timestamp: i64,
    pub last_caught_up_timestamp: i64,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct MetadataQuorum {
    pub leader_id: i32,
    pub leader_epoch: i32,
    pub high_watermark: i64,
    pub voters: Vec<QuorumReplica>,
    pub observers: Vec<QuorumReplica>,
    /// The listener endpoints of each node, as Kafka's `QuorumInfo.nodes()`
    /// reads them from the response's `Nodes` (`DescribeQuorum` v2 and
    /// later). Empty when the controller answered at v0 or v1.
    pub nodes: Vec<QuorumNode>,
}

/// One node of `QuorumInfo.nodes()`: its id and listener endpoints.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct QuorumNode {
    pub node_id: i32,
    pub endpoints: Vec<RaftVoterEndpoint>,
}

fn broker_error(api: &'static str, code: i16, message: Option<String>) -> AdminError {
    AdminError::Broker {
        api,
        code,
        name: kafka_error_name(code),
        message,
    }
}

fn replica(
    value: &krabka_protocol::owned::common::describe_quorum_response::replica_state::ReplicaState,
) -> QuorumReplica {
    QuorumReplica {
        node_id: value.replica_id,
        directory_id: uuid::Uuid::from_bytes(value.replica_directory_id.0),
        log_end_offset: value.log_end_offset,
        last_fetch_timestamp: value.last_fetch_timestamp,
        last_caught_up_timestamp: value.last_caught_up_timestamp,
    }
}

/// A response node as Kafka's `DescribeQuorumResponse.getNodes` maps it. The
/// listener fields come straight from the wire, so they are not re-validated
/// the way a caller-built `RaftVoterEndpoint` is.
fn quorum_node(node: &krabka_protocol::owned::describe_quorum_response::Node) -> QuorumNode {
    QuorumNode {
        node_id: node.node_id,
        endpoints: node
            .listeners
            .iter()
            .map(|listener| RaftVoterEndpoint {
                listener: listener.name.clone(),
                host: listener.host.clone(),
                port: listener.port,
            })
            .collect(),
    }
}

impl AdminClient {
    /// Return the live `__cluster_metadata` partition-zero quorum view.
    ///
    /// # Errors
    /// Returns a transport, protocol, or Kafka error from `DescribeQuorum`.
    pub async fn describe_metadata_quorum(&mut self) -> Result<MetadataQuorum, AdminError> {
        let response = self
            .conn
            .send(DescribeQuorumRequest {
                topics: vec![RequestTopic {
                    topic_name: CLUSTER_METADATA_TOPIC.into(),
                    partitions: vec![RequestPartition {
                        partition_index: 0,
                        ..Default::default()
                    }],
                    ..Default::default()
                }],
                ..Default::default()
            })
            .await?;
        if response.error_code != 0 {
            return Err(broker_error(
                "DescribeQuorum",
                response.error_code,
                response.error_message,
            ));
        }
        let nodes = response.nodes.iter().map(quorum_node).collect();
        let partition = response
            .topics
            .into_iter()
            .find(|topic| topic.topic_name == CLUSTER_METADATA_TOPIC)
            .and_then(|topic| {
                topic
                    .partitions
                    .into_iter()
                    .find(|partition| partition.partition_index == 0)
            })
            .ok_or_else(|| {
                AdminError::Protocol("DescribeQuorum omitted __cluster_metadata partition 0".into())
            })?;
        if partition.error_code != 0 {
            return Err(broker_error(
                "DescribeQuorum",
                partition.error_code,
                partition.error_message,
            ));
        }
        Ok(MetadataQuorum {
            leader_id: partition.leader_id,
            leader_epoch: partition.leader_epoch,
            high_watermark: partition.high_watermark,
            voters: partition.current_voters.iter().map(replica).collect(),
            observers: partition.observers.iter().map(replica).collect(),
            nodes,
        })
    }

    /// Adds a voter to the metadata quorum (KIP-853), as Kafka's
    /// `addRaftVoter` operation does.
    ///
    /// The client sends `AddRaftVoter` on its connection: the active
    /// controller through controller bootstrap (KIP-919), or a broker, which
    /// forwards it, as Kafka's `LeastLoadedBrokerOrActiveKController` picks.
    /// `cluster_id` is Kafka's `AddRaftVoterOptions.clusterId`; `None` sends
    /// a null cluster ID, which the controller does not check. The request
    /// carries the time left before the call deadline as its `timeout_ms`.
    ///
    /// `NOT_CONTROLLER` (41) makes the client find the controller again and
    /// resend the request with the backoff until `default.api.timeout.ms`
    /// (60 s), as Kafka's `handleNotControllerError` does.
    ///
    /// # Errors
    /// Returns [`AdminError::Broker`] with the controller's error, such as
    /// `DUPLICATE_VOTER` (126), and with `REQUEST_TIMED_OUT` (7) at the
    /// deadline, or a transport error.
    pub async fn add_raft_voter(
        &mut self,
        cluster_id: Option<&str>,
        voter_id: i32,
        voter_directory_id: uuid::Uuid,
        endpoints: &[RaftVoterEndpoint],
    ) -> Result<(), AdminError> {
        let mut retry = ControllerRetry::new("AddRaftVoter", self.retry);
        loop {
            let request = add_raft_voter_request(
                cluster_id,
                voter_id,
                voter_directory_id,
                endpoints,
                retry.remaining_millis(),
            );
            let response = retry.bounded(self.conn.send(request)).await?;
            if response.error_code != NOT_CONTROLLER {
                return voter_result("AddRaftVoter", response.error_code, response.error_message);
            }
            retry.after_not_controller(self).await?;
        }
    }

    /// Remove one exact node and directory identity from the metadata quorum,
    /// as Kafka's `removeRaftVoter` operation does.
    ///
    /// `cluster_id` is Kafka's `RemoveRaftVoterOptions.clusterId`, the
    /// cluster ID string as `meta.properties` holds it; `None` sends a null
    /// cluster ID, which the controller does not check.
    ///
    /// `NOT_CONTROLLER` (41) makes the client find the controller again and
    /// resend the request with the backoff until `default.api.timeout.ms`
    /// (60 s), as Kafka's `handleNotControllerError` does.
    ///
    /// # Errors
    /// Returns a transport, protocol, or Kafka error from `RemoveRaftVoter`,
    /// and `REQUEST_TIMED_OUT` (7) at the deadline.
    pub async fn remove_raft_voter(
        &mut self,
        cluster_id: Option<&str>,
        node_id: i32,
        directory_id: uuid::Uuid,
    ) -> Result<(), AdminError> {
        let request = remove_raft_voter_request(cluster_id, node_id, directory_id);
        let mut retry = ControllerRetry::new("RemoveRaftVoter", self.retry);
        loop {
            let response = retry.bounded(self.conn.send(request.clone())).await?;
            if response.error_code != NOT_CONTROLLER {
                return voter_result(
                    "RemoveRaftVoter",
                    response.error_code,
                    response.error_message,
                );
            }
            retry.after_not_controller(self).await?;
        }
    }
}

#[cfg(test)]
mod tests {
    use std::sync::{Arc, Mutex};

    use krabka_client_core::MockReply;
    use krabka_protocol::owned::{
        add_raft_voter_request, add_raft_voter_response::AddRaftVoterResponse,
        remove_raft_voter_request, remove_raft_voter_response::RemoveRaftVoterResponse,
    };

    use super::*;
    use crate::partition_leaders::test_support::{
        ApiVersionRange, decode_request, encode_response, fast_admin, scripted_broker,
    };

    const DIRECTORY: uuid::Uuid = uuid::Uuid::from_u128(0x0123_4567_89ab_cdef_0123_4567_89ab_cdef);

    fn endpoint(listener: &str, host: &str, port: u16) -> RaftVoterEndpoint {
        RaftVoterEndpoint::new(listener, host, port).expect("valid endpoint")
    }

    #[test]
    fn endpoint_listener_must_be_trimmed_non_empty_upper_case() {
        for (name, listener, valid) in [
            ("upper case", "CONTROLLER", true),
            ("upper case with digits and symbols", "CONTROLLER_2-X", true),
            ("empty", "", false),
            ("lower case", "controller", false),
            ("leading whitespace", " CONTROLLER", false),
            ("trailing whitespace", "CONTROLLER ", false),
        ] {
            let result = RaftVoterEndpoint::new(listener, "localhost", 9093);
            assert2::assert!(
                matches!(result, Err(AdminError::InvalidArgument(_))) != valid,
                "case {name}"
            );
        }
    }

    #[test]
    fn add_request_names_each_endpoint_once() {
        let endpoints = [
            endpoint("CONTROLLER", "c1", 9093),
            endpoint("CONTROLLER", "c1", 9093),
            endpoint("SSL", "c1", 9094),
        ];
        for (name, cluster_id, expected_cluster) in [
            (
                "with cluster id",
                Some("MkU3OEVBNTcwNTJENDM2Qk"),
                Some("MkU3OEVBNTcwNTJENDM2Qk"),
            ),
            ("without cluster id", None, None),
        ] {
            assert2::assert!(
                add_raft_voter_request(cluster_id, 3, DIRECTORY, &endpoints, 1_000)
                    == AddRaftVoterRequest {
                        cluster_id: expected_cluster.map(str::to_owned),
                        timeout_ms: 1_000,
                        voter_id: 3,
                        voter_directory_id: ProtoUuid(*DIRECTORY.as_bytes()),
                        listeners: vec![
                            Listener {
                                name: "CONTROLLER".to_owned(),
                                host: "c1".to_owned(),
                                port: 9093,
                                ..Default::default()
                            },
                            Listener {
                                name: "SSL".to_owned(),
                                host: "c1".to_owned(),
                                port: 9094,
                                ..Default::default()
                            },
                        ],
                        ack_when_committed: true,
                        ..Default::default()
                    },
                "case {name}"
            );
        }
    }

    #[test]
    fn remove_request_sends_the_cluster_id_as_given() {
        for (name, cluster_id) in [
            ("with cluster id", Some("MkU3OEVBNTcwNTJENDM2Qk")),
            ("without cluster id", None),
        ] {
            assert2::assert!(
                remove_raft_voter_request(cluster_id, 3, DIRECTORY)
                    == RemoveRaftVoterRequest {
                        cluster_id: cluster_id.map(str::to_owned),
                        voter_id: 3,
                        voter_directory_id: ProtoUuid(*DIRECTORY.as_bytes()),
                        ..Default::default()
                    },
                "case {name}"
            );
        }
    }

    /// `describe_metadata_quorum` reads the leader, voters, observers and,
    /// from v2, every node's listener endpoints, as Kafka's
    /// `DescribeQuorumResponse.getQuorumInfo` does. A v1 answer carries no
    /// nodes.
    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn describe_metadata_quorum_reads_nodes_from_v2() {
        use krabka_protocol::owned::{
            common::describe_quorum_response::replica_state::ReplicaState,
            describe_quorum_request,
            describe_quorum_response::{
                DescribeQuorumResponse, Listener, Node, PartitionData, TopicData,
            },
        };

        let voter = |replica_id| ReplicaState {
            replica_id,
            log_end_offset: 40,
            ..Default::default()
        };
        let response = DescribeQuorumResponse {
            topics: vec![TopicData {
                topic_name: CLUSTER_METADATA_TOPIC.into(),
                partitions: vec![PartitionData {
                    leader_id: 1,
                    leader_epoch: 3,
                    high_watermark: 41,
                    current_voters: vec![voter(1), voter(2)],
                    observers: vec![voter(7)],
                    ..Default::default()
                }],
                ..Default::default()
            }],
            nodes: vec![Node {
                node_id: 1,
                listeners: vec![Listener {
                    name: "CONTROLLER".into(),
                    host: "c1.example".into(),
                    port: 9093,
                    ..Default::default()
                }],
                ..Default::default()
            }],
            ..Default::default()
        };
        let quorum = |nodes| MetadataQuorum {
            leader_id: 1,
            leader_epoch: 3,
            high_watermark: 41,
            voters: vec![
                QuorumReplica {
                    node_id: 1,
                    directory_id: uuid::Uuid::nil(),
                    log_end_offset: 40,
                    last_fetch_timestamp: -1,
                    last_caught_up_timestamp: -1,
                },
                QuorumReplica {
                    node_id: 2,
                    directory_id: uuid::Uuid::nil(),
                    log_end_offset: 40,
                    last_fetch_timestamp: -1,
                    last_caught_up_timestamp: -1,
                },
            ],
            observers: vec![QuorumReplica {
                node_id: 7,
                directory_id: uuid::Uuid::nil(),
                log_end_offset: 40,
                last_fetch_timestamp: -1,
                last_caught_up_timestamp: -1,
            }],
            nodes,
        };
        for (name, max_version, expected) in [
            (
                "v2 carries nodes",
                2,
                quorum(vec![QuorumNode {
                    node_id: 1,
                    endpoints: vec![endpoint("CONTROLLER", "c1.example", 9093)],
                }]),
            ),
            ("v1 carries none", 1, quorum(vec![])),
        ] {
            let answer = response.clone();
            let broker = scripted_broker(
                vec![
                    ApiVersionRange::builder()
                        .api_key(describe_quorum_request::API_KEY)
                        .max_version(max_version)
                        .build(),
                ],
                move |key, version, _, _| {
                    if key == describe_quorum_request::API_KEY {
                        MockReply::Respond(encode_response(&answer, version, true))
                    } else {
                        MockReply::Silent
                    }
                },
            )
            .await;
            let mut admin = fast_admin(broker.addr, krabka_units::secs(5)).await;

            let described = admin.describe_metadata_quorum().await.expect("describes");

            broker.stop();
            assert2::assert!(described == expected, "case {name}");
        }
    }

    /// Kafka's `addRaftVoter` and `removeRaftVoter` resend after
    /// `NOT_CONTROLLER` and fail at once on every other error code.
    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn voter_calls_retry_not_controller_and_stop_on_other_codes() {
        for (name, add, codes, expected) in [
            ("add succeeds", true, vec![0], (Ok(()), 1)),
            (
                "add after not controller",
                true,
                vec![NOT_CONTROLLER, 0],
                (Ok(()), 2),
            ),
            (
                "add duplicate voter is final",
                true,
                vec![126],
                (Err(("AddRaftVoter", 126, Some("dup".to_owned()))), 1),
            ),
            ("remove succeeds", false, vec![0], (Ok(()), 1)),
            (
                "remove after not controller",
                false,
                vec![NOT_CONTROLLER, NOT_CONTROLLER, 0],
                (Ok(()), 3),
            ),
            (
                "remove voter not found is final",
                false,
                vec![127],
                (Err(("RemoveRaftVoter", 127, Some("dup".to_owned()))), 1),
            ),
        ] {
            let requests = Arc::new(Mutex::new(Vec::<(i16, i32)>::new()));
            let handler_requests = Arc::clone(&requests);
            let broker = scripted_broker(
                vec![
                    ApiVersionRange::builder()
                        .api_key(add_raft_voter_request::API_KEY)
                        .max_version(1)
                        .build(),
                    ApiVersionRange::builder()
                        .api_key(remove_raft_voter_request::API_KEY)
                        .build(),
                ],
                move |api_key, version, body, _| {
                    let mut requests = handler_requests.lock().expect("requests lock");
                    let code = codes[requests.len().min(codes.len() - 1)];
                    let message = (code != 0).then(|| "dup".to_owned());
                    let reply = match api_key {
                        add_raft_voter_request::API_KEY => {
                            let request: AddRaftVoterRequest = decode_request(body, version, true);
                            requests.push((version, request.voter_id));
                            encode_response(
                                &AddRaftVoterResponse {
                                    error_code: code,
                                    error_message: message,
                                    ..Default::default()
                                },
                                version,
                                true,
                            )
                        }
                        remove_raft_voter_request::API_KEY => {
                            let request: RemoveRaftVoterRequest =
                                decode_request(body, version, true);
                            requests.push((version, request.voter_id));
                            encode_response(
                                &RemoveRaftVoterResponse {
                                    error_code: code,
                                    error_message: message,
                                    ..Default::default()
                                },
                                version,
                                true,
                            )
                        }
                        _ => return MockReply::Silent,
                    };
                    MockReply::Respond(reply)
                },
            )
            .await;
            let mut admin = fast_admin(broker.addr, krabka_units::secs(5)).await;

            let result = if add {
                admin
                    .add_raft_voter(None, 3, DIRECTORY, &[endpoint("CONTROLLER", "c3", 9093)])
                    .await
            } else {
                admin.remove_raft_voter(None, 3, DIRECTORY).await
            }
            .map_err(|error| match error {
                AdminError::Broker {
                    api, code, message, ..
                } => (api, code, message),
                other => panic!("case {name}: unexpected error {other:?}"),
            });

            broker.stop();
            let version = i16::from(add);
            assert2::assert!(
                (result, requests.lock().expect("requests lock").clone())
                    == (expected.0, vec![(version, 3); expected.1]),
                "case {name}"
            );
        }
    }
}