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
use std::{sync::Arc, thread};

use d_engine_proto::server::election::VotedFor;

use super::super::*;

#[test]
fn test_voted_for_backward_compatibility() {
    // Simulate old VotedFor data (without committed field)
    // Protobuf default: bool fields default to false
    let old_vote = VotedFor {
        voted_for_id: 3,
        voted_for_term: 5,
        committed: false, // Old data will deserialize to false
    };

    // Verify default behavior
    assert_eq!(old_vote.voted_for_id, 3);
    assert_eq!(old_vote.voted_for_term, 5);
    assert!(!old_vote.committed);
}

#[test]
fn test_voted_for_committed_flag() {
    // New data with committed=true (leader elected)
    let leader_vote = VotedFor {
        voted_for_id: 1,
        voted_for_term: 10,
        committed: true,
    };

    assert!(leader_vote.committed);

    // Candidate vote (not yet leader)
    let candidate_vote = VotedFor {
        voted_for_id: 2,
        voted_for_term: 10,
        committed: false,
    };

    assert!(!candidate_vote.committed);
}

#[test]
fn test_hard_state_with_voted_for() {
    // Test HardState with VotedFor (migration scenario)
    let hs = HardState {
        current_term: 5,
        voted_for: Some(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: false, // Old data defaults to false
        }),
    };

    assert_eq!(hs.current_term, 5);
    assert!(hs.voted_for.is_some());

    let vote = hs.voted_for.unwrap();
    assert_eq!(vote.voted_for_id, 3);
    assert_eq!(vote.voted_for_term, 5);
    assert!(!vote.committed);
}

#[test]
fn test_candidate_to_leader_committed_vote() {
    // When candidate becomes leader, vote.committed should be true
    let leader_vote = VotedFor {
        voted_for_id: 1,
        voted_for_term: 10,
        committed: true,
    };

    assert!(leader_vote.committed);
    assert_eq!(leader_vote.voted_for_id, 1);
}

#[test]
fn test_step_down_resets_vote() {
    // When node steps down (higher term), voted_for should be reset
    let mut shared = SharedState::new(1, None, None);

    // Initially voted for someone
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 2,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    assert!(shared.voted_for().unwrap().is_some());

    // Step down - reset vote
    shared.reset_voted_for().unwrap();

    assert!(shared.voted_for().unwrap().is_none());
}

#[test]
fn test_committed_vote_represents_leader() {
    // Committed vote with committed=true means this node is leader
    let leader_vote = VotedFor {
        voted_for_id: 1,
        voted_for_term: 10,
        committed: true,
    };

    // Leader exists when vote is committed
    assert!(leader_vote.committed);

    // Uncommitted vote means no confirmed leader yet
    let candidate_vote = VotedFor {
        voted_for_id: 1,
        voted_for_term: 10,
        committed: false,
    };

    assert!(!candidate_vote.committed);
}

#[test]
fn test_follower_learns_leader_from_append_entries() {
    // Simulate follower receiving AppendEntries from leader
    let mut shared = SharedState::new(2, None, None);

    // Before AppendEntries: no leader known
    assert!(shared.voted_for().unwrap().is_none());

    // After successful AppendEntries: learn leader
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true, // Confirmed leader
        })
        .unwrap();

    let vote = shared.voted_for().unwrap().unwrap();
    assert_eq!(vote.voted_for_id, 3);
    assert!(vote.committed);
}

#[test]
fn test_vote_lifecycle() {
    let mut shared = SharedState::new(1, None, None);

    // 1. Initial state: no vote
    assert!(shared.voted_for().unwrap().is_none());

    // 2. Candidate votes for self (uncommitted)
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 1,
            voted_for_term: 5,
            committed: false,
        })
        .unwrap();

    let vote = shared.voted_for().unwrap().unwrap();
    assert!(!vote.committed);

    // 3. Receives quorum, becomes leader (committed)
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 1,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    let vote = shared.voted_for().unwrap().unwrap();
    assert!(vote.committed);

    // 4. Steps down (higher term discovered)
    shared.update_current_term(6);
    shared.reset_voted_for().unwrap();

    assert!(shared.voted_for().unwrap().is_none());
}

