Rename light-client to web-client and improve logging for wasm

Cargo.toml

@@ -24,7 +24,6 @@ members = [
   "keys",
   "lib",
   "light-blockchain",
-  "light-client",
   "log",
   "macros",
   "mempool",
@@ -58,6 +57,7 @@ members = [
   "validator-network",
   "vrf",
   "wallet",
+  "web-client",
   "zkp-component",
 ]
 

lib/Cargo.toml

@@ -39,9 +39,11 @@ strum_macros = "0.24"
 toml = "0.5"
 url = { version = "2.3", features = ["serde"] }
 thiserror = "1.0"
-tokio = { version = "1.24", features = ["rt", "tracing"], optional = true }
+time = { version = "0.3", optional = true }
+tokio = { version = "1.24", features = ["rt"], optional = true }
 tracing-loki = { version = "0.2.1", optional = true }
 tracing-subscriber = { version = "0.3", optional = true }
+tracing-web = { version = "0.1", optional = true}
 
 beserial = { path = "../beserial" }
 nimiq-block = { path = "../primitives/block" }
@@ -52,8 +54,8 @@ nimiq-bls = { path = "../bls" }
 nimiq-consensus = { path = "../consensus", default-features = false }
 nimiq-database = { path = "../database", optional = true }
 nimiq-genesis = { path = "../genesis", default-features = false }
-nimiq-jsonrpc-core = { git = "https://github.com/nimiq/jsonrpc.git", optional=true}
-nimiq-jsonrpc-server = { git = "https://github.com/nimiq/jsonrpc.git", optional=true}
+nimiq-jsonrpc-core = { git = "https://github.com/nimiq/jsonrpc.git", optional = true }
+nimiq-jsonrpc-server = { git = "https://github.com/nimiq/jsonrpc.git", optional = true }
 nimiq-keys = { path = "../keys" }
 nimiq-light-blockchain = { path = "../light-blockchain" }
 nimiq-log = { path = "../log", optional = true }
@@ -84,9 +86,10 @@ loki = ["logging", "tracing-loki"]
 metrics-server = ["nimiq-metrics-server", "nimiq-network-libp2p/metrics", "nimiq-validator/metrics"]
 panic = ["log-panics"]
 rpc-server = ["nimiq-jsonrpc-core", "nimiq-jsonrpc-server", "nimiq-rpc-server", "nimiq-wallet", "validator"]
-tokio-console = ["console-subscriber", "logging", "tokio"]
+tokio-console = ["console-subscriber", "logging", "tokio/tracing"]
 validator = ["nimiq-database", "nimiq-mempool", "nimiq-validator", "nimiq-validator-network", "nimiq-rpc-server"]
 wallet = ["nimiq-database", "nimiq-wallet"]
 websocket = ["nimiq-network-libp2p/websocket"]
+web-logging = ["nimiq-log", "time/wasm-bindgen", "tracing-subscriber", "tracing-web"]
 zkp-storage = ["nimiq-database", "nimiq-zkp-component/zkp-storage"]
 zkp-prover = ["nimiq-zkp-component/zkp-prover"]

lib/src/extras/logging.rs

@@ -8,12 +8,10 @@ use std::sync::Arc;
 use file_rotate::{compression::Compression, suffix::AppendCount, ContentLimit, FileRotate};
 use log::{level_filters::LevelFilter, Level, Subscriber};
 use parking_lot::Mutex;
-use tracing_subscriber::filter::Targets;
-use tracing_subscriber::fmt::time::SystemTime;
-use tracing_subscriber::layer::SubscriberExt;
-use tracing_subscriber::registry::LookupSpan;
-use tracing_subscriber::util::SubscriberInitExt;
-use tracing_subscriber::Layer;
+use tracing_subscriber::{
+    filter::Targets, fmt::time::SystemTime, layer::SubscriberExt, registry::LookupSpan,
+    util::SubscriberInitExt, Layer,
+};
 
 use crate::{
     config::{command_line::CommandLine, config_file::LogSettings},

lib/src/extras/mod.rs

@@ -1,5 +1,7 @@
 #[cfg(feature = "deadlock")]
 pub mod deadlock;
+#[cfg(feature = "launcher")]
+pub mod launcher;
 #[cfg(feature = "logging")]
 pub mod logging;
 #[cfg(feature = "metrics-server")]
@@ -10,6 +12,5 @@ pub mod panic;
 pub mod rpc_server;
 #[cfg(feature = "signal-handling")]
 pub mod signal_handling;
-
-#[cfg(feature = "launcher")]
-pub mod launcher;
+#[cfg(feature = "web-logging")]
+pub mod web_logging;

lib/src/extras/web_logging.rs

@@ -0,0 +1,64 @@
+use log::{level_filters::LevelFilter, Level};
+use tracing_subscriber::{
+    filter::Targets, fmt::format::Pretty, layer::SubscriberExt, util::SubscriberInitExt, Layer,
+};
+use tracing_web::{performance_layer, MakeConsoleWriter};
+
+use crate::{config::config_file::LogSettings, error::Error};
+use nimiq_log::{Formatting, MaybeSystemTime, TargetsExt};
+
+pub const DEFAULT_LEVEL: LevelFilter = LevelFilter::INFO;
+
+macro_rules! force_log {
+    ($lvl:expr, $($arg:tt)+) => ({
+        if log::enabled!($lvl) {
+            log::event!($lvl, $($arg)+);
+        }
+    })
+}
+
+pub fn log_error_cause_chain<E: std::error::Error>(e: &E) {
+    force_log!(Level::ERROR, "{}", e);
+
+    if let Some(mut e) = e.source() {
+        force_log!(Level::ERROR, "  caused by");
+        force_log!(Level::ERROR, "    {}", e);
+
+        while let Some(source) = e.source() {
+            force_log!(Level::ERROR, "    {}", source);
+
+            e = source;
+        }
+    }
+}
+
+pub fn initialize_web_logging(settings_opt: Option<&LogSettings>) -> Result<(), Error> {
+    // Get config from config file
+    let settings = settings_opt.cloned().unwrap_or_default();
+
+    // Set logging level for Nimiq and all other modules
+    // Creating ZKPs with a log level below WARN will consume huge amounts of memory due to tracing annotations in the dependency.
+    // That's why we specifically set its log level to WARN.
+    let mut filter = Targets::new()
+        .with_default(DEFAULT_LEVEL)
+        .with_nimiq_targets(settings.level.unwrap_or(DEFAULT_LEVEL))
+        .with_target("r1cs", LevelFilter::WARN);
+    // Set logging level for specific selected modules
+    filter = filter.with_targets(settings.tags);
+    // Set logging level from the environment
+    filter = filter.with_env();
+
+    let perf_layer = performance_layer().with_details_from_fields(Pretty::default());
+
+    tracing_subscriber::registry()
+        .with(
+            tracing_subscriber::fmt::layer()
+                .with_writer(MakeConsoleWriter)
+                .with_ansi(settings.file.is_none())
+                .event_format(Formatting(MaybeSystemTime(settings.timestamps)))
+                .with_filter(filter),
+        )
+        .with(perf_layer)
+        .init();
+    Ok(())
+}