protocols/gossipsub: Revert back to wasm_timer for interval (libp2p#2506

) Removed the custom interval implementation and removes support for wasm32-unknown-unknown. See libp2p#2497 for details. Co-authored-by: Diva M <divma@protonmail.com> Co-authored-by: Max Inden <mail@max-inden.de>
jsdanielh · Feb 14, 2022 · 60666f5 · 60666f5
1 parent 7fc342e
commit 60666f5
Show file tree

Hide file tree

Showing 15 changed files with 37 additions and 229 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -69,6 +69,10 @@
   - Update to `libp2p-websocket` `v0.34.0`.
   - Update to `libp2p-yamux` `v0.36.0`.
 
+- Drop support for gossipsub in the wasm32-unknown-unknown target (see [PR 2506]).
+
+[PR 2506]: https://github.com/libp2p/rust-libp2p/pull/2506
+
 ## Version 0.42.1 [2022-02-02]
 
 - Update individual crates.

diff --git a/Cargo.toml b/Cargo.toml
@@ -81,7 +81,6 @@ libp2p-autonat = { version = "0.2.0", path = "protocols/autonat", optional = tru
 libp2p-core = { version = "0.32.0", path = "core",  default-features = false }
 libp2p-dcutr = { version = "0.1.0", path = "protocols/dcutr",  optional = true }
 libp2p-floodsub = { version = "0.34.0", path = "protocols/floodsub", optional = true }
-libp2p-gossipsub = { version = "0.36.0", path = "./protocols/gossipsub", optional = true }
 libp2p-identify = { version = "0.34.0", path = "protocols/identify", optional = true }
 libp2p-kad = { version = "0.35.0", path = "protocols/kad", optional = true }
 libp2p-metrics = { version = "0.4.0", path = "misc/metrics", optional = true }
@@ -111,6 +110,9 @@ libp2p-mdns = { version = "0.35.0", path = "protocols/mdns", optional = true }
 libp2p-tcp = { version = "0.32.0", path = "transports/tcp", default-features = false, optional = true }
 libp2p-websocket = { version = "0.34.0", path = "transports/websocket", optional = true }
 
+[target.'cfg(not(target_os = "unknown"))'.dependencies]
+libp2p-gossipsub = { version = "0.36.0", path = "protocols/gossipsub", optional = true }
+
 [dev-dependencies]
 async-std = { version = "1.6.2", features = ["attributes"] }
 async-trait = "0.1"

diff --git a/misc/metrics/CHANGELOG.md b/misc/metrics/CHANGELOG.md
@@ -14,7 +14,10 @@
 
 - Move from `open-metrics-client` to `prometheus-client` (see [PR 2442]).
 
+- Drop support for gossipsub in wasm32-unknown-unknown target (see [PR 2506]).
+
 [PR 2442]: https://github.com/libp2p/rust-libp2p/pull/2442
+[PR 2506]: https://github.com/libp2p/rust-libp2p/pull/2506
 
 # 0.3.0 [2022-01-27]
 

diff --git a/misc/metrics/Cargo.toml b/misc/metrics/Cargo.toml
@@ -21,14 +21,16 @@ dcutr = ["libp2p-dcutr"]
 [dependencies]
 libp2p-core = { version = "0.32.0", path = "../../core", default-features = false }
 libp2p-dcutr =  { version = "0.1.0", path = "../../protocols/dcutr", optional = true }
-libp2p-gossipsub =  { version = "0.36.0", path = "../../protocols/gossipsub", optional = true }
 libp2p-identify = { version = "0.34.0", path = "../../protocols/identify", optional = true }
 libp2p-kad = { version = "0.35.0", path = "../../protocols/kad", optional = true }
 libp2p-ping = { version = "0.34.0", path = "../../protocols/ping", optional = true }
 libp2p-relay =  { version = "0.7.0", path = "../../protocols/relay", optional = true }
 libp2p-swarm = { version = "0.34.0", path = "../../swarm" }
 prometheus-client = "0.15.0"
 
+[target.'cfg(not(target_os = "unknown"))'.dependencies]
+libp2p-gossipsub =  { version = "0.36.0", path = "../../protocols/gossipsub", optional = true }
+
 [dev-dependencies]
 env_logger = "0.8.1"
 futures = "0.3.1"

diff --git a/misc/metrics/src/lib.rs b/misc/metrics/src/lib.rs
@@ -28,6 +28,7 @@
 #[cfg(feature = "dcutr")]
 mod dcutr;
 #[cfg(feature = "gossipsub")]
+#[cfg(not(target_os = "unknown"))]
 mod gossipsub;
 #[cfg(feature = "identify")]
 mod identify;
@@ -46,6 +47,7 @@ pub struct Metrics {
     #[cfg(feature = "dcutr")]
     dcutr: dcutr::Metrics,
     #[cfg(feature = "gossipsub")]
+    #[cfg(not(target_os = "unknown"))]
     gossipsub: gossipsub::Metrics,
     #[cfg(feature = "identify")]
     identify: identify::Metrics,
@@ -73,6 +75,7 @@ impl Metrics {
             #[cfg(feature = "dcutr")]
             dcutr: dcutr::Metrics::new(sub_registry),
             #[cfg(feature = "gossipsub")]
+            #[cfg(not(target_os = "unknown"))]
             gossipsub: gossipsub::Metrics::new(sub_registry),
             #[cfg(feature = "identify")]
             identify: identify::Metrics::new(sub_registry),

diff --git a/protocols/gossipsub/CHANGELOG.md b/protocols/gossipsub/CHANGELOG.md
@@ -10,9 +10,12 @@
 
 - Merge NetworkBehaviour's inject_\* paired methods (see PR 2445).
 
+- Revert to wasm-timer (see [PR 2506]).
+
 [PR 2442]: https://github.com/libp2p/rust-libp2p/pull/2442
 [PR 2481]: https://github.com/libp2p/rust-libp2p/pull/2481
 [PR 2445]: https://github.com/libp2p/rust-libp2p/pull/2445
+[PR 2506]: https://github.com/libp2p/rust-libp2p/pull/2506
 
 # 0.35.0 [2022-01-27]
 

diff --git a/protocols/gossipsub/Cargo.toml b/protocols/gossipsub/Cargo.toml
@@ -27,10 +27,9 @@ smallvec = "1.6.1"
 prost = "0.9"
 hex_fmt = "0.3.0"
 regex = "1.4.0"
-futures-timer = "3.0.2"
-pin-project = "1.0.8"
-instant = "0.1.11"
 serde = { version = "1", optional = true, features = ["derive"] }
+wasm-timer = "0.2.5"
+instant = "0.1.11"
 # Metrics dependencies
 prometheus-client = "0.15.0"
 

diff --git a/protocols/gossipsub/src/backoff.rs b/protocols/gossipsub/src/backoff.rs
@@ -20,13 +20,13 @@
 
 //! Data structure for efficiently storing known back-off's when pruning peers.
 use crate::topic::TopicHash;
-use instant::Instant;
-use libp2p_core::PeerId;
-use std::collections::{
-    hash_map::{Entry, HashMap},
-    HashSet,
-};
-use std::time::Duration;
+use libp2p_core::PeerId;
+use std::collections::{
+    hash_map::{Entry, HashMap},
+    HashSet,
+};
+use std::time::Duration;
+use wasm_timer::Instant;
 
 #[derive(Copy, Clone)]
 struct HeartbeatIndex(usize);

diff --git a/protocols/gossipsub/src/behaviour.rs b/protocols/gossipsub/src/behaviour.rs
@@ -36,7 +36,6 @@ use prometheus_client::registry::Registry;
 use prost::Message;
 use rand::{seq::SliceRandom, thread_rng};
 
-use instant::Instant;
 use libp2p_core::{
     connection::ConnectionId, identity::Keypair, multiaddr::Protocol::Ip4,
     multiaddr::Protocol::Ip6, ConnectedPoint, Multiaddr, PeerId,
@@ -45,7 +44,9 @@ use libp2p_swarm::{
     dial_opts::{self, DialOpts},
     IntoProtocolsHandler, NetworkBehaviour, NetworkBehaviourAction, NotifyHandler, PollParameters,
 };
+use wasm_timer::Instant;
 
+use crate::backoff::BackoffStorage;
 use crate::config::{GossipsubConfig, ValidationMode};
 use crate::error::{PublishError, SubscriptionError, ValidationError};
 use crate::gossip_promises::GossipPromises;
@@ -63,9 +64,9 @@ use crate::types::{
     GossipsubSubscriptionAction, MessageAcceptance, MessageId, PeerInfo, RawGossipsubMessage,
 };
 use crate::types::{GossipsubRpc, PeerConnections, PeerKind};
-use crate::{backoff::BackoffStorage, interval::Interval};
 use crate::{rpc_proto, TopicScoreParams};
 use std::{cmp::Ordering::Equal, fmt::Debug};
+use wasm_timer::Interval;
 
 #[cfg(test)]
 mod tests;
@@ -439,8 +440,8 @@ where
                 config.backoff_slack(),
             ),
             mcache: MessageCache::new(config.history_gossip(), config.history_length()),
-            heartbeat: Interval::new_initial(
-                config.heartbeat_initial_delay(),
+            heartbeat: Interval::new_at(
+                Instant::now() + config.heartbeat_initial_delay(),
                 config.heartbeat_interval(),
             ),
             heartbeat_ticks: 0,

diff --git a/protocols/gossipsub/src/gossip_promises.rs b/protocols/gossipsub/src/gossip_promises.rs
@@ -21,10 +21,10 @@
 use crate::error::ValidationError;
 use crate::peer_score::RejectReason;
 use crate::MessageId;
-use instant::Instant;
 use libp2p_core::PeerId;
 use log::debug;
 use std::collections::HashMap;
+use wasm_timer::Instant;
 
 /// Tracks recently sent `IWANT` messages and checks if peers respond to them.
 #[derive(Default)]

diff --git a/protocols/gossipsub/src/interval.rs b/protocols/gossipsub/src/interval.rs
diff --git a/protocols/gossipsub/src/lib.rs b/protocols/gossipsub/src/lib.rs
@@ -142,7 +142,6 @@ mod behaviour;
 mod config;
 mod gossip_promises;
 mod handler;
-mod interval;
 mod mcache;
 pub mod metrics;
 mod peer_score;