Merge #1361: Refactor: rename TorrentsMetrics to AggregateSwarmMetadata

144a338 refactor: [#1243] move and rename struct and fields (AggregateSwarmMetadata) (Jose Celano)
2020162 chore: [#1243] minor changes in comments and format (Jose Celano)

Pull request description:

  `TorrentsMetrics` has been refactored and moved to the `swarm_metadata` module.

  From (`packages/primitives/src/torrent_metrics.rs`):

  ```rust
  pub struct TorrentsMetrics {
      pub complete: u64,
      pub downloaded: u64,
      pub incomplete: u64,
      pub torrents: u64,
  }
  ```

  To (`packages/primitives/src/swarm_metadata.rs`):

  ```rust
  pub struct AggregateSwarmMetadata {
      pub total_complete: u64,
      pub total_downloaded: u64,
      pub total_incomplete: u64,
      pub total_torrents: u64,
  }
  ```

ACKs for top commit:
  josecelano:
    ACK 144a338

Tree-SHA512: 2c1c9fbbf602921a94ce4cd51ebe332a3b4d53680abecc6899ff8a79fafe07ae055da678e205911b40c0648b8c473e9140272e384be71f85d96a1c0b74c3ce3c

Author: josecelano

packages/axum-rest-tracker-api-server/src/v1/context/stats/resources.rs

@@ -79,10 +79,10 @@ pub struct Stats {
 impl From<TrackerMetrics> for Stats {
     fn from(metrics: TrackerMetrics) -> Self {
         Self {
-            torrents: metrics.torrents_metrics.torrents,
-            seeders: metrics.torrents_metrics.complete,
-            completed: metrics.torrents_metrics.downloaded,
-            leechers: metrics.torrents_metrics.incomplete,
+            torrents: metrics.torrents_metrics.total_torrents,
+            seeders: metrics.torrents_metrics.total_complete,
+            completed: metrics.torrents_metrics.total_downloaded,
+            leechers: metrics.torrents_metrics.total_incomplete,
             // TCP
             tcp4_connections_handled: metrics.protocol_metrics.tcp4_connections_handled,
             tcp4_announces_handled: metrics.protocol_metrics.tcp4_announces_handled,
@@ -119,19 +119,19 @@ impl From<TrackerMetrics> for Stats {
 mod tests {
     use torrust_rest_tracker_api_core::statistics::metrics::Metrics;
     use torrust_rest_tracker_api_core::statistics::services::TrackerMetrics;
-    use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+    use torrust_tracker_primitives::swarm_metadata::AggregateSwarmMetadata;
 
     use super::Stats;
 
     #[test]
     fn stats_resource_should_be_converted_from_tracker_metrics() {
         assert_eq!(
             Stats::from(TrackerMetrics {
-                torrents_metrics: TorrentsMetrics {
-                    complete: 1,
-                    downloaded: 2,
-                    incomplete: 3,
-                    torrents: 4
+                torrents_metrics: AggregateSwarmMetadata {
+                    total_complete: 1,
+                    total_downloaded: 2,
+                    total_incomplete: 3,
+                    total_torrents: 4
                 },
                 protocol_metrics: Metrics {
                     // TCP

packages/axum-rest-tracker-api-server/src/v1/context/stats/responses.rs

@@ -16,10 +16,10 @@ pub fn stats_response(tracker_metrics: TrackerMetrics) -> Response {
 pub fn metrics_response(tracker_metrics: &TrackerMetrics) -> Response {
     let mut lines = vec![];
 
-    lines.push(format!("torrents {}", tracker_metrics.torrents_metrics.torrents));
-    lines.push(format!("seeders {}", tracker_metrics.torrents_metrics.complete));
-    lines.push(format!("completed {}", tracker_metrics.torrents_metrics.downloaded));
-    lines.push(format!("leechers {}", tracker_metrics.torrents_metrics.incomplete));
+    lines.push(format!("torrents {}", tracker_metrics.torrents_metrics.total_torrents));
+    lines.push(format!("seeders {}", tracker_metrics.torrents_metrics.total_complete));
+    lines.push(format!("completed {}", tracker_metrics.torrents_metrics.total_downloaded));
+    lines.push(format!("leechers {}", tracker_metrics.torrents_metrics.total_incomplete));
 
     // TCP
 

packages/http-tracker-core/src/statistics/services.rs

@@ -23,7 +23,7 @@
 use std::sync::Arc;
 
 use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::AggregateSwarmMetadata;
 
 use crate::statistics::metrics::Metrics;
 use crate::statistics::repository::Repository;
@@ -34,7 +34,7 @@ pub struct TrackerMetrics {
     /// Domain level metrics.
     ///
     /// General metrics for all torrents (number of seeders, leechers, etcetera)
-    pub torrents_metrics: TorrentsMetrics,
+    pub torrents_metrics: AggregateSwarmMetadata,
 
     /// Application level metrics. Usage statistics/metrics.
     ///
@@ -72,7 +72,7 @@ mod tests {
     use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use bittorrent_tracker_core::{self};
     use torrust_tracker_configuration::Configuration;
-    use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+    use torrust_tracker_primitives::swarm_metadata::AggregateSwarmMetadata;
     use torrust_tracker_test_helpers::configuration;
 
     use crate::statistics;
@@ -96,7 +96,7 @@ mod tests {
         assert_eq!(
             tracker_metrics,
             TrackerMetrics {
-                torrents_metrics: TorrentsMetrics::default(),
+                torrents_metrics: AggregateSwarmMetadata::default(),
                 protocol_metrics: statistics::metrics::Metrics::default(),
             }
         );

packages/primitives/src/lib.rs

@@ -8,7 +8,6 @@ pub mod core;
 pub mod pagination;
 pub mod peer;
 pub mod swarm_metadata;
-pub mod torrent_metrics;
 
 use std::collections::BTreeMap;
 use std::time::Duration;

packages/primitives/src/swarm_metadata.rs

@@ -1,16 +1,24 @@
+use std::ops::AddAssign;
+
 use derive_more::Constructor;
 
 /// Swarm statistics for one torrent.
+///
 /// Swarm metadata dictionary in the scrape response.
 ///
 /// See [BEP 48: Tracker Protocol Extension: Scrape](https://www.bittorrent.org/beps/bep_0048.html)
 #[derive(Copy, Clone, Debug, PartialEq, Default, Constructor)]
 pub struct SwarmMetadata {
-    /// (i.e `completed`): The number of peers that have ever completed downloading
-    pub downloaded: u32, //
-    /// (i.e `seeders`): The number of active peers that have completed downloading (seeders)
-    pub complete: u32, //seeders
-    /// (i.e `leechers`): The number of active peers that have not completed downloading (leechers)
+    /// (i.e `completed`): The number of peers that have ever completed
+    /// downloading a given torrent.
+    pub downloaded: u32,
+
+    /// (i.e `seeders`): The number of active peers that have completed
+    /// downloading (seeders) a given torrent.
+    pub complete: u32,
+
+    /// (i.e `leechers`): The number of active peers that have not completed
+    /// downloading (leechers) a given torrent.
     pub incomplete: u32,
 }
 
@@ -20,3 +28,31 @@ impl SwarmMetadata {
         Self::default()
     }
 }
+
+/// Structure that holds aggregate swarm metadata.
+///
+/// Metrics are aggregate values for all torrents.
+#[derive(Copy, Clone, Debug, PartialEq, Default)]
+pub struct AggregateSwarmMetadata {
+    /// Total number of peers that have ever completed downloading for all
+    /// torrents.
+    pub total_downloaded: u64,
+
+    /// Total number of seeders for all torrents.
+    pub total_complete: u64,
+
+    /// Total number of leechers for all torrents.
+    pub total_incomplete: u64,
+
+    /// Total number of torrents.
+    pub total_torrents: u64,
+}
+
+impl AddAssign for AggregateSwarmMetadata {
+    fn add_assign(&mut self, rhs: Self) {
+        self.total_complete += rhs.total_complete;
+        self.total_downloaded += rhs.total_downloaded;
+        self.total_incomplete += rhs.total_incomplete;
+        self.total_torrents += rhs.total_torrents;
+    }
+}

packages/primitives/src/torrent_metrics.rs

@@ -4,7 +4,7 @@ use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepo
 use bittorrent_udp_tracker_core::services::banning::BanService;
 use bittorrent_udp_tracker_core::{self, statistics as udp_core_statistics};
 use tokio::sync::RwLock;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::AggregateSwarmMetadata;
 use torrust_udp_tracker_server::statistics as udp_server_statistics;
 
 use crate::statistics::metrics::Metrics;
@@ -15,7 +15,7 @@ pub struct TrackerMetrics {
     /// Domain level metrics.
     ///
     /// General metrics for all torrents (number of seeders, leechers, etcetera)
-    pub torrents_metrics: TorrentsMetrics,
+    pub torrents_metrics: AggregateSwarmMetadata,
 
     /// Application level metrics. Usage statistics/metrics.
     ///
@@ -83,7 +83,7 @@ mod tests {
     use bittorrent_udp_tracker_core::MAX_CONNECTION_ID_ERRORS_PER_IP;
     use tokio::sync::RwLock;
     use torrust_tracker_configuration::Configuration;
-    use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+    use torrust_tracker_primitives::swarm_metadata::AggregateSwarmMetadata;
     use torrust_tracker_test_helpers::configuration;
 
     use crate::statistics::metrics::Metrics;
@@ -127,7 +127,7 @@ mod tests {
         assert_eq!(
             tracker_metrics,
             TrackerMetrics {
-                torrents_metrics: TorrentsMetrics::default(),
+                torrents_metrics: AggregateSwarmMetadata::default(),
                 protocol_metrics: Metrics::default(),
             }
         );

packages/rest-tracker-api-core/src/statistics/services.rs

@@ -4,8 +4,7 @@ use bittorrent_primitives::info_hash::InfoHash;
 use dashmap::DashMap;
 use torrust_tracker_configuration::TrackerPolicy;
 use torrust_tracker_primitives::pagination::Pagination;
-use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::{AggregateSwarmMetadata, SwarmMetadata};
 use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch, PersistentTorrent, PersistentTorrents};
 
 use super::Repository;
@@ -47,15 +46,15 @@ where
         maybe_entry.map(|entry| entry.clone())
     }
 
-    fn get_metrics(&self) -> TorrentsMetrics {
-        let mut metrics = TorrentsMetrics::default();
+    fn get_metrics(&self) -> AggregateSwarmMetadata {
+        let mut metrics = AggregateSwarmMetadata::default();
 
         for entry in &self.torrents {
             let stats = entry.value().lock().expect("it should get a lock").get_swarm_metadata();
-            metrics.complete += u64::from(stats.complete);
-            metrics.downloaded += u64::from(stats.downloaded);
-            metrics.incomplete += u64::from(stats.incomplete);
-            metrics.torrents += 1;
+            metrics.total_complete += u64::from(stats.complete);
+            metrics.total_downloaded += u64::from(stats.downloaded);
+            metrics.total_incomplete += u64::from(stats.incomplete);
+            metrics.total_torrents += 1;
         }
 
         metrics

packages/torrent-repository/src/repository/dash_map_mutex_std.rs

@@ -1,8 +1,7 @@
 use bittorrent_primitives::info_hash::InfoHash;
 use torrust_tracker_configuration::TrackerPolicy;
 use torrust_tracker_primitives::pagination::Pagination;
-use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::{AggregateSwarmMetadata, SwarmMetadata};
 use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch, PersistentTorrent, PersistentTorrents};
 
 pub mod dash_map_mutex_std;
@@ -18,7 +17,7 @@ use std::fmt::Debug;
 
 pub trait Repository<T>: Debug + Default + Sized + 'static {
     fn get(&self, key: &InfoHash) -> Option<T>;
-    fn get_metrics(&self) -> TorrentsMetrics;
+    fn get_metrics(&self) -> AggregateSwarmMetadata;
     fn get_paginated(&self, pagination: Option<&Pagination>) -> Vec<(InfoHash, T)>;
     fn import_persistent(&self, persistent_torrents: &PersistentTorrents);
     fn remove(&self, key: &InfoHash) -> Option<T>;
@@ -31,7 +30,7 @@ pub trait Repository<T>: Debug + Default + Sized + 'static {
 #[allow(clippy::module_name_repetitions)]
 pub trait RepositoryAsync<T>: Debug + Default + Sized + 'static {
     fn get(&self, key: &InfoHash) -> impl std::future::Future<Output = Option<T>> + Send;
-    fn get_metrics(&self) -> impl std::future::Future<Output = TorrentsMetrics> + Send;
+    fn get_metrics(&self) -> impl std::future::Future<Output = AggregateSwarmMetadata> + Send;
     fn get_paginated(&self, pagination: Option<&Pagination>) -> impl std::future::Future<Output = Vec<(InfoHash, T)>> + Send;
     fn import_persistent(&self, persistent_torrents: &PersistentTorrents) -> impl std::future::Future<Output = ()> + Send;
     fn remove(&self, key: &InfoHash) -> impl std::future::Future<Output = Option<T>> + Send;

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

@@ -1,8 +1,7 @@
 use bittorrent_primitives::info_hash::InfoHash;
 use torrust_tracker_configuration::TrackerPolicy;
 use torrust_tracker_primitives::pagination::Pagination;
-use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::{AggregateSwarmMetadata, SwarmMetadata};
 use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch, PersistentTorrent, PersistentTorrents};
 
 use super::Repository;
@@ -65,15 +64,15 @@ where
         db.get(key).cloned()
     }
 
-    fn get_metrics(&self) -> TorrentsMetrics {
-        let mut metrics = TorrentsMetrics::default();
+    fn get_metrics(&self) -> AggregateSwarmMetadata {
+        let mut metrics = AggregateSwarmMetadata::default();
 
         for entry in self.get_torrents().values() {
             let stats = entry.get_swarm_metadata();
-            metrics.complete += u64::from(stats.complete);
-            metrics.downloaded += u64::from(stats.downloaded);
-            metrics.incomplete += u64::from(stats.incomplete);
-            metrics.torrents += 1;
+            metrics.total_complete += u64::from(stats.complete);
+            metrics.total_downloaded += u64::from(stats.downloaded);
+            metrics.total_incomplete += u64::from(stats.incomplete);
+            metrics.total_torrents += 1;
         }
 
         metrics

packages/torrent-repository/src/repository/rw_lock_std.rs

@@ -3,8 +3,7 @@ use std::sync::Arc;
 use bittorrent_primitives::info_hash::InfoHash;
 use torrust_tracker_configuration::TrackerPolicy;
 use torrust_tracker_primitives::pagination::Pagination;
-use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::{AggregateSwarmMetadata, SwarmMetadata};
 use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch, PersistentTorrent, PersistentTorrents};
 
 use super::Repository;
@@ -60,15 +59,15 @@ where
         db.get(key).cloned()
     }
 
-    fn get_metrics(&self) -> TorrentsMetrics {
-        let mut metrics = TorrentsMetrics::default();
+    fn get_metrics(&self) -> AggregateSwarmMetadata {
+        let mut metrics = AggregateSwarmMetadata::default();
 
         for entry in self.get_torrents().values() {
             let stats = entry.lock().expect("it should get a lock").get_swarm_metadata();
-            metrics.complete += u64::from(stats.complete);
-            metrics.downloaded += u64::from(stats.downloaded);
-            metrics.incomplete += u64::from(stats.incomplete);
-            metrics.torrents += 1;
+            metrics.total_complete += u64::from(stats.complete);
+            metrics.total_downloaded += u64::from(stats.downloaded);
+            metrics.total_incomplete += u64::from(stats.incomplete);
+            metrics.total_torrents += 1;
         }
 
         metrics

packages/torrent-repository/src/repository/rw_lock_std_mutex_std.rs

@@ -7,8 +7,7 @@ use futures::future::join_all;
 use futures::{Future, FutureExt};
 use torrust_tracker_configuration::TrackerPolicy;
 use torrust_tracker_primitives::pagination::Pagination;
-use torrust_tracker_primitives::swarm_metadata::SwarmMetadata;
-use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
+use torrust_tracker_primitives::swarm_metadata::{AggregateSwarmMetadata, SwarmMetadata};
 use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch, PersistentTorrent, PersistentTorrents};
 
 use super::RepositoryAsync;
@@ -86,17 +85,17 @@ where
         }
     }
 
-    async fn get_metrics(&self) -> TorrentsMetrics {
-        let mut metrics = TorrentsMetrics::default();
+    async fn get_metrics(&self) -> AggregateSwarmMetadata {
+        let mut metrics = AggregateSwarmMetadata::default();
 
         let entries: Vec<_> = self.get_torrents().values().cloned().collect();
 
         for entry in entries {
             let stats = entry.lock().await.get_swarm_metadata();
-            metrics.complete += u64::from(stats.complete);
-            metrics.downloaded += u64::from(stats.downloaded);
-            metrics.incomplete += u64::from(stats.incomplete);
-            metrics.torrents += 1;
+            metrics.total_complete += u64::from(stats.complete);
+            metrics.total_downloaded += u64::from(stats.downloaded);
+            metrics.total_incomplete += u64::from(stats.incomplete);
+            metrics.total_torrents += 1;
         }
 
         metrics