d-engine-core 0.2.3

Pure Raft consensus algorithm - for building custom Raft-based systems
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
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
use std::sync::Arc;
use std::time::Duration;

use bytes::Bytes;
use d_engine_proto::common::Entry;
use d_engine_proto::common::EntryPayload;
use d_engine_proto::common::NodeRole::Leader;
use d_engine_proto::common::membership_change::Change;
use tokio::sync::mpsc::{self};
use tokio::sync::watch;
use tokio::task::JoinHandle;
use tokio::time::{self};

use super::CommitHandler;
use super::CommitHandlerDependencies;
use super::DefaultCommitHandler;
use crate::Error;
use crate::MockMembership;
use crate::MockRaftLog;
use crate::MockStateMachineHandler;
use crate::MockTypeConfig;
use crate::NewCommitData;
use crate::RaftEvent;
use crate::Result;

const TEST_TERM: u64 = 1;

pub enum CommandType {
    Command(Bytes),
    Configuration(Change),
    Noop,
}

pub fn build_entries(
    commands: Vec<CommandType>,
    term: u64,
) -> Vec<Entry> {
    let mut r = vec![];
    let mut index = 1;
    for c in commands {
        let entry = match c {
            CommandType::Command(data) => Entry {
                index,
                term,
                payload: Some(EntryPayload::command(data)),
            },
            CommandType::Configuration(change) => Entry {
                index,
                term,
                payload: Some(EntryPayload::config(change)),
            },
            CommandType::Noop => Entry {
                index,
                term,
                payload: Some(EntryPayload::noop()),
            },
        };
        r.push(entry);
        index += 1;
    }
    r
}

pub struct TestHarness {
    role: i32,
    term: u64,
    mock_smh: Arc<MockStateMachineHandler<MockTypeConfig>>,
    mock_log: Arc<MockRaftLog>,
    mock_membership: Arc<MockMembership<MockTypeConfig>>,
    commit_tx: mpsc::UnboundedSender<NewCommitData>,
    commit_rx: Option<mpsc::UnboundedReceiver<NewCommitData>>,
    event_tx: mpsc::Sender<RaftEvent>,
    event_rx: mpsc::Receiver<RaftEvent>,
    shutdown_tx: watch::Sender<()>,
    shutdown_rx: Option<watch::Receiver<()>>,
    handle: Option<JoinHandle<()>>,
}
#[allow(clippy::too_many_arguments)]
fn setup_harness<F, G>(
    role: i32,
    term: u64,
    entries: Vec<Entry>,
    last_applied: u64,
    config_hook: F,
    command_hook: G,
    snapshot_condition: Option<u64>,
) -> TestHarness
where
    F: Fn() -> bool + 'static + Send + Sync,
    G: Fn() -> bool + 'static + Send + Sync,
{
    let (commit_tx, commit_rx) = mpsc::unbounded_channel();
    let (shutdown_tx, shutdown_rx) = watch::channel(());
    let (event_tx, event_rx) = mpsc::channel(1000); // Large capacity to prevent blocking in tests

    // Mock state machine
    let mut mock_smh = MockStateMachineHandler::new();
    let cloned_entries = entries.clone();
    mock_smh
        .expect_pending_range()
        .returning(move || Some(1..=cloned_entries.last().map(|e| e.index).unwrap_or(1)));
    mock_smh.expect_apply_chunk().returning(move |_| {
        if command_hook() {
            Err(Error::Fatal("Command execution failed".to_string()))
        } else {
            Ok(vec![])
        }
    });
    mock_smh.expect_update_pending().returning(|_| {});
    mock_smh.expect_last_applied().returning(move || last_applied);
    mock_smh
        .expect_should_snapshot()
        .returning(move |data| snapshot_condition.is_some_and(|idx| data.new_commit_index >= idx));

    // Mock raft log
    let mut mock_log = MockRaftLog::new();
    mock_log.expect_get_entries_range().returning(move |_| Ok(entries.clone()));

    // Mock membership
    let mut mock_membership = MockMembership::new();
    mock_membership.expect_notify_config_applied().returning(|_| {});
    mock_membership.expect_apply_config_change().returning(move |_| {
        if config_hook() {
            Err(Error::Fatal("Command execution failed".to_string()))
        } else {
            Ok(())
        }
    });

    TestHarness {
        role,
        term,
        mock_smh: Arc::new(mock_smh),
        mock_log: Arc::new(mock_log),
        mock_membership: Arc::new(mock_membership),
        commit_rx: Some(commit_rx),
        commit_tx,
        event_tx,
        event_rx,
        shutdown_tx,
        shutdown_rx: Some(shutdown_rx),
        handle: None,
    }
}

