Merge pull request #2221 from TheBlueMatt/2023-04-bp-exit-fast
authorMatt Corallo <649246+TheBlueMatt@users.noreply.github.com>
Mon, 24 Apr 2023 16:47:47 +0000 (16:47 +0000)
committerGitHub <noreply@github.com>
Mon, 24 Apr 2023 16:47:47 +0000 (16:47 +0000)
Check for `background-processor` exit condition before+after sleep

1  2 
lightning-background-processor/src/lib.rs

index b6b55e1c68a04e2998c5bcfc25090a36b3139438,c6706636433e2862380b7719237a1d1b0465cb72..940da6d2f2cab5f48af273d489a27346c65bf568
@@@ -241,21 -241,26 +241,21 @@@ fn update_scorer<'a, S: 'static + Deref
        let mut score = scorer.lock();
        match event {
                Event::PaymentPathFailed { ref path, short_channel_id: Some(scid), .. } => {
 -                      let path = path.iter().collect::<Vec<_>>();
 -                      score.payment_path_failed(&path, *scid);
 +                      score.payment_path_failed(path, *scid);
                },
                Event::PaymentPathFailed { ref path, payment_failed_permanently: true, .. } => {
                        // Reached if the destination explicitly failed it back. We treat this as a successful probe
                        // because the payment made it all the way to the destination with sufficient liquidity.
 -                      let path = path.iter().collect::<Vec<_>>();
 -                      score.probe_successful(&path);
 +                      score.probe_successful(path);
                },
                Event::PaymentPathSuccessful { path, .. } => {
 -                      let path = path.iter().collect::<Vec<_>>();
 -                      score.payment_path_successful(&path);
 +                      score.payment_path_successful(path);
                },
                Event::ProbeSuccessful { path, .. } => {
 -                      let path = path.iter().collect::<Vec<_>>();
 -                      score.probe_successful(&path);
 +                      score.probe_successful(path);
                },
                Event::ProbeFailed { path, short_channel_id: Some(scid), .. } => {
 -                      let path = path.iter().collect::<Vec<_>>();
 -                      score.probe_failed(&path, *scid);
 +                      score.probe_failed(path, *scid);
                },
                _ => {},
        }
@@@ -297,6 -302,12 +297,12 @@@ macro_rules! define_run_body 
                        // persistence.
                        $peer_manager.process_events();
  
+                       // Exit the loop if the background processor was requested to stop.
+                       if $loop_exit_check {
+                               log_trace!($logger, "Terminating background processor.");
+                               break;
+                       }
                        // We wait up to 100ms, but track how long it takes to detect being put to sleep,
                        // see `await_start`'s use below.
                        let mut await_start = None;
                        let updates_available = $await;
                        let await_slow = if $check_slow_await { $timer_elapsed(&mut await_start.unwrap(), 1) } else { false };
  
-                       if updates_available {
-                               log_trace!($logger, "Persisting ChannelManager...");
-                               $persister.persist_manager(&*$channel_manager)?;
-                               log_trace!($logger, "Done persisting ChannelManager.");
-                       }
                        // Exit the loop if the background processor was requested to stop.
                        if $loop_exit_check {
                                log_trace!($logger, "Terminating background processor.");
                                break;
                        }
