refactor: design error type

Design error type.

Fixes: #23

Signed-off-by: yaoyinnan <35447132+yaoyinnan@users.noreply.github.com>

src/error/config.rs

@@ -0,0 +1,10 @@
+use thiserror::Error;
+use toml;
+
+pub type Result<T> = std::result::Result<T, ConfigError>;
+
+#[derive(Debug, Error)]
+pub enum ConfigError {
+    #[error("parse toml error: {0}")]
+    ParseToml(#[from] toml::de::Error),
+}

src/error/mod.rs

@@ -0,0 +1,34 @@
+pub mod config;
+pub mod network;
+pub mod redis;
+pub mod server;
+
+use std::io;
+
+use crate::error::config::ConfigError;
+use crate::error::network::NetWorkError;
+use crate::error::redis::RedisError;
+use crate::error::server::ServerError;
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    #[error("unexpected error: {0}")]
+    Unexpected(String),
+
+    #[error("error on network: {0}")]
+    NetWork(#[from] NetWorkError),
+
+    #[error("IO error: {0}")]
+    IO(#[from] io::Error),
+
+    #[error("error on config: {0}")]
+    Config(#[from] ConfigError),
+
+    #[error("error on redis: {0}")]
+    Redis(#[from] RedisError),
+
+    #[error("error on server: {0}")]
+    Server(#[from] ServerError),
+}

src/error/network.rs

@@ -0,0 +1,9 @@
+use thiserror::Error;
+
+pub type Result<T> = std::result::Result<T, NetWorkError>;
+
+#[derive(Debug, Error)]
+pub enum NetWorkError {
+    #[error("error on network: {0}")]
+    NetWork(String),
+}

src/utils/error.rs → src/error/redis.rs

@@ -1,19 +1,9 @@
-use std::io;
 use thiserror::Error;
 
-// todo: 需要完成 Error 的具体设计
+pub type Result<T> = std::result::Result<T, RedisError>;
+
 #[derive(Debug, Error)]
-pub enum PikaProxyError {
-    #[error("error on network: {0}")]
-    NetWorkError(String),
-    #[error("can't not open file: {0}")]
-    FailedOpenDB(String),
-    #[error("IO error: {0}")]
-    Io(#[from] io::Error),
-    #[error("Parsing error: {0}")]
-    ParseError(#[from] toml::de::Error),
-    #[error("unexpected error: {0}")]
-    UnexpectedError(String),
+pub enum RedisError {
     #[error("key or value size is invalid")]
     InvalidKeyOrValue,
     #[error("can't decode on empty entry")]
@@ -33,5 +23,3 @@ pub enum PikaProxyError {
     #[error("merging")]
     AtMerging,
 }
-
-pub type Result<T> = std::result::Result<T, PikaProxyError>;

src/error/server.rs

@@ -0,0 +1,9 @@
+use thiserror::Error;
+
+pub type Result<T> = std::result::Result<T, ServerError>;
+
+#[derive(Debug, Error)]
+pub enum ServerError {
+    #[error("can't not open db: {0}")]
+    FailedOpenDB(String),
+}

src/main.rs

@@ -1,3 +1,4 @@
+pub mod error;
 pub mod models;
 pub mod proxy;
 pub mod utils;
@@ -24,7 +25,7 @@ fn main() {
         .build() // 创建runtime
         .unwrap();
 
-    let proxy = Proxy::from(&option);
+    let proxy = Proxy::new(&option).unwrap();
 
     rt.block_on(proxy.serve_proxy());
 }

src/proxy/config.rs

@@ -1,7 +1,7 @@
+use crate::error::config::ConfigError;
+use crate::error::Result;
 use serde::{de, Deserialize, Deserializer, Serialize};
-use std::{fs::File, io::Read, path::Path, time::Duration};
-
-use crate::utils::error::Result as PikaProxyResult;
+use std::{path::Path, time::Duration};
 
 const KB: u64 = 1024;
 const MB: u64 = 1024 * KB;
@@ -84,7 +84,7 @@ pub struct Config {
     metrics_report_stats_prefix: String,
 }
 
-fn deserialize_string_to_size<'de, D>(deserializer: D) -> Result<u64, D::Error>
+fn deserialize_string_to_size<'de, D>(deserializer: D) -> std::result::Result<u64, D::Error>
 where
     D: Deserializer<'de>,
 {
@@ -100,7 +100,9 @@ where
     }
 }
 
-fn deserialize_string_to_duration<'de, D>(deserializer: D) -> Result<Duration, D::Error>
+fn deserialize_string_to_duration<'de, D>(
+    deserializer: D,
+) -> std::result::Result<Duration, D::Error>
 where
     D: Deserializer<'de>,
 {
@@ -134,12 +136,9 @@ fn parse_string_to_num_and_unit(str: &str) -> (u64, &str) {
 }
 
 impl Config {
-    pub fn from_path<P: AsRef<Path>>(path: P) -> PikaProxyResult<Self> {
-        let mut f = File::open(path)?;
-        let mut content = String::new();
-        f.read_to_string(&mut content)?;
-        let config: Config = toml::from_str(&content)?;
-        Ok(config)
+    pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self> {
+        let content = std::fs::read_to_string(path)?;
+        Ok(toml::from_str(&content).map_err(ConfigError::ParseToml)?)
     }
 
     pub fn proxy_addr(&self) -> &str {
@@ -151,17 +150,15 @@ impl Config {
     }
 }
 
-#[cfg(test)]
 mod tests {
     use super::Config;
 
     #[test]
     fn test_config() {
-        let path = "config/proxy.toml";
-        let mut root_path = project_root::get_project_root().unwrap();
-        root_path.push(path);
-        let config = Config::from_path(root_path).unwrap();
-        assert_eq!(config.admin_addr, "0.0.0.0:11080");
-        assert_eq!(config.proxy_addr, "127.0.0.1:19000")
+        let mut config_path = project_root::get_project_root().unwrap();
+        config_path.push("config/proxy.toml");
+        let config = Config::from_path(config_path).unwrap();
+        assert_eq!(config.proxy_addr(), "127.0.0.1:19000");
+        assert_eq!(config.admin_addr(), "0.0.0.0:11080");
     }
 }

src/proxy/proxy.rs

@@ -1,5 +1,5 @@
 use super::config::Config;
-use crate::utils::error::{PikaProxyError, Result};
+use crate::error::Result;
 use core::str::FromStr;
 use std::net::SocketAddr;
 use std::sync::Arc;
@@ -31,9 +31,9 @@ pub(crate) struct ProxyOptions {
     pub(crate) config_path: String,
 }
 
-impl From<&ProxyOptions> for Proxy {
-    fn from(option: &ProxyOptions) -> Proxy {
-        let config = Config::from_path(&option.config_path).unwrap();
+impl Proxy {
+    pub(crate) fn new(option: &ProxyOptions) -> Result<Self> {
+        let config = Config::from_path(&option.config_path)?;
         let proxy = RawProxy {
             xauth: String::new(),
 
@@ -45,9 +45,9 @@ impl From<&ProxyOptions> for Proxy {
 
             config: Arc::new(config),
         };
-        Proxy {
+        Ok(Proxy {
             proxy: Arc::new(RwLock::new(proxy)),
-        }
+        })
     }
 }
 
@@ -100,7 +100,7 @@ async fn listen(addr: &SocketAddr) {
 }
 
 // 简单的打印服务器
-async fn do_task(mut stream: TcpStream) {
+async fn do_task(stream: TcpStream) {
     let mut buf_stream = BufStream::new(stream);
     let mut msg = vec![0; 1024];
     loop {
@@ -112,7 +112,7 @@ async fn do_task(mut stream: TcpStream) {
                 buf_stream.flush().await.unwrap();
                 println!("write_size: {}", size);
             }
-            Err(e) => break,
+            Err(_e) => break,
         }
     }
 }

src/proxy/router.rs

@@ -2,8 +2,8 @@ use std::collections::HashMap;
 
 use super::forward::ForwardMethod;
 use super::request::Request;
+use crate::error::{Error, Result};
 use crate::models::slots::Slot;
-use crate::utils::error::{PikaProxyError, Result};
 use crate::utils::redis::InfoCache;
 
 pub trait Router {

src/utils/mod.rs

@@ -1,3 +1,2 @@
 pub mod defer;
-pub mod error;
 pub mod redis;