openraft 0.10.0-alpha.32

Advanced Raft consensus
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
use std::collections::BTreeMap;
use std::collections::BTreeSet;

use maplit::btreeset;

use super::VecProgress;
use crate::progress::VecProgressEntry;
use crate::progress::VecProgressEntryData;
use crate::quorum::QuorumSet;

const LCG_A: u64 = 6364136223846793005;
const LCG_C: u64 = 1442695040888963407;

#[derive(Clone, Debug, PartialEq, Eq)]
struct IdValData<ID, Val, Data> {
    id: ID,
    val: Val,
    data: Data,
}

impl<ID, Val, Data> IdValData<ID, Val, Data> {
    fn new(id: ID, val: Val, data: Data) -> Self {
        Self { id, val, data }
    }
}

impl<ID, Val, Data> VecProgressEntry for IdValData<ID, Val, Data>
where
    ID: 'static + PartialEq,
    Val: Clone + Default + Ord,
{
    type Id = ID;
    type Progress = Val;

    fn id(&self) -> &Self::Id {
        &self.id
    }

    fn progress(&self) -> &Self::Progress {
        &self.val
    }

    fn progress_mut(&mut self) -> &mut Self::Progress {
        &mut self.val
    }
}

impl<ID, Val, Data> VecProgressEntryData for IdValData<ID, Val, Data>
where
    ID: 'static + PartialEq,
    Val: Clone + Default + Ord,
{
    type Data = Data;

    fn data(&self) -> &Self::Data {
        &self.data
    }

    fn data_mut(&mut self) -> &mut Self::Data {
        &mut self.data
    }
}

#[derive(Clone, Debug)]
struct RequiredSetQuorum {
    ids: BTreeSet<u64>,
    required: BTreeSet<u64>,
}

impl RequiredSetQuorum {
    /// Build a quorum set that grants only when every required ID is present.
    ///
    /// This intentionally does not implement majority semantics, so it can
    /// catch accidental assumptions in `VecProgress`.
    fn new(ids: impl IntoIterator<Item = u64>, required: impl IntoIterator<Item = u64>) -> Self {
        Self {
            ids: ids.into_iter().collect(),
            required: required.into_iter().collect(),
        }
    }
}

impl QuorumSet for RequiredSetQuorum {
    type Id = u64;

    type Iter = std::collections::btree_set::IntoIter<u64>;

    fn is_quorum<'a, I: Iterator<Item = &'a Self::Id> + Clone>(&self, ids: I) -> bool {
        let granted = ids.copied().collect::<BTreeSet<_>>();
        self.required.is_subset(&granted)
    }

    fn ids(&self) -> Self::Iter {
        self.ids.clone().into_iter()
    }
}

/// Advance a deterministic pseudo-random sequence for model-based tests.
///
/// The generator is intentionally tiny and reproducible; it is not used for
/// randomness quality, only for broadening the monotonic update cases.
fn next_random(seed: &mut u64) -> u64 {
    *seed = seed.wrapping_mul(LCG_A).wrapping_add(LCG_C);
    *seed
}

/// Build learner IDs as the complement of the current quorum IDs.
///
/// Randomized upgrade tests use this to preserve progress for all known
/// nodes when switching between simple, joint, and shrunk quorum sets.
fn learner_ids_for<QS>(quorum_set: &QS, known_ids: impl IntoIterator<Item = u64>) -> Vec<u64>
where QS: QuorumSet<Id = u64> {
    let voter_ids = quorum_set.ids().collect::<BTreeSet<_>>();
    known_ids.into_iter().filter(|id| !voter_ids.contains(id)).collect()
}

/// Copy both sides of a `Result<&u64, &u64>` returned by progress updates.
///
/// `Result::copied()` only copies the `Ok` value, but these tests compare
/// both successful updates and missing-id errors by value.
fn copy_result(res: Result<&u64, &u64>) -> Result<u64, u64> {
    match res {
        Ok(x) => Ok(*x),
        Err(x) => Err(*x),
    }
}

