Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
joostjager wants to merge 3 commits into from
Closed

Add log spans using thread local storage in tests #4287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5d3333
Add log spans for test debugging using thread-local storage
joostjager Dec 16, 2025
bb84bd6
Add log_scope to channelmanager
joostjager Dec 16, 2025
1756ae4
Add test logger scope
joostjager Dec 16, 2025
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
47 changes: 46 additions & 1 deletion lightning-macros/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
let mut name_attr: Option<String> = None;
if !attrs.is_empty() {
// Expect something like `name = "foo"`
let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

if let Expr::Assign(assign) = expr {
// Check left-hand side is `name`.
if let Expr::Path(path) = *assign.left {
if path.path.is_ident("name") {
if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
name_attr = Some(s.value());
}
}
}
}
}

let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
parsed
} else {
return (quote! {
compile_error!("log_scope can only be set on methods")
})
.into();
};

// Use the attribute name if present, otherwise fall back to the function name
let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

// Only create the LoggerScope in test builds
let stmt = quote! {
#[cfg(test)]
let _logging_context = crate::util::logger::LoggerScope::new(#name);
};

meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
quote! { #meth }.into()
}
26 changes: 25 additions & 1 deletion lightning/src/ln/chanmon_update_fail_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
test_scope!("Setup");

// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
// is force-closed between when we generate the update on reload and when we go to handle the
// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

test_scope!("Route payment");

// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
check_added_monitors(&nodes[2], 1);
expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

test_scope!("Handle fulfill from C to B");

chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
// ChannelMonitor.
test_scope!("Step commitment_signed from B to C forward");

nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
check_added_monitors(&nodes[1], 1);
let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

if close_chans_before_reload {
if !close_only_a {
test_scope!("Force close B<->C channel");

chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
let message = "Channel force-closed".to_owned();
nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
}

test_scope!("Force close A<->B channel");

chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
let message = "Channel force-closed".to_owned();
nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
}

test_scope!("Reload");

// Now reload node B
let manager_b = nodes[1].node.encode();
reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
}
}

test_scope!("Force close A<->B channel from A");

