krabka-client-admin 0.7.0

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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
//! Cluster feature administration, as Kafka's `Admin.describeFeatures` and
//! `Admin.updateFeatures`.

use std::{collections::BTreeMap, time::Duration};

use krabka_protocol::owned::{
    api_versions_request::ApiVersionsRequest,
    api_versions_response::ApiVersionsResponse,
    update_features_request::{FeatureUpdateKey, UpdateFeaturesRequest},
    update_features_response::UpdateFeaturesResponse,
};
use krabka_units::{Time, convert::TimeExt as _};

use crate::{
    AdminClient, AdminError, KafkaError, MetadataVersionUpdate, NOT_CONTROLLER, kafka_error_if,
    kafka_error_name,
    log_dirs::{NodeTarget, call_node},
    retry::{ControllerRetry, CoordinatorRetry, RetryPolicy},
};

const METADATA_VERSION_FEATURE: &str = "metadata.version";

/// `UNKNOWN_SERVER_ERROR`: Kafka's code for a plain `ApiException`.
const UNKNOWN_SERVER_ERROR: i16 = -1;

/// The lowest `ApiVersions` version whose response carries features.
const FEATURES_API_VERSIONS_MIN_VERSION: i16 = 3;

/// The lowest `UpdateFeatures` version with `UpgradeType` and `ValidateOnly`.
/// Kafka's generated `UpdateFeaturesRequestData` refuses to write either
/// field at a non-default value at v0, where neither exists.
const UPGRADE_TYPE_MIN_VERSION: i16 = 1;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FeatureRange {
    pub name: String,
    pub min_version: i16,
    pub max_version: i16,
}

/// The features that one node reports, as Kafka's `FeatureMetadata`.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FeatureMetadata {
    pub supported: Vec<FeatureRange>,
    pub finalized: Vec<FeatureRange>,
    /// The epoch of the finalized features. `None` when the node reports a
    /// negative epoch, as Kafka's `finalizedFeaturesEpoch` is empty then.
    pub finalized_features_epoch: Option<i64>,
}

/// What kind of change a [`FeatureUpdate`] asks for, as Kafka's
/// `FeatureUpdate.UpgradeType`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum UpgradeType {
    /// Raise the finalized level only.
    Upgrade,
    /// Lower the finalized level, or delete the feature, only where no
    /// metadata is lost.
    SafeDowngrade,
    /// Lower the finalized level, or delete the feature, even where metadata
    /// is lost.
    UnsafeDowngrade,
}

impl UpgradeType {
    /// The `UpgradeType` code of the wire request: 1, 2 or 3.
    #[must_use]
    pub const fn code(self) -> i8 {
        match self {
            Self::Upgrade => 1,
            Self::SafeDowngrade => 2,
            Self::UnsafeDowngrade => 3,
        }
    }
}

/// One finalized-feature change, as Kafka's `FeatureUpdate`. The feature name
/// is the key of the map that [`AdminClient::update_features`] takes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FeatureUpdate {
    max_version_level: i16,
    upgrade_type: UpgradeType,
}

impl FeatureUpdate {
    /// A change of the feature to `max_version_level`. Level 0 deletes the
    /// feature and needs a downgrade type.
    ///
    /// # Errors
    /// Returns [`AdminError::InvalidArgument`] for level 0 with
    /// [`UpgradeType::Upgrade`] and for a negative level, as Kafka's
    /// constructor throws `IllegalArgumentException`.
    pub fn new(max_version_level: i16, upgrade_type: UpgradeType) -> Result<Self, AdminError> {
        if max_version_level == 0 && upgrade_type == UpgradeType::Upgrade {
            return Err(AdminError::InvalidArgument(format!(
                "The upgradeType flag should be set to SAFE_DOWNGRADE or UNSAFE_DOWNGRADE when \
                 the provided maxVersionLevel:{max_version_level} is < 1."
            )));
        }
        if max_version_level < 0 {
            return Err(AdminError::InvalidArgument(
                "Cannot specify a negative version level.".into(),
            ));
        }
        Ok(Self {
            max_version_level,
            upgrade_type,
        })
    }

    /// The new maximum finalized level.
    #[must_use]
    pub const fn max_version_level(&self) -> i16 {
        self.max_version_level
    }

    /// The kind of change.
    #[must_use]
    pub const fn upgrade_type(&self) -> UpgradeType {
        self.upgrade_type
    }
}