/// Compute quorum-accepted progress with a straightforward reference model.
///
/// This intentionally ignores `VecProgress`'s internal ordering optimization:
/// it tries candidate progress values from high to low and returns the first
/// value whose reached node IDs form a quorum.
fn model_quorum_accepted<QS>(quorum_set: &QS, entries: &[(u64, u64)]) -> u64
where QS: QuorumSet<Id = u64> {
    let values = entries.iter().map(|item| (item.0, item.1)).collect::<BTreeMap<_, _>>();
    let mut candidates = quorum_set.ids().map(|id| values[&id]).collect::<Vec<_>>();

    candidates.sort_unstable_by(|a, b| b.cmp(a));
    candidates.dedup();

    for candidate in candidates {
        let ids = values.iter().filter_map(|(id, val)| (*val >= candidate).then_some(id));
        if quorum_set.is_quorum(ids) {
            return candidate;
        }
    }

    0
}

/// Assert that `VecProgress` agrees with the reference model.
///
/// This checks both the externally visible quorum-accepted value and the
/// internal ordering invariant relied on by the optimized update algorithm.
fn assert_matches_model<QS>(progress: &VecProgress<(u64, u64), QS>, context: &str)
where QS: QuorumSet<Id = u64> {
    let want = model_quorum_accepted(&progress.quorum_set, &progress.entries);
    assert_eq!(
        &want,
        progress.quorum_accepted(),
        "{}: entries: {:?}",
        context,
        progress.entries
    );
    assert_voter_prefix_is_sorted(progress, context);
}

/// Assert the voter ordering invariant maintained by `update()`.
///
/// Voter entries above `quorum_accepted` must form a descending prefix.
/// Learners are excluded because learner progress does not grant quorum.
fn assert_voter_prefix_is_sorted<QS>(progress: &VecProgress<(u64, u64), QS>, context: &str)
where QS: QuorumSet<Id = u64> {
    let quorum_accepted = *progress.quorum_accepted();
    let mut previous = None;
    let mut seen_not_above_quorum = false;

    for item in &progress.entries[..progress.voter_count] {
        if item.1 <= quorum_accepted {
            seen_not_above_quorum = true;
            continue;
        }

        assert!(
            !seen_not_above_quorum,
            "{}: non-prefix above-quorum entry: {:?}",
            context, progress.entries
        );
        if let Some(prev) = previous {
            assert!(prev >= item.1, "{}: unsorted voters: {:?}", context, progress.entries);
        }
        previous = Some(item.1);
    }
}

#[test]
fn vec_progress_new() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6, 7], |id| (id, 0));

    assert_eq!(
        vec![(0, 0), (1, 0), (2, 0), (3, 0), (4, 0), (6, 0), (7, 0),],
        progress.entries
    );
    assert_eq!(5, progress.voter_count());
}

#[test]
fn vec_progress_tuple_entry() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [3], |id| (id, 0));

    assert_eq!(
        vec![(0, 0), (1, 0), (2, 0), (3, 0)],
        progress.iter().cloned().collect::<Vec<_>>()
    );
    assert_eq!(Ok(&0), progress.update(&0, 5));
    assert_eq!(Ok(&5), progress.update(&1, 5));
    assert_eq!(Some(&(0, 5)), progress.try_get(&0));
    assert_eq!(Some(&(1, 5)), progress.try_get(&1));
    assert_eq!(&5, progress.quorum_accepted());
}

#[test]
fn vec_progress_index() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6, 7], |id| (id, 0));

    assert_eq!(Some(0), progress.index(&0));
    assert_eq!(Some(1), progress.index(&1));
    assert_eq!(Some(4), progress.index(&4));
    assert_eq!(Some(5), progress.index(&6));
    assert_eq!(Some(6), progress.index(&7));
    assert_eq!(None, progress.index(&9));
    assert_eq!(None, progress.index(&100));
}

#[test]
fn vec_progress_get() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6, 7], |id| (id, 0));

    progress.update(&6, 5).ok();
    assert_eq!(&5, &progress.get(&6).1);
    assert_eq!(Some(&5), progress.try_get(&6).map(|x| &x.1));
    assert_eq!(None, progress.try_get(&9));

    progress.update(&6, 10).ok();
    assert_eq!(Some(&10), progress.try_get(&6).map(|x| &x.1));
}