impl TestHarness {
    async fn run_handler(&mut self) {
        let (sm_apply_tx, mut sm_apply_rx) = tokio::sync::mpsc::unbounded_channel();

        let deps = CommitHandlerDependencies {
            state_machine_handler: self.mock_smh.clone(),
            raft_log: self.mock_log.clone(),
            membership: self.mock_membership.clone(),
            event_tx: self.event_tx.clone(),
            sm_apply_tx,
            shutdown_signal: self.shutdown_rx.take().unwrap(),
            max_batch_size: 10,
        };

        let mut handler = DefaultCommitHandler::<MockTypeConfig>::new(
            1,
            self.role,
            self.term,
            deps,
            self.commit_rx.take().unwrap(),
        );

        // Spawn SM Worker to process entries
        let _sm_worker_handle = tokio::spawn(async move {
            while let Some(_entries) = sm_apply_rx.recv().await {
                // SM Worker simply consumes entries from the channel
                // In a real system, this would apply them to the state machine
                // For testing, we just drain the channel to keep it open
            }
        });

        self.handle = Some(tokio::spawn(async move {
            let _ = handler.run().await;
        }));
    }

    async fn process_batch_handler(&mut self) -> Result<()> {
        let (sm_apply_tx, mut sm_apply_rx) = tokio::sync::mpsc::unbounded_channel();

        let deps = CommitHandlerDependencies {
            state_machine_handler: self.mock_smh.clone(),
            raft_log: self.mock_log.clone(),
            membership: self.mock_membership.clone(),
            event_tx: self.event_tx.clone(),
            sm_apply_tx,
            shutdown_signal: self.shutdown_rx.take().unwrap(),
            max_batch_size: 10,
        };

        let handler = DefaultCommitHandler::<MockTypeConfig>::new(
            1,
            self.role,
            self.term,
            deps,
            self.commit_rx.take().unwrap(),
        );

        // Spawn SM Worker to process entries
        let _sm_worker_handle = tokio::spawn(async move {
            while let Some(_entries) = sm_apply_rx.recv().await {
                // SM Worker simply consumes entries from the channel
            }
        });

        handler.process_batch().await
    }

    async fn send_commit(
        &self,
        index: u64,
        role: i32,
    ) {
        self.commit_tx
            .send(NewCommitData {
                new_commit_index: index,
                role,
                current_term: TEST_TERM,
            })
            .unwrap();
    }

    async fn expect_snapshot_trigger(&mut self) -> bool {
        match time::timeout(Duration::from_millis(50), self.event_rx.recv()).await {
            Ok(Some(_)) => true, // Event received normally
            Ok(None) => false,   // Channel closed
            Err(_) => false,     // Timeout
        }
    }
}

#[cfg(test)]
mod run_test {
    use d_engine_proto::common::AddNode;
    use d_engine_proto::common::NodeRole::Follower;
    use d_engine_proto::common::NodeRole::Leader;
    use d_engine_proto::common::RemoveNode;
    use d_engine_proto::common::membership_change::Change;
    use tokio::time;

    use super::*;

    /// 1. Test happy path with all entry types
    #[tokio::test]
    async fn test_full_processing_flow() {
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Configuration(Change::AddNode(AddNode {
                    node_id: 1,
                    address: "addr".into(),
                    status: d_engine_proto::common::NodeStatus::Promotable as i32,
                })),
                CommandType::Noop,
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            Some(4),
        );
        harness.run_handler().await;

        // Send commits to trigger processing
        for i in 1..=4 {
            harness.send_commit(i, Leader as i32).await;
        }

        // Verify snapshot triggered
        assert!(harness.expect_snapshot_trigger().await);