/// Options of [`AdminClient::update_features`], as Kafka's
/// `UpdateFeaturesOptions`.
#[derive(Debug, Clone, Copy, Default, PartialEq, bon::Builder)]
pub struct UpdateFeaturesOptions {
    /// The deadline of the call, including retries. Each request carries the
    /// time that remains as its `timeout_ms`. `None` uses the client's
    /// `default.api.timeout.ms`.
    #[builder(with = |millis: i64| Time::from_millis(millis))]
    pub timeout: Option<Time>,
    /// Ask the controller to validate the updates and apply none. Needs
    /// `UpdateFeatures` v1.
    #[builder(default)]
    pub validate_only: bool,
}

/// Options of [`AdminClient::describe_features`], as Kafka's
/// `DescribeFeaturesOptions`.
#[derive(Debug, Clone, Copy, Default, PartialEq, bon::Builder)]
pub struct DescribeFeaturesOptions {
    /// The deadline of the call, including retries. `None` uses the client's
    /// `default.api.timeout.ms`.
    #[builder(with = |millis: i64| Time::from_millis(millis))]
    pub timeout: Option<Time>,
    /// The node to ask. `None` asks the node of the client's connection, as
    /// Kafka's `LeastLoadedBrokerOrActiveKController` picks one. A node id
    /// goes to that broker, or to that controller with a controller
    /// bootstrap, as Kafka's `ConstantNodeIdProvider` does.
    pub node_id: Option<i32>,
}

/// The result of each feature of an [`AdminClient::update_features`] call,
/// as Kafka's `UpdateFeaturesResult.values`.
pub type UpdateFeaturesResults = BTreeMap<String, Result<(), KafkaError>>;

/// `base` with the call deadline `timeout`, when set.
fn call_policy(timeout: Option<Time>, base: RetryPolicy) -> RetryPolicy {
    match timeout {
        Some(timeout) => RetryPolicy {
            timeout: Duration::from_millis(u64::try_from(timeout.millis_i64()).unwrap_or(0)),
            ..base
        },
        None => base,
    }
}

/// The `UpdateFeatures` request of `updates`, as `KafkaAdminClient`'s
/// `updateFeatures` builds it. It sets `UpgradeType` and never the v0
/// `AllowDowngrade`, which stays `false`.
fn update_request(
    updates: &BTreeMap<String, FeatureUpdate>,
    options: UpdateFeaturesOptions,
    timeout_ms: i32,
) -> UpdateFeaturesRequest {
    UpdateFeaturesRequest {
        timeout_ms,
        feature_updates: updates
            .iter()
            .map(|(feature, update)| FeatureUpdateKey {
                feature: feature.clone(),
                max_version_level: update.max_version_level,
                upgrade_type: update.upgrade_type.code(),
                ..Default::default()
            })
            .collect(),
        validate_only: options.validate_only,
        ..Default::default()
    }
}

/// The lowest `UpdateFeatures` version that can carry `updates` and
/// `options`. Kafka's v0 serializer throws `UnsupportedVersionException` for
/// a non-default `UpgradeType` or `ValidateOnly`, so a downgrade or a
/// validate-only call needs v1.
fn update_min_version(
    updates: &BTreeMap<String, FeatureUpdate>,
    options: UpdateFeaturesOptions,
) -> i16 {
    let needs_v1 = options.validate_only
        || updates
            .values()
            .any(|update| update.upgrade_type != UpgradeType::Upgrade);
    if needs_v1 {
        UPGRADE_TYPE_MIN_VERSION
    } else {
        0
    }
}

