Correct maximum_pending_updates of 0 in MonitorUpdatingPersister

Though users maybe shouldn't use `MonitorUpdatingPersister` if they
don't actually want to persist `ChannelMonitorUpdate`s, we also
shouldn't panic if `maximum_pending_updates` is set to zero.

Author: TheBlueMatt

lightning/src/util/persist.rs

@@ -796,6 +796,7 @@ where
 		const LEGACY_CLOSED_CHANNEL_UPDATE_ID: u64 = u64::MAX;
 		if let Some(update) = update {
 			let persist_update = update.update_id != LEGACY_CLOSED_CHANNEL_UPDATE_ID
+				&& self.maximum_pending_updates != 0
 				&& update.update_id % self.maximum_pending_updates != 0;
 			if persist_update {
 				let monitor_key = monitor_name.to_string();
@@ -1188,17 +1189,12 @@ mod tests {
 	}
 
 	// Exercise the `MonitorUpdatingPersister` with real channels and payments.
-	#[test]
-	fn persister_with_real_monitors() {
-		// This value is used later to limit how many iterations we perform.
-		let persister_0_max_pending_updates = 7;
-		// Intentionally set this to a smaller value to test a different alignment.
-		let persister_1_max_pending_updates = 3;
+	fn do_persister_with_real_monitors(max_pending_updates_0: u64, max_pending_updates_1: u64) {
 		let chanmon_cfgs = create_chanmon_cfgs(4);
 		let persister_0 = MonitorUpdatingPersister {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
-			maximum_pending_updates: persister_0_max_pending_updates,
+			maximum_pending_updates: max_pending_updates_0,
 			entropy_source: &chanmon_cfgs[0].keys_manager,
 			signer_provider: &chanmon_cfgs[0].keys_manager,
 			broadcaster: &chanmon_cfgs[0].tx_broadcaster,
@@ -1207,7 +1203,7 @@ mod tests {
 		let persister_1 = MonitorUpdatingPersister {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
-			maximum_pending_updates: persister_1_max_pending_updates,
+			maximum_pending_updates: max_pending_updates_1,
 			entropy_source: &chanmon_cfgs[1].keys_manager,
 			signer_provider: &chanmon_cfgs[1].keys_manager,
 			broadcaster: &chanmon_cfgs[1].tx_broadcaster,
@@ -1256,35 +1252,35 @@ mod tests {
 					assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 
 					let monitor_name = mon.persistence_key();
-					assert_eq!(
-						KVStoreSync::list(
-							&*persister_0.kv_store,
-							CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
-							&monitor_name.to_string()
-						)
-						.unwrap()
-						.len() as u64,
-						mon.get_latest_update_id() % persister_0_max_pending_updates,
-						"Wrong number of updates stored in persister 0",
+					let expected_updates = if max_pending_updates_0 == 0 {
+						0
+					} else {
+						mon.get_latest_update_id() % max_pending_updates_0
+					};
+					let update_list = KVStoreSync::list(
+						&*persister_0.kv_store,
+						CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
+						&monitor_name.to_string(),
 					);
+					assert_eq!(update_list.unwrap().len() as u64, expected_updates, "persister 0");
 				}
 				persisted_chan_data_1 =
 					persister_1.read_all_channel_monitors_with_updates().unwrap();
 				assert_eq!(persisted_chan_data_1.len(), 1);
 				for (_, mon) in persisted_chan_data_1.iter() {
 					assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 					let monitor_name = mon.persistence_key();
-					assert_eq!(
-						KVStoreSync::list(
-							&*persister_1.kv_store,
-							CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
-							&monitor_name.to_string()
-						)
-						.unwrap()
-						.len() as u64,
-						mon.get_latest_update_id() % persister_1_max_pending_updates,
-						"Wrong number of updates stored in persister 1",
+					let expected_updates = if max_pending_updates_1 == 0 {
+						0
+					} else {
+						mon.get_latest_update_id() % max_pending_updates_1
+					};
+					let update_list = KVStoreSync::list(
+						&*persister_1.kv_store,
+						CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
+						&monitor_name.to_string(),
 					);
+					assert_eq!(update_list.unwrap().len() as u64, expected_updates, "persister 1");
 				}
 			};
 		}
@@ -1302,7 +1298,7 @@ mod tests {
 		// Send a few more payments to try all the alignments of max pending updates with
 		// updates for a payment sent and received.
 		let mut sender = 0;
-		for i in 3..=persister_0_max_pending_updates * 2 {
+		for i in 3..=max_pending_updates_0 * 2 {
 			let receiver;
 			if sender == 0 {
 				sender = 1;
@@ -1345,11 +1341,19 @@ mod tests {
 		check_added_monitors!(nodes[1], 1);
 
 		// Make sure everything is persisted as expected after close.
+		// We always send at least two payments, and loop up to max_pending_updates_0 * 2.
 		check_persisted_data!(
-			persister_0_max_pending_updates * 2 * EXPECTED_UPDATES_PER_PAYMENT + 1
+			cmp::max(2, max_pending_updates_0 * 2) * EXPECTED_UPDATES_PER_PAYMENT + 1
 		);
 	}
 
+	#[test]
+	fn persister_with_real_monitors() {
+		do_persister_with_real_monitors(7, 3);
+		do_persister_with_real_monitors(0, 1);
+		do_persister_with_real_monitors(4, 2);
+	}
+
 	// Test that if the `MonitorUpdatingPersister`'s can't actually write, trying to persist a
 	// monitor or update with it results in the persister returning an UnrecoverableError status.
 	#[test]