#[test]
fn test_committed_vote_persistence() {
    // Test that committed flag persists in HardState
    let hs = HardState {
        current_term: 10,
        voted_for: Some(VotedFor {
            voted_for_id: 2,
            voted_for_term: 10,
            committed: true,
        }),
    };

    // Verify committed flag is stored
    assert!(hs.voted_for.unwrap().committed);

    // Test with uncommitted vote
    let hs2 = HardState {
        current_term: 10,
        voted_for: Some(VotedFor {
            voted_for_id: 2,
            voted_for_term: 10,
            committed: false,
        }),
    };

    assert!(!hs2.voted_for.unwrap().committed);
}

/// Test atomic leader_id operations (Phase 2: performance optimization)
#[test]
fn test_shared_state_current_leader_default() {
    let shared = SharedState::new(1, None, None);

    // Default: no leader (0 = None)
    assert_eq!(shared.current_leader(), None);
}

#[test]
fn test_shared_state_set_current_leader() {
    let shared = SharedState::new(1, None, None);

    // Set leader
    shared.set_current_leader(5);
    assert_eq!(shared.current_leader(), Some(5));

    // Update leader
    shared.set_current_leader(3);
    assert_eq!(shared.current_leader(), Some(3));
}

#[test]
fn test_shared_state_clear_current_leader() {
    let shared = SharedState::new(1, None, None);

    // Set then clear
    shared.set_current_leader(5);
    assert_eq!(shared.current_leader(), Some(5));

    shared.clear_current_leader();
    assert_eq!(shared.current_leader(), None);
}

#[test]
fn test_shared_state_leader_zero_means_none() {
    let shared = SharedState::new(1, None, None);

    // Explicitly set to 0 (same as clear)
    shared.set_current_leader(0);
    assert_eq!(shared.current_leader(), None);

    // Set valid leader
    shared.set_current_leader(2);
    assert_eq!(shared.current_leader(), Some(2));

    // Clear via set_current_leader(0)
    shared.set_current_leader(0);
    assert_eq!(shared.current_leader(), None);
}

#[test]
fn test_shared_state_leader_clone() {
    let shared1 = SharedState::new(1, None, None);
    shared1.set_current_leader(10);

    // Clone preserves leader_id
    let shared2 = shared1.clone();
    assert_eq!(shared2.current_leader(), Some(10));

    // Clones are independent
    shared2.set_current_leader(20);
    assert_eq!(shared1.current_leader(), Some(10)); // Original unchanged
    assert_eq!(shared2.current_leader(), Some(20));
}

#[test]
fn test_shared_state_leader_debug() {
    let shared = SharedState::new(1, None, None);
    shared.set_current_leader(7);

    // Debug format includes current_leader
    let debug_str = format!("{shared:?}");
    assert!(debug_str.contains("current_leader"));
    assert!(debug_str.contains("7"));
}

#[test]
fn test_shared_state_concurrent_updates() {
    let shared = Arc::new(SharedState::new(1, None, None));

    // Simulate concurrent leader updates
    let handles: Vec<_> = (0..10)
        .map(|i| {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                shared.set_current_leader(i as u32);
            })
        })
        .collect();

    for h in handles {
        h.join().unwrap();
    }

    // Final value is one of the concurrent updates
    let final_leader = shared.current_leader();
    assert!(final_leader.is_some());
    assert!(final_leader.unwrap() < 10);
}

#[test]
fn test_shared_state_leader_lifecycle() {
    let shared = SharedState::new(1, None, None);

    // 1. Start: no leader
    assert_eq!(shared.current_leader(), None);

    // 2. AppendEntries from node 3
    shared.set_current_leader(3);
    assert_eq!(shared.current_leader(), Some(3));

    // 3. Leader step down (higher term)
    shared.clear_current_leader();
    assert_eq!(shared.current_leader(), None);

    // 4. New leader elected
    shared.set_current_leader(5);
    assert_eq!(shared.current_leader(), Some(5));
}

