Merge pull request #13 from future-highway/consensus

Refactoring and cleanup

Author: Klaven

Cargo.toml

@@ -1,7 +1,4 @@
 [workspace]
+resolver = "2"
 
-members = [
-    "cli",
-    "database",
-    "experiments/iocost", "html-test",
-]
+members = ["cli", "database", "experiments/iocost", "html-test"]

database/Cargo.toml

@@ -6,23 +6,23 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-clap = { version = "4.4.10", features = ["derive","string"]}
 actix-web = "4.3.1"
-lazy_static = "1.4.0"
+anyhow = "1"
+clap = { version = "4.4.10", features = ["derive", "string"] }
 easy_reader = "0.5.1"
+env_logger = "0.11.1"
 fnv = "1.0.7"
-anyhow = "1"
-tempfile = "3.8.0"
+lazy_static = "1.4.0"
+log = "0.4"
 prost = "0.12"
-tonic = { version = "0.10.2" }
-tokio = { version = "1.26.0", features = ["full"] }
+quick-xml = { version = "0.31.0", features = ["serialize"] }
 rand = "0.8.5"
 rand_chacha = "0.3.1"
-quick-xml = { version= "0.31.0", features = ["serialize"]}
-serde_json = "1.0.70"
 serde = { version = "1.0.130", features = ["derive"] }
-log = "0.4"
-env_logger = "0.11.1"
+serde_json = "1.0.70"
+tempfile = "3.8.0"
+tokio = { version = "1.26.0", features = ["full"] }
+tonic = { version = "0.10.2" }
 
 
 [build-dependencies]

database/src/file/file_engine.rs

@@ -1,11 +1,11 @@
-use quick_xml::de::from_str;
-use serde::{Deserialize, Serialize};
-
-use prost::Message;
+use std::str::FromStr;
 
 use super::proto;
 use super::record::{HtmlRecord, JsonRecord, Record};
 use crate::errors::NullDbReadError;
+use anyhow::anyhow;
+use prost::Message;
+use quick_xml::de::from_str;
 
 #[derive(Debug, Clone, Copy)]
 pub enum FileEngine {
@@ -14,18 +14,22 @@ pub enum FileEngine {
     Proto,
 }
 
-/// FileEngine is an enum that represents the different file engines that can be used to store records.
-impl FileEngine {
+impl FromStr for FileEngine {
+    type Err = anyhow::Error;
+
     /// new creates a new FileEngine from a string, valid options are json, html and proto.
-    pub fn new(engine: &str) -> Self {
-        match engine {
-            "json" => FileEngine::Json,
-            "html" => FileEngine::Html,
-            "proto" => FileEngine::Proto,
-            _ => panic!("Invalid file engine"),
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "json" => Ok(FileEngine::Json),
+            "html" => Ok(FileEngine::Html),
+            "proto" => Ok(FileEngine::Proto),
+            _ => Err(anyhow!("Invalid file engine")),
         }
     }
+}
 
+/// FileEngine is an enum that represents the different file engines that can be used to store records.
+impl FileEngine {
     /// deserialize a string into a Record.
     ///
     /// # Errors
@@ -35,16 +39,16 @@ impl FileEngine {
         match self {
             FileEngine::Json => {
                 let json: JsonRecord =
-                    serde_json::from_str(value).map_err(|e| NullDbReadError::Corrupted)?;
+                    serde_json::from_str(value).map_err(|_e| NullDbReadError::Corrupted)?;
                 Ok(Record::Json(json))
             }
             FileEngine::Html => {
-                let html: HtmlRecord = from_str(value).map_err(|e| NullDbReadError::Corrupted)?;
+                let html: HtmlRecord = from_str(value).map_err(|_e| NullDbReadError::Corrupted)?;
                 Ok(Record::Html(html))
             }
             FileEngine::Proto => {
                 let proto: proto::ProtoRecord = proto::ProtoRecord::decode(value.as_bytes())
-                    .map_err(|e| NullDbReadError::Corrupted)?;
+                    .map_err(|_e| NullDbReadError::Corrupted)?;
                 Ok(Record::Proto(proto))
             }
         }

database/src/file/record.rs

@@ -83,7 +83,15 @@ impl Record {
         }
     }
 
-    /// get_key returns the key of the record.
+    pub fn as_key(&self) -> &str {
+        match self {
+            Record::Json(json) => &json.key,
+            Record::Html(html) => &html.key,
+            Record::Proto(proto) => &proto.key,
+        }
+    }
+
+    /// to_key returns a clone of the recored's key.
     pub fn get_key(&self) -> String {
         match self {
             Record::Json(json) => json.key.clone(),
@@ -107,19 +115,21 @@ impl Record {
             Record::Json(json) => json.tombstone,
             Record::Proto(proto) => proto.tombstone,
             Record::Html(html) => match &html.class {
-                Some(class) => {
-                    if class == "tombstone" {
-                        Some(true)
-                    } else {
-                        None
-                    }
-                }
-                None => None,
+                Some(class) if class == "tombstone" => Some(true),
+                Some(_) | None => None,
             },
         }
     }
 
-    /// get_value returns the value of the record.
+    pub fn as_value(&self) -> Option<&str> {
+        match self {
+            Record::Json(json) => json.value.as_deref(),
+            Record::Html(html) => html.value.as_deref(),
+            Record::Proto(proto) => proto.value.as_deref(),
+        }
+    }
+
+    /// get_value returns a clone of the recored's value.
     pub fn get_value(&self) -> Option<String> {
         match self {
             Record::Json(json) => json.value.clone(),