Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wpaulino merged 4 commits into from
Jul 19, 2023
Merged

Drop tokio/macros dependency in lightning-net-tokio, fix MSRV #2426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd24643
Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV
TheBlueMatt Jul 17, 2023
4ab32f9
Test MSRV builds (without dev-dependencies) in CI
TheBlueMatt Jul 17, 2023
f6e0ad2
Pin `proc-macro2` in CI to fix MSRV breakage
tnull Jul 17, 2023
f38b80a
Only try to build `lightning-transaction-sync` if we meet its MSRV
TheBlueMatt Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
"lightning-custom-message",
"lightning-transaction-sync",
"no-std-check",
"msrv-no-dev-deps-check",
"bench",
]

Expand Down
42 changes: 34 additions & 8 deletions ci/ci-tests.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.
# lightning-transaction-sync's MSRV is 1.67
cargo check --verbose --color always --features lightning-transaction-sync
else
cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.
PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down
2 changes: 1 addition & 1 deletion lightning-net-tokio/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down
116 changes: 97 additions & 19 deletions lightning-net-tokio/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
pub a: A,
pub b: B,
}

impl<
A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
type Output = SelectorOutput;
fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
match Pin::new(&mut self.a).poll(ctx) {
Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
Poll::Pending => {},
}
match Pin::new(&mut self.b).poll(ctx) {
Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
Poll::Pending => {},
}
Poll::Pending
}
}

pub(crate) struct ThreeSelector<
A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
pub a: A,
pub b: B,
pub c: C,
}

