Make EventQueue persistence async#697

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

Merged
tnull merged 2 commits into from
Nov 13, 2025
Merged

Make EventQueue persistence async#697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5822a0
Introduce `InMemoryStore` for testing
tnull Nov 13, 2025
4c72541
Make `EventQueue` persistence `async`
tnull Nov 10, 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
5 changes: 3 additions & 2 deletions src/data_store.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
use lightning::impl_writeable_tlv_based;
use lightning::util::test_utils::{TestLogger, TestStore};
use lightning::util::test_utils::TestLogger;

use super::*;
use crate::hex_utils;
use crate::io::test_utils::InMemoryStore;

#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

#[test]
fn data_is_persisted() {
let store: Arc<DynStore> = Arc::new(TestStore::new(false));
let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
let logger = Arc::new(TestLogger::new());
let primary_namespace = "datastore_test_primary".to_string();
let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down
70 changes: 38 additions & 32 deletions src/event.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
Self { queue, waker, kv_store, logger }
}

pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
{
pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {

@joostjagerjoostjagerNov 11, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?

@tnulltnullNov 11, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?

But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?

@joostjagerjoostjagerNov 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?

@joostjagerjoostjagerNov 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?

@tnulltnullNov 13, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.

@joostjagerjoostjagerNov 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.

let data = {
let mut locked_queue = self.queue.lock().unwrap();
locked_queue.push_back(event);
self.persist_queue(&locked_queue)?;
}
EventQueueSerWrapper(&locked_queue).encode()
};

self.persist_queue(data).await?;

if let Some(waker) = self.waker.lock().unwrap().take() {
waker.wake();
Expand All@@ -323,28 +325,30 @@ where
EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
}

pub(crate) fn event_handled(&self) -> Result<(), Error> {
{
pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
let mut locked_queue = self.queue.lock().unwrap();
locked_queue.pop_front();
self.persist_queue(&locked_queue)?;
}
EventQueueSerWrapper(&locked_queue).encode()
};

self.persist_queue(data).await?;

if let Some(waker) = self.waker.lock().unwrap().take() {
waker.wake();
}
Ok(())
}

fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
let data = EventQueueSerWrapper(locked_queue).encode();
KVStoreSync::write(
async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
KVStore::write(
&*self.kv_store,
EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
)
.await
.map_err(|e| {
log_error!(
self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
claim_deadline,
custom_records,
};
match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
.map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
.unwrap_or_default(),
};
match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
fee_paid_msat,
};

match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

let event =
Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => return Ok(()),
Err(e) => {
log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
claim_from_onchain_tx,
outbound_amount_forwarded_msat,
};
self.event_queue.add_event(event).map_err(|e| {
self.event_queue.add_event(event).await.map_err(|e| {
log_error!(self.logger, "Failed to push to event queue: {}", e);
ReplayEvent()
})?;
Expand All@@ -1322,7 +1326,7 @@ where
counterparty_node_id,
funding_txo,
};
match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => {},
Err(e) => {
log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
user_channel_id: UserChannelId(user_channel_id),
counterparty_node_id: Some(counterparty_node_id),
};
match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => {},
Err(e) => {
log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
reason: Some(reason),
};

match self.event_queue.add_event(event) {
match self.event_queue.add_event(event).await {
Ok(_) => {},
Err(e) => {
log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
use std::sync::atomic::{AtomicU16, Ordering};
use std::time::Duration;

use lightning::util::test_utils::{TestLogger, TestStore};
use lightning::util::test_utils::TestLogger;

use super::*;
use crate::io::test_utils::InMemoryStore;

#[tokio::test]
async fn event_queue_persistence() {
let store: Arc<DynStore> = Arc::new(TestStore::new(false));
let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
let logger = Arc::new(TestLogger::new());
let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
user_channel_id: UserChannelId(2323),
counterparty_node_id: None,
};
event_queue.add_event(expected_event.clone()).unwrap();
event_queue.add_event(expected_event.clone()).await.unwrap();

// Check we get the expected event and that it is returned until we mark it handled.
for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
}

// Check we can read back what we persisted.
let persisted_bytes = KVStoreSync::read(
let persisted_bytes = KVStore::read(
&*store,
EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
EVENT_QUEUE_PERSISTENCE_KEY,
)
.await
.unwrap();
let deser_event_queue =
EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
assert_eq!(deser_event_queue.next_event_async().await, expected_event);

event_queue.event_handled().unwrap();
event_queue.event_handled().await.unwrap();
assert_eq!(event_queue.next_event(), None);
}

#[tokio::test]
async fn event_queue_concurrency() {
let store: Arc<DynStore> = Arc::new(TestStore::new(false));
let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
let logger = Arc::new(TestLogger::new());
let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
let mut delayed_enqueue = false;

for _ in 0..25 {
event_queue.add_event(expected_event.clone()).unwrap();
event_queue.add_event(expected_event.clone()).await.unwrap();
enqueued_events.fetch_add(1, Ordering::SeqCst);
}

loop {
tokio::select! {
_ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
event_queue.add_event(expected_event.clone()).unwrap();
event_queue.add_event(expected_event.clone()).await.unwrap();
enqueued_events.fetch_add(1, Ordering::SeqCst);
delayed_enqueue = true;
}
e = event_queue.next_event_async() => {
assert_eq!(e, expected_event);
event_queue.event_handled().unwrap();
event_queue.event_handled().await.unwrap();
received_events.fetch_add(1, Ordering::SeqCst);

event_queue.add_event(expected_event.clone()).unwrap();
event_queue.add_event(expected_event.clone()).await.unwrap();
enqueued_events.fetch_add(1, Ordering::SeqCst);
}
e = event_queue.next_event_async() => {
assert_eq!(e, expected_event);
event_queue.event_handled().unwrap();
event_queue.event_handled().await.unwrap();
received_events.fetch_add(1, Ordering::SeqCst);
}
}
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
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
Make EventQueue persistence async#697

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

 Merged

tnull
merged 2 commits into

from

Nov 13, 2025
 Merged


Make EventQueue persistence async#697
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
f5822a0

Introduce `InMemoryStore` for testing


tnull Nov 13, 2025
4c72541

Make `EventQueue` persistence `async`


tnull Nov 10, 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


5 changes: 3 additions & 2 deletions
src/data_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -172,10 +172,11 @@ where
#[cfg(test)]
mod tests {
	use lightning::impl_writeable_tlv_based;
	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::hex_utils;
	use crate::io::test_utils::InMemoryStore;

	#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
	struct TestObjectId {
Expand DownExpand Up@@ -234,7 +235,7 @@ mod tests {

	#[test]
	fn data_is_persisted() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let primary_namespace = "datastore_test_primary".to_string();
 let secondary_namespace = "datastore_test_secondary".to_string();
Expand Down

70 changes: 38 additions & 32 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use lightning::util::config::{
	ChannelConfigOverrides, ChannelConfigUpdate, ChannelHandshakeConfigUpdate,
};
use lightning::util::errors::APIError;
use lightning::util::persist::KVStoreSync;
use lightning::util::persist::KVStore;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning_liquidity::lsps2::utils::compute_opening_fee;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand DownExpand Up@@ -301,12 +301,14 @@ where
 Self { queue, waker, kv_store, logger }
	}

	pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
 {
	pub(crate) async fn add_event(&self, event: Event) -> Result<(), Error> {
@joostjagerjoostjagerNov 11, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
@tnulltnullNov 11, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at what's left in EventQueue that is sync. Just next_event. Unrelated to this PR, but in every test where that method is used, the test is already async. So it could use the async version?
But next_event doesn't do anything that would require async operation? It doesn't repersist or anything?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we set the example and use the async api of eventqueue?
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah maybe the naming isn't optimally clear. next_event_async waits, and next_event does not?
@tnulltnullNov 13, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The former returns a future, the second one could be named try_next_event.
@joostjagerjoostjagerNov 13, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that would be an improvement indeed.
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.push_back(event);
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
Expand All@@ -323,28 +325,30 @@ where
 EventFuture { event_queue: Arc::clone(&self.queue), waker: Arc::clone(&self.waker) }.await
	}

	pub(crate) fn event_handled(&self) -> Result<(), Error> {
 {
	pub(crate) async fn event_handled(&self) -> Result<(), Error> {
let data = {
 let mut locked_queue = self.queue.lock().unwrap();
 locked_queue.pop_front();
 self.persist_queue(&locked_queue)?;
 }
 EventQueueSerWrapper(&locked_queue).encode()
 };

 self.persist_queue(data).await?;

 if let Some(waker) = self.waker.lock().unwrap().take() {
 waker.wake();
 }
 Ok(())
	}

	fn persist_queue(&self, locked_queue: &VecDeque<Event>) -> Result<(), Error> {
 let data = EventQueueSerWrapper(locked_queue).encode();
 KVStoreSync::write(
	async fn persist_queue(&self, encoded_queue: Vec<u8>) -> Result<(), Error> {
 KVStore::write(
 &*self.kv_store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
data,
encoded_queue,
 )
 .await
 .map_err(|e| {
 log_error!(
 self.logger,
Expand DownExpand Up@@ -694,7 +698,7 @@ where
 claim_deadline,
 custom_records,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(
Expand DownExpand Up@@ -928,7 +932,7 @@ where
 .map(|cf| cf.custom_tlvs().into_iter().map(|tlv| tlv.into()).collect())
 .unwrap_or_default(),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -988,7 +992,7 @@ where
 fee_paid_msat,
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1019,7 +1023,7 @@ where

 let event =
 Event::PaymentFailed { payment_id: Some(payment_id), payment_hash, reason };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => return Ok(()),
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1295,7 +1299,7 @@ where
 claim_from_onchain_tx,
 outbound_amount_forwarded_msat,
 };
 self.event_queue.add_event(event).map_err(|e| {
 self.event_queue.add_event(event).await.map_err(|e| {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
 ReplayEvent()
 })?;
Expand All@@ -1322,7 +1326,7 @@ where
 counterparty_node_id,
 funding_txo,
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1383,7 +1387,7 @@ where
 user_channel_id: UserChannelId(user_channel_id),
 counterparty_node_id: Some(counterparty_node_id),
 };
 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand All@@ -1407,7 +1411,7 @@ where
 reason: Some(reason),
 };

 match self.event_queue.add_event(event) {
 match self.event_queue.add_event(event).await {
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to push to event queue: {}", e);
Expand DownExpand Up@@ -1605,13 +1609,14 @@ mod tests {
	use std::sync::atomic::{AtomicU16, Ordering};
	use std::time::Duration;

	use lightning::util::test_utils::{TestLogger, TestStore};
	use lightning::util::test_utils::TestLogger;

	use super::*;
	use crate::io::test_utils::InMemoryStore;

	#[tokio::test]
	async fn event_queue_persistence() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand All@@ -1621,7 +1626,7 @@ mod tests {
 user_channel_id: UserChannelId(2323),
 counterparty_node_id: None,
 };
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();

 // Check we get the expected event and that it is returned until we mark it handled.
 for _ in 0..5 {
Expand All@@ -1630,24 +1635,25 @@ mod tests {
 }

 // Check we can read back what we persisted.
 let persisted_bytes = KVStoreSync::read(
 let persisted_bytes = KVStore::read(
 &*store,
 EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_SECONDARY_NAMESPACE,
 EVENT_QUEUE_PERSISTENCE_KEY,
 )
 .await
 .unwrap();
 let deser_event_queue =
 EventQueue::read(&mut &persisted_bytes[..], (Arc::clone(&store), logger)).unwrap();
 assert_eq!(deser_event_queue.next_event_async().await, expected_event);

 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 assert_eq!(event_queue.next_event(), None);
	}

	#[tokio::test]
	async fn event_queue_concurrency() {
 let store: Arc<DynStore> = Arc::new(TestStore::new(false));
 let store: Arc<DynStore> = Arc::new(InMemoryStore::new());
 let logger = Arc::new(TestLogger::new());
 let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 assert_eq!(event_queue.next_event(), None);
Expand DownExpand Up@@ -1675,28 +1681,28 @@ mod tests {
 let mut delayed_enqueue = false;

 for _ in 0..25 {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }

 loop {
 tokio::select! {
 _ = tokio::time::sleep(Duration::from_millis(10)), if !delayed_enqueue => {
 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 delayed_enqueue = true;
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);

 event_queue.add_event(expected_event.clone()).unwrap();
 event_queue.add_event(expected_event.clone()).await.unwrap();
 enqueued_events.fetch_add(1, Ordering::SeqCst);
 }
 e = event_queue.next_event_async() => {
 assert_eq!(e, expected_event);
 event_queue.event_handled().unwrap();
 event_queue.event_handled().await.unwrap();
 received_events.fetch_add(1, Ordering::SeqCst);
 }
 }
Expand Down
Loading