#[test]
fn vec_progress_iter() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6, 7], |id| (id, 0));

    progress.update(&7, 7).ok();
    progress.update(&3, 3).ok();
    progress.update(&1, 1).ok();

    assert_eq!(
        vec![(3, 3), (1, 1), (0, 0), (2, 0), (4, 0), (6, 0), (7, 7),],
        progress.iter().cloned().collect::<Vec<_>>(),
        "iter() returns voter first, followed by learners"
    );
}

#[test]
fn vec_progress_move_up() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6], |id| (id, 0));

    // initial: 0-0, 1-0, 2-0, 3-0, 4-0
    let cases = [
        ((1, 2), vec![(1, 2), (0, 0), (2, 0), (3, 0), (4, 0), (6, 0)], 0),
        ((2, 3), vec![(2, 3), (1, 2), (0, 0), (3, 0), (4, 0), (6, 0)], 0),
        ((1, 3), vec![(2, 3), (1, 3), (0, 0), (3, 0), (4, 0), (6, 0)], 1), // no move
        ((4, 8), vec![(4, 8), (2, 3), (1, 3), (0, 0), (3, 0), (6, 0)], 0),
        ((0, 5), vec![(4, 8), (0, 5), (2, 3), (1, 3), (3, 0), (6, 0)], 1), // move to 1st
    ];
    for (ith, ((id, v), want_vec, want_new_index)) in cases.iter().enumerate() {
        // Update a value and move it up to keep the order.
        let index = progress.index(id).unwrap();
        progress.entries[index].1 = *v;
        let got = progress.move_up(index);

        assert_eq!(want_vec, &progress.entries, "{}-th case: idx:{}, v:{}", ith, *id, *v);
        assert_eq!(*want_new_index, got, "{}-th case: idx:{}, v:{}", ith, *id, *v);
    }
}

#[test]
fn vec_progress_update() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6], |id| (id, 0));

    // initial: 0,0,0,0,0
    let cases = vec![
        ((6, 9), Ok(&0)),  // 0,0,0,0,0,9 // learner won't affect quorum-accepted
        ((1, 2), Ok(&0)),  // 0,2,0,0,0,0
        ((2, 3), Ok(&0)),  // 0,2,3,0,0,0
        ((3, 1), Ok(&1)),  // 0,2,3,1,0,0
        ((4, 5), Ok(&2)),  // 0,2,3,1,5,0
        ((0, 4), Ok(&3)),  // 4,2,3,1,5,0
        ((3, 2), Ok(&3)),  // 4,2,3,2,5,0
        ((3, 3), Ok(&3)),  // 4,2,3,2,5,0
        ((1, 4), Ok(&4)),  // 4,4,3,2,5,0
        ((9, 1), Err(&4)), // nonexistent id, ignore.
    ];

    for (ith, ((id, v), want_quorum_accepted)) in cases.iter().enumerate() {
        let got = progress.update_with(id, |x| *x = *v);
        assert_eq!(want_quorum_accepted.clone(), got, "{}-th case: id:{}, v:{}", ith, id, v);
    }
}

#[test]
fn vec_progress_matches_reference_model_for_monotonic_updates() {
    let cases = [
        (vec![btreeset! {0, 1, 2, 3, 4}], vec![5, 6]),
        (vec![btreeset! {0, 1, 2}, btreeset! {2, 3, 4}], vec![5, 6]),
    ];

    for (case_id, (quorum_set, learners)) in cases.into_iter().enumerate() {
        for seed in 0..32 {
            let mut seed = seed + 1;
            let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set.clone(), learners.clone(), |id| (id, 0));

            assert_matches_model(&progress, &format!("case-{case_id} seed-{seed} initial"));

            for step in 0..128 {
                let id = next_random(&mut seed) % 8;
                let value =
                    progress.try_get(&id).map(|entry| entry.1).unwrap_or_default() + next_random(&mut seed) % 7 + 1;
                let got = copy_result(progress.update(&id, value));
                let want = model_quorum_accepted(&progress.quorum_set, &progress.entries);
                let want_result = progress.try_get(&id).map(|_| want).ok_or(want);
                let context = format!("case-{case_id} seed-{seed} step-{step} update-{id}-{value}");

                assert_eq!(want_result, got, "{context}: entries: {:?}", progress.entries);
                assert_matches_model(&progress, &context);
            }
        }
    }
}

