Apply env_logger module filters on Dart & UniFFI binding loggers

libs/Cargo.toml

@@ -20,6 +20,7 @@ version = "0.6.2"
 aes = "0.8"
 anyhow = { version = "1.0.79", features = ["backtrace"] }
 base64 = "0.13.0"
+env_logger = "0.10"
 bitcoin = "=0.29.2" # Same version as used in gl-client
 # Pin the reqwest dependency until macOS linker issue is fixed: https://github.com/seanmonstar/reqwest/issues/2006
 hex = "0.4"

libs/sdk-bindings/Cargo.toml

@@ -17,6 +17,7 @@ crate-type = ["staticlib", "cdylib", "lib"]
 anyhow = { workspace = true }
 breez-sdk-core = { path = "../sdk-core" }
 sdk-common = { path = "../sdk-common" }
+env_logger = { workspace = true }
 thiserror = { workspace = true }
 tokio = { workspace = true }
 uniffi = { version = "0.23.0", features = ["bindgen-tests", "cli"] }

libs/sdk-bindings/bindings-csharp/test/Program.cs

@@ -4,7 +4,7 @@
 try
 {
  var seed = BreezSdkMethods.MnemonicToSeed("repeat hawk combine screen network rhythm ritual social neither casual volcano powder");
- BreezSdkMethods.SetLogStream(new LogStreamListener());
+ BreezSdkMethods.SetLogStream(new LogStreamListener(), LevelFilter.TRACE);
  var config = BreezSdkMethods.DefaultConfig(EnvironmentType.PRODUCTION, "code", new NodeConfig.Greenlight(new GreenlightNodeConfig(null, null)));
  var connectRequest = new ConnectRequest(config, seed);
  BlockingBreezServices sdkServices = BreezSdkMethods.Connect(connectRequest, new SDKListener());

libs/sdk-bindings/src/breez_sdk.udl

@@ -828,6 +828,15 @@ dictionary RefundResponse {
     string refund_tx_id;
 };
 
+enum LevelFilter {
+    "Off",
+    "Error",
+    "Warn",
+    "Info",
+    "Debug",
+    "Trace",
+};
+
 interface BlockingBreezServices {
 
    [Throws=SdkError]
@@ -993,7 +1002,7 @@ namespace breez_sdk {
  BlockingBreezServices connect(ConnectRequest req, EventListener listener);
 
  [Throws=SdkError]
- void set_log_stream(LogStream log_stream);
+ void set_log_stream(LogStream log_stream, LevelFilter? filter_level);
 
  [Throws=SdkError]
  LNInvoice parse_invoice(string invoice);

libs/sdk-bindings/src/uniffi_binding.rs

@@ -2,6 +2,7 @@ use std::sync::Arc;
 
 use anyhow::Result;
 use breez_sdk_core::lnurl::pay::{LnUrlPayResult, LnUrlPaySuccessData};
+use breez_sdk_core::logger::{get_filter_level, init_env_logger};
 use breez_sdk_core::{
     error::*, mnemonic_to_seed as sdk_mnemonic_to_seed, parse as sdk_parse_input,
     parse_invoice as sdk_parse_invoice, AesSuccessActionDataDecrypted, AesSuccessActionDataResult,
@@ -10,7 +11,7 @@ use breez_sdk_core::{
     CheckMessageResponse, ClosedChannelPaymentDetails, Config, ConfigureNodeRequest,
     ConnectRequest, CurrencyInfo, EnvironmentType, EventListener, FeeratePreset, FiatCurrency,
     GreenlightCredentials, GreenlightDeviceCredentials, GreenlightNodeConfig, HealthCheckStatus,
-    InputType, InvoicePaidDetails, LNInvoice, ListPaymentsRequest, LnPaymentDetails,
+    InputType, InvoicePaidDetails, LNInvoice, LevelFilter, ListPaymentsRequest, LnPaymentDetails,
     LnUrlAuthError, LnUrlAuthRequestData, LnUrlCallbackStatus, LnUrlErrorData, LnUrlPayError,
     LnUrlPayErrorData, LnUrlPayRequest, LnUrlPayRequestData, LnUrlWithdrawError,
     LnUrlWithdrawRequest, LnUrlWithdrawRequestData, LnUrlWithdrawResult, LnUrlWithdrawSuccessData,
@@ -31,35 +32,72 @@ use breez_sdk_core::{
     SwapAmountType, SwapInfo, SwapStatus, Symbol, TlvEntry, UnspentTransactionOutput,
     UrlSuccessActionData,
 };
-use log::{Level, LevelFilter, Metadata, Record};
-use once_cell::sync::{Lazy, OnceCell};
+use env_logger::{Logger, Target};
+use log::{
+    error, max_level, set_boxed_logger, set_max_level, Log, Metadata, Record, STATIC_MAX_LEVEL,
+};
+use once_cell::sync::Lazy;
+use std::sync::Once;
 
 static RT: Lazy<tokio::runtime::Runtime> = Lazy::new(|| tokio::runtime::Runtime::new().unwrap());
-static LOG_INIT: OnceCell<bool> = OnceCell::new();
 
-struct BindingLogger {
+/* UniFFI Logger */
+
+static INIT_UNIFFI_LOGGER: Once = Once::new();
+
+fn init_uniffi_logger(log_stream: Box<dyn LogStream>, filter_level: Option<LevelFilter>) {
+    INIT_UNIFFI_LOGGER.call_once(|| {
+        UniFFILogger::set_log_stream(log_stream, filter_level);
+    });
+}
+
+struct UniFFILogger {
+    env_logger: Logger,
     log_stream: Box<dyn LogStream>,
 }
 
-impl BindingLogger {
-    fn init(log_stream: Box<dyn LogStream>) {
-        let binding_logger = BindingLogger { log_stream };
-        log::set_boxed_logger(Box::new(binding_logger)).unwrap();
-        log::set_max_level(LevelFilter::Trace);
+impl UniFFILogger {
+    fn set_log_stream(log_stream: Box<dyn LogStream>, filter_level: Option<LevelFilter>) {
+        let filter_level = get_filter_level(filter_level);
+        assert!(
+            filter_level <= STATIC_MAX_LEVEL,
+            "Should respect STATIC_MAX_LEVEL={:?}, which is done in compile time. level{:?}",
+            STATIC_MAX_LEVEL,
+            filter_level
+        );
+
+        let env_logger = init_env_logger(Some(Target::Stdout), Some(filter_level));
+
+        let uniffi_logger = UniFFILogger {
+            env_logger,
+            log_stream,
+        };
+        set_boxed_logger(Box::new(uniffi_logger))
+            .unwrap_or_else(|_| error!("Log stream already created."));
+        set_max_level(filter_level);
+    }
+
+    fn record_to_entry(record: &Record) -> LogEntry {
+        LogEntry {
+            line: format!("{}", record.args()),
+            level: format!("{}", record.level()),
+        }
     }
 }
 
-impl log::Log for BindingLogger {
-    fn enabled(&self, m: &Metadata) -> bool {
+impl Log for UniFFILogger {
+    fn enabled(&self, metadata: &Metadata) -> bool {
         // ignore the internal uniffi log to prevent infinite loop.
-        return m.level() <= Level::Trace && *m.target() != *"breez_sdk_bindings::uniffi_binding";
+        return metadata.level() <= max_level()
+            && *metadata.target() != *"breez_sdk_bindings::uniffi_binding";
     }
 
     fn log(&self, record: &Record) {
-        self.log_stream.log(LogEntry {
-            line: record.args().to_string(),
-            level: record.level().as_str().to_string(),
-        });
+        let metadata = record.metadata();
+        if self.enabled(metadata) && self.env_logger.enabled(metadata) {
+            let entry = Self::record_to_entry(record);
+            self.log_stream.log(entry);
+        }
     }
     fn flush(&self) {}
 }
@@ -109,11 +147,11 @@ pub fn connect(
 }
 
 /// If used, this must be called before `connect`
-pub fn set_log_stream(log_stream: Box<dyn LogStream>) -> SdkResult<()> {
-    LOG_INIT.set(true).map_err(|_| SdkError::Generic {
-        err: "Log stream already created".into(),
-    })?;
-    BindingLogger::init(log_stream);
+pub fn set_log_stream(
+    log_stream: Box<dyn LogStream>,
+    filter_level: Option<LevelFilter>,
+) -> SdkResult<()> {
+    init_uniffi_logger(log_stream, filter_level);
     Ok(())
 }
 

libs/sdk-bindings/tests/bindings/csharp/Program.cs

@@ -4,7 +4,7 @@
 try
 {
  var seed = BreezSdkMethods.MnemonicToSeed("repeat hawk combine screen network rhythm ritual social neither casual volcano powder");
- BreezSdkMethods.SetLogStream(new LogStreamListener());
+ BreezSdkMethods.SetLogStream(new LogStreamListener(), LevelFilter.TRACE);
  var config = BreezSdkMethods.DefaultConfig(EnvironmentType.PRODUCTION, "code", new NodeConfig.Greenlight(new GreenlightNodeConfig(null, null)));
  var connectRequest = new ConnectRequest(config, seed);
  BlockingBreezServices sdkServices = BreezSdkMethods.Connect(connectRequest, new SDKListener());

libs/sdk-bindings/tests/bindings/golang/test_breez_sdk.go

@@ -22,7 +22,9 @@ func (BreezListener) OnEvent(e breez_sdk.BreezEvent) {
 func main() {
 	breezListener := BreezListener{}
 
-	breez_sdk.SetLogStream(breezListener)
+	filterLevel := breez_sdk.LevelFilterTrace
+
+	breez_sdk.SetLogStream(breezListener, &filterLevel)
 
 	seed, err := breez_sdk.MnemonicToSeed("repeat hawk combine screen network rhythm ritual social neither casual volcano powder")
 

libs/sdk-bindings/tests/bindings/test_breez_sdk.cs

@@ -4,7 +4,7 @@
 try
 {
  var seed = BreezSdkMethods.MnemonicToSeed("repeat hawk combine screen network rhythm ritual social neither casual volcano powder");
- BreezSdkMethods.SetLogStream(new LogStreamListener());
+ BreezSdkMethods.SetLogStream(new LogStreamListener(), LevelFilter.TRACE);
  var config = BreezSdkMethods.DefaultConfig(EnvironmentType.PRODUCTION, "code", new NodeConfig.Greenlight(new GreenlightNodeConfig(null, null)));
  var connectRequest = new ConnectRequest(config, seed);
  BlockingBreezServices sdkServices = BreezSdkMethods.Connect(connectRequest, new SDKListener());

libs/sdk-bindings/tests/bindings/test_breez_sdk.kts

@@ -1,28 +1,33 @@
 
 import breez_sdk.BreezEvent
 
-class SDKListener: breez_sdk.EventListener {
+class SDKListener : breez_sdk.EventListener {
     override fun onEvent(e: BreezEvent) {
-        println(e.toString());
+        println(e.toString())
     }
 }
 
-class LogStreamListener: breez_sdk.LogStream { 
+class LogStreamListener : breez_sdk.LogStream {
     override fun log(l: breez_sdk.LogEntry) {
         if (l.level != "TRACE") {
-            println(l.line);
+            println(l.line)
         }
     }
 }
 
 try {
-    breez_sdk.setLogStream(LogStreamListener());
-    var seed = breez_sdk.mnemonicToSeed("repeat hawk combine screen network rhythm ritual social neither casual volcano powder");
-    var config = breez_sdk.defaultConfig(breez_sdk.EnvironmentType.PRODUCTION, "code", breez_sdk.NodeConfig.Greenlight(breez_sdk.GreenlightNodeConfig(null, null)))
+    breez_sdk.setLogStream(LogStreamListener(), breez_sdk.LevelFilter.TRACE)
+    var seed = breez_sdk.mnemonicToSeed("repeat hawk combine screen network rhythm ritual social neither casual volcano powder")
+    var config =
+        breez_sdk.defaultConfig(
+            breez_sdk.EnvironmentType.PRODUCTION,
+            "code",
+            breez_sdk.NodeConfig.Greenlight(breez_sdk.GreenlightNodeConfig(null, null)),
+        )
     var connectRequest = breez_sdk.ConnectRequest(config, seed)
-    var sdkServices = breez_sdk.connect(connectRequest, SDKListener());    
-    var nodeInfo = sdkServices.nodeInfo();
-    assert(nodeInfo.id.equals("027e2b899f9f75b92a1ad210da21d74e7314e3499375213a71c6bf3e1b4b4394a1"));
-}catch (ex: Exception) {
+    var sdkServices = breez_sdk.connect(connectRequest, SDKListener())
+    var nodeInfo = sdkServices.nodeInfo()
+    assert(nodeInfo.id.equals("027e2b899f9f75b92a1ad210da21d74e7314e3499375213a71c6bf3e1b4b4394a1"))
+} catch (ex: Exception) {
     throw RuntimeException(ex.toString())
-}
+}

libs/sdk-bindings/tests/bindings/test_breez_sdk.swift

@@ -16,7 +16,7 @@ class LogStreamListener: LogStream {
 }
 
 do {
-    try setLogStream(logStream: LogStreamListener());
+    try setLogStream(logStream: LogStreamListener(), filterLevel: LevelFilter.trace);
     let seed = try mnemonicToSeed(phrase: "repeat hawk combine screen network rhythm ritual social neither casual volcano powder");
     let config = breez_sdk.defaultConfig(envType: EnvironmentType.production, apiKey: "code", nodeConfig: NodeConfig.greenlight(config: GreenlightNodeConfig(partnerCredentials: nil, inviteCode: nil)));
     let connectRequest = ConnectRequest(config: config, seed: seed)

libs/sdk-core/Cargo.toml

@@ -19,12 +19,13 @@ zbase32 = "0.1.2"
 base64 = { workspace = true }
 chrono = "0.4"
 ecies = { version = "0.2.6", default-features = false, features = ["pure"] }
-env_logger = "0.10"
+env_logger = { workspace = true }
 futures = "0.3.30"
 ripemd = "0.1"
 rand = "0.8"
 tiny-bip39 = "1"
 tokio = { workspace = true }
+parking_lot = "0.12.3"
 prost = { workspace = true }
 rusqlite = { workspace = true }
 rusqlite_migration = "1.0"