feat(logger): impl Logger struct

LeoBorai · LeoBorai · commit e0d3fad39b8a · 2021-12-12T12:07:59.000-03:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -43,6 +43,7 @@ mime_guess = "2.0.3"
 rustls = "0.20.2"
 rustls-pemfile = "0.2.1"
 tokio = { version = "1.14.0", features = ["fs", "rt-multi-thread", "signal", "macros"] }
+termcolor = "1.1.2"
 tokio-rustls = "0.23.1"
 toml = "0.5.8"
 serde = { version = "1.0.131", features = ["derive"] }
diff --git a/src/addon/logger.rs b/src/addon/logger.rs
@@ -0,0 +1,93 @@
+use anyhow::Result;
+use chrono::{DateTime, Utc};
+use http::header::USER_AGENT;
+use http::Method;
+use hyper::Body;
+use std::io::Write;
+use termcolor::{BufferWriter, Color, ColorChoice, ColorSpec, WriteColor};
+
+use crate::server::middleware::{Request, Response};
+
+pub struct Logger {
+    buffer_writer: BufferWriter,
+}
+
+impl Logger {
+    pub fn new() -> Self {
+        let buffer_writer = BufferWriter::stdout(ColorChoice::Always);
+
+        Logger { buffer_writer }
+    }
+
+    pub async fn log(&mut self, request: Request<Body>, response: Response<Body>) -> Result<()> {
+        let mut buffer = self.buffer_writer.buffer();
+        let request = request.lock().await;
+        let response = response.lock().await;
+
+        // UTC Time
+        let moment: DateTime<Utc> = Utc::now();
+        write!(&mut buffer, "[{:?}] \"", moment)?;
+
+        // HTTP Request Method
+        let method = request.method();
+
+        match *method {
+            Method::GET => buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)))?,
+            Method::POST | Method::PUT | Method::PATCH => {
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Blue)))?
+            }
+            Method::DELETE => buffer.set_color(ColorSpec::new().set_fg(Some(Color::Red)))?,
+            _ => buffer.set_color(ColorSpec::new().set_fg(Some(Color::Magenta)))?,
+        };
+
+        write!(&mut buffer, "{} ", method)?;
+        buffer.reset()?;
+
+        // HTTP Request URI and Version
+        write!(&mut buffer, "{} {:?} ", request.uri(), request.version())?;
+
+        // HTTP Response Status Code
+        match response.status().as_u16() {
+            100..=199 => {
+                // Informational Responses
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Blue)))?;
+            }
+            200..=299 => {
+                // Successful responses
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)))?;
+            }
+            300..=399 => {
+                // Redirection messages
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Yellow)))?;
+            }
+            400..=499 => {
+                // Client error responses
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Rgb(255, 140, 0))))?;
+            }
+            500..=599 => {
+                // Server error responses
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Red)))?;
+            }
+            _ => {
+                // Unknown response codes
+                buffer.set_color(ColorSpec::new().set_fg(Some(Color::Magenta)))?;
+            }
+        }
+        write!(&mut buffer, "{}", response.status())?;
+        buffer.reset()?;
+
+        // HTTP Request User Agent
+        let user_agent = if let Some(value) = request.headers().get(USER_AGENT) {
+            value.to_str()?
+        } else {
+            "N/A"
+        };
+        write!(&mut buffer, "\" \"{}\" ", user_agent)?;
+
+        writeln!(&mut buffer)?;
+        self.buffer_writer.print(&buffer)?;
+        buffer.reset()?;
+
+        Ok(())
+    }
+}
diff --git a/src/addon/mod.rs b/src/addon/mod.rs
@@ -1,3 +1,4 @@
 pub mod compression;
 pub mod cors;
 pub mod file_server;
+pub mod logger;
diff --git a/src/server/middleware/logger.rs b/src/server/middleware/logger.rs
@@ -0,0 +1,28 @@
+use http::{Request, Response};
+use hyper::Body;
+use std::sync::Arc;
+use tokio::sync::Mutex;
+
+use crate::addon::logger::Logger;
+
+use super::MiddlewareAfter;
+
+pub fn make_logger_middleware() -> MiddlewareAfter {
+    let logger = Arc::new(Mutex::new(Logger::new()));
+
+    Box::new(
+        move |request: Arc<Mutex<Request<Body>>>, response: Arc<Mutex<Response<Body>>>| {
+            let logger = Arc::clone(&logger);
+
+            Box::pin(async move {
+                let mut logger = logger.lock().await;
+
+                if let Err(error) = logger.log(request, response).await {
+                    eprintln!("{:#?}", error);
+                }
+
+                Ok(())
+            })
+        },
+    )
+}
diff --git a/src/server/middleware/mod.rs b/src/server/middleware/mod.rs
@@ -1,6 +1,7 @@
 pub mod basic_auth;
 pub mod cors;
 pub mod gzip;
+pub mod logger;
 
 use anyhow::Error;
 use futures::Future;
@@ -16,6 +17,7 @@ use crate::config::Config;
 use self::basic_auth::make_basic_auth_middleware;
 use self::cors::make_cors_middleware;
 use self::gzip::make_gzip_compression_middleware;
+use self::logger::make_logger_middleware;
 
 /// Middleware HTTP Response which expands to a `Arc<Mutex<http::Request<T>>>`
 pub type Request<T> = Arc<Mutex<http::Request<T>>>;
@@ -119,6 +121,8 @@ impl TryFrom<Arc<Config>> for Middleware {
             }
         }
 
+        middleware.after(make_logger_middleware());
+
         Ok(middleware)
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`pub mod basic_auth;`
`2`	`2`	`pub mod cors;`
`3`	`3`	`pub mod gzip;`
	`4`	`+pub mod logger;`
`4`	`5`
`5`	`6`	`use anyhow::Error;`
`6`	`7`	`use futures::Future;`
`@@ -16,6 +17,7 @@ use crate::config::Config;`
`16`	`17`	`use self::basic_auth::make_basic_auth_middleware;`
`17`	`18`	`use self::cors::make_cors_middleware;`
`18`	`19`	`use self::gzip::make_gzip_compression_middleware;`
	`20`	`+use self::logger::make_logger_middleware;`
`19`	`21`
`20`	`22`	/// Middleware HTTP Response which expands to a `Arc<Mutex<http::Request<T>>>`
`21`	`23`	`pub type Request<T> = Arc<Mutex<http::Request<T>>>;`
`@@ -119,6 +121,8 @@ impl TryFrom<Arc<Config>> for Middleware {`
`119`	`121`	`}`
`120`	`122`	`}`
`121`	`123`
	`124`	`+ middleware.after(make_logger_middleware());`
	`125`	`+`
`122`	`126`	`Ok(middleware)`
`123`	`127`	`}`
`124`	`128`	`}`