openraft 0.10.0-alpha.18

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

use crate::engine::Command;
use crate::engine::Engine;
use crate::engine::LogIdList;
use crate::engine::testing::UTConfig;
use crate::engine::testing::log_id;
use crate::raft_state::LogStateReader;

fn eng() -> Engine<UTConfig> {
    let mut eng = Engine::testing_default(0);
    eng.state.enable_validation(false); // Disable validation for incomplete state

    // Setup: purged at 2 (leader 2), leader 2's logs at 3-4, leader 4's logs at 5-6
    eng.state.log_ids = LogIdList::new(Some(log_id(2, 1, 2)), vec![log_id(2, 1, 4), log_id(4, 1, 6)]);
    eng
}

#[test]
fn test_purge_log_already_purged() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(1, 1, 1));
    lh.purge_log();

    assert_eq!(Some(&log_id(2, 1, 2)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(2, 1, 2)), lh.state.log_ids.purged());
    assert_eq!(log_id(2, 1, 4), lh.state.log_ids.key_log_ids()[0]);
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_log_id());

    assert_eq!(0, lh.output.take_commands().len());

    Ok(())
}

#[test]
fn test_purge_log_equal_prev_last_purged() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(2, 1, 2));
    lh.purge_log();

    assert_eq!(Some(&log_id(2, 1, 2)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(2, 1, 2)), lh.state.log_ids.purged());
    assert_eq!(log_id(2, 1, 4), lh.state.log_ids.key_log_ids()[0]);
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_log_id());

    assert_eq!(0, lh.output.take_commands().len());

    Ok(())
}

#[test]
fn test_purge_log_same_leader_as_prev_last_purged() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    // Purge to 3 (within leader 2's range)
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(2, 1, 3));
    lh.purge_log();

    assert_eq!(Some(&log_id(2, 1, 3)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(2, 1, 3)), lh.state.log_ids.purged());
    // key_log_ids still has leader 2's last at 4, leader 4's last at 6
    assert_eq!(log_id(2, 1, 4), lh.state.log_ids.key_log_ids()[0]);
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_log_id());

    assert_eq!(
        vec![Command::PurgeLog { upto: log_id(2, 1, 3) }],
        lh.output.take_commands()
    );

    Ok(())
}

#[test]
fn test_purge_log_to_last_key_log() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    // Purge to 4 (at leader 2's last)
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(2, 1, 4));
    lh.purge_log();

    assert_eq!(Some(&log_id(2, 1, 4)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(2, 1, 4)), lh.state.log_ids.purged());
    // leader 2 is completely purged, only leader 4 remains
    assert_eq!(log_id(4, 1, 6), lh.state.log_ids.key_log_ids()[0]);
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_log_id());

    assert_eq!(
        vec![Command::PurgeLog { upto: log_id(2, 1, 4) }],
        lh.output.take_commands()
    );

    Ok(())
}

#[test]
fn test_purge_log_go_pass_last_key_log() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    // Purge to 5 (within leader 4's range)
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(4, 1, 5));
    lh.purge_log();

    assert_eq!(Some(&log_id(4, 1, 5)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(4, 1, 5)), lh.state.log_ids.purged());
    // Only leader 4's log at 6 remains
    assert_eq!(log_id(4, 1, 6), lh.state.log_ids.key_log_ids()[0]);
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_log_id());

    assert_eq!(
        vec![Command::PurgeLog { upto: log_id(4, 1, 5) }],
        lh.output.take_commands()
    );

    Ok(())
}

#[test]
fn test_purge_log_to_last_log_id() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    // Purge to 6 (at last log)
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(4, 1, 6));
    lh.purge_log();

    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.log_ids.purged());
    // All logs purged, key_log_ids is empty
    assert!(lh.state.log_ids.key_log_ids().is_empty());
    // last_log_id returns the purged log when all logs are purged
    assert_eq!(Some(&log_id(4, 1, 6)), lh.state.last_log_id());

    assert_eq!(
        vec![Command::PurgeLog { upto: log_id(4, 1, 6) }],
        lh.output.take_commands()
    );

    Ok(())
}

#[test]
fn test_purge_log_go_pass_last_log_id() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    // Purge to 7 (beyond last log)
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(4, 1, 7));
    lh.purge_log();

    assert_eq!(Some(&log_id(4, 1, 7)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(4, 1, 7)), lh.state.log_ids.purged());
    // All logs purged, key_log_ids is empty
    assert!(lh.state.log_ids.key_log_ids().is_empty());
    // last_log_id returns the purged log when all logs are purged
    assert_eq!(Some(&log_id(4, 1, 7)), lh.state.last_log_id());

    assert_eq!(
        vec![Command::PurgeLog { upto: log_id(4, 1, 7) }],
        lh.output.take_commands()
    );

    Ok(())
}

#[test]
fn test_purge_log_to_higher_leader_lgo() -> anyhow::Result<()> {
    // Setup: purged at 2, leader 2 at 3-4, leader 4 at 5-6
    // Purge to 7 with higher leader (installing snapshot scenario)
    let mut eng = eng();

    let mut lh = eng.log_handler();
    lh.state.purge_upto = Some(log_id(5, 1, 7));
    lh.purge_log();

    assert_eq!(Some(&log_id(5, 1, 7)), lh.state.last_purged_log_id());
    assert_eq!(Some(&log_id(5, 1, 7)), lh.state.log_ids.purged());
    // All logs purged, key_log_ids is empty
    assert!(lh.state.log_ids.key_log_ids().is_empty());
    // last_log_id returns the purged log when all logs are purged
    assert_eq!(Some(&log_id(5, 1, 7)), lh.state.last_log_id());

    assert_eq!(
        vec![Command::PurgeLog { upto: log_id(5, 1, 7) }],
        lh.output.take_commands()
    );

    Ok(())
}