Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Test logging interface by enigbe · Pull Request #463 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bindings/ldk_node.udl
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@ interface Builder {
void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
void set_log_facade_logger(LogLevel? max_log_level);
void set_log_facade_logger();
void set_custom_logger(LogWriter log_writer);
void set_network(Network network);
[Throws=BuildError]
Expand Down
25 changes: 7 additions & 18 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ struct LiquiditySourceConfig {
#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Log { max_log_level: Option<LogLevel> },
Log,
Custom(Arc<dyn LogWriter>),
}

Expand All@@ -125,9 +125,7 @@ impl std::fmt::Debug for LogWriterConfig {
.field("max_log_level", max_log_level)
.field("log_file_path", log_file_path)
.finish(),
LogWriterConfig::Log { max_log_level } => {
f.debug_tuple("Log").field(max_log_level).finish()
},
LogWriterConfig::Log => write!(f, "LogWriterConfig::Log"),
LogWriterConfig::Custom(_) => {
f.debug_tuple("Custom").field(&"<config internal to custom log writer>").finish()
},
Expand DownExpand Up@@ -385,11 +383,8 @@ impl NodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&mut self, max_log_level: Option<LogLevel>) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log { max_log_level });
pub fn set_log_facade_logger(&mut self) -> &mut Self {
self.log_writer_config = Some(LogWriterConfig::Log);
self
}

Expand DownExpand Up@@ -750,11 +745,8 @@ impl ArcedNodeBuilder {
}

