Create separate timer for scorer persistence in background processor.

Author: arik-so

lightning-background-processor/src/lib.rs

@@ -2,7 +2,7 @@
 //! running properly, and (2) either can or should be run in the background. See docs for
 //! [`BackgroundProcessor`] for more details on the nitty-gritty.
 
-#![deny(broken_intra_doc_links)]
+#![deny(rustdoc::broken_intra_doc_links)]
 #![deny(missing_docs)]
 #![deny(unsafe_code)]
 
@@ -79,6 +79,11 @@ const PING_TIMER: u64 = 1;
 /// Prune the network graph of stale entries hourly.
 const NETWORK_PRUNE_TIMER: u64 = 60 * 60;
 
+#[cfg(all(not(test), debug_assertions))]
+const SCORER_PERSIST_TIMER: u64 = 30;
+#[cfg(test)]
+const SCORER_PERSIST_TIMER: u64 = 1;
+
 #[cfg(not(test))]
 const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
 #[cfg(test)]
@@ -214,6 +219,7 @@ impl BackgroundProcessor {
 			let mut last_freshness_call = Instant::now();
 			let mut last_ping_call = Instant::now();
 			let mut last_prune_call = Instant::now();
+			let mut last_scorer_persist_call = Instant::now();
 			let mut have_pruned = false;
 
 			loop {
@@ -306,15 +312,16 @@ impl BackgroundProcessor {
 							log_trace!(logger, "Not pruning network graph due to pending gossip sync");
 						}
 					}
+				}
+
+				if last_scorer_persist_call.elapsed().as_secs() > SCORER_PERSIST_TIMER {
 					if let Some(ref scorer) = scorer {
 						log_trace!(logger, "Persisting scorer");
 						if let Err(e) = persister.persist_scorer(&scorer) {
 							log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 						}
 					}
-
-					last_prune_call = Instant::now();
-					have_pruned = true;
+					last_scorer_persist_call = Instant::now();
 				}
 			}
 
@@ -899,7 +906,7 @@ mod tests {
 		assert_eq!(network_graph.read_only().channels().len(), 3);
 
 		let _ = receiver
-			.recv_timeout(Duration::from_secs(super::FIRST_NETWORK_PRUNE_TIMER * 2))
+			.recv_timeout(Duration::from_secs(super::FIRST_NETWORK_PRUNE_TIMER * 5))
 			.expect("Network graph not pruned within deadline");
 
 		background_processor.stop().unwrap();

lightning-rapid-gossip-sync/src/lib.rs

@@ -60,7 +60,6 @@ extern crate test;
 
 use std::fs::File;
 use std::ops::Deref;
-use std::sync::Arc;
 use std::sync::atomic::{AtomicBool, Ordering};
 
 use lightning::routing::network_graph::NetworkGraph;
@@ -74,17 +73,20 @@ pub mod error;
 pub mod processing;
 
 /// Rapid Gossip Sync holder struct
+/// See [module-level documentation] for usage.
+///
+/// [module-level documentation]: crate
 pub struct RapidGossipSync<NG: Deref<Target=NetworkGraph>> {
 	network_graph: NG,
-	is_initial_sync_complete: Arc<AtomicBool>
+	is_initial_sync_complete: AtomicBool
 }
 
 impl<NG: Deref<Target=NetworkGraph>> RapidGossipSync<NG> {
-	/// Instantiate a new RapidGossipSync holder
+	/// Instantiate a new RapidGossipSync instance
 	pub fn new(network_graph: NG) -> Self {
 		Self {
 			network_graph,
-			is_initial_sync_complete: Arc::new(AtomicBool::new(false))
+			is_initial_sync_complete: AtomicBool::new(false)
 		}
 	}
 
@@ -103,7 +105,7 @@ impl<NG: Deref<Target=NetworkGraph>> RapidGossipSync<NG> {
 		self.update_network_graph_from_byte_stream(&mut file)
 	}
 
-	/// Bool indicating whether a rapid gossip sync has completed at least once
+	/// Returns whether a rapid gossip sync has completed at least once
 	pub fn is_initial_sync_complete(&self) -> bool {
 		self.is_initial_sync_complete.load(Ordering::Acquire)
 	}
@@ -213,12 +215,12 @@ mod tests {
 
 		assert_eq!(network_graph.read_only().channels().len(), 0);
 
-		let rapid_sync = RapidGossipSync::new(network_graph);
+		let rapid_sync = RapidGossipSync::new(&network_graph);
 		let start = std::time::Instant::now();
 		let sync_result = rapid_sync
 			.sync_network_graph_with_file_path("./res/full_graph.lngossip");
 		if let Err(crate::error::GraphSyncError::DecodeError(DecodeError::Io(io_error))) = &sync_result {
-			let error_string = format!("Input file lightning-graph-sync/res/full_graph.lngossip is missing! Download it from https://bitcoin.ninja/ldk-compressed_graph-bc08df7542-2022-05-05.bin\n\n{:?}", io_error);
+			let error_string = format!("Input file lightning-rapid-gossip-sync/res/full_graph.lngossip is missing! Download it from https://bitcoin.ninja/ldk-compressed_graph-bc08df7542-2022-05-05.bin\n\n{:?}", io_error);
 			#[cfg(not(require_route_graph_test))]
 			{
 				println!("{}", error_string);
@@ -255,7 +257,7 @@ pub mod bench {
 			let rapid_sync = RapidGossipSync::new(&network_graph);
 			let sync_result = rapid_sync.sync_network_graph_with_file_path("./res/full_graph.lngossip");
 			if let Err(crate::error::GraphSyncError::DecodeError(DecodeError::Io(io_error))) = &sync_result {
-				let error_string = format!("Input file lightning-graph-sync/res/full_graph.lngossip is missing! Download it from https://bitcoin.ninja/ldk-compressed_graph-bc08df7542-2022-05-05.bin\n\n{:?}", io_error);
+				let error_string = format!("Input file lightning-rapid-gossip-sync/res/full_graph.lngossip is missing! Download it from https://bitcoin.ninja/ldk-compressed_graph-bc08df7542-2022-05-05.bin\n\n{:?}", io_error);
 				#[cfg(not(require_route_graph_test))]
 				{
 					println!("{}", error_string);