Merge pull request #93 from nymtech/feature/consistent-logging

Feature/consistent logging

Author: jstuczyn

Cargo.lock

@@ -7,3 +7,5 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+log = "0.4"
+pretty_env_logger = "0.3"

common/addressing/Cargo.toml

@@ -7,6 +7,8 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+log = "0.4"
+pretty_env_logger = "0.3"
 reqwest = "0.9.22"
 serde = { version = "1.0.104", features = ["derive"] }
 

common/clients/directory-client/Cargo.toml

@@ -1,5 +1,6 @@
 use crate::requests::presence_topology_get::PresenceTopologyGetRequester;
 use crate::{Client, Config, DirectoryClient};
+use log::*;
 use serde::{Deserialize, Serialize};
 use std::convert::TryInto;
 use std::io;
@@ -159,7 +160,7 @@ pub struct Topology {
 
 impl NymTopology for Topology {
     fn new(directory_server: String) -> Self {
-        println!("Using directory server: {:?}", directory_server);
+        debug!("Using directory server: {:?}", directory_server);
         let directory_config = Config {
             base_url: directory_server,
         };

common/clients/directory-client/src/presence.rs

@@ -8,6 +8,7 @@ edition = "2018"
 
 [dependencies]
 log = "0.4.8"
+pretty_env_logger = "0.3"
 rand = "0.7.2"
 rand_distr = "0.2.2"
 tokio = { version = "0.2", features = ["full"] }

common/clients/mix-client/Cargo.toml

@@ -9,6 +9,7 @@ edition = "2018"
 [dependencies]
 futures = "0.3.1"
 log = "0.4.8"
+pretty_env_logger = "0.3"
 tokio = { version = "0.2", features = ["full"] }
 
 ## internal

common/clients/provider-client/Cargo.toml

@@ -1,4 +1,5 @@
 use futures::io::Error;
+use log::*;
 use sfw_provider_requests::requests::{ProviderRequest, PullRequest, RegisterRequest};
 use sfw_provider_requests::responses::{
     ProviderResponse, ProviderResponseError, PullResponse, RegisterResponse,
@@ -67,16 +68,14 @@ impl ProviderClient {
 
         socket.set_keepalive(Some(Duration::from_secs(2))).unwrap();
         socket.write_all(&bytes[..]).await?;
-        if let Err(_e) = socket.shutdown(Shutdown::Write) {
-            // TODO: make it a silent log once we have a proper logging library
-            //            eprintln!("failed to close write part of the socket; err = {:?}", e)
+        if let Err(e) = socket.shutdown(Shutdown::Write) {
+            warn!("failed to close write part of the socket; err = {:?}", e)
         }
 
         let mut response = Vec::new();
         socket.read_to_end(&mut response).await?;
-        if let Err(_e) = socket.shutdown(Shutdown::Read) {
-            // TODO: make it a silent log once we have a proper logging library
-            //            eprintln!("failed to close read part of the socket; err = {:?}", e)
+        if let Err(e) = socket.shutdown(Shutdown::Read) {
+            warn!("failed to close read part of the socket; err = {:?}", e)
         }
 
         Ok(response)

common/clients/provider-client/src/lib.rs

@@ -7,3 +7,5 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+log = "0.4"
+pretty_env_logger = "0.3"

common/clients/validator-client/Cargo.toml

@@ -9,5 +9,7 @@ edition = "2018"
 [dependencies]
 base64 = "0.11.0"
 curve25519-dalek = "1.2.3"
+log = "0.4"
+pretty_env_logger = "0.3"
 rand = "0.7.2"
 rand_os = "0.1"

common/crypto/Cargo.toml

@@ -10,6 +10,7 @@ edition = "2018"
 futures = "0.3.1"
 itertools = "0.8.2"
 log = "0.4.8"
+pretty_env_logger = "0.3"
 serde = "1.0.104"
 serde_derive = "1.0.104"
 tokio = { version = "0.2", features = ["full"] }

common/healthcheck/Cargo.toml

@@ -7,7 +7,9 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+log = "0.4"
 pem = "0.7.0"
+pretty_env_logger = "0.3"
 
 ## internal
 crypto = {path = "../crypto"}

common/pemstore/Cargo.toml

@@ -10,7 +10,8 @@ edition = "2018"
 base64 = "0.11.0"
 curve25519-dalek = "1.2.3"
 itertools = "0.8.2"
-log = "0.4.8"
+log = "0.4"
+pretty_env_logger = "0.3"
 rand = "0.7.2"
 serde = { version = "1.0.104", features = ["derive"] }
 

common/topology/Cargo.toml

@@ -11,8 +11,10 @@ edition = "2018"
 base64 = "0.11.0"
 clap = "2.33.0"
 curve25519-dalek = "1.2.3"
+dotenv = "0.15.0"
 futures = "0.3.1"
-log = "0.4.8"
+log = "0.4"
+pretty_env_logger = "0.3"
 tokio = { version = "0.2", features = ["full"] }
 
 ## internal

mixnode/Cargo.toml

@@ -1,10 +1,14 @@
 use clap::{App, Arg, ArgMatches, SubCommand};
+use log::*;
 use std::process;
 
 mod mix_peer;
 mod node;
 
 fn main() {
+    dotenv::dotenv().ok();
+    pretty_env_logger::init();
+
     let arg_matches = App::new("Nym Mixnode")
         .version(built_info::PKG_VERSION)
         .author("Nymtech")
@@ -54,7 +58,7 @@ fn main() {
         .get_matches();
 
     if let Err(e) = execute(arg_matches) {
-        println!("{}", e);
+        error!("{}", e);
         process::exit(1);
     }
 }

mixnode/src/main.rs

@@ -6,6 +6,7 @@ use curve25519_dalek::scalar::Scalar;
 use futures::channel::mpsc;
 use futures::lock::Mutex;
 use futures::SinkExt;
+use log::*;
 use sphinx::header::delays::Delay as SphinxDelay;
 use sphinx::{ProcessedPacket, SphinxPacket};
 use std::net::SocketAddr;
@@ -140,15 +141,15 @@ impl PacketProcessor {
             .await
             .unwrap();
 
-        println!("RECIPIENT: {:?}", forwarding_data.recipient);
+        trace!("RECIPIENT: {:?}", forwarding_data.recipient);
         match forwarding_data
             .recipient
             .send(forwarding_data.packet.to_bytes())
             .await
         {
             Ok(()) => (),
             Err(e) => {
-                println!(
+                warn!(
                     "failed to write bytes to next mix peer. err = {:?}",
                     e.to_string()
                 );
@@ -190,7 +191,7 @@ impl MixNode {
             match socket.read(&mut buf).await {
                 // socket closed
                 Ok(n) if n == 0 => {
-                    println!("Remote connection closed.");
+                    trace!("Remote connection closed.");
                     return;
                 }
                 Ok(_) => {
@@ -203,14 +204,14 @@ impl MixNode {
                     PacketProcessor::wait_and_forward(fwd_data).await;
                 }
                 Err(e) => {
-                    println!("failed to read from socket; err = {:?}", e);
+                    warn!("failed to read from socket; err = {:?}", e);
                     return;
                 }
             };
 
             // Write the some data back
             if let Err(e) = socket.write_all(b"foomp").await {
-                println!("failed to write reply to socket; err = {:?}", e);
+                warn!("failed to write reply to socket; err = {:?}", e);
                 return;
             }
         }

mixnode/src/node/mod.rs

@@ -16,11 +16,12 @@ base64 = "0.11.0"
 clap = "2.33.0"
 curve25519-dalek = "1.2.3"
 dirs = "2.0.2"
-env_logger = "0.7.1"
+dotenv = "0.15.0"
 futures = "0.3.1"
 hex = "0.4.0"
-log = "0.4.8"
+log = "0.4"
 pem = "0.7.0"
+pretty_env_logger = "0.3"
 reqwest = "0.9.22"
 serde = { version = "1.0.104", features = ["derive"] }
 serde_json = "1.0.44"

nym-client/Cargo.toml

@@ -259,7 +259,7 @@ impl NymClient {
         });
 
         // this line in theory should never be reached as the runtime should be permanently blocked on traffic senders
-        eprintln!("The client went kaput...");
+        error!("The client went kaput...");
         Ok(())
     }
 }

nym-client/src/client/mod.rs

@@ -7,7 +7,8 @@ pub mod config;
 mod sockets;
 
 fn main() {
-    env_logger::init();
+    dotenv::dotenv().ok();
+    pretty_env_logger::init();
 
     let arg_matches = App::new("Nym Client")
         .version(built_info::PKG_VERSION)