#[test]
fn vec_progress_matches_reference_model_after_random_quorum_upgrades() {
    let quorum_sets = [
        vec![btreeset! {0, 1, 2, 3, 4}],
        vec![btreeset! {0, 1, 2}, btreeset! {2, 3, 4}],
        vec![btreeset! {2, 3, 4}],
        vec![btreeset! {1, 3, 5}, btreeset! {3, 4, 5, 6}],
        vec![btreeset! {0, 5, 6}],
    ];
    let known_ids = (0..=8).collect::<Vec<_>>();

    for seed in 0..16 {
        let mut seed = seed + 11;
        let quorum_set = quorum_sets[0].clone();
        let learner_ids = learner_ids_for(&quorum_set, known_ids.clone());
        let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, learner_ids, |id| (id, 0));

        assert_matches_model(&progress, &format!("seed-{seed} initial"));

        for round in 0..24 {
            for step in 0..16 {
                let id = next_random(&mut seed) % 10;
                let value =
                    progress.try_get(&id).map(|entry| entry.1).unwrap_or_default() + next_random(&mut seed) % 11 + 1;
                progress.update(&id, value).ok();
                assert_matches_model(&progress, &format!("seed-{seed} round-{round} step-{step} update"));
            }

            let quorum_index = next_random(&mut seed) as usize % quorum_sets.len();
            let quorum_set = quorum_sets[quorum_index].clone();
            let learner_ids = learner_ids_for(&quorum_set, known_ids.clone());

            progress = progress.upgrade_quorum_set(quorum_set, learner_ids, |id| (id, 0));
            assert_matches_model(&progress, &format!("seed-{seed} round-{round} upgrade-{quorum_index}"));
        }
    }
}

#[test]
fn vec_progress_joint_quorum_update() {
    let quorum_set = vec![btreeset! {0, 1, 2}, btreeset! {2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [5, 6], |id| (id, 0));

    let cases = [
        (0, 5, 0),
        (1, 5, 0),
        (2, 4, 0),
        (3, 4, 4),
        (4, 6, 4),
        (3, 6, 5),
        (2, 7, 5),
        (0, 7, 6),
    ];

    for (ith, (id, value, want_quorum_accepted)) in cases.iter().enumerate() {
        let got = copy_result(progress.update(id, *value));
        let context = format!("{ith}-th case: id:{id}, value:{value}");

        assert_eq!(
            Ok(*want_quorum_accepted),
            got,
            "{context}: entries: {:?}",
            progress.entries
        );
        assert_matches_model(&progress, &context);
    }

    let entries: Vec<_> = progress.collect_mapped(|item| (item.0, item.1));
    assert_eq!(vec![(2, 7), (0, 7), (4, 6), (3, 6), (1, 5), (5, 0), (6, 0)], entries);
}

#[test]
fn vec_progress_non_member_and_learner_edge_cases() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [1, 3, 3], |id| (id, 0));

    assert_eq!(vec![(0, 0), (1, 0), (2, 0), (1, 0), (3, 0), (3, 0),], progress.entries);
    assert_eq!(3, progress.voter_count);
    assert_eq!(Some(true), progress.is_voter(&1));
    assert_eq!(Some(false), progress.is_voter(&3));
    assert_eq!(None, progress.is_voter(&9));

    assert_eq!(Ok(0), copy_result(progress.update(&3, 7)));
    assert_eq!(
        vec![(0, 0), (1, 0), (2, 0), (1, 0), (3, 7), (3, 0),],
        progress.entries,
        "only the first duplicate learner is updated"
    );

    assert_eq!(Ok(0), copy_result(progress.update(&1, 5)));
    assert_eq!(
        vec![(1, 5), (0, 0), (2, 0), (1, 0), (3, 7), (3, 0),],
        progress.entries,
        "a learner ID that is also a voter resolves to the voter entry"
    );

    assert_eq!(Ok(4), copy_result(progress.update(&2, 4)));
    assert_eq!(vec![(1, 5), (2, 4), (0, 0), (1, 0), (3, 7), (3, 0),], progress.entries);

    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut no_learners = VecProgress::<(u64, u64), _>::new(quorum_set, [], |id| (id, 0));

    assert_eq!(vec![(0, 0), (1, 0), (2, 0)], no_learners.entries);
    assert_eq!(3, no_learners.voter_count);
    assert_eq!(Err(0), copy_result(no_learners.update(&9, 5)));
    assert_eq!(vec![(0, 0), (1, 0), (2, 0)], no_learners.entries);
}

