Respond to comments.

Author: arik-so

lightning-background-processor/src/lib.rs

@@ -58,7 +58,7 @@ use lightning_rapid_gossip_sync::RapidGossipSync;
 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
 pub struct BackgroundProcessor {
 	stop_thread: Arc<AtomicBool>,
-	thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>
+	thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
 }
 
 #[cfg(not(test))]
@@ -156,9 +156,10 @@ impl BackgroundProcessor {
 	///
 	/// # Rapid Gossip Sync
 	///
-	/// If a rapid gossip sync is meant to run at startup, set `await_rapid_gossip_sync_completion`
-	/// to true to indicate to [`BackgroundProcessor`] not to prune the [`NetworkGraph`] instance
-	/// until [`rapid_gossip_sync_complete`] is called.
+	/// If a rapid gossip sync is meant to run at startup, pass an option with a set
+	/// [`RapidGossipSync`] reference to `rapid_gossip_sync` to indicate to [`BackgroundProcessor`]
+	/// not to prune the [`NetworkGraph`] instance until the [`RapidGossipSync`] instance
+	/// completes its first sync.
 	pub fn start<
 		'a,
 		Signer: 'static + Sign,
@@ -186,7 +187,7 @@ impl BackgroundProcessor {
 	>(
 		persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
 		net_graph_msg_handler: Option<NG>, peer_manager: PM, logger: L, scorer: Option<S>,
-		rapid_gossip_sync: Option<Arc<RapidGossipSync<G>>>
+		rapid_gossip_sync: Option<&RapidGossipSync<G>>
 	) -> Self
 	where
 		CA::Target: 'static + chain::Access,
@@ -289,13 +290,14 @@ impl BackgroundProcessor {
 					if let Some(ref handler) = net_graph_msg_handler {
 						log_trace!(logger, "Assessing prunability of network graph");
 						// The network graph must not be pruned while rapid sync completion is pending
-						let is_currently_awaiting_graph_sync = !is_initial_sync_complete.load(Ordering::Acquire);
-						if is_currently_awaiting_graph_sync {
+						if is_initial_sync_complete.load(Ordering::Acquire) {
+							log_trace!(logger, "Pruning network graph of stale entries");
+							handler.network_graph().remove_stale_channels();
+						} else {
 							log_trace!(logger, "Not pruning network graph due to pending gossip sync");
 							continue;
 						}
-						log_trace!(logger, "Pruning network graph of stale entries");
-						handler.network_graph().remove_stale_channels();
+
 						if let Err(e) = persister.persist_graph(handler.network_graph()) {
 							log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e)
 						}
@@ -830,7 +832,7 @@ mod tests {
 		let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 		let persister = Arc::new(Persister::new(data_dir.clone()).with_graph_persistence_notifier(sender));
 		let network_graph = nodes[0].network_graph.clone();
-		let rapid_sync = Arc::new(RapidGossipSync::new(network_graph.clone()));
+		let rapid_sync = RapidGossipSync::new(network_graph.clone());
 		let features = ChannelFeatures::empty();
 		network_graph.add_channel_from_partial_announcement(42, 53, features, nodes[0].node.get_our_node_id(), nodes[1].node.get_our_node_id())
 			.expect("Failed to update channel from partial announcement");
@@ -839,7 +841,7 @@ mod tests {
 		assert_eq!(network_graph.read_only().channels().len(), 1);
 
 		let event_handler = |_: &_| {};
-		let background_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()), Some(rapid_sync.clone()));
+		let background_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()), Some(&rapid_sync));
 
 		loop {
 			let log_entries = nodes[0].logger.lines.lock().unwrap();