rust-libp2p/protocols/kad/tests/client_mode.rs
Thomas Eizinger 92c8cc451f
feat(kad): implement automatic client mode
Currently, the kademlia behaviour can only learn that the remote node supports kademlia on a particular connection if we successfully negotiate a stream to them.

Using the newly introduced abstractions from #3651, we don't have to attempt to establish a stream to the remote to learn whether they support kademlia on a connection but we can directly learn it from the `ConnectionEvent::RemoteProtocolsChange` event. This happens directly once a connection is established which should overall benefit the DHT.

Clients do not advertise the kademlia protocol and thus we will immediately learn that a given connection is not suitable for kadmelia requests. We may receive inbound messages from it but this does not affect the routing table.

Resolves: #2032.

Pull-Request: #3877.
2023-05-31 09:02:19 +00:00

134 lines
4.3 KiB
Rust

use libp2p_identify as identify;
use libp2p_identity as identity;
use libp2p_kad::store::MemoryStore;
use libp2p_kad::{Kademlia, KademliaConfig, KademliaEvent};
use libp2p_swarm::Swarm;
use libp2p_swarm_test::SwarmExt;
#[async_std::test]
async fn server_gets_added_to_routing_table_by_client() {
let _ = env_logger::try_init();
let mut client = Swarm::new_ephemeral(MyBehaviour::new);
let mut server = Swarm::new_ephemeral(MyBehaviour::new);
server.listen().await;
client.connect(&mut server).await;
let server_peer_id = *server.local_peer_id();
match libp2p_swarm_test::drive(&mut client, &mut server).await {
(
[MyBehaviourEvent::Identify(_), MyBehaviourEvent::Identify(_), MyBehaviourEvent::Kad(KademliaEvent::RoutingUpdated { peer, .. })],
[MyBehaviourEvent::Identify(_), MyBehaviourEvent::Identify(_)],
) => {
assert_eq!(peer, server_peer_id)
}
other => panic!("Unexpected events: {other:?}"),
}
}
#[async_std::test]
async fn two_servers_add_each_other_to_routing_table() {
let _ = env_logger::try_init();
let mut server1 = Swarm::new_ephemeral(MyBehaviour::new);
let mut server2 = Swarm::new_ephemeral(MyBehaviour::new);
server2.listen().await;
server1.connect(&mut server2).await;
let server1_peer_id = *server1.local_peer_id();
let server2_peer_id = *server2.local_peer_id();
use KademliaEvent::*;
use MyBehaviourEvent::*;
match libp2p_swarm_test::drive(&mut server1, &mut server2).await {
(
[Identify(_), Identify(_), Kad(RoutingUpdated { peer: peer1, .. })],
[Identify(_), Identify(_)],
) => {
assert_eq!(peer1, server2_peer_id);
}
other => panic!("Unexpected events: {other:?}"),
}
server1.listen().await;
server2.connect(&mut server1).await;
match libp2p_swarm_test::drive(&mut server2, &mut server1).await {
(
[Identify(_), Kad(RoutingUpdated { peer: peer2, .. }), Identify(_)],
[Identify(_), Identify(_)],
) => {
assert_eq!(peer2, server1_peer_id);
}
other => panic!("Unexpected events: {other:?}"),
}
}
#[async_std::test]
async fn adding_an_external_addresses_activates_server_mode_on_existing_connections() {
let _ = env_logger::try_init();
let mut client = Swarm::new_ephemeral(MyBehaviour::new);
let mut server = Swarm::new_ephemeral(MyBehaviour::new);
let server_peer_id = *server.local_peer_id();
let (memory_addr, _) = server.listen().await;
// Remove memory address to simulate a server that doesn't know its external address.
server.remove_external_address(&memory_addr);
client.dial(memory_addr.clone()).unwrap();
use MyBehaviourEvent::*;
// Do the usual identify send/receive dance.
match libp2p_swarm_test::drive(&mut client, &mut server).await {
([Identify(_), Identify(_)], [Identify(_), Identify(_)]) => {}
other => panic!("Unexpected events: {other:?}"),
}
use KademliaEvent::*;
// Server learns its external address (this could be through AutoNAT or some other mechanism).
server.add_external_address(memory_addr);
// The server reconfigured its connection to the client to be in server mode, pushes that information to client which as a result updates its routing table.
match libp2p_swarm_test::drive(&mut client, &mut server).await {
(
[Identify(identify::Event::Received { .. }), Kad(RoutingUpdated { peer: peer1, .. })],
[Identify(identify::Event::Pushed { .. })],
) => {
assert_eq!(peer1, server_peer_id);
}
other => panic!("Unexpected events: {other:?}"),
}
}
#[derive(libp2p_swarm::NetworkBehaviour)]
#[behaviour(prelude = "libp2p_swarm::derive_prelude")]
struct MyBehaviour {
identify: identify::Behaviour,
kad: Kademlia<MemoryStore>,
}
impl MyBehaviour {
fn new(k: identity::Keypair) -> Self {
let local_peer_id = k.public().to_peer_id();
Self {
identify: identify::Behaviour::new(identify::Config::new(
"/test/1.0.0".to_owned(),
k.public(),
)),
kad: Kademlia::with_config(
local_peer_id,
MemoryStore::new(local_peer_id),
KademliaConfig::default(),
),
}
}
}