#[test]
fn vec_progress_custom_quorum_set() {
    let quorum_set = RequiredSetQuorum::new([0, 1, 2, 3], [0, 3]);
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [], |id| (id, 0));

    assert_eq!(Ok(0), copy_result(progress.update(&1, 10)));
    assert_eq!(Ok(0), copy_result(progress.update(&2, 9)));
    assert_eq!(Ok(0), copy_result(progress.update(&0, 8)));
    assert_matches_model(&progress, "custom quorum before required set is reached");

    assert_eq!(vec![(1, 10), (2, 9), (0, 8), (3, 0)], progress.entries);

    assert_eq!(Ok(7), copy_result(progress.update(&3, 7)));
    assert_eq!(&7, progress.quorum_accepted());
    assert_matches_model(&progress, "custom quorum reaches required set");

    assert_eq!(Ok(8), copy_result(progress.update(&3, 11)));
    assert_eq!(vec![(3, 11), (1, 10), (2, 9), (0, 8)], progress.entries);
    assert_matches_model(&progress, "custom quorum follows required set threshold");
}

#[test]
fn vec_progress_update_with() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6], |id| (id, 0));

    // Test that update_with can use closures to modify values
    // Case 0: 0,2,0,0,0,0
    let got = progress.update_with(&1, |x| *x += 2);
    assert_eq!(Ok(&0), got, "case 0: id:1, +=2");

    // Case 1: 0,2,3,0,0,0
    let got = progress.update_with(&2, |x| *x += 3);
    assert_eq!(Ok(&0), got, "case 1: id:2, +=3");

    // Case 2: 0,2,3,1,0,0
    let got = progress.update_with(&3, |x| *x = 1);
    assert_eq!(Ok(&1), got, "case 2: id:3, =1");

    // Case 3: 0,2,3,1,5,0
    let got = progress.update_with(&4, |x| *x += 5);
    assert_eq!(Ok(&2), got, "case 3: id:4, +5");

    // Case 4: 4,2,3,1,5,0 - closure can see updated value
    let got = progress.update_with(&0, |x| {
        *x += 4;
        assert_eq!(4, *x, "closure sees the updated value");
    });
    assert_eq!(Ok(&3), got, "case 4: id:0, +=4");

    // Case 5: 4,2,3,2,5,0 - using max
    let got = progress.update_with(&3, |x| *x = (*x).max(2));
    assert_eq!(Ok(&3), got, "case 5: id:3, max(2)");

    // Case 6: 4,4,3,2,5,0
    let got = progress.update_with(&1, |x| *x *= 2);
    assert_eq!(Ok(&4), got, "case 6: id:1, *=2");

    // Verify final values
    assert_eq!(&4, &progress.get(&0).1);
    assert_eq!(&4, &progress.get(&1).1);
    assert_eq!(&3, &progress.get(&2).1);
    assert_eq!(&2, &progress.get(&3).1);
    assert_eq!(&5, &progress.get(&4).1);
    assert_eq!(&0, &progress.get(&6).1);

    // Test nonexistent id returns Err with current quorum-accepted
    let got = progress.update_with(&9, |x| *x = 10);
    assert_eq!(Err(&4), got, "nonexistent id returns Err");
}

#[test]
fn vec_progress_update_data_with() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress =
        VecProgress::<IdValData<u64, u64, &'static str>, _>::new(quorum_set, [3], |id| IdValData::new(id, 0, "foo"));

    assert_eq!(Ok(&0), progress.update(&1, 2));

    let stats_before = (
        progress.stat().update_count,
        progress.stat().move_count,
        progress.stat().is_quorum_count,
    );

    assert_eq!(Some(&"bar"), progress.update_data_with(&1, |data| *data = "bar"));
    assert_eq!(None, progress.update_data_with(&9, |data| *data = "unknown"));

    assert_eq!(
        vec![
            IdValData::new(1, 2, "bar"),
            IdValData::new(0, 0, "foo"),
            IdValData::new(2, 0, "foo"),
            IdValData::new(3, 0, "foo"),
        ],
        progress.iter().cloned().collect::<Vec<_>>()
    );
    assert_eq!(&0, progress.quorum_accepted());
    assert_eq!(
        stats_before,
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );
}