impl AdminClient {
    /// Returns the supported and cluster-finalized feature ranges of one node,
    /// as Kafka's `describeFeatures`.
    ///
    /// # Errors
    /// Returns a transport, protocol, or broker error. With a node id, a node
    /// that the metadata does not name, or that does not answer, is retried
    /// until the deadline and then gives `REQUEST_TIMED_OUT` (7).
    pub async fn describe_features(
        &self,
        options: DescribeFeaturesOptions,
    ) -> Result<FeatureMetadata, AdminError> {
        let request = ApiVersionsRequest {
            client_software_name: "krabka-client-rs".into(),
            client_software_version: env!("CARGO_PKG_VERSION").into(),
            ..Default::default()
        };
        let policy = call_policy(options.timeout, self.retry);
        let response = if let Some(node_id) = options.node_id {
            call_node(
                &self.conn,
                NodeTarget {
                    node_id,
                    supports_controllers: true,
                    min_version: Some(FEATURES_API_VERSIONS_MIN_VERSION),
                },
                &self.options,
                request,
                CoordinatorRetry::new(policy),
            )
            .await
            .map_err(|error| AdminError::Broker {
                api: "ApiVersions",
                code: error.code,
                name: error.name,
                message: error.message,
            })?
        } else {
            ControllerRetry::new("ApiVersions", policy)
                .bounded(
                    self.conn
                        .send_at_least(request, FEATURES_API_VERSIONS_MIN_VERSION),
                )
                .await?
        };
        parse_feature_metadata(response)
    }

    /// Applies finalized-feature updates through `UpdateFeatures` on the
    /// active controller, as Kafka's `updateFeatures`.
    ///
    /// Every feature of `updates` gets a result. A top-level error of the
    /// controller fails every feature with it. A v2 response with no
    /// per-feature results and no error succeeds every feature, and a
    /// feature that a v0/v1 response leaves out fails with
    /// `UNKNOWN_SERVER_ERROR`, as Kafka does.
    ///
    /// # Errors
    /// Returns [`AdminError::InvalidArgument`], and sends nothing, for no
    /// updates or a blank feature name, as Kafka throws
    /// `IllegalArgumentException`. Returns
    /// [`krabka_client_core::ClientError::IncompatibleVersion`] before
    /// sending when a downgrade or [`UpdateFeaturesOptions::validate_only`]
    /// meets a controller with only v0, as Kafka's request serializer throws
    /// `UnsupportedVersionException`. A `NOT_CONTROLLER` answer is retried
    /// after controller discovery until the deadline, then gives
    /// `REQUEST_TIMED_OUT` (7). Transport errors are returned as they are.
    pub async fn update_features(
        &mut self,
        updates: &BTreeMap<String, FeatureUpdate>,
        options: UpdateFeaturesOptions,
    ) -> Result<UpdateFeaturesResults, AdminError> {
        if updates.is_empty() {
            return Err(AdminError::InvalidArgument(
                "Feature updates can not be null or empty.".into(),
            ));
        }
        if updates.keys().any(|feature| feature.trim().is_empty()) {
            return Err(AdminError::InvalidArgument(
                "Provided feature can not be empty.".into(),
            ));
        }
        let min_version = update_min_version(updates, options);
        let mut retry =
            ControllerRetry::new("UpdateFeatures", call_policy(options.timeout, self.retry));
        loop {
            let request = update_request(updates, options, retry.remaining_millis());
            let response = retry
                .bounded(self.conn.send_at_least(request, min_version))
                .await?;
            if response.error_code != NOT_CONTROLLER {
                return Ok(update_results(updates, response));
            }
            retry.after_not_controller(self).await?;
        }
    }

    /// Finalize `metadata.version` at `level` through `UpdateFeatures`.
    ///
    /// # Errors
    /// Returns a transport, protocol, or broker error when Kafka rejects the
    /// requested level.
    pub async fn update_metadata_version(
        &mut self,
        level: i16,
        upgrade_type: UpgradeType,
        timeout: Time,
    ) -> Result<MetadataVersionUpdate, AdminError> {
        let updates = maplit::btreemap! {
            METADATA_VERSION_FEATURE.to_owned() => FeatureUpdate::new(level, upgrade_type)?,
        };
        let results = self
            .update_features(
                &updates,
                UpdateFeaturesOptions::builder()
                    .timeout(timeout.millis_i64())
                    .validate_only(false)
                    .build(),
            )
            .await?;
        if let Some(Err(error)) = results.into_values().next() {
            return Err(AdminError::Broker {
                api: "UpdateFeatures",
                code: error.code,
                name: error.name,
                message: error.message,
            });
        }
        Ok(MetadataVersionUpdate { level })
    }
}

