minikv 0.7.0

A production-grade distributed KV store with Raft consensus in ~1,500 lines
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
//! Raft consensus node (simplified wrapper)
//!
//! This is a minimal Raft implementation wrapper.
//! Only basic leader/follower roles are currently supported.
//! Full multi-node Raft (log replication, elections, etc.) is still in progress.
//! For production, use a full Raft library like tikv/raft.

use crate::common::Result;
use crate::coordinator::raft_rpc_client::{send_append_entries_rpc, send_request_vote_rpc};
use std::sync::{Arc, Mutex};

/// Simplified Raft state
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RaftRole {
    Follower,
    Candidate,
    Leader,
}

impl std::fmt::Display for RaftRole {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            RaftRole::Follower => write!(f, "follower"),
            RaftRole::Candidate => write!(f, "candidate"),
            RaftRole::Leader => write!(f, "leader"),
        }
    }
}

/// Raft node state
pub struct RaftNode {
    node_id: String,
    role: Arc<Mutex<RaftRole>>,
    term: Arc<Mutex<u64>>,
    voted_for: Arc<Mutex<Option<String>>>,
    leader_id: Arc<Mutex<Option<String>>>,
    log: Arc<Mutex<Vec<crate::common::raft::LogEntry>>>,
    peers: Arc<Mutex<Vec<String>>>, // List of peer node IDs
    commit_index: Arc<Mutex<u64>>,
    last_applied: Arc<Mutex<u64>>,
    snapshot: Arc<Mutex<Option<Vec<u8>>>>, // Optionally store snapshot bytes
}

impl RaftNode {
    /// Get a copy of the current peer list
    pub fn get_peers(&self) -> Vec<String> {
        self.peers.lock().unwrap().clone()
    }
    /// Detects a network partition (no heartbeat received)
    pub fn detect_partition(
        &self,
        last_heartbeat: tokio::time::Instant,
        timeout: tokio::time::Duration,
    ) -> bool {
        last_heartbeat.elapsed() > timeout
    }

    /// Recovery: reloads the snapshot and log after a crash or partition
    pub fn recover(&self) {
        if self.load_snapshot().is_some() {
            // Apply the snapshot to the real state machine here
        }
        let log = self.log.lock().unwrap().clone();
        if !log.is_empty() {
            // Apply each entry to the real state machine here
        }
        let mut applied = self.last_applied.lock().unwrap();
        *applied = *self.commit_index.lock().unwrap();
    }
    /// Save a snapshot of the current state (log, index, etc.)
    pub fn save_snapshot(&self, data: Vec<u8>) {
        let mut snap = self.snapshot.lock().unwrap();
        *snap = Some(data);
    }

    /// Load a snapshot into the state machine
    pub fn load_snapshot(&self) -> Option<Vec<u8>> {
        self.snapshot.lock().unwrap().clone()
    }