#[test]
fn vec_progress_update_does_not_move_learner_elt() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6], |id| (id, 0));

    assert_eq!(Some(5), progress.index(&6));

    progress.update(&6, 6).ok();
    assert_eq!(Some(5), progress.index(&6), "learner is not moved");

    progress.update(&4, 4).ok();
    assert_eq!(Some(0), progress.index(&4), "voter is not moved");
}

#[test]
fn vec_progress_upgrade_quorum_set() {
    let qs012 = vec![btreeset! {0, 1, 2}];
    let qs012_345 = vec![btreeset! {0, 1, 2}, btreeset! {3, 4, 5}];
    let qs345 = vec![btreeset! {3, 4, 5}];

    // Initially, quorum-accepted is 5

    let mut p012 = VecProgress::<(u64, u64), _>::new(qs012, [5], |id| (id, 0));

    p012.update(&0, 5).ok();
    p012.update(&1, 6).ok();
    p012.update(&5, 9).ok();
    assert_eq!(&5, p012.quorum_accepted());

    // After upgrading to a bigger quorum set, quorum-accepted fall back to 0

    let mut p012_345 = p012.upgrade_quorum_set(qs012_345, [6], |id| (id, 0));
    assert_eq!(
        &0,
        p012_345.quorum_accepted(),
        "quorum extended from 012 to 012_345, quorum-accepted falls back"
    );
    assert_eq!(&9, &p012_345.get(&5).1, "inherit learner progress");

    // When quorum set shrinks, quorum-accepted becomes greater.

    p012_345.update(&3, 7).ok();
    p012_345.update(&4, 8).ok();
    assert_eq!(&5, p012_345.quorum_accepted());

    let p345 = p012_345.upgrade_quorum_set(qs345, [1], |id| (id, 0));

    assert_eq!(
        &8,
        p345.quorum_accepted(),
        "shrink quorum set, greater value becomes quorum-accepted"
    );
    assert_eq!(&6, &p345.get(&1).1, "inherit voter progress");
}

#[test]
fn vec_progress_upgrade_joint_quorum_set() {
    let qs01234 = vec![btreeset! {0, 1, 2, 3, 4}];
    let qs012_234 = vec![btreeset! {0, 1, 2}, btreeset! {2, 3, 4}];
    let qs345 = vec![btreeset! {3, 4, 5}];

    let mut p = VecProgress::<(u64, u64), _>::new(qs01234, [5], |id| (id, 0));

    for (id, value) in [(0, 9), (1, 8), (2, 7), (3, 2), (4, 1), (5, 10)] {
        p.update(&id, value).ok();
    }

    assert_eq!(&7, p.quorum_accepted());

    let mut joint = p.upgrade_quorum_set(qs012_234, [5, 6], |id| (id, 0));

    assert_eq!(&2, joint.quorum_accepted(), "joint quorum lowers the accepted value");
    let entries: Vec<_> = joint.collect_mapped(|item| (item.0, item.1));
    assert_eq!(vec![(0, 9), (1, 8), (2, 7), (3, 2), (4, 1), (5, 10), (6, 0)], entries);
    assert_matches_model(&joint, "after upgrade to joint quorum");

    joint.update(&3, 8).ok();
    joint.update(&4, 8).ok();
    assert_eq!(&8, joint.quorum_accepted());
    assert_matches_model(&joint, "after joint quorum catches up");

    let shrunk = joint.upgrade_quorum_set(qs345, [0], |id| (id, 0));

    assert_eq!(&8, shrunk.quorum_accepted());
    let entries: Vec<_> = shrunk.collect_mapped(|item| (item.0, item.1));
    assert_eq!(vec![(5, 10), (3, 8), (4, 8), (0, 9)], entries);
    assert_matches_model(&shrunk, "after shrinking joint quorum");
}

