Replace `futures` `select` with our own select enum to fix MSRV
authorMatt Corallo <git@bluematt.me>
Thu, 30 Mar 2023 21:52:03 +0000 (21:52 +0000)
committerMatt Corallo <git@bluematt.me>
Fri, 31 Mar 2023 00:01:40 +0000 (00:01 +0000)
`futures` recently broke our MSRV by bumping the `syn` major
version in a patch release. This makes it impractical for us to
use, instead here we replace the usage of its `select_biased` macro
with a trivial enum.

Given its simplicity we likely should have done this without ever
taking the dependency.

lightning-background-processor/Cargo.toml
lightning-background-processor/src/lib.rs

index 6a4925a0be007b6609d4e2ef2f0f10ac3066932c..fe4f272385832f1798d04415313fc876d3870ede 100644 (file)
@@ -23,7 +23,7 @@ default = ["std"]
 bitcoin = { version = "0.29.0", default-features = false }
 lightning = { version = "0.0.114", path = "../lightning", default-features = false }
 lightning-rapid-gossip-sync = { version = "0.0.114", path = "../lightning-rapid-gossip-sync", default-features = false }
-futures-util = { version = "0.3", default-features = false, features = ["async-await-macro"], optional = true }
+futures-util = { version = "0.3", default-features = false, optional = true }
 
 [dev-dependencies]
 lightning = { version = "0.0.114", path = "../lightning", features = ["_test_utils"] }
index 665bdf543841176796bef758f37951ed736ace23..e15458d54b22c101c63d5961d11cd6182515e398 100644 (file)
@@ -53,7 +53,7 @@ use std::thread::{self, JoinHandle};
 use std::time::Instant;
 
 #[cfg(feature = "futures")]
-use futures_util::{select_biased, future::FutureExt, task};
+use futures_util::task;
 #[cfg(not(feature = "std"))]
 use alloc::vec::Vec;
 
@@ -384,6 +384,40 @@ macro_rules! define_run_body {
        } }
 }
 
+#[cfg(feature = "futures")]
+use core::future::Future;
+#[cfg(feature = "futures")]
+use core::task::Poll;
+#[cfg(feature = "futures")]
+use core::pin::Pin;
+#[cfg(feature = "futures")]
+use core::marker::Unpin;
+#[cfg(feature = "futures")]
+struct Selector<A: Future<Output=()> + Unpin, B: Future<Output=bool> + Unpin> {
+       a: A,
+       b: B,
+}
+#[cfg(feature = "futures")]
+enum SelectorOutput {
+       A, B(bool),
+}
+
+#[cfg(feature = "futures")]
+impl<A: Future<Output=()> + Unpin, B: Future<Output=bool> + Unpin> Future for Selector<A, B> {
+       type Output = SelectorOutput;
+       fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<SelectorOutput> {
+               match Pin::new(&mut self.a).poll(ctx) {
+                       Poll::Ready(()) => { return Poll::Ready(SelectorOutput::A); },
+                       Poll::Pending => {},
+               }
+               match Pin::new(&mut self.b).poll(ctx) {
+                       Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
+                       Poll::Pending => {},
+               }
+               Poll::Pending
+       }
+}
+
 /// Processes background events in a future.
 ///
 /// `sleeper` should return a future which completes in the given amount of time and returns a
@@ -470,9 +504,13 @@ where
                chain_monitor, chain_monitor.process_pending_events_async(async_event_handler).await,
                channel_manager, channel_manager.process_pending_events_async(async_event_handler).await,
                gossip_sync, peer_manager, logger, scorer, should_break, {
-                       select_biased! {
-                               _ = channel_manager.get_persistable_update_future().fuse() => true,
-                               exit = sleeper(Duration::from_millis(100)).fuse() => {
+                       let fut = Selector {
+                               a: channel_manager.get_persistable_update_future(),
+                               b: sleeper(Duration::from_millis(100)),
+                       };
+                       match fut.await {
+                               SelectorOutput::A => true,
+                               SelectorOutput::B(exit) => {
                                        should_break = exit;
                                        false
                                }