dev: remove announce event wrapper

Author: da2ce7

packages/primitives/src/announce_event.rs

@@ -7,10 +7,10 @@
 use std::collections::BTreeMap;
 use std::time::Duration;
 
+pub use aquatic_udp_protocol::{AnnounceEvent, AnnounceEventBytes};
 use info_hash::InfoHash;
 use serde::{Deserialize, Serialize};
 
-pub mod announce_event;
 pub mod info_hash;
 pub mod pagination;
 pub mod peer;
@@ -29,6 +29,29 @@ pub fn ser_unix_time_value<S: serde::Serializer>(unix_time_value: &DurationSince
     ser.serialize_u64(unix_time_value.as_millis() as u64)
 }
 
+#[derive(Serialize)]
+pub enum AnnounceEventSer {
+    Started,
+    Stopped,
+    Completed,
+    None,
+}
+
+/// Serializes a `DurationSinceUnixEpoch` as a Unix timestamp in milliseconds.
+/// # Errors
+///
+/// Will return `serde::Serializer::Error` if unable to serialize the `unix_time_value`.
+pub fn ser_announce_event<S: serde::Serializer>(announce_event: &AnnounceEvent, ser: S) -> Result<S::Ok, S::Error> {
+    let event_ser = match announce_event {
+        AnnounceEvent::Started => AnnounceEventSer::Started,
+        AnnounceEvent::Stopped => AnnounceEventSer::Stopped,
+        AnnounceEvent::Completed => AnnounceEventSer::Completed,
+        AnnounceEvent::None => AnnounceEventSer::None,
+    };
+
+    ser.serialize_some(&event_ser)
+}
+
 /// IP version used by the peer to connect to the tracker: IPv4 or IPv6
 #[derive(PartialEq, Eq, Debug)]
 pub enum IPVersion {

packages/primitives/src/lib.rs

@@ -24,10 +24,10 @@
 use std::net::{IpAddr, SocketAddr};
 use std::sync::Arc;
 
+use aquatic_udp_protocol::AnnounceEvent;
 use serde::Serialize;
 
-use crate::announce_event::AnnounceEvent;
-use crate::{ser_unix_time_value, DurationSinceUnixEpoch, IPVersion, NumberOfBytes};
+use crate::{ser_announce_event, ser_unix_time_value, DurationSinceUnixEpoch, IPVersion, NumberOfBytes};
 
 /// Peer struct used by the core `Tracker`.
 ///
@@ -51,7 +51,7 @@ use crate::{ser_unix_time_value, DurationSinceUnixEpoch, IPVersion, NumberOfByte
 ///     event: AnnounceEvent::Started,
 /// };
 /// ```
-#[derive(Debug, Clone, Serialize, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Clone, Serialize, Copy, PartialEq, Eq, Hash)]
 pub struct Peer {
     /// ID used by the downloader peer
     pub peer_id: Id,
@@ -67,9 +67,22 @@ pub struct Peer {
     /// The number of bytes this peer still has to download
     pub left: NumberOfBytes,
     /// This is an optional key which maps to started, completed, or stopped (or empty, which is the same as not being present).
+    #[serde(serialize_with = "ser_announce_event")]
     pub event: AnnounceEvent,
 }
 
+impl Ord for Peer {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.peer_id.cmp(&other.peer_id)
+    }
+}
+
+impl PartialOrd for Peer {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        Some(self.peer_id.cmp(&other.peer_id))
+    }
+}
+
 pub trait ReadInfo {
     fn is_seeder(&self) -> bool;
     fn get_event(&self) -> AnnounceEvent;
@@ -344,8 +357,9 @@ impl<P: Encoding> FromIterator<Peer> for Vec<P> {
 pub mod fixture {
     use std::net::{IpAddr, Ipv4Addr, SocketAddr};
 
+    use aquatic_udp_protocol::AnnounceEvent;
+
     use super::{Id, Peer};
-    use crate::announce_event::AnnounceEvent;
     use crate::{DurationSinceUnixEpoch, NumberOfBytes};
 
     #[derive(PartialEq, Debug)]

packages/primitives/src/peer.rs

@@ -1,10 +1,9 @@
 use std::collections::HashSet;
 use std::net::{IpAddr, Ipv4Addr, SocketAddr};
 
-use torrust_tracker_primitives::announce_event::AnnounceEvent;
 use torrust_tracker_primitives::info_hash::InfoHash;
 use torrust_tracker_primitives::peer::{Id, Peer};
-use torrust_tracker_primitives::{DurationSinceUnixEpoch, NumberOfBytes};
+use torrust_tracker_primitives::{AnnounceEvent, DurationSinceUnixEpoch, NumberOfBytes};
 
 pub const DEFAULT_PEER: Peer = Peer {
     peer_id: Id([0; 20]),

packages/torrent-repository/benches/helpers/utils.rs

@@ -2,10 +2,9 @@ use std::net::SocketAddr;
 use std::sync::Arc;
 
 use torrust_tracker_configuration::TrackerPolicy;
-use torrust_tracker_primitives::announce_event::AnnounceEvent;
 use torrust_tracker_primitives::peer::{self};
 use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::DurationSinceUnixEpoch;
+use torrust_tracker_primitives::{AnnounceEvent, DurationSinceUnixEpoch};
 
 use super::Entry;
 use crate::EntrySingle;

packages/torrent-repository/src/entry/single.rs

@@ -1,8 +1,7 @@
 use std::net::SocketAddr;
 
 use torrust_tracker_clock::clock::Time;
-use torrust_tracker_primitives::announce_event::AnnounceEvent;
-use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch, NumberOfBytes};
+use torrust_tracker_primitives::{peer, AnnounceEvent, DurationSinceUnixEpoch, NumberOfBytes};
 
 use crate::CurrentClock;
 

packages/torrent-repository/tests/common/torrent_peer_builder.rs

@@ -6,9 +6,8 @@ use rstest::{fixture, rstest};
 use torrust_tracker_clock::clock::stopped::Stopped as _;
 use torrust_tracker_clock::clock::{self, Time as _};
 use torrust_tracker_configuration::{TrackerPolicy, TORRENT_PEERS_LIMIT};
-use torrust_tracker_primitives::announce_event::AnnounceEvent;
 use torrust_tracker_primitives::peer::Peer;
-use torrust_tracker_primitives::{peer, NumberOfBytes};
+use torrust_tracker_primitives::{peer, AnnounceEvent, NumberOfBytes};
 use torrust_tracker_torrent_repository::{
     EntryMutexParkingLot, EntryMutexStd, EntryMutexTokio, EntryRwLockParkingLot, EntrySingle,
 };

packages/torrent-repository/tests/entry/mod.rs

@@ -3,11 +3,10 @@ use std::hash::{DefaultHasher, Hash, Hasher};
 
 use rstest::{fixture, rstest};
 use torrust_tracker_configuration::TrackerPolicy;
-use torrust_tracker_primitives::announce_event::AnnounceEvent;
 use torrust_tracker_primitives::info_hash::InfoHash;
 use torrust_tracker_primitives::pagination::Pagination;
 use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::{NumberOfBytes, PersistentTorrents};
+use torrust_tracker_primitives::{AnnounceEvent, NumberOfBytes, PersistentTorrents};
 use torrust_tracker_torrent_repository::entry::Entry as _;
 use torrust_tracker_torrent_repository::repository::dash_map_mutex_std::XacrimonDashMap;
 use torrust_tracker_torrent_repository::repository::rw_lock_std::RwLockStd;

packages/torrent-repository/tests/repository/mod.rs

@@ -55,15 +55,15 @@
 //! Once you have instantiated the `Tracker` you can `announce` a new [`peer::Peer`] with:
 //!
 //! ```rust,no_run
-//! use torrust_tracker_primitives::peer;
-//! use torrust_tracker_primitives::info_hash::InfoHash;
-//! use torrust_tracker_primitives::{DurationSinceUnixEpoch, NumberOfBytes};
-//! use torrust_tracker_primitives::announce_event::AnnounceEvent;
 //! use std::net::SocketAddr;
 //! use std::net::IpAddr;
 //! use std::net::Ipv4Addr;
 //! use std::str::FromStr;
 //!
+//! use aquatic_udp_protocol::AnnounceEvent;
+//! use torrust_tracker_primitives::peer;
+//! use torrust_tracker_primitives::info_hash::InfoHash;
+//! use torrust_tracker_primitives::{DurationSinceUnixEpoch, NumberOfBytes};
 //!
 //! let info_hash = InfoHash::from_str("3b245504cf5f11bbdbe1201cea6a6bf45aee1bc0").unwrap();
 //!
@@ -1198,7 +1198,7 @@ mod tests {
         use std::str::FromStr;
         use std::sync::Arc;
 
-        use torrust_tracker_primitives::announce_event::AnnounceEvent;
+        use aquatic_udp_protocol::AnnounceEvent;
         use torrust_tracker_primitives::info_hash::InfoHash;
         use torrust_tracker_primitives::{DurationSinceUnixEpoch, NumberOfBytes};
         use torrust_tracker_test_helpers::configuration;
@@ -2035,7 +2035,7 @@ mod tests {
 
         mod handling_torrent_persistence {
 
-            use torrust_tracker_primitives::announce_event::AnnounceEvent;
+            use aquatic_udp_protocol::AnnounceEvent;
             use torrust_tracker_torrent_repository::entry::EntrySync;
             use torrust_tracker_torrent_repository::repository::Repository;
 

src/core/mod.rs

@@ -2,9 +2,9 @@
 
 use std::net::{IpAddr, Ipv4Addr, SocketAddr};
 
+use aquatic_udp_protocol::AnnounceEvent;
 use torrust_tracker_clock::clock::stopped::Stopped as _;
 use torrust_tracker_clock::clock::{self, Time};
-use torrust_tracker_primitives::announce_event::AnnounceEvent;
 use torrust_tracker_primitives::{peer, NumberOfBytes};
 
 use crate::CurrentClock;