fn parse_feature_metadata(response: ApiVersionsResponse) -> Result<FeatureMetadata, AdminError> {
    if response.error_code != 0 {
        return Err(AdminError::Broker {
            api: "ApiVersions",
            code: response.error_code,
            name: kafka_error_name(response.error_code),
            message: None,
        });
    }
    Ok(FeatureMetadata {
        supported: response
            .supported_features
            .into_iter()
            .map(|feature| FeatureRange {
                name: feature.name,
                min_version: feature.min_version,
                max_version: feature.max_version,
            })
            .collect(),
        finalized: response
            .finalized_features
            .into_iter()
            .map(|feature| FeatureRange {
                name: feature.name,
                min_version: feature.min_version_level,
                max_version: feature.max_version_level,
            })
            .collect(),
        finalized_features_epoch: (response.finalized_features_epoch >= 0)
            .then_some(response.finalized_features_epoch),
    })
}

/// The result of each feature of `updates` from `response`, as
/// `KafkaAdminClient`'s `updateFeatures` completes its futures.
fn update_results(
    updates: &BTreeMap<String, FeatureUpdate>,
    response: UpdateFeaturesResponse,
) -> UpdateFeaturesResults {
    if let Some(error) = kafka_error_if(response.error_code, response.error_message) {
        return updates
            .keys()
            .map(|feature| (feature.clone(), Err(error.clone())))
            .collect();
    }
    if response.results.is_empty() {
        return updates
            .keys()
            .map(|feature| (feature.clone(), Ok(())))
            .collect();
    }
    let mut results = BTreeMap::new();
    for result in response.results {
        if !updates.contains_key(&result.feature) {
            tracing::warn!(
                feature = %result.feature,
                "server response mentioned unknown feature"
            );
            continue;
        }
        let outcome = match kafka_error_if(result.error_code, result.error_message) {
            Some(error) => Err(error),
            None => Ok(()),
        };
        results.insert(result.feature, outcome);
    }
    for feature in updates.keys() {
        results.entry(feature.clone()).or_insert_with(|| {
            Err(KafkaError {
                code: UNKNOWN_SERVER_ERROR,
                name: kafka_error_name(UNKNOWN_SERVER_ERROR),
                message: Some(format!(
                    "The controller response did not contain a result for feature {feature}"
                )),
            })
        });
    }
    results
}

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

    use krabka_client_core::{ClientError, MockBroker, MockReply};
    use krabka_protocol::owned::{
        api_versions_request,
        api_versions_response::{ApiVersion, FinalizedFeatureKey, SupportedFeatureKey},
        metadata_request,
        metadata_response::{MetadataResponse, MetadataResponseBroker},
        update_features_request,
        update_features_response::UpdatableFeatureResult,
    };

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

    fn update(level: i16, upgrade_type: UpgradeType) -> FeatureUpdate {
        FeatureUpdate::new(level, upgrade_type).expect("valid update")
    }

    fn key(feature: &str, max_version_level: i16, upgrade_type: i8) -> FeatureUpdateKey {
        FeatureUpdateKey {
            feature: feature.into(),
            max_version_level,
            upgrade_type,
            ..Default::default()
        }
    }

    fn error(code: i16, message: Option<&str>) -> KafkaError {
        KafkaError {
            code,
            name: kafka_error_name(code),
            message: message.map(Into::into),
        }
    }

    #[test]
    fn feature_update_refuses_what_kafka_refuses() {
        for (name, level, upgrade_type, ok) in [
            ("upgrade to 1", 1, UpgradeType::Upgrade, true),
            ("safe delete", 0, UpgradeType::SafeDowngrade, true),
            ("unsafe delete", 0, UpgradeType::UnsafeDowngrade, true),
            ("upgrade to 0", 0, UpgradeType::Upgrade, false),
            ("negative level", -1, UpgradeType::SafeDowngrade, false),
        ] {
            let result = FeatureUpdate::new(level, upgrade_type);
            match (ok, result) {
                (true, Ok(update)) => assert2::assert!(
                    (update.max_version_level(), update.upgrade_type()) == (level, upgrade_type),
                    "case {name}"
                ),
                (false, Err(AdminError::InvalidArgument(_))) => {}
                (_, other) => panic!("case {name}: {other:?}"),
            }
        }
    }

    #[test]
    fn upgrade_type_codes_match_kafka() {
        assert2::assert!(
            [
                UpgradeType::Upgrade.code(),
                UpgradeType::SafeDowngrade.code(),
                UpgradeType::UnsafeDowngrade.code(),
            ] == [1, 2, 3]
        );
    }

    #[test]
    fn describe_features_preserves_supported_finalized_and_epoch() {
        for (name, epoch, expected_epoch) in
            [("finalized", 7, Some(7)), ("no finalized epoch", -1, None)]
        {
            let metadata = parse_feature_metadata(ApiVersionsResponse {
                supported_features: vec![SupportedFeatureKey {
                    name: "kraft.version".into(),
                    min_version: 0,
                    max_version: 1,
                    ..Default::default()
                }],
                finalized_features: vec![FinalizedFeatureKey {
                    name: "kraft.version".into(),
                    min_version_level: 1,
                    max_version_level: 1,
                    ..Default::default()
                }],
                finalized_features_epoch: epoch,
                ..Default::default()
            })
            .unwrap();
            assert2::assert!(
                metadata
                    == FeatureMetadata {
                        supported: vec![FeatureRange {
                            name: "kraft.version".into(),
                            min_version: 0,
                            max_version: 1,
                        }],
                        finalized: vec![FeatureRange {
                            name: "kraft.version".into(),
                            min_version: 1,
                            max_version: 1,
                        }],
                        finalized_features_epoch: expected_epoch,
                    },
                "case {name}"
            );
        }
    }

    #[test]
    fn update_results_complete_every_feature_as_kafka_does() {
        let updates = maplit::btreemap! {
            "group.version".to_owned() => update(1, UpgradeType::Upgrade),
            "metadata.version".to_owned() => update(20, UpgradeType::Upgrade),
        };
        let row = |feature: &str, error_code, message: Option<&str>| UpdatableFeatureResult {
            feature: feature.into(),
            error_code,
            error_message: message.map(Into::into),
            ..Default::default()
        };
        let missing = "The controller response did not contain a result for feature \
                       metadata.version";
        for (name, response, expected) in [
            (
                "v2 success has no rows",
                UpdateFeaturesResponse::default(),
                [Ok(()), Ok(())],
            ),
            (
                "top-level error fails every feature",
                UpdateFeaturesResponse {
                    error_code: 95,
                    error_message: Some("bad".into()),
                    ..Default::default()
                },
                [Err(error(95, Some("bad"))), Err(error(95, Some("bad")))],
            ),
            (
                "per-feature rows, one missing, one unknown",
                UpdateFeaturesResponse {
                    results: vec![
                        row("group.version", 95, Some("no")),
                        row("other.version", 0, None),
                    ],
                    ..Default::default()
                },
                [
                    Err(error(95, Some("no"))),
                    Err(error(UNKNOWN_SERVER_ERROR, Some(missing))),
                ],
            ),
        ] {
            let [group, metadata] = expected;
            assert2::assert!(
                update_results(&updates, response)
                    == maplit::btreemap! {
                        "group.version".to_owned() => group,
                        "metadata.version".to_owned() => metadata,
                    },
                "case {name}"
            );
        }
    }

    /// A broker that advertises `UpdateFeatures` v0 up to `max_version`,
    /// records each `UpdateFeatures` request with its version, and answers
    /// with no error.
    async fn update_features_broker(
        max_version: i16,
        seen: Arc<Mutex<Vec<(i16, UpdateFeaturesRequest)>>>,
    ) -> MockBroker {
        MockBroker::start(move |api_key, version, _, body| match api_key {
            api_versions_request::API_KEY => Some(
                api_versions()
                    .apis(vec![
                        ApiVersionRange::builder()
                            .api_key(update_features_request::API_KEY)
                            .max_version(max_version)
                            .build(),
                    ])
                    .call(),
            ),
            update_features_request::API_KEY => {
                let mut request: UpdateFeaturesRequest = decode_request(body, version, true);
                // The deadline that remains differs between runs.
                request.timeout_ms = 0;
                seen.lock().expect("seen lock").push((version, request));
                Some(encode_response(
                    &UpdateFeaturesResponse::default(),
                    version,
                    true,
                ))
            }
            _ => None,
        })
        .await
    }

    /// The whole `UpdateFeatures` request that reaches the controller, for
    /// each version the controller advertises, each upgrade type and each
    /// `validate_only`. A downgrade or a validate-only call is refused
    /// before sending against a v0-only controller, as Kafka's v0 serializer
    /// throws `UnsupportedVersionException` for a non-default `UpgradeType`
    /// or `ValidateOnly`. `AllowDowngrade` is never set, as Kafka never sets
    /// it.
    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn update_features_sends_kafkas_request_per_version() {
        let upgrade_types = [
            UpgradeType::Upgrade,
            UpgradeType::SafeDowngrade,
            UpgradeType::UnsafeDowngrade,
        ];
        for max_version in 0..=2 {
            for upgrade_type in upgrade_types {
                for validate_only in [false, true] {
                    let name = format!("v{max_version} {upgrade_type:?} validate={validate_only}");
                    let seen = Arc::new(Mutex::new(Vec::new()));
                    let broker = update_features_broker(max_version, Arc::clone(&seen)).await;
                    let mut admin = AdminClient::connect(&[broker.addr.to_string()])
                        .await
                        .expect("admin connects");
                    let level = if upgrade_type == UpgradeType::Upgrade {
                        7
                    } else {
                        0
                    };
                    let updates = maplit::btreemap! {
                        "group.version".to_owned() => update(1, upgrade_type),
                        "share.version".to_owned() => update(level, upgrade_type),
                    };

                    let result = admin
                        .update_features(
                            &updates,
                            UpdateFeaturesOptions::builder()
                                .validate_only(validate_only)
                                .build(),
                        )
                        .await;
                    broker.stop();

                    let sendable = max_version >= 1
                        || (upgrade_type == UpgradeType::Upgrade && !validate_only);
                    if !sendable {
                        assert2::assert!(
                            matches!(
                                result,
                                Err(AdminError::Transport(ClientError::IncompatibleVersion {
                                    api_key: update_features_request::API_KEY,
                                    client_min: 1,
                                    ..
                                }))
                            ),
                            "case {name}: {result:?}"
                        );
                        assert2::assert!(seen.lock().unwrap().is_empty(), "case {name}");
                        continue;
                    }
                    let code = upgrade_type.code();
                    // v0 carries neither field, so it decodes as the defaults.
                    let (wire_code, wire_validate) = if max_version == 0 {
                        (1, false)
                    } else {
                        (code, validate_only)
                    };
                    assert2::assert!(
                        result.expect("update succeeds")
                            == maplit::btreemap! {
                                "group.version".to_owned() => Ok(()),
                                "share.version".to_owned() => Ok(()),
                            },
                        "case {name}"
                    );
                    assert2::assert!(
                        *seen.lock().unwrap()
                            == vec![(
                                max_version,
                                UpdateFeaturesRequest {
                                    timeout_ms: 0,
                                    feature_updates: vec![
                                        key("group.version", 1, wire_code),
                                        key("share.version", level, wire_code),
                                    ],
                                    validate_only: wire_validate,
                                    ..Default::default()
                                }
                            )],
                        "case {name}"
                    );
                }
            }
        }
    }

    #[tokio::test]
    async fn update_features_refuses_empty_or_blank_features_before_sending() {
        let broker = MockBroker::start(|api_key, _, _, _| {
            (api_key == api_versions_request::API_KEY).then(|| {
                api_versions()
                    .apis(vec![
                        ApiVersionRange::builder()
                            .api_key(update_features_request::API_KEY)
                            .max_version(2)
                            .build(),
                    ])
                    .call()
            })
        })
        .await;
        let mut admin = AdminClient::connect(&[broker.addr.to_string()])
            .await
            .expect("admin connects");
        for (name, updates) in [
            ("empty", BTreeMap::new()),
            (
                "blank",
                maplit::btreemap! {
                    " ".to_owned() => update(1, UpgradeType::Upgrade),
                },
            ),
        ] {
            let result = admin
                .update_features(&updates, UpdateFeaturesOptions::builder().build())
                .await;
            assert2::assert!(
                matches!(result, Err(AdminError::InvalidArgument(_))),
                "case {name}"
            );
        }
        broker.stop();
    }

    /// A broker `node_id` that answers `ApiVersions` with `supported` as its
    /// one supported feature, and `Metadata` with `nodes`.
    async fn feature_node(
        supported: &'static str,
        nodes: Arc<Mutex<Vec<(i32, SocketAddr)>>>,
    ) -> MockBroker {
        MockBroker::start_with_replies(move |api_key, version, _, _| match api_key {
            api_versions_request::API_KEY => MockReply::Respond(encode_response(
                &ApiVersionsResponse {
                    api_keys: vec![
                        ApiVersion {
                            api_key: api_versions_request::API_KEY,
                            min_version: 0,
                            max_version: 4,
                            ..Default::default()
                        },
                        ApiVersion {
                            api_key: metadata_request::API_KEY,
                            min_version: 12,
                            max_version: 12,
                            ..Default::default()
                        },
                    ],
                    supported_features: vec![SupportedFeatureKey {
                        name: supported.into(),
                        min_version: 0,
                        max_version: 1,
                        ..Default::default()
                    }],
                    finalized_features_epoch: 3,
                    ..Default::default()
                },
                version,
                false,
            )),
            metadata_request::API_KEY => MockReply::Respond(encode_response(
                &MetadataResponse {
                    controller_id: 1,
                    brokers: nodes
                        .lock()
                        .expect("nodes lock")
                        .iter()
                        .map(|(node_id, addr)| MetadataResponseBroker {
                            node_id: *node_id,
                            host: addr.ip().to_string(),
                            port: i32::from(addr.port()),
                            ..Default::default()
                        })
                        .collect(),
                    ..Default::default()
                },
                version,
                true,
            )),
            _ => MockReply::Silent,
        })
        .await
    }

    /// `describe_features` asks the node of the client's connection, or the
    /// node that `node_id` names, as Kafka's `describeFeatures` with a
    /// `DescribeFeaturesOptions.nodeId` does for `kafka-features describe
    /// --node-id`.
    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn describe_features_asks_the_named_node() {
        let nodes = Arc::new(Mutex::new(Vec::new()));
        let first = feature_node("on.node.1", Arc::clone(&nodes)).await;
        let second = feature_node("on.node.2", Arc::clone(&nodes)).await;
        *nodes.lock().unwrap() = vec![(1, first.addr), (2, second.addr)];
        let admin = fast_admin(first.addr, krabka_units::secs(5)).await;

        for (name, node_id, feature) in [
            ("any node", None, "on.node.1"),
            ("node 1", Some(1), "on.node.1"),
            ("node 2", Some(2), "on.node.2"),
        ] {
            let metadata = admin
                .describe_features(
                    DescribeFeaturesOptions::builder()
                        .maybe_node_id(node_id)
                        .build(),
                )
                .await
                .expect("describe succeeds");
            assert2::assert!(
                metadata
                    == FeatureMetadata {
                        supported: vec![FeatureRange {
                            name: feature.into(),
                            min_version: 0,
                            max_version: 1,
                        }],
                        finalized: Vec::new(),
                        finalized_features_epoch: Some(3),
                    },
                "case {name}"
            );
        }

        let unknown = admin
            .describe_features(
                DescribeFeaturesOptions::builder()
                    .timeout(50)
                    .node_id(9)
                    .build(),
            )
            .await;
        assert2::assert!(
            matches!(
                unknown,
                Err(AdminError::Broker {
                    code: crate::retry::REQUEST_TIMED_OUT,
                    ..
                })
            ),
            "{unknown:?}"
        );
        first.stop();
        second.stop();
    }

    #[tokio::test]
    async fn update_metadata_version_surfaces_the_feature_error() {
        let broker = MockBroker::start(|api_key, version, _, _| match api_key {
            api_versions_request::API_KEY => Some(
                api_versions()
                    .apis(vec![
                        ApiVersionRange::builder()
                            .api_key(update_features_request::API_KEY)
                            .max_version(1)
                            .build(),
                    ])
                    .call(),
            ),
            update_features_request::API_KEY => Some(encode_response(
                &UpdateFeaturesResponse {
                    results: vec![UpdatableFeatureResult {
                        feature: METADATA_VERSION_FEATURE.into(),
                        error_code: 95,
                        error_message: Some("not supported by every broker".into()),
                        ..Default::default()
                    }],
                    ..Default::default()
                },
                version,
                true,
            )),
            _ => None,
        })
        .await;
        let mut admin = AdminClient::connect(&[broker.addr.to_string()])
            .await
            .expect("admin connects");
        let result = admin
            .update_metadata_version(15, UpgradeType::SafeDowngrade, krabka_units::secs(5))
            .await;
        broker.stop();
        assert2::assert!(
            matches!(
                result,
                Err(AdminError::Broker {
                    api: "UpdateFeatures",
                    code: 95,
                    ..
                })
            ),
            "{result:?}"
        );
    }
}