Rename background-processor test Persister to PersisterSync

Author: joostjager

lightning-background-processor/src/lib.rs

@@ -928,21 +928,21 @@ impl BackgroundProcessor {
 	/// documentation].
 	///
 	/// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
-	/// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
+	/// [`PersisterSync::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
 	/// either [`join`] or [`stop`].
 	///
 	/// # Data Persistence
 	///
-	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
+	/// [`PersisterSync::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
 	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
 	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
 	/// provided implementation.
 	///
-	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk, if
+	/// [`PersisterSync::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk, if
 	/// [`GossipSync`] is supplied. See [`NetworkGraph::write`] for writing out a [`NetworkGraph`].
 	/// See the `lightning-persister` crate for LDK's provided implementation.
 	///
-	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
+	/// Typically, users should either implement [`PersisterSync::persist_manager`] to never return an
 	/// error or call [`join`] and handle any error that may arise. For the latter case,
 	/// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
 	///
@@ -964,8 +964,8 @@ impl BackgroundProcessor {
 	/// [`stop`]: Self::stop
 	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
-	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
-	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
+	/// [`PersisterSync::persist_manager`]: lightning::util::persist::PersisterSync::persist_manager
+	/// [`PersisterSync::persist_graph`]: lightning::util::persist::PersisterSync::persist_graph
 	/// [`NetworkGraph`]: lightning::routing::gossip::NetworkGraph
 	/// [`NetworkGraph::write`]: lightning::routing::gossip::NetworkGraph#impl-Writeable
 	pub fn start<
@@ -1384,15 +1384,15 @@ mod tests {
 		}
 	}
 
-	struct Persister {
+	struct PersisterSync {
 		graph_error: Option<(std::io::ErrorKind, &'static str)>,
 		graph_persistence_notifier: Option<SyncSender<()>>,
 		manager_error: Option<(std::io::ErrorKind, &'static str)>,
 		scorer_error: Option<(std::io::ErrorKind, &'static str)>,
 		kv_store: FilesystemStore,
 	}
 
-	impl Persister {
+	impl PersisterSync {
 		fn new(data_dir: PathBuf) -> Self {
 			let kv_store = FilesystemStore::new(data_dir);
 			Self {
@@ -1421,7 +1421,7 @@ mod tests {
 		}
 	}
 
-	impl KVStoreSync for Persister {
+	impl KVStoreSync for PersisterSync {
 		fn read(
 			&self, primary_namespace: &str, secondary_namespace: &str, key: &str,
 		) -> lightning::io::Result<Vec<u8>> {
@@ -1937,7 +1937,7 @@ mod tests {
 
 		// Initiate the background processors to watch each node.
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir));
+		let persister = Arc::new(PersisterSync::new(data_dir));
 		let event_handler = |_: _| Ok(());
 		let bg_processor = BackgroundProcessor::start(
 			persister,
@@ -2032,7 +2032,7 @@ mod tests {
 		// - `OnionMessageHandler::timer_tick_occurred` is called every `ONION_MESSAGE_HANDLER_TIMER`.
 		let (_, nodes) = create_nodes(1, "test_timer_tick_called");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir));
+		let persister = Arc::new(PersisterSync::new(data_dir));
 		let event_handler = |_: _| Ok(());
 		let bg_processor = BackgroundProcessor::start(
 			persister,
@@ -2075,7 +2075,7 @@ mod tests {
 
 		let data_dir = nodes[0].kv_store.get_data_dir();
 		let persister = Arc::new(
-			Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"),
+			PersisterSync::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"),
 		);
 		let event_handler = |_: _| Ok(());
 		let bg_processor = BackgroundProcessor::start(
@@ -2108,7 +2108,7 @@ mod tests {
 
 		let data_dir = nodes[0].kv_store.get_data_dir();
 		let persister = Arc::new(
-			Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"),
+			PersisterSync::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"),
 		);
 
 		let bp_future = super::process_events_async(
@@ -2146,8 +2146,9 @@ mod tests {
 		// Test that if we encounter an error during network graph persistence, an error gets returned.
 		let (_, nodes) = create_nodes(2, "test_persist_network_graph_error");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister =
-			Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
+		let persister = Arc::new(
+			PersisterSync::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"),
+		);
 		let event_handler = |_: _| Ok(());
 		let bg_processor = BackgroundProcessor::start(
 			persister,
@@ -2177,8 +2178,9 @@ mod tests {
 		// Test that if we encounter an error during scorer persistence, an error gets returned.
 		let (_, nodes) = create_nodes(2, "test_persist_scorer_error");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister =
-			Arc::new(Persister::new(data_dir).with_scorer_error(std::io::ErrorKind::Other, "test"));
+		let persister = Arc::new(
+			PersisterSync::new(data_dir).with_scorer_error(std::io::ErrorKind::Other, "test"),
+		);
 		let event_handler = |_: _| Ok(());
 		let bg_processor = BackgroundProcessor::start(
 			persister,
@@ -2211,7 +2213,7 @@ mod tests {
 
 		let channel_value = 100000;
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir.clone()));
+		let persister = Arc::new(PersisterSync::new(data_dir.clone()));
 
 		// Set up a background event handler for FundingGenerationReady events.
 		let (funding_generation_send, funding_generation_recv) = std::sync::mpsc::sync_channel(1);
@@ -2291,7 +2293,7 @@ mod tests {
 			}
 			Ok(())
 		};
-		let persister = Arc::new(Persister::new(data_dir));
+		let persister = Arc::new(PersisterSync::new(data_dir));
 		let bg_processor = BackgroundProcessor::start(
 			persister,
 			event_handler,
@@ -2437,7 +2439,7 @@ mod tests {
 		let (_, nodes) = create_nodes(2, "test_event_handling_failures_are_replayed");
 		let channel_value = 100000;
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir.clone()));
+		let persister = Arc::new(PersisterSync::new(data_dir.clone()));
 
 		let (first_event_send, first_event_recv) = std::sync::mpsc::sync_channel(1);
 		let (second_event_send, second_event_recv) = std::sync::mpsc::sync_channel(1);
@@ -2486,7 +2488,7 @@ mod tests {
 	fn test_scorer_persistence() {
 		let (_, nodes) = create_nodes(2, "test_scorer_persistence");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir));
+		let persister = Arc::new(PersisterSync::new(data_dir));
 		let event_handler = |_: _| Ok(());
 		let bg_processor = BackgroundProcessor::start(
 			persister,
@@ -2582,7 +2584,8 @@ mod tests {
 		let (_, nodes) =
 			create_nodes(2, "test_not_pruning_network_graph_until_graph_sync_completion");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir).with_graph_persistence_notifier(sender));
+		let persister =
+			Arc::new(PersisterSync::new(data_dir).with_graph_persistence_notifier(sender));
 
 		let event_handler = |_: _| Ok(());
 		let background_processor = BackgroundProcessor::start(
@@ -2615,7 +2618,8 @@ mod tests {
 		let (_, nodes) =
 			create_nodes(2, "test_not_pruning_network_graph_until_graph_sync_completion_async");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir).with_graph_persistence_notifier(sender));
+		let persister =
+			Arc::new(PersisterSync::new(data_dir).with_graph_persistence_notifier(sender));
 
 		let (exit_sender, exit_receiver) = tokio::sync::watch::channel(());
 		let bp_future = super::process_events_async(
@@ -2783,7 +2787,7 @@ mod tests {
 
 		let (_, nodes) = create_nodes(1, "test_payment_path_scoring");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir));
+		let persister = Arc::new(PersisterSync::new(data_dir));
 		let bg_processor = BackgroundProcessor::start(
 			persister,
 			event_handler,
@@ -2831,7 +2835,7 @@ mod tests {
 
 		let (_, nodes) = create_nodes(1, "test_payment_path_scoring_async");
 		let data_dir = nodes[0].kv_store.get_data_dir();
-		let persister = Arc::new(Persister::new(data_dir));
+		let persister = Arc::new(PersisterSync::new(data_dir));
 
 		let (exit_sender, exit_receiver) = tokio::sync::watch::channel(());
 

lightning/src/ln/channelmanager.rs

@@ -1886,7 +1886,7 @@ where
 /// - Perform any periodic channel and payment checks by calling [`timer_tick_occurred`] roughly
 ///   every minute
 /// - Persist to disk whenever [`get_and_clear_needs_persistence`] returns `true` using a
-///   [`Persister`] such as a [`KVStoreSync`] implementation
+///   [`PersisterSync`] such as a [`KVStoreSync`] implementation
 /// - Handle [`Event`]s obtained via its [`EventsProvider`] implementation
 ///
 /// The [`Future`] returned by [`get_event_or_persistence_needed_future`] is useful in determining
@@ -2468,7 +2468,7 @@ where
 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
 /// [`get_and_clear_needs_persistence`]: Self::get_and_clear_needs_persistence
-/// [`Persister`]: crate::util::persist::Persister
+/// [`PersisterSync`]: crate::util::persist::PersisterSync
 /// [`KVStoreSync`]: crate::util::persist::KVStoreSync
 /// [`get_event_or_persistence_needed_future`]: Self::get_event_or_persistence_needed_future
 /// [`lightning-block-sync`]: https://docs.rs/lightning_block_sync/latest/lightning_block_sync