feat: let old nodes open ws listen by default

nervosnetwork · Dec 5, 2024 · 52b5ec1 · 52b5ec1
1 parent 9df053c
commit 52b5ec1
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 24 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/network/src/network.rs b/network/src/network.rs
@@ -1163,30 +1163,58 @@ impl NetworkService {
             let p2p_control: ServiceAsyncControl = p2p_control.clone().into();
             handle.spawn_task(async move {
                 #[cfg(not(target_family = "wasm"))]
-                for addr in &config.listen_addresses {
-                    match p2p_service.listen(addr.to_owned()).await {
-                        Ok(listen_address) => {
-                            info!("Listen on address: {}", listen_address);
-                            network_state
-                                .listened_addrs
-                                .write()
-                                .push(listen_address.clone());
-                        }
-                        Err(err) => {
-                            warn!(
-                                "Listen on address {} failed, due to error: {}",
-                                addr.clone(),
-                                err
-                            );
-                            start_sender
-                                .send(Err(Error::P2P(P2PError::Transport(err))))
-                                .expect("channel abnormal shutdown");
-                            return;
+                {
+                    let listen_addresses = {
+                        let mut addresses = config.listen_addresses.clone();
+                        if config.reuse_tcp_with_ws {
+                            let has_ws = addresses
+                                .iter()
+                                .any(|a| matches!(find_type(a), TransportType::Ws));
+                            if !has_ws {
+                                let ws_listen = {
+                                    let mut addr = addresses
+                                        .iter()
+                                        .find(|a| matches!(find_type(a), TransportType::Tcp))
+                                        .expect("Tcp listen must exsit")
+                                        .clone();
+                                    addr.push(Protocol::Ws);
+                                    addr
+                                };
+                                addresses.push(ws_listen);
+                            }
                         }
+                        addresses
+                            .into_iter()
+                            .collect::<HashSet<_>>()
+                            .into_iter()
+                            .collect::<Vec<_>>()
                     };
+
+                    for addr in &listen_addresses {
+                        match p2p_service.listen(addr.to_owned()).await {
+                            Ok(listen_address) => {
+                                info!("Listen on address: {}", listen_address);
+                                network_state
+                                    .listened_addrs
+                                    .write()
+                                    .push(listen_address.clone());
+                            }
+                            Err(err) => {
+                                warn!(
+                                    "Listen on address {} failed, due to error: {}",
+                                    addr.clone(),
+                                    err
+                                );
+                                start_sender
+                                    .send(Err(Error::P2P(P2PError::Transport(err))))
+                                    .expect("channel abnormal shutdown");
+                                return;
+                            }
+                        };
+                    }
+                    start_sender.send(Ok(())).unwrap();
                 }
-                #[cfg(not(target_family = "wasm"))]
-                start_sender.send(Ok(())).unwrap();
+
                 p2p::runtime::spawn(async move { p2p_service.run().await });
                 tokio::select! {
                     _ = receiver.cancelled() => {

diff --git a/resource/ckb.toml b/resource/ckb.toml
@@ -84,6 +84,8 @@ bootnodes = [] # {{
 # whitelist_peers = []
 ### Enable `SO_REUSEPORT` feature to reuse port on Linux, not supported on other OS yet
 # reuse_port_on_linux = true
+### Allow ckb to upgrade tcp listening to tcp + ws listening when only tcp listening is found
+# reuse_tcp_with_ws = true
 
 max_peers = 125
 max_outbound_peers = 8

diff --git a/util/app-config/src/configs/network.rs b/util/app-config/src/configs/network.rs
@@ -83,6 +83,9 @@ pub struct Config {
     /// Network use reuse port or not
     #[serde(default = "default_reuse")]
     pub reuse_port_on_linux: bool,
+    /// Allow ckb to upgrade tcp listening to tcp + ws listening when only tcp listening is found
+    #[serde(default = "default_reuse_tcp_with_ws")]
+    pub reuse_tcp_with_ws: bool,
     /// Chain synchronization config options.
     #[serde(default)]
     pub sync: SyncConfig,
@@ -353,3 +356,9 @@ impl Config {
 const fn default_reuse() -> bool {
     true
 }
+
+/// By default, allow ckb to upgrade tcp listening to tcp + ws listening
+/// when only tcp listening is found
+const fn default_reuse_tcp_with_ws() -> bool {
+    true
+}