        // Clean shutdown
        harness.shutdown_tx.send(()).unwrap();
        harness.handle.unwrap().await.unwrap();
    }

    /// 2. Test leadership change during batch processing
    #[tokio::test]
    async fn test_leadership_loss_during_batch() {
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );
        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );

        harness.run_handler().await;
        harness.send_commit(1, Leader as i32).await;
        harness.send_commit(2, Follower as i32).await;

        // Should not process second command
        time::sleep(Duration::from_millis(50)).await;
        harness.shutdown_tx.send(()).unwrap();
        harness.handle.unwrap().await.unwrap();
    }

    /// 3. Test config change with node removal (non-self)
    #[tokio::test]
    async fn test_config_remove_node() {
        let entries = build_entries(
            vec![CommandType::Configuration(Change::RemoveNode(RemoveNode {
                node_id: 2, // Remove different node (not self)
            }))],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            Some(4),
        );

        harness.run_handler().await;
        harness.send_commit(1, Leader as i32).await;
        time::sleep(Duration::from_millis(50)).await;
        harness.shutdown_tx.send(()).unwrap();
        harness.handle.unwrap().await.unwrap();
    }

    /// 4. Test self-removal detection logic
    ///
    /// Lightweight unit test verifying is_self_removal_config() correctly
    /// identifies when a node is removing itself from cluster.
    ///
    /// Related: Issue #200
    #[test]
    fn test_is_self_removal_config() {
        use d_engine_proto::common::AddNode;
        use d_engine_proto::common::MembershipChange;
        use d_engine_proto::common::RemoveNode;
        use d_engine_proto::common::membership_change::Change;

        // Case 1: Self-removal (my_id matches remove node_id)
        let self_removal = MembershipChange {
            change: Some(Change::RemoveNode(RemoveNode { node_id: 1 })),
        };
        assert!(
            DefaultCommitHandler::<MockTypeConfig>::is_self_removal_config(1, &self_removal),
            "Should detect self-removal when my_id == removed node_id"
        );

        // Case 2: Removing other node (my_id != remove node_id)
        let other_removal = MembershipChange {
            change: Some(Change::RemoveNode(RemoveNode { node_id: 2 })),
        };
        assert!(
            !DefaultCommitHandler::<MockTypeConfig>::is_self_removal_config(1, &other_removal),
            "Should NOT detect self-removal when removing different node"
        );

        // Case 3: AddNode (not a removal)
        let add_node = MembershipChange {
            change: Some(Change::AddNode(AddNode {
                node_id: 1,
                address: "127.0.0.1:8080".to_string(),
                status: 1,
            })),
        };
        assert!(
            !DefaultCommitHandler::<MockTypeConfig>::is_self_removal_config(1, &add_node),
            "Should NOT detect self-removal for AddNode changes"
        );

        // Case 4: No change
        let no_change = MembershipChange { change: None };
        assert!(
            !DefaultCommitHandler::<MockTypeConfig>::is_self_removal_config(1, &no_change),
            "Should NOT detect self-removal when change is None"
        );
    }

    /// 5. Test batch processing under load
    #[tokio::test]
    async fn test_high_throughput_processing() {
        let mut entries = Vec::new();
        for i in 1..=1000 {
            entries.push(CommandType::Command(Bytes::from(format!("cmd{i}"))));
        }
        let entries = build_entries(entries, 1);

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        harness.run_handler().await;

        // Send all commits at once
        for i in 1..=1000 {
            harness.send_commit(i, Leader as i32).await;
        }

        println!("Sent all commits");
        // Verify snapshot at end
        assert!(!harness.expect_snapshot_trigger().await);
        harness.shutdown_tx.send(()).unwrap();
        println!("Shutdown sent");
        println!("Waiting for handle to finish");
        harness.handle.unwrap().await.unwrap();
        println!("Handle finished");
    }

    // Case 1: test if process_batch been triggered if
    // interval ticks
    //
    // ## Setup:
    // - process_interval_ms  = 1ms

    // ## Criterias:
    // - apply_batch been triggered twice
    //
    #[tokio::test]
    async fn test_run_case1() {
        tokio::time::pause();

        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            Some(4),
        );
        harness.run_handler().await;

        // Send commits to trigger processing
        for i in 1..=2 {
            harness.send_commit(i, Leader as i32).await;
        }
        tokio::time::advance(Duration::from_millis(3)).await;
        // Clean shutdown
        harness.shutdown_tx.send(()).unwrap();
        // Ensure the task completes
        harness.handle.unwrap().await.unwrap();
    }

    // Case 2: test if process_batch been triggered if
    // batch exceeds threshold
    //
    // ## Setup:
    // - commit_handle_interval_in_ms  = 1s
    // - send 10 new commit ids
    // - batch threshold = 2
    //
    // ## Criterias:
    // - apply_batch been triggered twice
    //
    #[tokio::test]
    async fn test_run_case2() {
        tokio::time::pause();

        // prepare commit channel
        // let (new_commit_tx, new_commit_rx) = mpsc::unbounded_channel::<NewCommitData>();
        // let (_graceful_tx, graceful_rx) = watch::channel(());
        // let mut handler = setup(batch_thresold, 1000, 2, new_commit_rx, graceful_rx);
        let batch_thresold = 10;
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        harness.run_handler().await;

        for i in 1..=batch_thresold {
            harness.send_commit(i, Leader as i32).await;
        }
        tokio::time::advance(Duration::from_millis(2)).await;
        tokio::time::sleep(Duration::from_millis(2)).await;
        // Clean shutdown
        harness.shutdown_tx.send(()).unwrap();
        // Ensure the task completes
        harness.handle.unwrap().await.unwrap();
    }

    // Case 3: test if process_batch will not be triggered if
    // batch not exceeds threshold, duration not exceeds interval
    //
    // ## Setup:
    // - commit_handle_interval_in_ms  = 1s
    // - send 10 new commit ids
    // - batch threshold = 1000
    //
    // ## Criterias:
    // - apply_batch been triggered only 1 time
    //
    #[tokio::test]
    async fn test_run_case3() {
        tokio::time::pause();

        // prepare commit channel
        // let (new_commit_tx, new_commit_rx) = mpsc::unbounded_channel::<NewCommitData>();
        // let (_graceful_tx, graceful_rx) = watch::channel(());
        // let mut handler = setup(batch_thresold, 1000, 1, new_commit_rx, graceful_rx);
        let batch_thresold = 1000;
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        harness.run_handler().await;

        for i in 1..=(batch_thresold - 10) {
            harness.send_commit(i, Leader as i32).await;
        }
        tokio::time::advance(Duration::from_millis(2)).await;
        tokio::time::sleep(Duration::from_millis(2)).await;
        // Clean shutdown
        harness.shutdown_tx.send(()).unwrap();
        // Ensure the task completes
        harness.handle.unwrap().await.unwrap();
    }

    // Case 4: test if process_batch will be triggered if both
    // batch exceeds threshold and duration exceeds interval
    //
    // ## Setup:
    // - commit_handle_interval_in_ms  = 2ms
    // - run for 3ms
    // - send 10 new commit ids
    // - batch threshold = 10
    //
    // ## Criterias:
    // - apply_batch been triggered only 3 time
    //
    #[tokio::test]
    async fn test_run_case4() {
        tokio::time::pause();

        // prepare commit channel
        // let (new_commit_tx, new_commit_rx) = mpsc::unbounded_channel::<NewCommitData>();
        // let (_graceful_tx, graceful_rx) = watch::channel(());
        let batch_thresold = 10;
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        harness.run_handler().await;

        for i in 1..=batch_thresold {
            harness.send_commit(i, Leader as i32).await;
        }
        tokio::time::advance(Duration::from_millis(2)).await;
        tokio::time::sleep(Duration::from_millis(2)).await;
        // Clean shutdown
        harness.shutdown_tx.send(()).unwrap();
        // Ensure the task completes
        harness.handle.unwrap().await.unwrap();
    }
}

