Add a simple test for ChainMonitor MonitorUpdate-holding behavior

diff --git a/lightning/src/chain/chainmonitor.rs b/lightning/src/chain/chainmonitor.rs
index 4ff3bba11a7e10b2e2f00b24a59ba5d4eb82ec06..ccce772f8a1df927031a2e304e14dff52814283f 100644 (file)
--- a/lightning/src/chain/chainmonitor.rs
+++ b/lightning/src/chain/chainmonitor.rs
@@ -727,10 +727,16 @@ impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> even
 
 #[cfg(test)]
 mod tests {
-       use ::{check_added_monitors, get_local_commitment_txn};
+       use bitcoin::BlockHeader;
+       use ::{check_added_monitors, check_closed_broadcast, check_closed_event, expect_payment_sent};
+       use ::{get_local_commitment_txn, get_route_and_payment_hash, unwrap_send_err};
+       use chain::{ChannelMonitorUpdateErr, Confirm, Watch};
+       use chain::channelmonitor::LATENCY_GRACE_PERIOD_BLOCKS;
+       use ln::channelmanager::PaymentSendFailure;
        use ln::features::InitFeatures;
        use ln::functional_test_utils::*;
-       use util::events::MessageSendEventsProvider;
+       use util::errors::APIError;
+       use util::events::{ClosureReason, MessageSendEventsProvider};
        use util::test_utils::{OnRegisterOutput, TxOutReference};
 
        /// Tests that in-block dependent transactions are processed by `block_connected` when not
@@ -775,4 +781,81 @@ mod tests {
                nodes[1].node.get_and_clear_pending_msg_events();
                nodes[1].node.get_and_clear_pending_events();
        }
+
+       fn do_chainsync_pauses_events(block_timeout: bool) {
+               // When a chainsync monitor update occurs, any MonitorUpdates should be held before being
+               // passed upstream to a `ChannelManager` via `Watch::release_pending_monitor_events`. This
+               // tests that behavior, as well as some ways it might go wrong.
+               let chanmon_cfgs = create_chanmon_cfgs(2);
+               let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
+               let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
+               let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
+               let channel = create_announced_chan_between_nodes(
+                       &nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
+
+               // Get a route for later and rebalance the channel somewhat
+               send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
+               let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
+
+               // First route a payment that we will claim on chain and give the recipient the preimage.
+               let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1_000_000).0;
+               nodes[1].node.claim_funds(payment_preimage);
+               nodes[1].node.get_and_clear_pending_msg_events();
+               check_added_monitors!(nodes[1], 1);
+               let remote_txn = get_local_commitment_txn!(nodes[1], channel.2);
+               assert_eq!(remote_txn.len(), 2);
+
+               // Temp-fail the block connection which will hold the channel-closed event
+               chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
+               chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
+
+               // Connect B's commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
+               // channel is now closed, but the ChannelManager doesn't know that yet.
+               let new_header = BlockHeader {
+                       version: 2, time: 0, bits: 0, nonce: 0,
+                       prev_blockhash: nodes[0].best_block_info().0,
+                       merkle_root: Default::default() };
+               nodes[0].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
+                       &[(0, &remote_txn[0]), (1, &remote_txn[1])], nodes[0].best_block_info().1 + 1);
+               assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
+               nodes[0].chain_monitor.chain_monitor.best_block_updated(&new_header, nodes[0].best_block_info().1 + 1);
+               assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
+
+               // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
+               // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
+               chanmon_cfgs[0].persister.set_update_ret(Ok(()));
+               unwrap_send_err!(nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)),
+                       true, APIError::ChannelUnavailable { ref err },
+                       assert!(err.contains("ChannelMonitor storage failure")));
+               check_added_monitors!(nodes[0], 2); // After the failure we generate a close-channel monitor update
+               check_closed_broadcast!(nodes[0], true);
+               check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
+
+               // However, as the ChainMonitor is still waiting for the original persistence to complete,
+               // it won't yet release the MonitorEvents.
+               assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
+
+               if block_timeout {
+                       // After three blocks, pending MontiorEvents should be released either way.
+                       let latest_header = BlockHeader {
+                               version: 2, time: 0, bits: 0, nonce: 0,
+                               prev_blockhash: nodes[0].best_block_info().0,
+                               merkle_root: Default::default() };
+                       nodes[0].chain_monitor.chain_monitor.best_block_updated(&latest_header, nodes[0].best_block_info().1 + LATENCY_GRACE_PERIOD_BLOCKS);
+               } else {
+                       for (funding_outpoint, update_ids) in chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().iter() {
+                               for update_id in update_ids {
+                                       nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(*funding_outpoint, *update_id).unwrap();
+                               }
+                       }
+               }
+
+               expect_payment_sent!(nodes[0], payment_preimage);
+       }
+
+       #[test]
+       fn chainsync_pauses_events() {
+               do_chainsync_pauses_events(false);
+               do_chainsync_pauses_events(true);
+       }
 }