impl<
A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
type Output = SelectorOutput;
fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
match Pin::new(&mut self.a).poll(ctx) {
Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
Poll::Pending => {},
}
match Pin::new(&mut self.b).poll(ctx) {
Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
Poll::Pending => {},
}
match Pin::new(&mut self.c).poll(ctx) {
Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
Poll::Pending => {},
}
Poll::Pending
}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
}
us_lock.read_paused
};
tokio::select! {
v = write_avail_receiver.recv() => {
// TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
let select_result = if read_paused {
TwoSelector {
a: Box::pin(write_avail_receiver.recv()),
b: Box::pin(read_wake_receiver.recv()),
}.await
} else {
ThreeSelector {
a: Box::pin(write_avail_receiver.recv()),
b: Box::pin(read_wake_receiver.recv()),
c: Box::pin(reader.read(&mut buf)),
}.await
};
match select_result {
SelectorOutput::A(v) => {
assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
break Disconnect::CloseConnection;
}
},
_ = read_wake_receiver.recv() => {},
read = reader.read(&mut buf), if !read_paused => match read {
Ok(0) => break Disconnect::PeerDisconnected,
Ok(len) => {
let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
let mut us_lock = us.lock().unwrap();
match read_res {
Ok(pause_read) => {
if pause_read {
us_lock.read_paused = true;
}
},
Err(_) => break Disconnect::CloseConnection,
}
},
Err(_) => break Disconnect::PeerDisconnected,
SelectorOutput::B(_) => {},
SelectorOutput::C(read) => {
match read {
Ok(0) => break Disconnect::PeerDisconnected,
Ok(len) => {
let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
let mut us_lock = us.lock().unwrap();
match read_res {
Ok(pause_read) => {
if pause_read {
us_lock.read_paused = true;
}
},
Err(_) => break Disconnect::CloseConnection,
}
},
Err(_) => break Disconnect::PeerDisconnected,
}
},
}
let _ = event_waker.try_send(());
Expand Down
13 changes: 13 additions & 0 deletions msrv-no-dev-deps-check/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs
View file
Open in desktop
Empty file.
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Drop tokio/macros dependency in lightning-net-tokio, fix MSRV#2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wpaulino
merged 4 commits into

from

Jul 19, 2023
 Merged


Drop tokio/macros dependency in lightning-net-tokio, fix MSRV
#2426
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fd24643

Drop `tokio/macros` dependency in `lightning-net-tokio`, fix MSRV


TheBlueMatt Jul 17, 2023
4ab32f9

Test MSRV builds (without dev-dependencies) in CI


TheBlueMatt Jul 17, 2023
f6e0ad2

Pin `proc-macro2` in CI to fix MSRV breakage


tnull Jul 17, 2023
f38b80a

Only try to build `lightning-transaction-sync` if we meet its MSRV


TheBlueMatt Jul 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ exclude = [
 "lightning-custom-message",
 "lightning-transaction-sync",
 "no-std-check",
 "msrv-no-dev-deps-check",
 "bench",
]

Expand Down

42 changes: 34 additions & 8 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,33 @@ set -eox pipefail
RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
# Some crates require pinning to meet our MSRV even for our downstream users,
# which we do here.
# Further crates which appear only as dev-dependencies are pinned further down.
function PIN_RELEASE_DEPS {
	# Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
	[[ "$RUSTC_MINOR_VERSION" -gt 48 && "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose

# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
	# Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
	[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose

	# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
	[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose

	return 0 # Don't fail the script if our rustc is higher than the last check
}

PIN_RELEASE_DEPS # pin the release dependencies in our main workspace

# The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
[ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose

# The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
# The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose

# The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
[ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose

[ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

Expand DownExpand Up@@ -62,7 +77,18 @@ popd
echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
pushd no-std-check
cargo check --verbose --color always --features lightning-transaction-sync
if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
Comment thread
tnull marked this conversation as resolved.

	# lightning-transaction-sync's MSRV is 1.67
	cargo check --verbose --color always --features lightning-transaction-sync
else
	cargo check --verbose --color always
fi
popd

# Test that we can build downstream code with only the "release pins".
pushd msrv-no-dev-deps-check
Comment thread
tnull marked this conversation as resolved.

PIN_RELEASE_DEPS
cargo check
popd

if [ -f "$(which arm-none-eabi-gcc)" ]; then
Expand Down

2 changes: 1 addition & 1 deletion
lightning-net-tokio/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.29.0"
lightning = { version = "0.0.116-rc1", path = "../lightning" }
tokio = { version = "1.0", features = [ "io-util", "macros", "rt", "sync", "net", "time" ] }
tokio = { version = "1.0", features = [ "io-util", "rt", "sync", "net", "time" ] }

[dev-dependencies]
tokio = { version = "1.14", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] }
Expand Down

116 changes: 97 additions & 19 deletions
lightning-net-tokio/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,79 @@ use lightning::ln::peer_handler::APeerManager;
use lightning::ln::msgs::NetAddress;

use std::ops::Deref;
use std::task;
use std::task::{self, Poll};
use std::future::Future;
use std::net::SocketAddr;
use std::net::TcpStream as StdTcpStream;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use std::pin::Pin;
use std::hash::Hash;

static ID_COUNTER: AtomicU64 = AtomicU64::new(0);

// We only need to select over multiple futures in one place, and taking on the full `tokio/macros`
// dependency tree in order to do so (which has broken our MSRV before) is excessive. Instead, we
// define a trivial two- and three- select macro with the specific types we need and just use that.

pub(crate) enum SelectorOutput {
	A(Option<()>), B(Option<()>), C(tokio::io::Result<usize>),
}

pub(crate) struct TwoSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> {
	pub a: A,
	pub b: B,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin
> Future for TwoSelector<A, B> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

pub(crate) struct ThreeSelector<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> {
	pub a: A,
	pub b: B,
	pub c: C,
}

impl<
	A: Future<Output=Option<()>> + Unpin, B: Future<Output=Option<()>> + Unpin, C: Future<Output=tokio::io::Result<usize>> + Unpin
> Future for ThreeSelector<A, B, C> {
	type Output = SelectorOutput;
	fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context<'_>) -> Poll<SelectorOutput> {
 match Pin::new(&mut self.a).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::A(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.b).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::B(res)); },
 Poll::Pending => {},
 }
 match Pin::new(&mut self.c).poll(ctx) {
 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 Poll::Pending => {},
 }
 Poll::Pending
	}
}

/// Connection contains all our internal state for a connection - we hold a reference to the
/// Connection object (in an Arc<Mutex<>>) in each SocketDescriptor we create as well as in the
/// read future (which is returned by schedule_read).
Expand DownExpand Up@@ -127,29 +190,44 @@ impl Connection {
 }
 us_lock.read_paused
 };
 tokio::select! {
 v = write_avail_receiver.recv() => {
 // TODO: Drop the Box'ing of the futures once Rust has pin-on-stack support.
 let select_result = if read_paused {
 TwoSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 }.await
 } else {
 ThreeSelector {
 a: Box::pin(write_avail_receiver.recv()),
 b: Box::pin(read_wake_receiver.recv()),
 c: Box::pin(reader.read(&mut buf)),
 }.await
 };
 match select_result {
 SelectorOutput::A(v) => {
 assert!(v.is_some()); // We can't have dropped the sending end, its in the us Arc!
 if peer_manager.as_ref().write_buffer_space_avail(&mut our_descriptor).is_err() {
 break Disconnect::CloseConnection;
 }
 },
 _ = read_wake_receiver.recv() => {},
 read = reader.read(&mut buf), if !read_paused => match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 SelectorOutput::B(_) => {},
 SelectorOutput::C(read) => {
 match read {
 Ok(0) => break Disconnect::PeerDisconnected,
 Ok(len) => {
 let read_res = peer_manager.as_ref().read_event(&mut our_descriptor, &buf[0..len]);
 let mut us_lock = us.lock().unwrap();
 match read_res {
 Ok(pause_read) => {
 if pause_read {
 us_lock.read_paused = true;
 }
 },
 Err(_) => break Disconnect::CloseConnection,
 }
 },
 Err(_) => break Disconnect::PeerDisconnected,
 }
 },
 }
 let _ = event_waker.try_send(());
Expand Down

13 changes: 13 additions & 0 deletions
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
[package]
name = "msrv-check"
version = "0.1.0"
edition = "2018"

[dependencies]
lightning = { path = "../lightning" }
lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-client", "rpc-client" ] }
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
Empty file addedmsrv-no-dev-deps-check/src/lib.rs

View file


Open in desktop


Empty file.