#[cfg(test)]
mod process_batch_test {
    use d_engine_proto::common::AddNode;
    use d_engine_proto::common::RemoveNode;
    use d_engine_proto::common::membership_change::Change;
    use parking_lot::Mutex;

    use super::*;
    use crate::test_utils::*;

    // Test helper setup with configurable mocks
    // fn setup_test_handler<F, G>(
    //     role: i32,
    //     term: u64,
    //     entries: Vec<Entry>,
    //     config_hook: F,
    //     command_hook: G,
    //     snapshot_condition: Option<u64>,
    // ) -> (
    //     DefaultCommitHandler<MockTypeConfig>,
    //     mpsc::Receiver<RaftEvent>,
    //     watch::Sender<()>,
    // ) where
    //     F: Fn() -> bool + 'static + Send + Sync,
    //     G: Fn() -> bool + 'static + Send + Sync
    // {
    //     let (_new_commit_tx, new_commit_rx) = mpsc::unbounded_channel();
    //     let (shutdown_tx, shutdown_rx) = watch::channel(());
    //     let (event_tx, event_rx) = mpsc::channel(10);

    //     // Mock state machine
    //     let mut mock_smh = MockStateMachineHandler::new();
    //     let cloned_entries = entries.clone();
    //     mock_smh.expect_pending_range()
    //         .returning(move || Some(1..=cloned_entries.last().map(|e| e.index).unwrap_or(1)));
    //     mock_smh.expect_apply_chunk()
    //         .returning(move |_| {
    //             if command_hook() {
    //                 Err(Error::Fatal("Command execution failed".to_string()))
    //             } else {
    //                 Ok(())
    //             }
    //         });
    //     mock_smh.expect_should_snapshot()
    //         .returning(move |data| snapshot_condition.map_or(false, |idx| data.new_commit_index
    // >= idx));

