feat(logger): support for logger configuration

Author: LeoBorai

.github/workflows/bench.yml

@@ -34,3 +34,6 @@ jobs:
 
       - name: "Bench w/ Basic Authentication"
         run: ./scripts/bench.sh '--username "john" --password "appleseed"'
+
+      - name: "Bench w/ Logger"
+        run: ./scripts/bench.sh '--logger'

src/cli.rs

@@ -51,6 +51,9 @@ pub struct Cli {
     /// Specifies password for basic authentication
     #[structopt(long = "password")]
     pub password: Option<String>,
+    /// Prints HTTP request and response details to stdout
+    #[structopt(long = "logger")]
+    pub logger: bool,
 }
 
 impl Cli {
@@ -75,6 +78,7 @@ impl Default for Cli {
             gzip: false,
             username: None,
             password: None,
+            logger: false,
         }
     }
 }
@@ -228,4 +232,14 @@ mod tests {
 
         assert_eq!(from_args, expect);
     }
+
+    #[test]
+    fn with_logger() {
+        let from_args = Cli::from_str_args(vec!["http-server", "--logger"]);
+        let mut expect = Cli::default();
+
+        expect.logger = true;
+
+        assert_eq!(from_args, expect);
+    }
 }

src/config/file.rs

@@ -22,6 +22,7 @@ pub struct ConfigFile {
     pub cors: Option<CorsConfig>,
     pub compression: Option<CompressionConfig>,
     pub basic_auth: Option<BasicAuthConfig>,
+    pub logger: Option<bool>,
 }
 
 impl ConfigFile {
@@ -82,11 +83,12 @@ mod tests {
 
         root_dir.push("./fixtures");
 
+        assert!(config.logger.is_none());
+        assert!(config.compression.is_none());
         assert_eq!(config.host, host);
         assert_eq!(config.port, port);
         assert_eq!(config.verbose, Some(true));
         assert_eq!(config.root_dir, Some(root_dir));
-        assert_eq!(config.compression, None);
     }
 
     #[test]
@@ -279,4 +281,16 @@ mod tests {
         assert_eq!(basic_auth.username, String::from("johnappleseed"));
         assert_eq!(basic_auth.password, String::from("john::likes::apples!"));
     }
+
+    #[test]
+    fn parses_config_with_logger() {
+        let file_contents = r#"
+            host = "0.0.0.0"
+            port = 7878
+            logger = true
+        "#;
+        let config = ConfigFile::parse_toml(file_contents).unwrap();
+
+        assert_eq!(config.logger, Some(true));
+    }
 }

src/config/mod.rs

@@ -30,6 +30,7 @@ pub struct Config {
     cors: Option<CorsConfig>,
     compression: Option<CompressionConfig>,
     basic_auth: Option<BasicAuthConfig>,
+    logger: Option<bool>,
 }
 
 impl Config {
@@ -68,6 +69,10 @@ impl Config {
     pub fn basic_auth(&self) -> Option<BasicAuthConfig> {
         self.basic_auth.clone()
     }
+
+    pub fn logger(&self) -> Option<bool> {
+        self.logger
+    }
 }
 
 impl Default for Config {
@@ -87,6 +92,7 @@ impl Default for Config {
             cors: None,
             compression: None,
             basic_auth: None,
+            logger: None,
         }
     }
 }
@@ -137,6 +143,12 @@ impl TryFrom<Cli> for Config {
                 None
             };
 
+        let logger = if cli_arguments.logger {
+            Some(true)
+        } else {
+            None
+        };
+
         Ok(Config {
             host: cli_arguments.host,
             port: cli_arguments.port,
@@ -147,6 +159,7 @@ impl TryFrom<Cli> for Config {
             cors,
             compression,
             basic_auth,
+            logger,
         })
     }
 }
@@ -177,6 +190,7 @@ impl TryFrom<ConfigFile> for Config {
             cors: file.cors,
             compression: file.compression,
             basic_auth: file.basic_auth,
+            logger: file.logger,
         })
     }
 }

src/server/middleware/mod.rs

@@ -121,7 +121,11 @@ impl TryFrom<Arc<Config>> for Middleware {
             }
         }
 
-        middleware.after(make_logger_middleware());
+        if let Some(should_log) = config.logger() {
+            if should_log {
+                middleware.after(make_logger_middleware());
+            }
+        }
 
         Ok(middleware)
     }