// ============================================================================
// update_voted_for() Business Scenario Tests
// ============================================================================

/// Scenario 1: First time discovering leader (follower receives first AppendEntries)
#[test]
fn test_update_voted_for_first_leader_discovery() {
    let mut shared = SharedState::new(2, None, None);

    // Initial state: no voted_for, no leader
    assert!(shared.voted_for().unwrap().is_none());
    assert_eq!(shared.current_leader(), None);

    // Receive first AppendEntries from leader 3
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    // Should trigger LeaderDiscovered event
    assert!(is_new, "First leader discovery should return true");
    assert_eq!(shared.voted_for().unwrap().unwrap().voted_for_id, 3);
    assert_eq!(shared.voted_for().unwrap().unwrap().voted_for_term, 5);
}

/// Scenario 2: Same leader sends heartbeat (no change)
#[test]
fn test_update_voted_for_same_leader_heartbeat() {
    let mut shared = SharedState::new(2, None, None);

    // First heartbeat
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    // Simulate memory update (in real code, caller updates current_leader_id)
    shared.set_current_leader(3);

    // Second heartbeat from same leader
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    // Should NOT trigger event (same leader)
    assert!(!is_new, "Same leader heartbeat should return false");
}

/// Scenario 3: Leader changes (new leader elected)
#[test]
fn test_update_voted_for_leader_change() {
    let mut shared = SharedState::new(2, None, None);

    // Old leader
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();
    shared.set_current_leader(3);

    // New leader elected in higher term
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 5,
            voted_for_term: 6,
            committed: true,
        })
        .unwrap();

    // Should trigger LeaderDiscovered event
    assert!(is_new, "Leader change should return true");
    assert_eq!(shared.voted_for().unwrap().unwrap().voted_for_id, 5);
    assert_eq!(shared.voted_for().unwrap().unwrap().voted_for_term, 6);
}

/// Scenario 4: Candidate votes for self (uncommitted)
#[test]
fn test_update_voted_for_candidate_vote() {
    let mut shared = SharedState::new(1, None, None);

    // Candidate votes for self (not yet leader)
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 1,
            voted_for_term: 5,
            committed: false,
        })
        .unwrap();

    // Should NOT trigger event (not committed)
    assert!(!is_new, "Uncommitted candidate vote should return false");
    assert!(!shared.voted_for().unwrap().unwrap().committed);
}

/// Scenario 5: Candidate becomes leader (uncommitted → committed)
#[test]
fn test_update_voted_for_candidate_to_leader() {
    let mut shared = SharedState::new(1, None, None);

    // Step 1: Candidate votes for self
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 1,
            voted_for_term: 5,
            committed: false,
        })
        .unwrap();

    // Step 2: Receives quorum, becomes leader
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 1,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    // Should trigger event (committed flag transition)
    assert!(is_new, "Candidate to leader transition should return true");
    assert!(shared.voted_for().unwrap().unwrap().committed);
}

/// Scenario 6: Node restart - same leader still exists (CRITICAL FIX)
#[test]
fn test_update_voted_for_node_restart_same_leader() {
    // Simulate node state before shutdown
    let hard_state_before_shutdown = HardState {
        current_term: 4,
        voted_for: Some(VotedFor {
            voted_for_id: 3,
            voted_for_term: 4,
            committed: true,
        }),
    };

    // Node restarts - load hard_state from disk
    let mut shared = SharedState::new(1, Some(hard_state_before_shutdown), None);

    // Key: current_leader_id is reset to 0 (memory cleared)
    assert_eq!(
        shared.current_leader(),
        None,
        "After restart, current_leader should be None"
    );
    assert!(
        shared.voted_for().unwrap().is_some(),
        "voted_for loaded from disk"
    );

    // Leader 3 sends first heartbeat after restart
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 4,
            committed: true,
        })
        .unwrap();

    // CRITICAL: Should trigger LeaderDiscovered event
    // Because current_leader_id is None (memory cleared after restart)
    assert!(
        is_new,
        "Node restart: should rediscover leader even if voted_for unchanged"
    );
}

