Skip to content
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

Jump to bottom

swarm/: include ListenerId in SwarmEvents #2123

Merged
merged 3 commits into from
Jul 8, 2021
Merged

swarm/: include ListenerId in SwarmEvents #2123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9b086b
swarm/: include ListenerId in SwarmEvents
elenaf9 Jul 6, 2021
567c938
swarm/: fix docs and examples, add changelog
elenaf9 Jul 7, 2021
8e76741
protocols/relay/test: consistent variable names
elenaf9 Jul 8, 2021
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
4 changes: 2 additions & 2 deletions examples/chat-tokio.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
swarm.behaviour_mut().floodsub.publish(floodsub_topic.clone(), line.as_bytes());
}
event = swarm.select_next_some() => {
if let SwarmEvent::NewListenAddr(addr) = event {
println!("Listening on {:?}", addr);
if let SwarmEvent::NewListenAddr { address, .. } = event {
println!("Listening on {:?}", address);
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions examples/chat.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
loop {
match swarm.poll_next_unpin(cx) {
Poll::Ready(Some(event)) => {
if let SwarmEvent::NewListenAddr(addr) = event {
println!("Listening on {:?}", addr);
if let SwarmEvent::NewListenAddr { address, .. } = event {
println!("Listening on {:?}", address);
}
}
Poll::Ready(None) => return Poll::Ready(Ok(())),
Expand Down
4 changes: 2 additions & 2 deletions examples/distributed-key-value-store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
loop {
match swarm.poll_next_unpin(cx) {
Poll::Ready(Some(event)) => {
if let SwarmEvent::NewListenAddr(addr) = event {
println!("Listening on {:?}", addr);
if let SwarmEvent::NewListenAddr { address, .. } = event {
println!("Listening on {:?}", address);
}
}
Poll::Ready(None) => return Poll::Ready(Ok(())),
Expand Down
4 changes: 2 additions & 2 deletions examples/gossipsub-chat.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
id,
peer_id
),
SwarmEvent::NewListenAddr(addr) => {
println!("Listening on {:?}", addr);
SwarmEvent::NewListenAddr { address, .. } => {
println!("Listening on {:?}", address);
}
_ => {}
},
Expand Down
4 changes: 2 additions & 2 deletions examples/ipfs-private.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,8 +287,8 @@ fn main() -> Result<(), Box<dyn Error>> {
loop {
match swarm.poll_next_unpin(cx) {
Poll::Ready(Some(event)) => {
if let SwarmEvent::NewListenAddr(addr) = event {
println!("Listening on {:?}", addr);
if let SwarmEvent::NewListenAddr { address, .. } = event {
println!("Listening on {:?}", address);
}
}
Poll::Ready(None) => return Poll::Ready(Ok(())),
Expand Down
2 changes: 1 addition & 1 deletion examples/ping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ fn main() -> Result<(), Box<dyn Error>> {
block_on(future::poll_fn(move |cx| loop {
match swarm.poll_next_unpin(cx) {
Poll::Ready(Some(event)) => match event {
SwarmEvent::NewListenAddr(addr) => println!("Listening on {:?}", addr),
SwarmEvent::NewListenAddr{ address, .. } => println!("Listening on {:?}", address),
SwarmEvent::Behaviour(event) => println!("{:?}", event),
_ => {}
},
Expand Down
4 changes: 2 additions & 2 deletions protocols/identify/src/identify.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ mod tests {
let swarm1_fut = swarm1.select_next_some();
pin_mut!(swarm1_fut);
match swarm1_fut.await {
SwarmEvent::NewListenAddr(addr) => return addr,
SwarmEvent::NewListenAddr { address, .. } => return address,
_ => {}
}
}
Expand Down Expand Up @@ -577,7 +577,7 @@ mod tests {
let swarm1_fut = swarm1.select_next_some();
pin_mut!(swarm1_fut);
match swarm1_fut.await {
SwarmEvent::NewListenAddr(addr) => return addr,
SwarmEvent::NewListenAddr { address, .. } => return address,
_ => {}
}
}
Expand Down
4 changes: 2 additions & 2 deletions protocols/ping/tests/ping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ fn ping_pong() {
let peer1 = async move {
loop {
match swarm1.select_next_some().await {
SwarmEvent::NewListenAddr(listener) => tx.send(listener).await.unwrap(),
SwarmEvent::NewListenAddr { address, .. } => tx.send(address).await.unwrap(),
SwarmEvent::Behaviour(PingEvent { peer, result: Ok(PingSuccess::Ping { rtt }) }) => {
count1 -= 1;
if count1 == 0 {
Expand Down Expand Up @@ -137,7 +137,7 @@ fn max_failures() {

loop {
match swarm1.select_next_some().await {
SwarmEvent::NewListenAddr(listener) => tx.send(listener).await.unwrap(),
SwarmEvent::NewListenAddr { address, .. } => tx.send(address).await.unwrap(),
SwarmEvent::Behaviour(PingEvent {
result: Ok(PingSuccess::Ping { .. }), ..
}) => {
Expand Down
4 changes: 2 additions & 2 deletions protocols/relay/examples/relay.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ fn main() -> Result<(), Box<dyn Error>> {
loop {
match swarm.poll_next_unpin(cx) {
Poll::Ready(Some(event)) => match event {
SwarmEvent::NewListenAddr(addr) => {
print_listener_peer(&addr, &opt.mode, local_peer_id)
SwarmEvent::NewListenAddr { address, .. } => {
print_listener_peer(&address, &opt.mode, local_peer_id)
}
_ => println!("{:?}", event),
},
Expand Down
84 changes: 62 additions & 22 deletions protocols/relay/tests/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ fn src_connect_to_dst_listening_via_relay() {
relay_swarm.listen_on(relay_addr.clone()).unwrap();
spawn_swarm_on_pool(&pool, relay_swarm);

dst_swarm.listen_on(dst_listen_addr_via_relay.clone()).unwrap();
let dst_listener = dst_swarm
.listen_on(dst_listen_addr_via_relay.clone())
.unwrap();

pool.run_until(async {
// Destination Node dialing Relay.
Expand All @@ -93,7 +95,13 @@ fn src_connect_to_dst_listening_via_relay() {
// Destination Node reporting listen address via relay.
loop {
match dst_swarm.select_next_some().await {
SwarmEvent::NewListenAddr(addr) if addr == dst_listen_addr_via_relay => break,
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener => {
assert_eq!(address, dst_listen_addr_via_relay);
break;
}
SwarmEvent::Behaviour(CombinedEvent::Ping(_)) => {}
SwarmEvent::Behaviour(CombinedEvent::Kad(KademliaEvent::RoutingUpdated {
..
Expand Down Expand Up @@ -282,14 +290,20 @@ fn src_connect_to_dst_via_established_connection_to_relay() {
relay_swarm.listen_on(relay_addr.clone()).unwrap();
spawn_swarm_on_pool(&pool, relay_swarm);

dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
let dst_listener = dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
// Wait for destination to listen via relay.
pool.run_until(async {
loop {
match dst_swarm.select_next_some().await {
SwarmEvent::Dialing(_) => {}
SwarmEvent::ConnectionEstablished { .. } => {}
SwarmEvent::NewListenAddr(addr) if addr == dst_addr_via_relay => break,
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener => {
assert_eq!(address, dst_addr_via_relay);
break;
}
e => panic!("{:?}", e),
}
}
Expand Down Expand Up @@ -531,7 +545,7 @@ fn firewalled_src_discover_firewalled_dst_via_kad_and_connect_to_dst_via_routabl
spawn_swarm_on_pool(&pool, relay_swarm);

// Destination Node listen via Relay.
dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
let dst_listener = dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();

pool.run_until(async {
// Destination Node dialing Relay.
Expand All @@ -556,7 +570,13 @@ fn firewalled_src_discover_firewalled_dst_via_kad_and_connect_to_dst_via_routabl
// Destination Node reporting listen address via relay.
loop {
match dst_swarm.select_next_some().await {
SwarmEvent::NewListenAddr(addr) if addr == dst_addr_via_relay => break,
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener => {
assert_eq!(address, dst_addr_via_relay);
break;
}
SwarmEvent::Behaviour(CombinedEvent::Ping(_)) => {}
SwarmEvent::Behaviour(CombinedEvent::Kad(KademliaEvent::RoutingUpdated {
..
Expand Down Expand Up @@ -715,14 +735,20 @@ fn inactive_connection_timeout() {
relay_swarm.listen_on(relay_addr.clone()).unwrap();
spawn_swarm_on_pool(&pool, relay_swarm);

dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
let new_listener = dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
// Wait for destination to listen via relay.
pool.run_until(async {
loop {
match dst_swarm.select_next_some().await {
SwarmEvent::Dialing(_) => {}
SwarmEvent::ConnectionEstablished { .. } => {}
SwarmEvent::NewListenAddr(addr) if addr == dst_addr_via_relay => break,
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == new_listener => {
assert_eq!(address, dst_addr_via_relay);
break;
}
e => panic!("{:?}", e),
}
}
Expand Down Expand Up @@ -789,14 +815,20 @@ fn concurrent_connection_same_relay_same_dst() {
relay_swarm.listen_on(relay_addr.clone()).unwrap();
spawn_swarm_on_pool(&pool, relay_swarm);

dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
let dst_listener = dst_swarm.listen_on(dst_addr_via_relay.clone()).unwrap();
// Wait for destination to listen via relay.
pool.run_until(async {
loop {
match dst_swarm.select_next_some().await {
SwarmEvent::Dialing(_) => {}
SwarmEvent::ConnectionEstablished { .. } => {}
SwarmEvent::NewListenAddr(addr) if addr == dst_addr_via_relay => break,
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener => {
assert_eq!(address, dst_addr_via_relay);
break;
}
e => panic!("{:?}", e),
}
}
Expand Down Expand Up @@ -904,10 +936,10 @@ fn yield_incoming_connection_through_correct_listener() {
relay_3_swarm.listen_on(relay_3_addr.clone()).unwrap();
spawn_swarm_on_pool(&pool, relay_3_swarm);

dst_swarm.listen_on(relay_1_addr_incl_circuit.clone()).unwrap();
dst_swarm.listen_on(relay_2_addr_incl_circuit.clone()).unwrap();
let dst_listener_via_relay_1 = dst_swarm.listen_on(relay_1_addr_incl_circuit.clone()).unwrap();
let dst_listener_via_relay_2 = dst_swarm.listen_on(relay_2_addr_incl_circuit.clone()).unwrap();
// Listen on own address in order for relay 3 to be able to connect to destination node.
dst_swarm.listen_on(dst_addr.clone()).unwrap();
let dst_listener = dst_swarm.listen_on(dst_addr.clone()).unwrap();

// Wait for destination node to establish connections to relay 1 and 2.
pool.run_until(async {
Expand All @@ -924,10 +956,18 @@ fn yield_incoming_connection_through_correct_listener() {
break;
}
}
SwarmEvent::NewListenAddr(addr)
if addr == relay_1_addr_incl_circuit
|| addr == relay_2_addr_incl_circuit
|| addr == dst_addr => {}
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener_via_relay_2 => assert_eq!(address, relay_2_addr_incl_circuit),
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener_via_relay_1 => assert_eq!(address, relay_1_addr_incl_circuit),
SwarmEvent::NewListenAddr {
address,
listener_id,
} if listener_id == dst_listener => assert_eq!(address, dst_addr),
SwarmEvent::Behaviour(CombinedEvent::Ping(_)) => {}
e => panic!("{:?}", e),
}
Expand Down Expand Up @@ -966,10 +1006,10 @@ fn yield_incoming_connection_through_correct_listener() {
unreachable!();
}
}
SwarmEvent::NewListenAddr(addr)
if addr == relay_1_addr_incl_circuit
|| addr == relay_2_addr_incl_circuit
|| addr == dst_addr => {}
SwarmEvent::NewListenAddr { address, .. }
if address == relay_1_addr_incl_circuit
|| address == relay_2_addr_incl_circuit
|| address == dst_addr => {}
SwarmEvent::Behaviour(CombinedEvent::Ping(PingEvent {
peer,
result: Ok(_),
Expand Down Expand Up @@ -1044,7 +1084,7 @@ fn yield_incoming_connection_through_correct_listener() {
pool.run_until(async {
loop {
match dst_swarm.select_next_some().await {
SwarmEvent::NewListenAddr(addr) if addr == Protocol::P2pCircuit.into() => break,
SwarmEvent::NewListenAddr { address, .. } if address == Protocol::P2pCircuit.into() => break,
SwarmEvent::Behaviour(CombinedEvent::Ping(_)) => {}
SwarmEvent::Behaviour(CombinedEvent::Kad(KademliaEvent::RoutingUpdated {
..
Expand Down
4 changes: 2 additions & 2 deletions protocols/request-response/tests/ping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ fn ping_protocol() {
let peer1 = async move {
loop {
match swarm1.select_next_some().await {
SwarmEvent::NewListenAddr(addr) => tx.send(addr).await.unwrap(),
SwarmEvent::NewListenAddr { address, .. }=> tx.send(address).await.unwrap(),
SwarmEvent::Behaviour(RequestResponseEvent::Message {
peer,
message: RequestResponseMessage::Request { request, channel, .. }
Expand Down Expand Up @@ -312,7 +312,7 @@ fn ping_protocol_throttled() {
let peer1 = async move {
for i in 1 .. {
match swarm1.select_next_some().await {
SwarmEvent::NewListenAddr(addr) => tx.send(addr).await.unwrap(),
SwarmEvent::NewListenAddr { address, .. } => tx.send(address).await.unwrap(),
SwarmEvent::Behaviour(throttled::Event::Event(RequestResponseEvent::Message {
peer,
message: RequestResponseMessage::Request { request, channel, .. },
Expand Down
4 changes: 2 additions & 2 deletions src/tutorial.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,8 @@
//! block_on(future::poll_fn(move |cx| loop {
//! match swarm.poll_next_unpin(cx) {
//! Poll::Ready(Some(event)) => {
//! if let SwarmEvent::NewListenAddr(addr) = event {
//! println!("Listening on {:?}", addr);
//! if let SwarmEvent::NewListenAddr { address, .. }= event {
//! println!("Listening on {:?}", address);
//! }
//! },
//! Poll::Ready(None) => return Poll::Ready(()),
Expand Down
5 changes: 5 additions & 0 deletions swarm/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,13 @@
`NetworkBehaviourAction::CloseConnection` to close connections to a specific
peer via an `ExpandedSwarm` or `NetworkBehaviour`. See [PR 2110] for details.

- Expose the `ListenerId` in `SwarmEvent`s that are associated with a listener.

See [PR 2123] for details.

[PR 2100]: https://github.com/libp2p/rust-libp2p/pull/2100
[PR 2110]: https://github.com/libp2p/rust-libp2p/pull/2110/
[PR 2123]: https://github.com/libp2p/rust-libp2p/pull/2123

# 0.29.0 [2021-04-13]

Expand Down
Loading