    /// Apply a snapshot received from the leader (InstallSnapshot RPC)
    pub fn apply_snapshot(&self, data: Vec<u8>, last_included_index: u64, last_included_term: u64) {
        self.save_snapshot(data);
        let mut log = self.log.lock().unwrap();
        log.retain(|entry| entry.index > last_included_index);
        let mut commit = self.commit_index.lock().unwrap();
        *commit = last_included_index;
        let mut applied = self.last_applied.lock().unwrap();
        *applied = last_included_index;
        let mut term = self.term.lock().unwrap();
        *term = last_included_term;
    }
    pub fn get_log(&self) -> std::sync::MutexGuard<'_, Vec<crate::common::raft::LogEntry>> {
        self.log.lock().unwrap()
    }

    /// Periodically send heartbeats (AppendEntries RPC) to all followers.
    /// This maintains leadership and triggers log replication.
    /// Send heartbeats (AppendEntries RPC) to all followers.
    /// This maintains leadership and triggers log replication.
    pub async fn send_heartbeats(&self) {
        let peers = self.peers.lock().unwrap().clone();
        let term = self.get_term();
        let leader_id = self.node_id.clone();
        let log_snapshot = self.log.lock().unwrap().clone();
        let prev_log_index = log_snapshot.last().map(|e| e.index).unwrap_or(0);
        let prev_log_term = log_snapshot.last().map(|e| e.term).unwrap_or(0);
        let leader_commit = prev_log_index;
        for peer in &peers {
            let req = crate::common::raft::AppendRequest {
                term,
                leader_id: leader_id.clone(),
                prev_log_index,
                prev_log_term,
                entries: vec![], // Heartbeat: no entries
                leader_commit,
            };
            let _ = send_append_entries_rpc(peer, req).await;
        }
    }

    /// Start the election timer and trigger elections if no heartbeat is received.
    /// This is a stub for multi-node Raft; should run in a background task.
    /// Election timer: triggers election if no heartbeat received.
    pub async fn run_election_timer(&self) {
        use rand::Rng;
        let mut rng = rand::thread_rng();
        loop {
            let timeout = rng.gen_range(150..300);
            tokio::time::sleep(tokio::time::Duration::from_millis(timeout)).await;
            if !self.is_leader() {
                // If no heartbeat, start election
                let peers = {
                    let peers_guard = self.peers.lock().unwrap();
                    peers_guard.clone()
                };
                self.start_election_and_collect_votes(peers).await;
            }
        }
    }

    /// Handle incoming RequestVote RPC from other nodes.
    pub fn handle_request_vote(
        &self,
        req: crate::common::raft::VoteRequest,
    ) -> crate::common::raft::VoteResponse {
        let mut term = self.term.lock().unwrap();
        let mut voted_for = self.voted_for.lock().unwrap();
        let current_term = *term;
        let mut vote_granted = false;

        if req.term < current_term {
            vote_granted = false;
        } else {
            if req.term > current_term {
                *term = req.term;
                *voted_for = None;
            }
            if voted_for.is_none() || voted_for.as_ref() == Some(&req.candidate_id) {
                *voted_for = Some(req.candidate_id.clone());
                vote_granted = true;
            }
        }
        crate::common::raft::VoteResponse {
            term: *term,
            vote_granted,
        }
    }

    /// Handle incoming AppendEntries RPC from leader.
    /// Used for log replication and heartbeat.
    pub fn handle_append_entries(
        &self,
        req: crate::common::raft::AppendRequest,
    ) -> crate::common::raft::AppendResponse {
        let mut term = self.term.lock().unwrap();
        let current_term = *term;
        let mut log = self.log.lock().unwrap();
        let mut conflict_index = 0;
        let success = if req.term < current_term {
            false
        } else {
            if req.term > current_term {
                *term = req.term;
            }
            if req.prev_log_index as usize <= log.len() {
                for entry in req.entries {
                    log.push(entry);
                }
                // Update the commit index
                let mut commit = self.commit_index.lock().unwrap();
                if req.leader_commit > *commit {
                    *commit =
                        std::cmp::min(req.leader_commit, log.last().map(|e| e.index).unwrap_or(0));
                }
                true
            } else {
                conflict_index = log.len() as u64;
                false
            }
        };
        crate::common::raft::AppendResponse {
            term: *term,
            success,
            conflict_index,
        }
    }

    pub async fn start_election_and_collect_votes(&self, peers: Vec<String>) -> bool {
        let new_term = self.start_election();
        let log_snapshot = self.log.lock().unwrap().clone();
        let last_log_index = log_snapshot.last().map(|e| e.index).unwrap_or(0);
        let last_log_term = log_snapshot.last().map(|e| e.term).unwrap_or(0);
        let mut votes = 1; // Vote for self
        for peer in &peers {
            let req = crate::common::raft::VoteRequest {
                term: new_term,
                candidate_id: self.node_id.clone(),
                last_log_index,
                last_log_term,
            };
            if let Ok(resp) = send_request_vote_rpc(peer, req).await {
                if resp.vote_granted {
                    votes += 1;
                }
            }
        }
        let majority = (peers.len() + 1).div_ceil(2);
        if votes >= majority {
            self.become_leader();
            true
        } else {
            self.step_down(new_term, None);
            false
        }
    }
    pub fn new(node_id: String) -> Self {
        Self {
            node_id,
            role: Arc::new(Mutex::new(RaftRole::Follower)),
            term: Arc::new(Mutex::new(0)),
            voted_for: Arc::new(Mutex::new(None)),
            leader_id: Arc::new(Mutex::new(None)),
            log: Arc::new(Mutex::new(Vec::new())),
            peers: Arc::new(Mutex::new(Vec::new())),
            commit_index: Arc::new(Mutex::new(0)),
            last_applied: Arc::new(Mutex::new(0)),
            snapshot: Arc::new(Mutex::new(None)),
        }
    }

    pub fn is_leader(&self) -> bool {
        matches!(*self.role.lock().unwrap(), RaftRole::Leader)
    }

    pub fn get_role(&self) -> RaftRole {
        *self.role.lock().unwrap()
    }

    pub fn get_leader(&self) -> Option<String> {
        self.leader_id.lock().unwrap().clone()
    }

    pub fn get_term(&self) -> u64 {
        *self.term.lock().unwrap()
    }

    /// Become leader (for single-node testing)
    pub fn become_leader(&self) {
        *self.role.lock().unwrap() = RaftRole::Leader;
        *self.leader_id.lock().unwrap() = Some(self.node_id.clone());
    }

    /// Step down to follower
    pub fn step_down(&self, new_term: u64, leader_id: Option<String>) {
        *self.role.lock().unwrap() = RaftRole::Follower;
        *self.term.lock().unwrap() = new_term;
        *self.leader_id.lock().unwrap() = leader_id;
        *self.voted_for.lock().unwrap() = None;
    }

    /// Start election
    pub fn start_election(&self) -> u64 {
        let mut term = self.term.lock().unwrap();
        *term += 1;
        let new_term = *term;

        *self.role.lock().unwrap() = RaftRole::Candidate;
        *self.voted_for.lock().unwrap() = Some(self.node_id.clone());
        *self.leader_id.lock().unwrap() = None;

        new_term
    }

    /// Grant vote
    pub fn grant_vote(&self, term: u64, candidate_id: String) -> bool {
        let mut current_term = self.term.lock().unwrap();
        let mut voted = self.voted_for.lock().unwrap();

        if term < *current_term {
            return false;
        }

        if term > *current_term {
            *current_term = term;
            *voted = None;
        }

        if voted.is_none() || voted.as_ref() == Some(&candidate_id) {
            *voted = Some(candidate_id);
            true
        } else {
            false
        }
    }

    /// Replicate entry (simplified)
    pub async fn replicate(&self, _entry: Vec<u8>) -> Result<()> {
        if !self.is_leader() {
            return Err(crate::Error::NotLeader(
                self.get_leader().unwrap_or_else(|| "unknown".to_string()),
            ));
        }
        // 1. Append entry to local log
        let index;
        let term;
        let entry;
        {
            let mut log = self.log.lock().unwrap();
            index = log.last().map(|e| e.index + 1).unwrap_or(1);
            term = self.get_term();
            entry = crate::common::raft::LogEntry {
                term,
                index,
                data: _entry,
            };
            log.push(entry.clone());
        }
        let peers = {
            let peers_guard = self.peers.lock().unwrap();
            peers_guard.clone()
        };
        let entry_snapshot = entry.clone();
        let node_id = self.node_id.clone();
        let mut ack_count = 1; // Leader self-ack
        for peer in &peers {
            let req = crate::common::raft::AppendRequest {
                term,
                leader_id: node_id.clone(),
                prev_log_index: index - 1,
                prev_log_term: term,
                entries: vec![entry_snapshot.clone()],
                leader_commit: index,
            };
            if let Ok(resp) = send_append_entries_rpc(peer, req).await {
                if resp.success {
                    ack_count += 1;
                }
            }
        }
        let majority = (peers.len() + 1).div_ceil(2);
        if ack_count >= majority {
            // Effective commit: advance commit_index
            let mut commit = self.commit_index.lock().unwrap();
            *commit = index;
            let mut applied = self.last_applied.lock().unwrap();
            while *applied < *commit {
                // Apply log[*applied] to the real state machine here
                *applied += 1;
            }
            Ok(())
        } else {
            Err(crate::Error::Internal(
                "Raft: no majority for commit".to_string(),
            ))
        }
    }
}

pub fn start_raft_tasks(node: Arc<RaftNode>) -> tokio::task::JoinHandle<()> {
    tokio::spawn({
        let node = node.clone();
        async move {
            let mut last_heartbeat = tokio::time::Instant::now();
            let mut election_timeout =
                tokio::time::Duration::from_millis(150 + rand::random::<u64>() % 150);
            loop {
                tokio::time::sleep(tokio::time::Duration::from_millis(50)).await;
                // Clone peers each loop to avoid holding MutexGuard
                let peers = node.peers.lock().unwrap().clone();
                // If follower and no heartbeat received, start election
                if !node.is_leader() && last_heartbeat.elapsed() > election_timeout {
                    tracing::info!("Node {} starting election", node.node_id);
                    node.start_election_and_collect_votes(peers).await;
                    election_timeout =
                        tokio::time::Duration::from_millis(150 + rand::random::<u64>() % 150);
                    last_heartbeat = tokio::time::Instant::now();
                }
                // If leader, send heartbeats
                if node.is_leader() {
                    node.send_heartbeats().await;
                    last_heartbeat = tokio::time::Instant::now();
                }
            }
        }
    })
}