use bitcoin::secp256k1::PublicKey;
use core::cmp;
use core::fmt;
use core::ops::Deref;
use crate::ln::ChannelId;
#[cfg(c_bindings)]
use crate::prelude::*; static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
pub enum Level {
Gossip,
Trace,
Debug,
Info,
Warn,
Error,
}
impl PartialOrd for Level {
#[inline]
fn partial_cmp(&self, other: &Level) -> Option<cmp::Ordering> {
Some(self.cmp(other))
}
#[inline]
fn lt(&self, other: &Level) -> bool {
(*self as usize) < *other as usize
}
#[inline]
fn le(&self, other: &Level) -> bool {
*self as usize <= *other as usize
}
#[inline]
fn gt(&self, other: &Level) -> bool {
*self as usize > *other as usize
}
#[inline]
fn ge(&self, other: &Level) -> bool {
*self as usize >= *other as usize
}
}
impl Ord for Level {
#[inline]
fn cmp(&self, other: &Level) -> cmp::Ordering {
(*self as usize).cmp(&(*other as usize))
}
}
impl fmt::Display for Level {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
fmt.pad(LOG_LEVEL_NAMES[*self as usize])
}
}
impl Level {
#[inline]
pub fn max() -> Level {
Level::Gossip
}
}
#[derive(Clone, Debug)]
pub struct Record<'a> {
pub level: Level,
pub peer_id: Option<PublicKey>,
pub channel_id: Option<ChannelId>,
#[cfg(not(c_bindings))]
pub args: fmt::Arguments<'a>,
#[cfg(c_bindings)]
pub args: String,
pub module_path: &'static str,
pub file: &'static str,
pub line: u32,
#[cfg(c_bindings)]
_phantom: core::marker::PhantomData<&'a ()>,
}
impl<'a> Record<'a> {
#[inline]
pub fn new(
level: Level, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>,
args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32
) -> Record<'a> {
Record {
level,
peer_id,
channel_id,
#[cfg(not(c_bindings))]
args,
#[cfg(c_bindings)]
args: format!("{}", args),
module_path,
file,
line,
#[cfg(c_bindings)]
_phantom: core::marker::PhantomData,
}
}
}
pub trait Logger {
fn log(&self, record: Record);
}
pub struct WithContext<'a, L: Deref> where L::Target: Logger {
logger: &'a L,
peer_id: Option<PublicKey>,
channel_id: Option<ChannelId>,
}
impl<'a, L: Deref> Logger for WithContext<'a, L> where L::Target: Logger {
fn log(&self, mut record: Record) {
if self.peer_id.is_some() {
record.peer_id = self.peer_id
};
if self.channel_id.is_some() {
record.channel_id = self.channel_id;
}
self.logger.log(record)
}
}
impl<'a, L: Deref> WithContext<'a, L> where L::Target: Logger {
pub fn from(logger: &'a L, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>) -> Self {
WithContext {
logger,
peer_id,
channel_id,
}
}
}
#[doc(hidden)]
pub struct DebugPubKey<'a>(pub &'a PublicKey);
impl<'a> core::fmt::Display for DebugPubKey<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
for i in self.0.serialize().iter() {
write!(f, "{:02x}", i)?;
}
Ok(())
}
}
#[doc(hidden)]
pub struct DebugBytes<'a>(pub &'a [u8]);
impl<'a> core::fmt::Display for DebugBytes<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
for i in self.0 {
write!(f, "{:02x}", i)?;
}
Ok(())
}
}
#[doc(hidden)]
pub struct DebugIter<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone>(pub I);
impl<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone> fmt::Display for DebugIter<T, I> {
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(f, "[")?;
let mut iter = self.0.clone();
if let Some(item) = iter.next() {
write!(f, "{}", item)?;
}
while let Some(item) = iter.next() {
write!(f, ", {}", item)?;
}
write!(f, "]")?;
Ok(())
}
}
#[cfg(test)]
mod tests {
use bitcoin::secp256k1::{PublicKey, SecretKey, Secp256k1};
use crate::ln::ChannelId;
use crate::util::logger::{Logger, Level, WithContext};
use crate::util::test_utils::TestLogger;
use crate::sync::Arc;
#[test]
fn test_level_show() {
assert_eq!("INFO", Level::Info.to_string());
assert_eq!("ERROR", Level::Error.to_string());
assert_ne!("WARN", Level::Error.to_string());
}
struct WrapperLog {
logger: Arc<dyn Logger>
}
impl WrapperLog {
fn new(logger: Arc<dyn Logger>) -> WrapperLog {
WrapperLog {
logger,
}
}
fn call_macros(&self) {
log_error!(self.logger, "This is an error");
log_warn!(self.logger, "This is a warning");
log_info!(self.logger, "This is an info");
log_debug!(self.logger, "This is a debug");
log_trace!(self.logger, "This is a trace");
log_gossip!(self.logger, "This is a gossip");
}
}
#[test]
fn test_logging_macros() {
let mut logger = TestLogger::new();
logger.enable(Level::Gossip);
let logger : Arc<dyn Logger> = Arc::new(logger);
let wrapper = WrapperLog::new(Arc::clone(&logger));
wrapper.call_macros();
}
#[test]
fn test_logging_with_context() {
let logger = &TestLogger::new();
let secp_ctx = Secp256k1::new();
let pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
let context_logger = WithContext::from(&logger, Some(pk), Some(ChannelId([0; 32])));
log_error!(context_logger, "This is an error");
log_warn!(context_logger, "This is an error");
log_debug!(context_logger, "This is an error");
log_trace!(context_logger, "This is an error");
log_gossip!(context_logger, "This is an error");
log_info!(context_logger, "This is an error");
logger.assert_log_context_contains(
"lightning::util::logger::tests", Some(pk), Some(ChannelId([0;32])), 6
);
}
#[test]
fn test_logging_with_multiple_wrapped_context() {
let logger = &TestLogger::new();
let secp_ctx = Secp256k1::new();
let pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
let context_logger = &WithContext::from(&logger, None, Some(ChannelId([0; 32])));
let full_context_logger = WithContext::from(&context_logger, Some(pk), None);
log_error!(full_context_logger, "This is an error");
log_warn!(full_context_logger, "This is an error");
log_debug!(full_context_logger, "This is an error");
log_trace!(full_context_logger, "This is an error");
log_gossip!(full_context_logger, "This is an error");
log_info!(full_context_logger, "This is an error");
logger.assert_log_context_contains(
"lightning::util::logger::tests", Some(pk), Some(ChannelId([0;32])), 6
);
}
#[test]
fn test_log_ordering() {
assert!(Level::Error > Level::Warn);
assert!(Level::Error >= Level::Warn);
assert!(Level::Error >= Level::Error);
assert!(Level::Warn > Level::Info);
assert!(Level::Warn >= Level::Info);
assert!(Level::Warn >= Level::Warn);
assert!(Level::Info > Level::Debug);
assert!(Level::Info >= Level::Debug);
assert!(Level::Info >= Level::Info);
assert!(Level::Debug > Level::Trace);
assert!(Level::Debug >= Level::Trace);
assert!(Level::Debug >= Level::Debug);
assert!(Level::Trace > Level::Gossip);
assert!(Level::Trace >= Level::Gossip);
assert!(Level::Trace >= Level::Trace);
assert!(Level::Gossip >= Level::Gossip);
assert!(Level::Error <= Level::Error);
assert!(Level::Warn < Level::Error);
assert!(Level::Warn <= Level::Error);
assert!(Level::Warn <= Level::Warn);
assert!(Level::Info < Level::Warn);
assert!(Level::Info <= Level::Warn);
assert!(Level::Info <= Level::Info);
assert!(Level::Debug < Level::Info);
assert!(Level::Debug <= Level::Info);
assert!(Level::Debug <= Level::Debug);
assert!(Level::Trace < Level::Debug);
assert!(Level::Trace <= Level::Debug);
assert!(Level::Trace <= Level::Trace);
assert!(Level::Gossip < Level::Trace);
assert!(Level::Gossip <= Level::Trace);
assert!(Level::Gossip <= Level::Gossip);
}
}