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
// #![deny(missing_docs)]
//! Module with key-value storage
use serde::{Deserialize, Serialize};
use serde_json::Deserializer;
use std::collections::HashMap;
use std::fs::{File, OpenOptions};
use std::io::{BufReader, Read, Seek, SeekFrom, Write};
use std::path::PathBuf;

use crate::engine::KvsEngine;
use crate::error::{KVSError, Result};

const COMPACTION_THRESHOLD: u64 = 1024 * 1024;
const DATABASE_FILENAME: &str = "kvs.db";

// TODO: its duplicated in kvs.rs for cli usage
#[derive(Serialize, Deserialize)]
enum DBInsertion {
    /// Set up value by key into KVS
    Set { key: String, value: String },
    /// Removes value by key
    Rm { key: String },
}

/// Database insertion log
impl DBInsertion {
    pub fn get_key(&self) -> &String {
        match self {
            DBInsertion::Rm { key } => key,
            DBInsertion::Set { key, .. } => key,
        }
    }
}

#[derive(Debug, Clone)]
struct ItemPosition {
    pos: u64,
    len: usize,
}

/// Usage
/// ```rust
/// # use std::error::Error;
/// # use assert_cmd::prelude::*;
/// # fn main() -> Result<(), Box<dyn Error>> {
/// use std::path::Path;
/// use kvs::KvStore;
/// use crate::kvs::KvsEngine;
/// let db_path = "/tmp/";
///
/// let mut path = Path::new(db_path);
///
/// let mut store = KvStore::open(path).unwrap();
/// store.set("key1".to_owned(), "value1".to_owned());
/// assert_eq!(store.get("key1".to_owned())?, Some("value1".to_owned()));
/// store.remove("key1".to_owned());
/// #
/// #     Ok(())
/// # }
/// ```

/// In memory key value storage String:String
///
#[derive(Debug)]
pub struct KvStore {
    storage: HashMap<String, ItemPosition>,
    possible_compaction: u64,
    file: File,
}

impl KvsEngine for KvStore {
    /// Set up value by key into KVS
    fn set(&mut self, key: String, value: String) -> Result<()> {
        if self.possible_compaction > COMPACTION_THRESHOLD {
            let _ = self.compaction();
        }

        let insertion = DBInsertion::Set {
            key: key.clone(),
            value,
        };
        let insertion_str = serde_json::to_string(&insertion)?;
        let len = insertion_str.len();
        // move to end of the file and then write
        let pos = self.file.seek(SeekFrom::End(0))?;

        let position = ItemPosition { pos, len };

        self.file.write_all(insertion_str.as_bytes())?;
        self.file.flush()?;
        if let Some(_old_position) = self.storage.insert(key, position) {
            self.possible_compaction += len as u64;
        }
        Ok(())
    }
    /// Get value by key
    fn get(&mut self, key: String) -> Result<Option<String>> {
        // println!("{:?}", self.storage);
        let record_option = self.storage.get(key.as_str());
        match record_option {
            Some(record) => {
                let mut buf_reader = BufReader::new(&self.file);
                buf_reader.seek(SeekFrom::Start(record.pos))?;
                let handle = buf_reader.take(record.len as u64);

                let insertion: DBInsertion = serde_json::from_reader(handle)?;
                match insertion {
                    DBInsertion::Set { value, .. } => Ok(Some(value)),
                    _ => Err(KVSError::GeneralKVSError),
                }
            }
            None => Ok(None),
        }
    }
    /// Removes value by key
    fn remove(&mut self, key: String) -> Result<()> {
        let insertion = DBInsertion::Rm { key: key.clone() };

        if let Some(old_insertion_pos) = self.storage.remove(key.as_str()) {
            // move to end of the file and then write
            let insertion_str = serde_json::to_string(&insertion)?;
            self.file.seek(SeekFrom::End(0))?;
            self.file.write_all(insertion_str.as_bytes())?;
            self.file.flush()?;
            self.possible_compaction += old_insertion_pos.len as u64;
            Ok(())
        } else {
            Err(KVSError::GeneralKVSError)
        }
    }
}

impl KvStore {
    /// Create new instance
    pub fn new(path: PathBuf) -> Result<Self> {
        let file = OpenOptions::new()
            .create(true)
            .write(true)
            .read(true)
            .append(true)
            .open(path)
            .unwrap();
        let possible_compaction = 0;
        let storage = HashMap::new();

        let mut obj = Self {
            storage,
            possible_compaction,
            file,
        };
        obj.create_index()?;
        Ok(obj)
    }

    fn create_index(&mut self) -> Result<()> {
        let buf_reader = BufReader::new(&self.file);

        let mut stream = Deserializer::from_reader(buf_reader).into_iter::<DBInsertion>();
        let mut start = 0;
        // loop over all commands deserialized in file
        while let Some(Ok(insertion)) = stream.next() {
            let end = stream.byte_offset();
            let len = end - start;

            let position = ItemPosition {
                pos: start as u64,
                len,
            };
            start = end;
            // insert or remove keys from memory
            // sum up repeated keys for compaction acountability
            match insertion {
                DBInsertion::Set { key, .. } => {
                    if let Some(old_insertion_pos) = self.storage.insert(key.to_owned(), position) {
                        self.possible_compaction += old_insertion_pos.len as u64;
                    }
                }
                DBInsertion::Rm { key } => {
                    if let Some(old_insertion_pos) = self.storage.remove(key.as_str()) {
                        self.possible_compaction += old_insertion_pos.len as u64;
                    }
                }
            }
        }
        Ok(())
    }

    fn compaction(&mut self) -> Result<()> {
        log::info!("Compaction triggered");
        self.file.seek(SeekFrom::Start(0))?;
        let buf_reader = BufReader::new(&self.file);

        let mut stream = Deserializer::from_reader(buf_reader).into_iter::<DBInsertion>();

        let mut index: HashMap<String, String> = HashMap::new();
        while let Some(Ok(insertion)) = stream.next() {
            self.storage.remove(insertion.get_key());
            match insertion {
                DBInsertion::Set { key, value } => {
                    index.insert(key.to_owned(), value.to_owned());
                }
                DBInsertion::Rm { key } => {
                    index.remove(key.as_str());
                }
            }
        }
        // flush file
        self.file.set_len(0)?;
        self.possible_compaction = 0;
        for (key, value) in index {
            self.set(key, value)?
        }
        Ok(())
    }

    /// Open the KvStore at a given path. Return the KvStore.
    pub fn open(path: impl Into<PathBuf>) -> Result<KvStore> {
        let mut path_buf = path.into();
        path_buf.push(DATABASE_FILENAME);
        KvStore::new(path_buf)
    }
}