/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
///
/// If set, the `max_log_level` sets the maximum log level. Otherwise, the latter defaults to
/// [`DEFAULT_LOG_LEVEL`].
pub fn set_log_facade_logger(&self, log_level: Option<LogLevel>) {
self.inner.write().unwrap().set_log_facade_logger(log_level);
pub fn set_log_facade_logger(&self) {
self.inner.write().unwrap().set_log_facade_logger();
}

/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
Expand DownExpand Up@@ -1421,10 +1413,7 @@ fn setup_logger(
Logger::new_fs_writer(log_file_path, max_log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?
},
Some(LogWriterConfig::Log { max_log_level }) => {
let max_log_level = max_log_level.unwrap_or_else(|| DEFAULT_LOG_LEVEL);
Logger::new_log_facade(max_log_level)
},
Some(LogWriterConfig::Log) => Logger::new_log_facade(),

Some(LogWriterConfig::Custom(custom_log_writer)) => {
Logger::new_custom_writer(Arc::clone(&custom_log_writer))
Expand Down
16 changes: 5 additions & 11 deletions src/logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,7 +108,7 @@ pub(crate) enum Writer {
/// Writes logs to the file system.
FileWriter { file_path: String, max_log_level: LogLevel },
/// Forwards logs to the `log` facade.
LogFacadeWriter { max_log_level: LogLevel },
LogFacadeWriter,
/// Forwards logs to a custom writer.
CustomWriter(Arc<dyn LogWriter>),
}
Expand DownExpand Up@@ -138,10 +138,7 @@ impl LogWriter for Writer {
.write_all(log.as_bytes())
.expect("Failed to write to log file")
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
macro_rules! log_with_level {
($log_level:expr, $target: expr, $($args:tt)*) => {
match $log_level {
Expand DownExpand Up@@ -186,8 +183,8 @@ impl Logger {
Ok(Self { writer: Writer::FileWriter { file_path, max_log_level } })
}

pub fn new_log_facade(max_log_level: LogLevel) -> Self {
Self { writer: Writer::LogFacadeWriter { max_log_level } }
pub fn new_log_facade() -> Self {
Self { writer: Writer::LogFacadeWriter }
}

pub fn new_custom_writer(log_writer: Arc<dyn LogWriter>) -> Self {
Expand All@@ -204,10 +201,7 @@ impl LdkLogger for Logger {
}
self.writer.log(record.into());
},
Writer::LogFacadeWriter { max_log_level } => {
if record.level < *max_log_level {
return;
}
Writer::LogFacadeWriter => {
self.writer.log(record.into());
},
Writer::CustomWriter(_arc) => {
Expand Down
146 changes: 146 additions & 0 deletions tests/common/logging.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
use chrono::Utc;
#[cfg(not(feature = "uniffi"))]
use ldk_node::logger::LogRecord;
use ldk_node::logger::{LogLevel, LogWriter};
#[cfg(not(feature = "uniffi"))]
use log::Record as LogFacadeRecord;
use log::{Level as LogFacadeLevel, LevelFilter as LogFacadeLevelFilter, Log as LogFacadeLog};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub(crate) enum TestLogWriter {
FileWriter,
LogFacade,
Custom(Arc<dyn LogWriter>),
}

impl Default for TestLogWriter {
fn default() -> Self {
TestLogWriter::FileWriter
}
}

pub(crate) struct MockLogFacadeLogger {
logs: Arc<Mutex<Vec<String>>>,
}

impl MockLogFacadeLogger {
pub fn new() -> Self {
Self { logs: Arc::new(Mutex::new(Vec::new())) }
}

pub fn retrieve_logs(&self) -> Vec<String> {
self.logs.lock().unwrap().to_vec()
}
}

impl LogFacadeLog for MockLogFacadeLogger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let message = format!(
"{} {:<5} [{}:{}] {}",
Utc::now().format("%Y-%m-%d %H:%M:%S"),
record.level().to_string(),
record.module_path().unwrap(),
record.line().unwrap(),
record.args()
);
println!("{message}");
self.logs.lock().unwrap().push(message);
}

fn flush(&self) {}
}

#[cfg(not(feature = "uniffi"))]
impl LogWriter for MockLogFacadeLogger {
fn log<'a>(&self, record: LogRecord) {
let record = MockLogRecord(record).into();
LogFacadeLog::log(self, &record);
}
}

#[cfg(not(feature = "uniffi"))]
struct MockLogRecord<'a>(LogRecord<'a>);
struct MockLogLevel(LogLevel);

impl From<MockLogLevel> for LogFacadeLevel {
fn from(level: MockLogLevel) -> Self {
match level.0 {
LogLevel::Gossip | LogLevel::Trace => LogFacadeLevel::Trace,
LogLevel::Debug => LogFacadeLevel::Debug,
LogLevel::Info => LogFacadeLevel::Info,
LogLevel::Warn => LogFacadeLevel::Warn,
LogLevel::Error => LogFacadeLevel::Error,
}
}
}

#[cfg(not(feature = "uniffi"))]
impl<'a> From<MockLogRecord<'a>> for LogFacadeRecord<'a> {
fn from(log_record: MockLogRecord<'a>) -> Self {
let log_record = log_record.0;
let level = MockLogLevel(log_record.level).into();

let mut record_builder = LogFacadeRecord::builder();
let record = record_builder
.level(level)
.module_path(Some(&log_record.module_path))
.line(Some(log_record.line))
.args(log_record.args);

record.build()
}
}

pub(crate) fn init_log_logger(level: LogFacadeLevelFilter) -> Arc<MockLogFacadeLogger> {
let logger = Arc::new(MockLogFacadeLogger::new());
log::set_boxed_logger(Box::new(logger.clone())).unwrap();
log::set_max_level(level);

logger
}

pub(crate) fn validate_log_entry(entry: &String) {
let parts = entry.splitn(4, ' ').collect::<Vec<_>>();
assert_eq!(parts.len(), 4);
let (day, time, level, path_and_msg) = (parts[0], parts[1], parts[2], parts[3]);

let day_parts = day.split('-').collect::<Vec<_>>();
assert_eq!(day_parts.len(), 3);
let (year, month, day) = (day_parts[0], day_parts[1], day_parts[2]);
assert!(year.len() == 4 && month.len() == 2 && day.len() == 2);
assert!(
year.chars().all(|c| c.is_digit(10))
&& month.chars().all(|c| c.is_digit(10))
&& day.chars().all(|c| c.is_digit(10))
);

let time_parts = time.split(':').collect::<Vec<_>>();
assert_eq!(time_parts.len(), 3);
let (hour, minute, second) = (time_parts[0], time_parts[1], time_parts[2]);
assert!(hour.len() == 2 && minute.len() == 2 && second.len() == 2);
assert!(
hour.chars().all(|c| c.is_digit(10))
&& minute.chars().all(|c| c.is_digit(10))
&& second.chars().all(|c| c.is_digit(10))
);

assert!(["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"].contains(&level),);

let path = path_and_msg.split_whitespace().next().unwrap();
assert!(path.contains('[') && path.contains(']'));
let module_path = &path[1..path.len() - 1];
let path_parts = module_path.rsplitn(2, ':').collect::<Vec<_>>();
assert_eq!(path_parts.len(), 2);
let (line_number, module_name) = (path_parts[0], path_parts[1]);
assert!(module_name.chars().all(|c| c.is_alphanumeric() || c == '_' || c == ':'));
assert!(line_number.chars().all(|c| c.is_digit(10)));

let msg_start_index = path_and_msg.find(']').unwrap() + 1;
let msg = &path_and_msg[msg_start_index..];
assert!(!msg.is_empty());
}
51 changes: 35 additions & 16 deletions tests/common/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,12 @@
#![cfg(any(test, cln_test, vss_test))]
#![allow(dead_code)]

pub(crate) mod logging;
Comment thread
enigbe marked this conversation as resolved.

use logging::TestLogWriter;

use ldk_node::config::{Config, EsploraSyncConfig};
use ldk_node::io::sqlite_store::SqliteStore;
use ldk_node::logger::LogLevel;
use ldk_node::payment::{PaymentDirection, PaymentKind, PaymentStatus};
use ldk_node::{
Builder, CustomTlvRecord, Event, LightningBalance, Node, NodeError, PendingSweepBalance,
Expand DownExpand Up@@ -221,29 +224,29 @@ pub(crate) fn random_node_alias() -> Option<NodeAlias> {
Some(NodeAlias(bytes))
}

pub(crate) fn random_config(anchor_channels: bool) -> Config {
let mut config = Config::default();
pub(crate) fn random_config(anchor_channels: bool) -> TestConfig {
let mut node_config = Config::default();

if !anchor_channels {
config.anchor_channels_config = None;
node_config.anchor_channels_config = None;
}

config.network = Network::Regtest;
println!("Setting network: {}", config.network);
node_config.network = Network::Regtest;
println!("Setting network: {}", node_config.network);

let rand_dir = random_storage_path();
println!("Setting random LDK storage dir: {}", rand_dir.display());
config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();
node_config.storage_dir_path = rand_dir.to_str().unwrap().to_owned();

let rand_listening_addresses = random_listening_addresses();
println!("Setting random LDK listening addresses: {:?}", rand_listening_addresses);
config.listening_addresses = Some(rand_listening_addresses);
node_config.listening_addresses = Some(rand_listening_addresses);

let alias = random_node_alias();
println!("Setting random LDK node alias: {:?}", alias);
config.node_alias = alias;
node_config.node_alias = alias;

config
TestConfig { node_config, ..Default::default() }
}

#[cfg(feature = "uniffi")]
Expand All@@ -257,6 +260,12 @@ pub(crate) enum TestChainSource<'a> {
BitcoindRpc(&'a BitcoinD),
}

#[derive(Clone, Default)]
pub(crate) struct TestConfig {
pub node_config: Config,
pub log_writer: TestLogWriter,
}

macro_rules! setup_builder {
($builder: ident, $config: expr) => {
#[cfg(feature = "uniffi")]
Expand All@@ -279,10 +288,11 @@ pub(crate) fn setup_two_nodes(
println!("\n== Node B ==");
let mut config_b = random_config(anchor_channels);
if allow_0conf {
config_b.trusted_peers_0conf.push(node_a.node_id());
config_b.node_config.trusted_peers_0conf.push(node_a.node_id());
}
if anchor_channels && anchors_trusted_no_reserve {
config_b
.node_config
.anchor_channels_config
.as_mut()
.unwrap()
Expand All@@ -294,9 +304,9 @@ pub(crate) fn setup_two_nodes(
}

pub(crate) fn setup_node(
chain_source: &TestChainSource, config: Config, seed_bytes: Option<Vec<u8>>,
chain_source: &TestChainSource, config: TestConfig, seed_bytes: Option<Vec<u8>>,
) -> TestNode {
setup_builder!(builder, config);
setup_builder!(builder, config.node_config);
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
Expand All@@ -315,14 +325,23 @@ pub(crate) fn setup_node(
},
}

let log_file_path = format!("{}/{}", config.storage_dir_path, "ldk_node.log");
builder.set_filesystem_logger(Some(log_file_path), Some(LogLevel::Gossip));
match &config.log_writer {
TestLogWriter::FileWriter => {
builder.set_filesystem_logger(None, None);
},
TestLogWriter::LogFacade => {
builder.set_log_facade_logger();
},
TestLogWriter::Custom(custom_log_writer) => {
builder.set_custom_logger(Arc::clone(custom_log_writer));
},
}

if let Some(seed) = seed_bytes {
builder.set_entropy_seed_bytes(seed).unwrap();
}

let test_sync_store = Arc::new(TestSyncStore::new(config.storage_dir_path.into()));
let test_sync_store = Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.into()));
let node = builder.build_with_store(test_sync_store).unwrap();
node.start().unwrap();
assert!(node.status().is_running);
Expand Down
2 changes: 1 addition & 1 deletion tests/integration_tests_cln.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ fn test_cln() {

// Setup LDK Node
let config = common::random_config(true);
let mut builder = Builder::from_config(config);
let mut builder = Builder::from_config(config.node_config);
builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);

let node = builder.build().unwrap();
Expand Down
Loading