    //     // Mock raft log
    //     let mut mock_log = MockRaftLog::new();
    //     mock_log.expect_get_entries_range()
    //         .return_once(move |_| entries.clone());

    //     // Mock membership
    //     let mut mock_membership = MockMembership::new();
    //     mock_membership.expect_apply_config_change()
    //         .returning(move |_| if config_hook() {
    //             Err(Error::Fatal("Command execution failed".to_string()))
    //         } else {
    //             Ok(())
    //         });

    //     let handler = DefaultCommitHandler::new(
    //         role,
    //         term,
    //         Arc::new(mock_smh),
    //         Arc::new(mock_log),
    //         Arc::new(mock_membership),
    //         new_commit_rx,
    //         event_tx.clone(),
    //         100, // batch_threshold
    //         100, // process_interval
    //         shutdown_rx,
    //     );

    //     (handler, event_rx, shutdown_tx)
    // }

    // Generic entry creation helpers
    #[tokio::test]
    async fn processes_empty_batch_successfully() {
        let last_applied = 0;
        let mut harness = setup_harness(
            Leader as i32,
            1,
            vec![],
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        let result = harness.process_batch_handler().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn batches_consecutive_commands() {
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
                CommandType::Command(Bytes::from(b"cmd3".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );

        // Expect single apply_chunk call with all 3 commands
        let result = harness.process_batch_handler().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn flushes_commands_at_config_change() {
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Configuration(Change::AddNode(AddNode {
                    node_id: 1,
                    address: "addr".into(),
                    status: d_engine_proto::common::NodeStatus::Promotable as i32,
                })),
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );

        // Expect single apply_chunk call with all 3 commands
        let result = harness.process_batch_handler().await;
        assert!(result.is_ok());

        // Verification:
        // - apply_chunk called twice: [cmd1] and [cmd2]
        // - apply_config_change called once for entry 2
    }

    #[allow(dead_code)]
    pub fn build_entries_with_noop(term: u64) -> Vec<Entry> {
        let (builder, cmd1) = EntryBuilder::new(1, term).command(b"cmd1");
        let (builder, noop) = builder.noop();
        let (_, cmd2) = builder.command(b"cmd2");
        vec![cmd1, noop, cmd2]
    }
    #[tokio::test]
    async fn flushes_commands_at_noop() {
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Noop,
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );

        // Expect single apply_chunk call with all 3 commands
        let result = harness.process_batch_handler().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn handles_config_failure_properly() {
        let entries = build_entries(
            vec![
                CommandType::Configuration(Change::AddNode(AddNode {
                    node_id: 1,
                    address: "addr".into(),
                    status: d_engine_proto::common::NodeStatus::Promotable as i32,
                })),
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || true, // Config will fail
            move || false,
            None,
        );
        let result = harness.process_batch_handler().await;
        assert!(result.is_err());

        // Verify command was NOT applied
    }

    #[tokio::test]
    async fn processes_mixed_entries_correctly() {
        let entries = build_entries(
            vec![
                CommandType::Command(Bytes::from(b"cmd1".to_vec())),
                CommandType::Configuration(Change::AddNode(AddNode {
                    node_id: 1,
                    address: "addr".into(),
                    status: d_engine_proto::common::NodeStatus::Promotable as i32,
                })),
                CommandType::Noop,
                CommandType::Command(Bytes::from(b"cmd2".to_vec())),
                CommandType::Command(Bytes::from(b"cmd3".to_vec())),
            ],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        let result = harness.process_batch_handler().await;
        assert!(result.is_ok());
        // Verification:
        // - apply_config_change called once for entry 2
        // - apply_chunk called twice: [cmd1] and [cmd2, cmd3]
    }

    #[tokio::test]
    async fn handles_large_command_batches() {
        let mut r = vec![];
        for _i in 1..=1000 {
            r.push(CommandType::Command(Bytes::from(b"cmd".to_vec())))
        }
        let entries = build_entries(r, 1);
        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            move || false,
            move || false,
            None,
        );
        let result = harness.process_batch_handler().await;
        assert!(result.is_ok());

        // Verification: apply_chunk called once with 1000 commands
    }

    /// Test 1: MembershipApplied event MUST be sent after successful config change
    ///
    /// Verifies that when apply_config_change() succeeds, the commit handler
    /// sends RaftEvent::MembershipApplied to notify Leader to refresh cache.
    ///
    /// Related: Bug fix #209 - cluster metadata cache timing issue
    #[tokio::test]
    async fn membership_applied_event_sent_on_success() {
        let entries = build_entries(
            vec![CommandType::Configuration(Change::AddNode(AddNode {
                node_id: 2,
                address: "127.0.0.1:8080".into(),
                status: d_engine_proto::common::NodeStatus::Promotable as i32,
            }))],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            || false, // Config succeeds
            || false,
            None,
        );

        let result = harness.process_batch_handler().await;
        assert!(result.is_ok(), "Config change should succeed");

        // Verify MembershipApplied event was sent
        match tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await {
            Ok(Some(RaftEvent::MembershipApplied)) => {
                // Success - event received
            }
            Ok(Some(other)) => panic!("Expected MembershipApplied, got {other:?}"),
            Ok(None) => panic!("Event channel closed unexpectedly"),
            Err(_) => panic!("Timeout waiting for MembershipApplied event"),
        }
    }

    /// Test 2: Event order - MembershipApplied sent AFTER apply_config_change
    ///
    /// Verifies the critical ordering guarantee:
    /// 1. apply_config_change() updates membership state
    /// 2. notify_config_applied() barrier
    /// 3. MembershipApplied event sent
    ///
    /// This ensures Leader refreshes cache with up-to-date membership.
    ///
    /// Related: Bug fix #209
    #[tokio::test]
    async fn membership_applied_event_sent_after_apply() {
        let apply_order = Arc::new(Mutex::new(Vec::new()));
        let order_clone = apply_order.clone();

        let entries = build_entries(
            vec![CommandType::Configuration(Change::AddNode(AddNode {
                node_id: 2,
                address: "127.0.0.1:8080".into(),
                status: d_engine_proto::common::NodeStatus::Promotable as i32,
            }))],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            {
                let order = order_clone.clone();
                move || {
                    order.lock().push("apply_config_change");
                    false
                }
            },
            || false,
            None,
        );

        harness.process_batch_handler().await.unwrap();

        // Verify event received
        match tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await {
            Ok(Some(RaftEvent::MembershipApplied)) => {
                // Record event reception
                apply_order.lock().push("MembershipApplied_event");
            }
            _ => panic!("Expected MembershipApplied event"),
        }

        // Verify ordering: apply first, then event
        let order = apply_order.lock();
        assert_eq!(
            *order,
            vec!["apply_config_change", "MembershipApplied_event"],
            "Event must be sent AFTER apply_config_change"
        );
    }

    /// Test 3: NO event sent when config change fails
    ///
    /// Verifies that when apply_config_change() returns an error,
    /// MembershipApplied event is NOT sent (membership state is unchanged).
    ///
    /// Related: Bug fix #209
    #[tokio::test]
    async fn no_membership_applied_event_on_config_failure() {
        let entries = build_entries(
            vec![CommandType::Configuration(Change::AddNode(AddNode {
                node_id: 2,
                address: "127.0.0.1:8080".into(),
                status: d_engine_proto::common::NodeStatus::Promotable as i32,
            }))],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            || true, // Config fails
            || false,
            None,
        );

        let result = harness.process_batch_handler().await;
        assert!(result.is_err(), "Config change should fail");

        // Verify NO event was sent
        match tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await {
            Err(_) => {
                // Timeout is expected - no event sent
            }
            Ok(Some(event)) => panic!("Expected no event, but received {event:?}"),
            Ok(None) => {
                // Channel closed is also acceptable
            }
        }
    }

    /// Test 5: All config change types trigger MembershipApplied event
    ///
    /// Verifies that AddNode, RemoveNode, and Promote all send the event.
    ///
    /// Related: Bug fix #209
    #[tokio::test]
    async fn all_config_change_types_send_membership_applied() {
        use d_engine_proto::common::NodeStatus;
        use d_engine_proto::common::PromoteLearner;

        // Test AddNode
        let entries = build_entries(
            vec![CommandType::Configuration(Change::AddNode(AddNode {
                node_id: 2,
                address: "127.0.0.1:8080".into(),
                status: d_engine_proto::common::NodeStatus::Promotable as i32,
            }))],
            1,
        );
        let mut harness = setup_harness(Leader as i32, 1, entries, 1, || false, || false, None);
        harness.process_batch_handler().await.unwrap();
        assert!(
            matches!(
                tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await,
                Ok(Some(RaftEvent::MembershipApplied))
            ),
            "AddNode should send MembershipApplied"
        );

        // Test RemoveNode
        let entries = build_entries(
            vec![CommandType::Configuration(Change::RemoveNode(RemoveNode {
                node_id: 2,
            }))],
            1,
        );
        let mut harness = setup_harness(Leader as i32, 1, entries, 1, || false, || false, None);
        harness.process_batch_handler().await.unwrap();
        assert!(
            matches!(
                tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await,
                Ok(Some(RaftEvent::MembershipApplied))
            ),
            "RemoveNode should send MembershipApplied"
        );

        // Test PromoteLearner
        let entries = build_entries(
            vec![CommandType::Configuration(Change::Promote(
                PromoteLearner {
                    node_id: 2,
                    status: NodeStatus::Active as i32,
                },
            ))],
            1,
        );
        let mut harness = setup_harness(Leader as i32, 1, entries, 1, || false, || false, None);
        harness.process_batch_handler().await.unwrap();
        assert!(
            matches!(
                tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await,
                Ok(Some(RaftEvent::MembershipApplied))
            ),
            "PromoteLearner should send MembershipApplied"
        );
    }

    /// Test 6: Self-removal sends both MembershipApplied AND StepDownSelfRemoved
    ///
    /// Verifies that when Leader removes itself:
    /// 1. MembershipApplied is sent (to refresh cache)
    /// 2. StepDownSelfRemoved is sent (to trigger step down)
    ///
    /// Order: MembershipApplied should be sent before StepDownSelfRemoved
    ///
    /// Related: Bug fix #209, Issue #200 (self-removal)
    #[tokio::test]
    async fn self_removal_sends_both_events() {
        let entries = build_entries(
            vec![CommandType::Configuration(Change::RemoveNode(RemoveNode {
                node_id: 1, // Remove self (node_id = 1)
            }))],
            1,
        );

        let last_applied = entries.len();
        let mut harness = setup_harness(
            Leader as i32,
            1,
            entries,
            last_applied as u64,
            || false,
            || false,
            None,
        );

        harness.process_batch_handler().await.unwrap();

        // First event should be MembershipApplied
        match tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await {
            Ok(Some(RaftEvent::MembershipApplied)) => {
                // Correct first event
            }
            Ok(Some(other)) => panic!("Expected MembershipApplied first, got {other:?}"),
            _ => panic!("Expected MembershipApplied event"),
        }

        // Second event should be StepDownSelfRemoved
        match tokio::time::timeout(Duration::from_millis(50), harness.event_rx.recv()).await {
            Ok(Some(RaftEvent::StepDownSelfRemoved)) => {
                // Correct second event
            }
            Ok(Some(other)) => panic!("Expected StepDownSelfRemoved second, got {other:?}"),
            _ => panic!("Expected StepDownSelfRemoved event"),
        }
    }
}