Merge #1363: Refactor: remove counter for HTTP connections internally

89607cc refactor: [#1342] remove counter for HTTP connetions internally (Jose Celano)

Pull request description:

  The number of HTTP tracker connections don't make sense. There are connection requests only in the UDP tracker.

  That code is removed but, in order to keep backward compatibility, the API still exposes that value which is the:

  number of announce requests + number of scrape requests

ACKs for top commit:
  josecelano:
    ACK 89607cc

Tree-SHA512: 066132e56f5e7e14050d78a15981c07f79acfe0b11903da35f15ca4214d16873799479f0aa98bb767eb23b496988e808d3f1ab1544b78ab072393711f28598b7

Author: josecelano

packages/axum-http-tracker-server/tests/server/v1/contract.rs

@@ -666,91 +666,6 @@ mod for_all_config_modes {
             compact_announce.is_ok()
         }
 
-        #[tokio::test]
-        async fn should_increase_the_number_of_tcp4_connections_handled_in_statistics() {
-            logging::setup();
-
-            let env = Started::new(&configuration::ephemeral_public().into()).await;
-
-            Client::new(*env.bind_address())
-                .announce(&QueryBuilder::default().query())
-                .await;
-
-            let stats = env
-                .container
-                .http_tracker_core_container
-                .http_stats_repository
-                .get_stats()
-                .await;
-
-            assert_eq!(stats.tcp4_connections_handled, 1);
-
-            drop(stats);
-
-            env.stop().await;
-        }
-
-        #[tokio::test]
-        async fn should_increase_the_number_of_tcp6_connections_handled_in_statistics() {
-            logging::setup();
-
-            if TcpListener::bind(SocketAddrV6::new(Ipv6Addr::LOCALHOST, 0, 0, 0))
-                .await
-                .is_err()
-            {
-                return; // we cannot bind to a ipv6 socket, so we will skip this test
-            }
-
-            let env = Started::new(&configuration::ephemeral_ipv6().into()).await;
-
-            Client::bind(*env.bind_address(), IpAddr::from_str("::1").unwrap())
-                .announce(&QueryBuilder::default().query())
-                .await;
-
-            let stats = env
-                .container
-                .http_tracker_core_container
-                .http_stats_repository
-                .get_stats()
-                .await;
-
-            assert_eq!(stats.tcp6_connections_handled, 1);
-
-            drop(stats);
-
-            env.stop().await;
-        }
-
-        #[tokio::test]
-        async fn should_not_increase_the_number_of_tcp6_connections_handled_if_the_client_is_not_using_an_ipv6_ip() {
-            logging::setup();
-
-            // The tracker ignores the peer address in the request param. It uses the client remote ip address.
-
-            let env = Started::new(&configuration::ephemeral_public().into()).await;
-
-            Client::new(*env.bind_address())
-                .announce(
-                    &QueryBuilder::default()
-                        .with_peer_addr(&IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)))
-                        .query(),
-                )
-                .await;
-
-            let stats = env
-                .container
-                .http_tracker_core_container
-                .http_stats_repository
-                .get_stats()
-                .await;
-
-            assert_eq!(stats.tcp6_connections_handled, 0);
-
-            drop(stats);
-
-            env.stop().await;
-        }
-
         #[tokio::test]
         async fn should_increase_the_number_of_tcp4_announce_requests_handled_in_statistics() {
             logging::setup();

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

@@ -77,6 +77,7 @@ pub struct Stats {
 }
 
 impl From<TrackerMetrics> for Stats {
+    #[allow(deprecated)]
     fn from(metrics: TrackerMetrics) -> Self {
         Self {
             torrents: metrics.torrents_metrics.total_torrents,
@@ -124,6 +125,7 @@ mod tests {
     use super::Stats;
 
     #[test]
+    #[allow(deprecated)]
     fn stats_resource_should_be_converted_from_tracker_metrics() {
         assert_eq!(
             Stats::from(TrackerMetrics {

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

@@ -12,6 +12,7 @@ pub fn stats_response(tracker_metrics: TrackerMetrics) -> Response {
 }
 
 /// `200` response that contains the [`Stats`] resource in Prometheus Text Exposition Format .
+#[allow(deprecated)]
 #[must_use]
 pub fn metrics_response(tracker_metrics: &TrackerMetrics) -> Response {
     let mut lines = vec![];

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

@@ -28,12 +28,8 @@ use crate::statistics;
 ///
 /// The service sends an statistics event that increments:
 ///
-/// - The number of TCP connections handled by the HTTP tracker.
 /// - The number of TCP `announce` requests handled by the HTTP tracker.
-///
-/// > **NOTICE**: as the HTTP tracker does not requires a connection request
-/// > like the UDP tracker, the number of TCP connections is incremented for
-/// > each `announce` request.
+/// - The number of TCP `scrape` requests handled by the HTTP tracker.
 pub struct AnnounceService {
     core_config: Arc<Core>,
     announce_handler: Arc<AnnounceHandler>,

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

@@ -25,13 +25,9 @@ use crate::statistics;
 ///
 /// The service sends an statistics event that increments:
 ///
-/// - The number of TCP connections handled by the HTTP tracker.
+/// - The number of TCP `announce` requests handled by the HTTP tracker.
 /// - The number of TCP `scrape` requests handled by the HTTP tracker.
 ///
-/// > **NOTICE**: as the HTTP tracker does not requires a connection request
-/// > like the UDP tracker, the number of TCP connections is incremented for
-/// > each `scrape` request.
-///
 /// # Errors
 ///
 /// This function will return an error if:

packages/http-tracker-core/src/statistics/event/handler.rs

@@ -6,21 +6,17 @@ pub async fn handle_event(event: Event, stats_repository: &Repository) {
         // TCP4
         Event::Tcp4Announce => {
             stats_repository.increase_tcp4_announces().await;
-            stats_repository.increase_tcp4_connections().await;
         }
         Event::Tcp4Scrape => {
             stats_repository.increase_tcp4_scrapes().await;
-            stats_repository.increase_tcp4_connections().await;
         }
 
         // TCP6
         Event::Tcp6Announce => {
             stats_repository.increase_tcp6_announces().await;
-            stats_repository.increase_tcp6_connections().await;
         }
         Event::Tcp6Scrape => {
             stats_repository.increase_tcp6_scrapes().await;
-            stats_repository.increase_tcp6_connections().await;
         }
     }
 
@@ -44,17 +40,6 @@ mod tests {
         assert_eq!(stats.tcp4_announces_handled, 1);
     }
 
-    #[tokio::test]
-    async fn should_increase_the_tcp4_connections_counter_when_it_receives_a_tcp4_announce_event() {
-        let stats_repository = Repository::new();
-
-        handle_event(Event::Tcp4Announce, &stats_repository).await;
-
-        let stats = stats_repository.get_stats().await;
-
-        assert_eq!(stats.tcp4_connections_handled, 1);
-    }
-
     #[tokio::test]
     async fn should_increase_the_tcp4_scrapes_counter_when_it_receives_a_tcp4_scrape_event() {
         let stats_repository = Repository::new();
@@ -66,17 +51,6 @@ mod tests {
         assert_eq!(stats.tcp4_scrapes_handled, 1);
     }
 
-    #[tokio::test]
-    async fn should_increase_the_tcp4_connections_counter_when_it_receives_a_tcp4_scrape_event() {
-        let stats_repository = Repository::new();
-
-        handle_event(Event::Tcp4Scrape, &stats_repository).await;
-
-        let stats = stats_repository.get_stats().await;
-
-        assert_eq!(stats.tcp4_connections_handled, 1);
-    }
-
     #[tokio::test]
     async fn should_increase_the_tcp6_announces_counter_when_it_receives_a_tcp6_announce_event() {
         let stats_repository = Repository::new();
@@ -88,17 +62,6 @@ mod tests {
         assert_eq!(stats.tcp6_announces_handled, 1);
     }
 
-    #[tokio::test]
-    async fn should_increase_the_tcp6_connections_counter_when_it_receives_a_tcp6_announce_event() {
-        let stats_repository = Repository::new();
-
-        handle_event(Event::Tcp6Announce, &stats_repository).await;
-
-        let stats = stats_repository.get_stats().await;
-
-        assert_eq!(stats.tcp6_connections_handled, 1);
-    }
-
     #[tokio::test]
     async fn should_increase_the_tcp6_scrapes_counter_when_it_receives_a_tcp6_scrape_event() {
         let stats_repository = Repository::new();
@@ -109,15 +72,4 @@ mod tests {
 
         assert_eq!(stats.tcp6_scrapes_handled, 1);
     }
-
-    #[tokio::test]
-    async fn should_increase_the_tcp6_connections_counter_when_it_receives_a_tcp6_scrape_event() {
-        let stats_repository = Repository::new();
-
-        handle_event(Event::Tcp6Scrape, &stats_repository).await;
-
-        let stats = stats_repository.get_stats().await;
-
-        assert_eq!(stats.tcp6_connections_handled, 1);
-    }
 }

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

@@ -8,20 +8,12 @@
 /// and also for each IP version used by the peers: IPv4 and IPv6.
 #[derive(Debug, PartialEq, Default)]
 pub struct Metrics {
-    /// Total number of TCP (HTTP tracker) connections from IPv4 peers.
-    /// Since the HTTP tracker spec does not require a handshake, this metric
-    /// increases for every HTTP request.
-    pub tcp4_connections_handled: u64,
-
     /// Total number of TCP (HTTP tracker) `announce` requests from IPv4 peers.
     pub tcp4_announces_handled: u64,
 
     /// Total number of TCP (HTTP tracker) `scrape` requests from IPv4 peers.
     pub tcp4_scrapes_handled: u64,
 
-    /// Total number of TCP (HTTP tracker) connections from IPv6 peers.
-    pub tcp6_connections_handled: u64,
-
     /// Total number of TCP (HTTP tracker) `announce` requests from IPv6 peers.
     pub tcp6_announces_handled: u64,
 

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

@@ -34,12 +34,6 @@ impl Repository {
         drop(stats_lock);
     }
 
-    pub async fn increase_tcp4_connections(&self) {
-        let mut stats_lock = self.stats.write().await;
-        stats_lock.tcp4_connections_handled += 1;
-        drop(stats_lock);
-    }
-
     pub async fn increase_tcp4_scrapes(&self) {
         let mut stats_lock = self.stats.write().await;
         stats_lock.tcp4_scrapes_handled += 1;
@@ -52,12 +46,6 @@ impl Repository {
         drop(stats_lock);
     }
 
-    pub async fn increase_tcp6_connections(&self) {
-        let mut stats_lock = self.stats.write().await;
-        stats_lock.tcp6_connections_handled += 1;
-        drop(stats_lock);
-    }
-
     pub async fn increase_tcp6_scrapes(&self) {
         let mut stats_lock = self.stats.write().await;
         stats_lock.tcp6_scrapes_handled += 1;

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

@@ -54,11 +54,9 @@ pub async fn get_metrics(
         torrents_metrics,
         protocol_metrics: Metrics {
             // TCPv4
-            tcp4_connections_handled: stats.tcp4_connections_handled,
             tcp4_announces_handled: stats.tcp4_announces_handled,
             tcp4_scrapes_handled: stats.tcp4_scrapes_handled,
             // TCPv6
-            tcp6_connections_handled: stats.tcp6_connections_handled,
             tcp6_announces_handled: stats.tcp6_announces_handled,
             tcp6_scrapes_handled: stats.tcp6_scrapes_handled,
         },

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

@@ -11,6 +11,7 @@ pub struct Metrics {
     /// Total number of TCP (HTTP tracker) connections from IPv4 peers.
     /// Since the HTTP tracker spec does not require a handshake, this metric
     /// increases for every HTTP request.
+    #[deprecated(since = "3.1.0")]
     pub tcp4_connections_handled: u64,
 
     /// Total number of TCP (HTTP tracker) `announce` requests from IPv4 peers.
@@ -20,6 +21,7 @@ pub struct Metrics {
     pub tcp4_scrapes_handled: u64,
 
     /// Total number of TCP (HTTP tracker) connections from IPv6 peers.
+    #[deprecated(since = "3.1.0")]
     pub tcp6_connections_handled: u64,
 
     /// Total number of TCP (HTTP tracker) `announce` requests from IPv6 peers.