+                       if updates_available {
+                               log_trace!($logger, "Persisting ChannelManager...");
+                               $persister.persist_manager(&*$channel_manager)?;
+                               log_trace!($logger, "Done persisting ChannelManager.");
+                       }
                        if $timer_elapsed(&mut last_freshness_call, FRESHNESS_TIMER) {
                                log_trace!($logger, "Calling ChannelManager's timer_tick_occurred");
                                $channel_manager.timer_tick_occurred();
@@@ -762,7 -774,7 +769,7 @@@ mod tests 
        use lightning::ln::msgs::{ChannelMessageHandler, Init};
        use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
        use lightning::routing::gossip::{NetworkGraph, NodeId, P2PGossipSync};
 -      use lightning::routing::router::{DefaultRouter, RouteHop};
 +      use lightning::routing::router::{DefaultRouter, Path, RouteHop};
        use lightning::routing::scoring::{ChannelUsage, Score};
        use lightning::util::config::UserConfig;
        use lightning::util::ser::Writeable;
  
        #[derive(Debug)]
        enum TestResult {
 -              PaymentFailure { path: Vec<RouteHop>, short_channel_id: u64 },
 -              PaymentSuccess { path: Vec<RouteHop> },
 -              ProbeFailure { path: Vec<RouteHop> },
 -              ProbeSuccess { path: Vec<RouteHop> },
 +              PaymentFailure { path: Path, short_channel_id: u64 },
 +              PaymentSuccess { path: Path },
 +              ProbeFailure { path: Path },
 +              ProbeSuccess { path: Path },
        }
  
        impl TestScorer {
                        &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, _usage: ChannelUsage
                ) -> u64 { unimplemented!(); }
  
 -              fn payment_path_failed(&mut self, actual_path: &[&RouteHop], actual_short_channel_id: u64) {
 +              fn payment_path_failed(&mut self, actual_path: &Path, actual_short_channel_id: u64) {
                        if let Some(expectations) = &mut self.event_expectations {
                                match expectations.pop_front().unwrap() {
                                        TestResult::PaymentFailure { path, short_channel_id } => {
 -                                              assert_eq!(actual_path, &path.iter().collect::<Vec<_>>()[..]);
 +                                              assert_eq!(actual_path, &path);
                                                assert_eq!(actual_short_channel_id, short_channel_id);
                                        },
                                        TestResult::PaymentSuccess { path } => {
                        }
                }
  
 -              fn payment_path_successful(&mut self, actual_path: &[&RouteHop]) {
 +              fn payment_path_successful(&mut self, actual_path: &Path) {
                        if let Some(expectations) = &mut self.event_expectations {
                                match expectations.pop_front().unwrap() {
                                        TestResult::PaymentFailure { path, .. } => {
                                                panic!("Unexpected payment path failure: {:?}", path)
                                        },
                                        TestResult::PaymentSuccess { path } => {
 -                                              assert_eq!(actual_path, &path.iter().collect::<Vec<_>>()[..]);
 +                                              assert_eq!(actual_path, &path);
                                        },
                                        TestResult::ProbeFailure { path } => {
                                                panic!("Unexpected probe failure: {:?}", path)
                        }
                }
  
 -              fn probe_failed(&mut self, actual_path: &[&RouteHop], _: u64) {
 +              fn probe_failed(&mut self, actual_path: &Path, _: u64) {
                        if let Some(expectations) = &mut self.event_expectations {
                                match expectations.pop_front().unwrap() {
                                        TestResult::PaymentFailure { path, .. } => {
                                                panic!("Unexpected payment path success: {:?}", path)
                                        },
                                        TestResult::ProbeFailure { path } => {
 -                                              assert_eq!(actual_path, &path.iter().collect::<Vec<_>>()[..]);
 +                                              assert_eq!(actual_path, &path);
                                        },
                                        TestResult::ProbeSuccess { path } => {
                                                panic!("Unexpected probe success: {:?}", path)
                                }
                        }
                }
 -              fn probe_successful(&mut self, actual_path: &[&RouteHop]) {
 +              fn probe_successful(&mut self, actual_path: &Path) {
                        if let Some(expectations) = &mut self.event_expectations {
                                match expectations.pop_front().unwrap() {
                                        TestResult::PaymentFailure { path, .. } => {
                                                panic!("Unexpected probe failure: {:?}", path)
                                        },
                                        TestResult::ProbeSuccess { path } => {
 -                                              assert_eq!(actual_path, &path.iter().collect::<Vec<_>>()[..]);
 +                                              assert_eq!(actual_path, &path);
                                        }
                                }
                        }
                        let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
                        let node_1_id = PublicKey::from_secret_key(&secp_ctx, &node_1_privkey);
  
 -                      let path = vec![RouteHop {
 +                      let path = Path { hops: vec![RouteHop {
                                pubkey: node_1_id,
                                node_features: NodeFeatures::empty(),
                                short_channel_id: scored_scid,
                                channel_features: ChannelFeatures::empty(),
                                fee_msat: 0,
                                cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA as u32,
 -                      }];
 +                      }], blinded_tail: None };
  
                        $nodes[0].scorer.lock().unwrap().expect(TestResult::PaymentFailure { path: path.clone(), short_channel_id: scored_scid });
                        $nodes[0].node.push_pending_event(Event::PaymentPathFailed {