let err_msg = "Channel force-closed".to_owned();
let reason = ClosureReason::HolderForceClosed {
broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
// ChannelMonitor (possible twice), even though the channel has since been closed.
test_scope!("Timer tick to apply preimage monitor update");

check_added_monitors(&nodes[1], 0);
let mons_added = if close_chans_before_reload {
if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
check_added_monitors(&nodes[1], mons_added);

// Finally, check that B created a payment preimage transaction and close out the payment.
test_scope!("Check preimage txn and complete payment");

let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

if !close_chans_before_reload || close_only_a {
test_scope!("Reconnect nodes B and C");
// Make sure the B<->C channel is still alive and well by sending a payment over it.
let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
// `PaymentForwarded` event will finally be released.
test_scope!("Complete blocked ChannelMonitorUpdate");
let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
if !close_chans_before_reload || close_only_a {
// Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
// will fly, removing the payment preimage from it.
test_scope!("Process pending events to complete B<->C monitor update");

check_added_monitors(&nodes[1], 1);
assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading

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

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading

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

Skip to content
Add log spans using thread local storage in tests#4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

joostjager
wants to merge
3
commits into

from

 Closed


Add log spans using thread local storage in tests
#4287
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d5d3333

Add log spans for test debugging using thread-local storage


joostjager Dec 16, 2025
bb84bd6

Add log_scope to channelmanager


joostjager Dec 16, 2025
1756ae4

Add test logger scope


joostjager Dec 16, 2025

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


47 changes: 46 additions & 1 deletion
lightning-macros/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@

extern crate alloc;

use alloc::string::String;
use alloc::string::ToString;
use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::spanned::Spanned;
use syn::{parse, ImplItemFn, Token};
use syn::{parse, parse2, Expr, ExprLit, ImplItemFn, Lit, Token};
use syn::{parse_macro_input, Item};

fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
Expand DownExpand Up@@ -400,3 +401,47 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {

	TokenStream::from(expanded)
}

/// Adds a logging scope at the top of a method.
/// In non-test builds, this is a no-op.
#[proc_macro_attribute]
pub fn log_scope(attrs: TokenStream, meth: TokenStream) -> TokenStream {
	let attrs: TokenStream2 = parse_macro_input!(attrs as TokenStream2);
	let mut name_attr: Option<String> = None;
	if !attrs.is_empty() {
 // Expect something like `name = "foo"`
 let expr: Expr = parse2(attrs.clone()).expect("invalid attribute syntax");

 if let Expr::Assign(assign) = expr {
 // Check left-hand side is `name`.
 if let Expr::Path(path) = *assign.left {
 if path.path.is_ident("name") {
 if let Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) = *assign.right {
 name_attr = Some(s.value());
 }
 }
 }
 }
	}

	let mut meth = if let Ok(parsed) = parse::<syn::ItemFn>(meth) {
 parsed
	} else {
 return (quote! {
 compile_error!("log_scope can only be set on methods")
 })
 .into();
	};

	// Use the attribute name if present, otherwise fall back to the function name
	let name = name_attr.unwrap_or_else(|| meth.sig.ident.to_string());

	// Only create the LoggerScope in test builds
	let stmt = quote! {
 #[cfg(test)]
 let _logging_context = crate::util::logger::LoggerScope::new(#name);
	};

	meth.block.stmts.insert(0, parse(stmt.into()).unwrap());
	quote! { #meth }.into()
}

26 changes: 25 additions & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,8 +44,8 @@ use crate::ln::functional_test_utils::*;

use crate::util::test_utils;

use crate::prelude::*;
use crate::sync::{Arc, Mutex};
use crate::{prelude::*, test_scope};
use bitcoin::hashes::Hash;

fn get_latest_mon_update_id<'a, 'b, 'c>(
Expand DownExpand Up@@ -3772,6 +3772,8 @@ fn test_inverted_mon_completion_order() {
fn do_test_durable_preimages_on_closed_channel(
	close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool,
) {
	test_scope!("Setup");

	// Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
	// is force-closed between when we generate the update on reload and when we go to handle the
	// update or prior to generating the update at all.
Expand All@@ -3798,6 +3800,8 @@ fn do_test_durable_preimages_on_closed_channel(
	let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
	let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;

	test_scope!("Route payment");

	// Route a payment from A, through B, to C, then claim it on C. Once we pass B the
	// `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
	// on the B<->C channel but leave the A<->B monitor update pending, then reload B.
Expand All@@ -3810,6 +3814,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[2], 1);
	expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);

	test_scope!("Handle fulfill from C to B");

	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
	let mut cs_updates = get_htlc_update_msgs(&nodes[2], &node_b_id);
	nodes[1].node.handle_update_fulfill_htlc(node_c_id, cs_updates.update_fulfill_htlcs.remove(0));
Expand All@@ -3822,6 +3828,8 @@ fn do_test_durable_preimages_on_closed_channel(
	// Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
	// the preimage when the nodes reconnect, at which point we have to ensure we get it from the
	// ChannelMonitor.
	test_scope!("Step commitment_signed from B to C forward");

	nodes[1].node.handle_commitment_signed_batch_test(node_c_id, &cs_updates.commitment_signed);
	check_added_monitors(&nodes[1], 1);
	let _ = get_revoke_commit_msgs(&nodes[1], &node_c_id);
Expand All@@ -3830,6 +3838,8 @@ fn do_test_durable_preimages_on_closed_channel(

	if close_chans_before_reload {
 if !close_only_a {
 test_scope!("Force close B<->C channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3842,6 +3852,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
 }

 test_scope!("Force close A<->B channel");

 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 let message = "Channel force-closed".to_owned();
 nodes[1]
Expand All@@ -3854,6 +3866,8 @@ fn do_test_durable_preimages_on_closed_channel(
 check_closed_event(&nodes[1], 1, reason, &[node_a_id], 100000);
	}

	test_scope!("Reload");

	// Now reload node B
	let manager_b = nodes[1].node.encode();
	reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);
Expand All@@ -3871,6 +3885,8 @@ fn do_test_durable_preimages_on_closed_channel(
 }
	}

	test_scope!("Force close A<->B channel from A");

	let err_msg = "Channel force-closed".to_owned();
	let reason = ClosureReason::HolderForceClosed {
 broadcasted_latest_txn: Some(true),
Expand All@@ -3889,6 +3905,8 @@ fn do_test_durable_preimages_on_closed_channel(

	// After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
	// ChannelMonitor (possible twice), even though the channel has since been closed.
	test_scope!("Timer tick to apply preimage monitor update");

	check_added_monitors(&nodes[1], 0);
	let mons_added = if close_chans_before_reload {
 if !close_only_a {
Expand All@@ -3913,6 +3931,8 @@ fn do_test_durable_preimages_on_closed_channel(
	check_added_monitors(&nodes[1], mons_added);

	// Finally, check that B created a payment preimage transaction and close out the payment.
	test_scope!("Check preimage txn and complete payment");

	let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
	assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
	let bs_preimage_tx = bs_txn
Expand All@@ -3926,6 +3946,7 @@ fn do_test_durable_preimages_on_closed_channel(
	expect_payment_sent(&nodes[0], payment_preimage, None, true, true);

	if !close_chans_before_reload || close_only_a {
 test_scope!("Reconnect nodes B and C");
 // Make sure the B<->C channel is still alive and well by sending a payment over it.
 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 reconnect_args.pending_responding_commitment_signed.1 = true;
Expand All@@ -3940,6 +3961,7 @@ fn do_test_durable_preimages_on_closed_channel(

	// Once the blocked `ChannelMonitorUpdate` *finally* completes, the pending
	// `PaymentForwarded` event will finally be released.
	test_scope!("Complete blocked ChannelMonitorUpdate");
	let (_, ab_update_id) = get_latest_mon_update_id(&nodes[1], chan_id_ab);
	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_id_ab, ab_update_id);

Expand All@@ -3957,6 +3979,8 @@ fn do_test_durable_preimages_on_closed_channel(
	if !close_chans_before_reload || close_only_a {
 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C channel
 // will fly, removing the payment preimage from it.
 test_scope!("Process pending events to complete B<->C monitor update");

 check_added_monitors(&nodes[1], 1);
 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 send_payment(&nodes[1], &[&nodes[2]], 100_000);
Expand Down
Loading
Loading