refactor: [torrust#1543] extract methods

Author: josecelano

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

@@ -134,9 +134,8 @@ impl From<TrackerLabeledMetrics> for LabeledStats {
 
 #[cfg(test)]
 mod tests {
-    use torrust_rest_tracker_api_core::statistics::metrics::Metrics;
+    use torrust_rest_tracker_api_core::statistics::metrics::{Metrics, TorrentsMetrics};
     use torrust_rest_tracker_api_core::statistics::services::TrackerMetrics;
-    use torrust_tracker_primitives::swarm_metadata::AggregateActiveSwarmMetadata;
 
     use super::Stats;
 
@@ -145,7 +144,7 @@ mod tests {
     fn stats_resource_should_be_converted_from_tracker_metrics() {
         assert_eq!(
             Stats::from(TrackerMetrics {
-                torrents_metrics: AggregateActiveSwarmMetadata {
+                torrents_metrics: TorrentsMetrics {
                     total_complete: 1,
                     total_downloaded: 2,
                     total_incomplete: 3,

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

@@ -1,4 +1,33 @@
-/// Metrics collected by the tracker.
+use torrust_tracker_primitives::swarm_metadata::AggregateActiveSwarmMetadata;
+
+/// Metrics collected by the tracker at the swarm layer.
+#[derive(Copy, Clone, Debug, PartialEq, Default)]
+pub struct TorrentsMetrics {
+    /// Total number of peers that have ever completed downloading.
+    pub total_downloaded: u64,
+
+    /// Total number of seeders.
+    pub total_complete: u64,
+
+    /// Total number of leechers.
+    pub total_incomplete: u64,
+
+    /// Total number of torrents.
+    pub total_torrents: u64,
+}
+
+impl From<AggregateActiveSwarmMetadata> for TorrentsMetrics {
+    fn from(value: AggregateActiveSwarmMetadata) -> Self {
+        Self {
+            total_downloaded: value.total_downloaded,
+            total_complete: value.total_complete,
+            total_incomplete: value.total_incomplete,
+            total_torrents: value.total_torrents,
+        }
+    }
+}
+
+/// Metrics collected by the tracker at the delivery layer.
 ///
 /// - Number of connections handled
 /// - Number of `announce` requests handled

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

@@ -9,10 +9,10 @@ use torrust_tracker_configuration::Core;
 use torrust_tracker_metrics::label::LabelSet;
 use torrust_tracker_metrics::metric_collection::MetricCollection;
 use torrust_tracker_metrics::metric_name;
-use torrust_tracker_primitives::swarm_metadata::AggregateActiveSwarmMetadata;
 use torrust_tracker_torrent_repository::statistics::TORRENT_REPOSITORY_TORRENTS_DOWNLOADS_TOTAL;
 use torrust_udp_tracker_server::statistics as udp_server_statistics;
 
+use super::metrics::TorrentsMetrics;
 use crate::statistics::metrics::Metrics;
 
 /// All the metrics collected by the tracker.
@@ -21,7 +21,7 @@ pub struct TrackerMetrics {
     /// Domain level metrics.
     ///
     /// General metrics for all torrents (number of seeders, leechers, etcetera)
-    pub torrents_metrics: AggregateActiveSwarmMetadata,
+    pub torrents_metrics: TorrentsMetrics,
 
     /// Application level metrics. Usage statistics/metrics.
     ///
@@ -30,7 +30,6 @@ pub struct TrackerMetrics {
 }
 
 /// It returns all the [`TrackerMetrics`]
-#[allow(deprecated)]
 pub async fn get_metrics(
     core_config: Arc<Core>,
     in_memory_torrent_repository: Arc<InMemoryTorrentRepository>,
@@ -40,10 +39,25 @@ pub async fn get_metrics(
     http_stats_repository: Arc<bittorrent_http_tracker_core::statistics::repository::Repository>,
     udp_server_stats_repository: Arc<udp_server_statistics::repository::Repository>,
 ) -> TrackerMetrics {
+    TrackerMetrics {
+        torrents_metrics: get_torrents_metrics(
+            core_config,
+            in_memory_torrent_repository,
+            torrent_repository_stats_repository,
+            tracker_core_stats_repository,
+        )
+        .await,
+        protocol_metrics: get_protocol_metrics(ban_service, http_stats_repository, udp_server_stats_repository).await,
+    }
+}
+
+async fn get_torrents_metrics(
+    core_config: Arc<Core>,
+    in_memory_torrent_repository: Arc<InMemoryTorrentRepository>,
+    torrent_repository_stats_repository: Arc<torrust_tracker_torrent_repository::statistics::repository::Repository>,
+    tracker_core_stats_repository: Arc<bittorrent_tracker_core::statistics::repository::Repository>,
+) -> TorrentsMetrics {
     let aggregate_active_swarm_metadata = in_memory_torrent_repository.get_aggregate_swarm_metadata().await;
-    let udp_banned_ips_total = ban_service.read().await.get_banned_ips_total();
-    let http_stats = http_stats_repository.get_stats().await;
-    let udp_server_stats = udp_server_stats_repository.get_stats().await;
 
     let total_downloaded = if core_config.tracker_policy.persistent_torrent_completed_stat {
         let metrics = tracker_core_stats_repository.get_metrics().await;
@@ -73,47 +87,57 @@ pub async fn get_metrics(
         }
     };
 
-    let mut torrents_metrics = aggregate_active_swarm_metadata;
+    let mut torrents_metrics: TorrentsMetrics = aggregate_active_swarm_metadata.into();
     torrents_metrics.total_downloaded = total_downloaded;
 
+    torrents_metrics
+}
+
+#[allow(deprecated)]
+async fn get_protocol_metrics(
+    ban_service: Arc<RwLock<BanService>>,
+    http_stats_repository: Arc<bittorrent_http_tracker_core::statistics::repository::Repository>,
+    udp_server_stats_repository: Arc<udp_server_statistics::repository::Repository>,
+) -> Metrics {
+    let udp_banned_ips_total = ban_service.read().await.get_banned_ips_total();
+    let http_stats = http_stats_repository.get_stats().await;
+    let udp_server_stats = udp_server_stats_repository.get_stats().await;
+
     // For backward compatibility we keep the `tcp4_connections_handled` and
     // `tcp6_connections_handled` metrics. They don't make sense for the HTTP
     // tracker, but we keep them for now. In new major versions we should remove
     // them.
 
-    TrackerMetrics {
-        torrents_metrics,
-        protocol_metrics: Metrics {
-            // TCPv4
-            tcp4_connections_handled: http_stats.tcp4_announces_handled + http_stats.tcp4_scrapes_handled,
-            tcp4_announces_handled: http_stats.tcp4_announces_handled,
-            tcp4_scrapes_handled: http_stats.tcp4_scrapes_handled,
-            // TCPv6
-            tcp6_connections_handled: http_stats.tcp6_announces_handled + http_stats.tcp6_scrapes_handled,
-            tcp6_announces_handled: http_stats.tcp6_announces_handled,
-            tcp6_scrapes_handled: http_stats.tcp6_scrapes_handled,
-            // UDP
-            udp_requests_aborted: udp_server_stats.udp_requests_aborted,
-            udp_requests_banned: udp_server_stats.udp_requests_banned,
-            udp_banned_ips_total: udp_banned_ips_total as u64,
-            udp_avg_connect_processing_time_ns: udp_server_stats.udp_avg_connect_processing_time_ns,
-            udp_avg_announce_processing_time_ns: udp_server_stats.udp_avg_announce_processing_time_ns,
-            udp_avg_scrape_processing_time_ns: udp_server_stats.udp_avg_scrape_processing_time_ns,
-            // UDPv4
-            udp4_requests: udp_server_stats.udp4_requests,
-            udp4_connections_handled: udp_server_stats.udp4_connections_handled,
-            udp4_announces_handled: udp_server_stats.udp4_announces_handled,
-            udp4_scrapes_handled: udp_server_stats.udp4_scrapes_handled,
-            udp4_responses: udp_server_stats.udp4_responses,
-            udp4_errors_handled: udp_server_stats.udp4_errors_handled,
-            // UDPv6
-            udp6_requests: udp_server_stats.udp6_requests,
-            udp6_connections_handled: udp_server_stats.udp6_connections_handled,
-            udp6_announces_handled: udp_server_stats.udp6_announces_handled,
-            udp6_scrapes_handled: udp_server_stats.udp6_scrapes_handled,
-            udp6_responses: udp_server_stats.udp6_responses,
-            udp6_errors_handled: udp_server_stats.udp6_errors_handled,
-        },
+    Metrics {
+        // TCPv4
+        tcp4_connections_handled: http_stats.tcp4_announces_handled + http_stats.tcp4_scrapes_handled,
+        tcp4_announces_handled: http_stats.tcp4_announces_handled,
+        tcp4_scrapes_handled: http_stats.tcp4_scrapes_handled,
+        // TCPv6
+        tcp6_connections_handled: http_stats.tcp6_announces_handled + http_stats.tcp6_scrapes_handled,
+        tcp6_announces_handled: http_stats.tcp6_announces_handled,
+        tcp6_scrapes_handled: http_stats.tcp6_scrapes_handled,
+        // UDP
+        udp_requests_aborted: udp_server_stats.udp_requests_aborted,
+        udp_requests_banned: udp_server_stats.udp_requests_banned,
+        udp_banned_ips_total: udp_banned_ips_total as u64,
+        udp_avg_connect_processing_time_ns: udp_server_stats.udp_avg_connect_processing_time_ns,
+        udp_avg_announce_processing_time_ns: udp_server_stats.udp_avg_announce_processing_time_ns,
+        udp_avg_scrape_processing_time_ns: udp_server_stats.udp_avg_scrape_processing_time_ns,
+        // UDPv4
+        udp4_requests: udp_server_stats.udp4_requests,
+        udp4_connections_handled: udp_server_stats.udp4_connections_handled,
+        udp4_announces_handled: udp_server_stats.udp4_announces_handled,
+        udp4_scrapes_handled: udp_server_stats.udp4_scrapes_handled,
+        udp4_responses: udp_server_stats.udp4_responses,
+        udp4_errors_handled: udp_server_stats.udp4_errors_handled,
+        // UDPv6
+        udp6_requests: udp_server_stats.udp6_requests,
+        udp6_connections_handled: udp_server_stats.udp6_connections_handled,
+        udp6_announces_handled: udp_server_stats.udp6_announces_handled,
+        udp6_scrapes_handled: udp_server_stats.udp6_scrapes_handled,
+        udp6_responses: udp_server_stats.udp6_responses,
+        udp6_errors_handled: udp_server_stats.udp6_errors_handled,
     }
 }
 
@@ -184,11 +208,10 @@ mod tests {
     use tokio::sync::RwLock;
     use torrust_tracker_configuration::Configuration;
     use torrust_tracker_events::bus::SenderStatus;
-    use torrust_tracker_primitives::swarm_metadata::AggregateActiveSwarmMetadata;
     use torrust_tracker_test_helpers::configuration;
     use torrust_tracker_torrent_repository::container::TorrentRepositoryContainer;
 
-    use crate::statistics::metrics::Metrics;
+    use crate::statistics::metrics::{Metrics, TorrentsMetrics};
     use crate::statistics::services::{get_metrics, TrackerMetrics};
 
     pub fn tracker_configuration() -> Configuration {
@@ -235,7 +258,7 @@ mod tests {
         assert_eq!(
             tracker_metrics,
             TrackerMetrics {
-                torrents_metrics: AggregateActiveSwarmMetadata::default(),
+                torrents_metrics: TorrentsMetrics::default(),
                 protocol_metrics: Metrics::default(),
             }
         );