#[test]
fn vec_progress_is_voter() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6, 7], |id| (id, 0));

    assert_eq!(Some(true), progress.is_voter(&1));
    assert_eq!(Some(true), progress.is_voter(&3));
    assert_eq!(Some(false), progress.is_voter(&7));
    assert_eq!(None, progress.is_voter(&8));
}

#[test]
fn vec_progress_display() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [3], |id| (id, 0));

    progress.update(&1, 5).ok();
    progress.update(&2, 3).ok();

    let display = format!(
        "{}",
        progress.display_with(|f, item| write!(f, "{}: {}", item.0, item.1))
    );
    assert_eq!("{1: 5, 2: 3, 0: 0, 3: 0}", display);
}

#[test]
fn vec_progress_iter_mut_without_reorder() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [3], |id| (id, 0));

    // Mutate values through iter_mut_without_reorder
    for item in progress.iter_mut_without_reorder() {
        if item.0 == 1 {
            item.1 = 10;
        }
    }

    assert_eq!(&10, &progress.get(&1).1);
    assert_eq!(&0, &progress.get(&0).1);
    assert_eq!(&0, &progress.get(&2).1);
}

#[test]
fn vec_progress_stat() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [3], |id| (id, 0));

    assert_eq!(
        (0, 0, 0),
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );

    progress.update(&3, 10).ok();
    assert_eq!(
        (1, 0, 0),
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );

    progress.update(&1, 5).ok();
    assert_eq!(
        (2, 1, 1),
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );

    progress.update(&2, 4).ok();
    assert_eq!(
        (3, 2, 2),
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );

    progress.update(&1, 6).ok();
    assert_eq!(
        (4, 3, 2),
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );

    progress.update(&9, 7).ok();
    assert_eq!(
        (5, 3, 2),
        (
            progress.stat().update_count,
            progress.stat().move_count,
            progress.stat().is_quorum_count,
        )
    );
}

#[test]
fn vec_progress_display_with() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [3], |id| (id, 0));

    progress.update(&1, 5).ok();
    progress.update(&2, 3).ok();

    let display = progress.display_with(|f, item| write!(f, "{}={}", item.0, item.1));

    let output = format!("{}", display);
    assert_eq!("{1=5, 2=3, 0=0, 3=0}", output);
}

#[test]
fn vec_progress_increase_to() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [6], |id| (id, 0));

    // Increase from 0 to 5
    progress.increase_to(&1, 5).ok();
    assert_eq!(&5, &progress.get(&1).1);

    // Try to decrease from 5 to 3 - should not change
    progress.increase_to(&1, 3).ok();
    assert_eq!(&5, &progress.get(&1).1);

    // Increase from 5 to 7
    progress.increase_to(&1, 7).ok();
    assert_eq!(&7, &progress.get(&1).1);

    // Try with nonexistent id
    let result = progress.increase_to(&9, 10);
    assert!(result.is_err());
}

#[test]
fn vec_progress_collect_mapped() {
    let quorum_set = vec![btreeset! {0, 1, 2}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [3], |id| (id, 0));

    progress.update(&1, 5).ok();
    progress.update(&2, 3).ok();

    // Collect ids as Vec - order matters after updates (sorted by value descending)
    let ids: Vec<u64> = progress.collect_mapped(|item| item.0);
    assert_eq!(vec![1, 2, 0, 3], ids);

    // Collect values as Vec - order matters after updates (sorted descending)
    let values: Vec<u64> = progress.collect_mapped(|item| item.1);
    assert_eq!(vec![5, 3, 0, 0], values);

    // Collect as Vec of tuples - order matters after updates
    let pairs: Vec<(u64, u64)> = progress.collect_mapped(|item| (item.0, item.1));
    assert_eq!(vec![(1, 5), (2, 3), (0, 0), (3, 0)], pairs);
}

