Skip to content

Serve multiple Kademlia requests on one inbound substream #647

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

Open
dharjeezy wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Serve multiple Kademlia requests on one inbound substream #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcae043
Serve multiple Kademlia requests on one inbound substream
dharjeezy Aug 23, 2026
60daf09
Merge master into dami/kad-reuse-inbound-substreams
dharjeezy Sep 29, 2026
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
100 changes: 13 additions & 87 deletions src/protocol/libp2p/kademlia/executor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,30 +188,28 @@ impl QueryExecutor {
}));
}

/// Read message from remote peer with timeout.
pub fn read_message(
&mut self,
peer: PeerId,
query_id: Option<QueryId>,
mut substream: Substream,
) {
/// Wait for a request on a substream the remote peer opened.
///
/// Call this again once the request has been served to keep the substream available for the
/// peer's next request, which also restarts the idle window.
pub fn read_request(&mut self, peer: PeerId, mut substream: Substream) {
self.futures.push(Box::pin(async move {
match tokio::time::timeout(READ_TIMEOUT, substream.next()).await {
Err(_) => QueryContext {
peer,
query_id,
query_id: None,
result: QueryResult::ReadFailure {
reason: FailureReason::Timeout,
},
},
Ok(Some(Ok(message))) => QueryContext {
peer,
query_id,
query_id: None,
result: QueryResult::ReadSuccess { substream, message },
},
Ok(None) | Ok(Some(Err(_))) => QueryContext {
peer,
query_id,
query_id: None,
result: QueryResult::ReadFailure {
reason: FailureReason::SubstreamClosed,
},
Expand Down Expand Up @@ -350,14 +348,14 @@ mod tests {
use crate::{mock::substream::MockSubstream, types::SubstreamId};

#[tokio::test]
async fn substream_read_timeout() {
async fn read_request_idle_timeout() {
let mut executor = QueryExecutor::new();
let peer = PeerId::random();
let mut substream = MockSubstream::new();
substream.expect_poll_next().returning(|_| Poll::Pending);
let substream = Substream::new_mock(peer, SubstreamId::from(0usize), Box::new(substream));

executor.read_message(peer, None, substream);
executor.read_request(peer, substream);

match tokio::time::timeout(Duration::from_secs(20), executor.next()).await {
Ok(Some(QueryContext {
Expand All @@ -379,17 +377,16 @@ mod tests {
}

#[tokio::test]
async fn substream_read_substream_closed() {
async fn read_request_substream_closed() {
let mut executor = QueryExecutor::new();
let peer = PeerId::random();
let mut substream = MockSubstream::new();
substream.expect_poll_next().times(1).return_once(|_| {
Poll::Ready(Some(Err(crate::error::SubstreamError::ConnectionClosed)))
});

executor.read_message(
executor.read_request(
peer,
Some(QueryId(1338)),
Substream::new_mock(peer, SubstreamId::from(0usize), Box::new(substream)),
);

Expand All @@ -400,7 +397,7 @@ mod tests {
result,
})) => {
assert_eq!(peer, queried_peer);
assert_eq!(query_id, Some(QueryId(1338)));
assert!(query_id.is_none());
assert!(std::matches!(
result,
QueryResult::ReadFailure {
Expand Down Expand Up @@ -490,75 +487,4 @@ mod tests {
result => panic!("invalid result received: {result:?}"),
}
}

#[tokio::test]
async fn read_message_timeout() {
let mut executor = QueryExecutor::new();
let peer = PeerId::random();

// prepare substream which succeeds in sending the message but closes right after
let mut substream = MockSubstream::new();
substream.expect_poll_next().returning(|_| Poll::Pending);

executor.read_message(
peer,
Some(QueryId(1336)),
Substream::new_mock(peer, SubstreamId::from(0usize), Box::new(substream)),
);

match tokio::time::timeout(Duration::from_secs(20), executor.next()).await {
Ok(Some(QueryContext {
peer: queried_peer,
query_id,
result,
})) => {
assert_eq!(peer, queried_peer);
assert_eq!(query_id, Some(QueryId(1336)));
assert!(std::matches!(
result,
QueryResult::ReadFailure {
reason: FailureReason::Timeout
}
));
}
result => panic!("invalid result received: {result:?}"),
}
}

#[tokio::test]
async fn read_message_substream_closed() {
let mut executor = QueryExecutor::new();
let peer = PeerId::random();

// prepare substream which succeeds in sending the message but closes right after
let mut substream = MockSubstream::new();
substream
.expect_poll_next()
.times(1)
.return_once(|_| Poll::Ready(Some(Err(crate::error::SubstreamError::ChannelClogged))));

executor.read_message(
peer,
Some(QueryId(1335)),
Substream::new_mock(peer, SubstreamId::from(0usize), Box::new(substream)),
);

match tokio::time::timeout(Duration::from_secs(20), executor.next()).await {
Ok(Some(QueryContext {
peer: queried_peer,
query_id,
result,
})) => {
assert_eq!(peer, queried_peer);
assert_eq!(query_id, Some(QueryId(1335)));
assert!(std::matches!(
result,
QueryResult::ReadFailure {
reason: FailureReason::SubstreamClosed
}
));
}
result => panic!("invalid result received: {result:?}"),
}
}
}
Loading