feat: make ping config unconfigurable, use default ping config instead

Author: varex83

crates/charon-p2p/src/behaviours/pluto.rs

@@ -1,10 +1,8 @@
 //! Pluto behaviour.
 
-use std::time::Duration;
-
 use libp2p::{identify, identity::Keypair, ping, relay, swarm::NetworkBehaviour};
 
-use crate::gater::ConnGater;
+use crate::{config::default_ping_config, gater::ConnGater};
 
 /// Pluto network behaviour.
 #[derive(NetworkBehaviour)]
@@ -36,17 +34,13 @@ impl PlutoBehaviour {
 pub struct PlutoBehaviourBuilder {
     gater: Option<ConnGater>,
     identify_protocol: String,
-    ping_interval: Duration,
-    ping_timeout: Duration,
 }
 
 impl Default for PlutoBehaviourBuilder {
     fn default() -> Self {
         Self {
             gater: None,
             identify_protocol: "/pluto/1.0.0-alpha".into(),
-            ping_interval: Duration::from_secs(1),
-            ping_timeout: Duration::from_secs(2),
         }
     }
 }
@@ -69,18 +63,6 @@ impl PlutoBehaviourBuilder {
         self
     }
 
-    /// Sets the ping interval.
-    pub fn with_ping_interval(mut self, interval: Duration) -> Self {
-        self.ping_interval = interval;
-        self
-    }
-
-    /// Sets the ping timeout.
-    pub fn with_ping_timeout(mut self, timeout: Duration) -> Self {
-        self.ping_timeout = timeout;
-        self
-    }
-
     /// Builds the [`PlutoBehaviour`] with the provided keypair and relay
     /// client.
     pub fn build(self, key: &Keypair, relay_client: relay::client::Behaviour) -> PlutoBehaviour {
@@ -93,11 +75,7 @@ impl PlutoBehaviourBuilder {
                 self.identify_protocol,
                 key.public(),
             )),
-            ping: ping::Behaviour::new(
-                ping::Config::new()
-                    .with_interval(self.ping_interval)
-                    .with_timeout(self.ping_timeout),
-            ),
+            ping: ping::Behaviour::new(default_ping_config()),
         }
     }
 }

crates/charon-p2p/src/config.rs

@@ -3,9 +3,10 @@
 use std::{
     net::{IpAddr, SocketAddr},
     str::FromStr,
+    time::Duration,
 };
 
-use libp2p::{Multiaddr, multiaddr};
+use libp2p::{Multiaddr, multiaddr, ping};
 
 /// P2P configuration error.
 #[derive(Debug, thiserror::Error)]
@@ -161,6 +162,18 @@ impl P2PConfigBuilder {
     }
 }
 
+/// The default ping interval.
+pub const DEFAULT_PING_INTERVAL: Duration = Duration::from_secs(1);
+/// The default ping timeout.
+pub const DEFAULT_PING_TIMEOUT: Duration = Duration::from_secs(5);
+
+/// Returns the default ping configuration.
+pub fn default_ping_config() -> ping::Config {
+    ping::Config::new()
+        .with_interval(DEFAULT_PING_INTERVAL)
+        .with_timeout(DEFAULT_PING_TIMEOUT)
+}
+
 /// Resolves a TCP address string to a SocketAddr, ensuring the IP is specified.
 fn resolve_listen_tcp_addr(addr: impl AsRef<str>) -> Result<SocketAddr> {
     let socket_addr: SocketAddr = addr

crates/relay-server/src/behaviour.rs

@@ -1,8 +1,6 @@
 #![allow(missing_docs)] // we need to allow missing docs for the derive macro
 //! Relay server behaviour.
 
-use std::time::Duration;
-
 use libp2p::{identify, identity::Keypair, ping, relay, swarm::NetworkBehaviour};
 
 use charon_p2p::gater::ConnGater;
@@ -36,8 +34,6 @@ impl RelayServerBehaviour {
 pub struct RelayServerBehaviourBuilder {
     gater: Option<ConnGater>,
     identify_protocol: String,
-    ping_interval: Duration,
-    ping_timeout: Duration,
     relay_config: Option<relay::Config>,
 }
 
@@ -46,8 +42,6 @@ impl Default for RelayServerBehaviourBuilder {
         Self {
             gater: None,
             identify_protocol: "/pluto/relay/1.0.0-alpha".into(),
-            ping_interval: Duration::from_secs(1),
-            ping_timeout: Duration::from_secs(2),
             relay_config: None,
         }
     }
@@ -71,18 +65,6 @@ impl RelayServerBehaviourBuilder {
         self
     }
 
-    /// Sets the ping interval.
-    pub fn with_ping_interval(mut self, interval: Duration) -> Self {
-        self.ping_interval = interval;
-        self
-    }
-
-    /// Sets the ping timeout.
-    pub fn with_ping_timeout(mut self, timeout: Duration) -> Self {
-        self.ping_timeout = timeout;
-        self
-    }
-
     /// Sets the relay server configuration.
     pub fn with_relay_config(mut self, config: relay::Config) -> Self {
         self.relay_config = Some(config);
@@ -100,11 +82,7 @@ impl RelayServerBehaviourBuilder {
                 self.identify_protocol,
                 key.public(),
             )),
-            ping: ping::Behaviour::new(
-                ping::Config::new()
-                    .with_interval(self.ping_interval)
-                    .with_timeout(self.ping_timeout),
-            ),
+            ping: ping::Behaviour::new(charon_p2p::config::default_ping_config()),
             gater: self
                 .gater
                 .unwrap_or_else(|| ConnGater::new_conn_gater(vec![], vec![])),