#[test]
fn vec_progress_reset_entry_with() {
    // 7 voters, majority = 4.
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4, 5, 6}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [7], |id| (id, 0));

    progress.update(&0, 12).ok();
    progress.update(&1, 11).ok();
    progress.update(&2, 10).ok();
    progress.update(&3, 9).ok();
    assert_eq!(&9, progress.quorum_accepted());

    // Node 1 log-reverts: its progress falls back to the default value and the
    // entry is moved down, while the quorum-accepted value must be kept.
    let entry = progress.reset_entry_with(&1, |entry| entry.1 = 0);
    assert_eq!(Some(&(1, 0)), entry);
    assert_eq!(&9, progress.quorum_accepted(), "reset never lowers quorum-accepted");
    assert_eq!(
        vec![(0, 12), (2, 10), (3, 9), (1, 0), (4, 0), (5, 0), (6, 0), (7, 0)],
        progress.entries
    );
    assert_voter_prefix_is_sorted(&progress, "after reset");

    // Node 4 catches up to exactly 10: without the move-down, the reverted node 1
    // would be counted spuriously and 10 would be accepted with only 3 real grants.
    assert_eq!(Ok(9), copy_result(progress.update(&4, 10)));
    assert_matches_model(&progress, "after catching up to 10");

    // A real quorum at 10: {0, 2, 4, 5}.
    assert_eq!(Ok(10), copy_result(progress.update(&5, 10)));
    assert_matches_model(&progress, "after a real quorum at 10");

    // Resetting a learner or a nonexistent id does not reorder anything.
    assert_eq!(Some(&(7, 0)), progress.reset_entry_with(&7, |entry| entry.1 = 0));
    assert_eq!(None, progress.reset_entry_with(&9, |entry| entry.1 = 0));
}

#[test]
fn vec_progress_matches_reference_model_with_resets() {
    let cases = [
        (vec![btreeset! {0, 1, 2, 3, 4, 5, 6}], vec![7]),
        (vec![btreeset! {0, 1, 2}, btreeset! {2, 3, 4}], vec![5, 6]),
    ];

    for (case_id, (quorum_set, learners)) in cases.into_iter().enumerate() {
        for seed in 0..32 {
            let mut seed = seed + 3;
            let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set.clone(), learners.clone(), |id| (id, 0));

            // The quorum-accepted value never moves backward, so the reference
            // is the running max of the instantaneous model value.
            let mut want = 0;

            for step in 0..128 {
                // Use high bits: the low bits of this LCG have a short period,
                // which makes power-of-two moduli cycle in lock-step.
                let id = (next_random(&mut seed) >> 32) % 8;
                let context = format!("case-{case_id} seed-{seed} step-{step} id-{id}");

                if (next_random(&mut seed) >> 32).is_multiple_of(8) {
                    progress.reset_entry_with(&id, |entry| entry.1 = 0);
                } else {
                    let value =
                        progress.try_get(&id).map(|entry| entry.1).unwrap_or_default() + next_random(&mut seed) % 7 + 1;
                    progress.update(&id, value).ok();
                }

                want = want.max(model_quorum_accepted(&progress.quorum_set, &progress.entries));
                assert_eq!(
                    &want,
                    progress.quorum_accepted(),
                    "{context}: entries: {:?}",
                    progress.entries
                );
                assert_voter_prefix_is_sorted(&progress, &context);
            }
        }
    }
}

#[test]
fn vec_progress_sub_quorum_commit_regression() {
    let quorum_set = vec![btreeset! {0, 1, 2, 3, 4}];
    let mut progress = VecProgress::<(u64, u64), _>::new(quorum_set, [], |id| (id, 0));

    progress.update(&0, 5).ok(); // qa = 0
    progress.update(&1, 3).ok(); // qa = 0
    progress.update(&2, 4).ok(); // qa = 3 ; above-qa region = [0:5, 2:4] (descending, ok)
    progress.update(&2, 10).ok(); // voter 2 was already > qa(3) and advances further:
    //   move_up must still run; if it were skipped, the region would become
    //   [0:5, 2:10] (NOT descending) and the next update would falsely accept 6.
    let qa = progress.update(&3, 6).ok();

    // True match values: {0:5, 1:3, 2:10, 3:6, 4:0}; sorted desc = 10,6,5,3,0 -> 3rd-largest = 5.
    // Only voters {2,3} reached 6 -> 2 voters -> NOT a majority.
    // Expected quorum_accepted = 5.
    assert_eq!(Some(&5), qa);
}