/// Scenario 7: Node restart - leader changed during downtime
#[test]
fn test_update_voted_for_node_restart_leader_changed() {
    // Node state before shutdown (old leader 3)
    let hard_state_before_shutdown = HardState {
        current_term: 4,
        voted_for: Some(VotedFor {
            voted_for_id: 3,
            voted_for_term: 4,
            committed: true,
        }),
    };

    // Node restarts
    let mut shared = SharedState::new(1, Some(hard_state_before_shutdown), None);

    // New leader 5 sends heartbeat (term advanced)
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 5,
            voted_for_term: 6,
            committed: true,
        })
        .unwrap();

    // Should trigger event (leader changed)
    assert!(is_new, "Node restart with new leader should return true");
    assert_eq!(shared.voted_for().unwrap().unwrap().voted_for_id, 5);
    assert_eq!(shared.voted_for().unwrap().unwrap().voted_for_term, 6);
}

/// Scenario 8: Term advances but no leader yet
#[test]
fn test_update_voted_for_term_advance_no_leader() {
    let mut shared = SharedState::new(2, None, None);

    // Old leader
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();
    shared.set_current_leader(3);

    // Term advances, candidate votes (not yet leader)
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 5,
            voted_for_term: 6,
            committed: false, // Not yet leader
        })
        .unwrap();

    // Should NOT trigger event (uncommitted)
    assert!(
        !is_new,
        "Term advance without committed leader should return false"
    );
}

/// Scenario 9: Leader step down (leader discovers higher term)
#[test]
fn test_update_voted_for_leader_step_down() {
    let mut shared = SharedState::new(3, None, None);

    // Node 3 is leader in term 5
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();
    shared.set_current_leader(3);

    // Discovers higher term, resets vote
    shared.update_current_term(6);
    shared.reset_voted_for().unwrap();
    shared.clear_current_leader();

    // New leader in term 6
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 5,
            voted_for_term: 6,
            committed: true,
        })
        .unwrap();

    // Should trigger event (new leader after step down)
    assert!(is_new, "New leader after step down should return true");
}

/// Scenario 10: Multiple leader changes in sequence
#[test]
fn test_update_voted_for_multiple_leader_changes() {
    let mut shared = SharedState::new(2, None, None);

    // Leader 1 (term 3)
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 1,
            voted_for_term: 3,
            committed: true,
        })
        .unwrap();
    assert!(is_new);
    shared.set_current_leader(1);

    // Leader 2 (term 4)
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 2,
            voted_for_term: 4,
            committed: true,
        })
        .unwrap();
    assert!(is_new, "First leader change");
    shared.set_current_leader(2);

    // Leader 3 (term 5)
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();
    assert!(is_new, "Second leader change");
}

/// Scenario 11: Edge case - same leader but term regressed (network partition recovery)
#[test]
fn test_update_voted_for_term_regression() {
    let mut shared = SharedState::new(2, None, None);

    // Current leader in term 6
    shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 6,
            committed: true,
        })
        .unwrap();
    shared.set_current_leader(3);

    // Receive stale message from term 5 (should be rejected in practice)
    // But test update_voted_for logic
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 5,
            committed: true,
        })
        .unwrap();

    // Term regression is considered a change
    assert!(is_new, "Term regression should return true");
}

/// Scenario 12: Learner node receives leader info
#[test]
fn test_update_voted_for_learner_discovers_leader() {
    let mut shared = SharedState::new(10, None, None); // Learner node

    // Learner discovers leader through snapshot or replication
    let is_new = shared
        .update_voted_for(VotedFor {
            voted_for_id: 3,
            voted_for_term: 8,
            committed: true,
        })
        .unwrap();

    // Should trigger event (first discovery)
    assert!(is_new, "Learner first leader discovery should return true");
}