Merge #1566: Add a new metric to count peers reverting Completed state

7be0366 feat: [#1534] add new metric to count peers reverting state from complete to any other state (Jose Celano)
b2feb7b docs: [#1534] Update comments after rename (Jose Celano)
8da42e4 refactor: [#1534] Rename torrent_repository_event_listener to swarm_coordination_registry_event_listener (Jose Celano)
b09e79c refactor: [#1534] Rename torrent_repository_container to swarm_coordination_registry_container (Jose Celano)
c26315a refactor: [#1534] Rename TorrentRepositoryContainer type to SwarmCoordinationRegistryContainer (Jose Celano)
c67f27a refactor: [#1534] Rename torrent_repository_ prefix to swarm_coordination_registry_ (Jose Celano)
45bc807 refactor: [#1534] rename TORRENT_REPOSITORY_LOG_TARGET to SWARM_COORDINATION_REGISTRY_LOG_TARGET (Jose Celano)

Pull request description:

  Add a new metric to count peers reverting the `Completed` state.

  ### Subtasks

  - Refactor `swarm-coordination-registry` package: rename types, variables, and constants to follow the package's new name.
  - Add the new metric: `swarm_coordination_registry_peers_completed_state_reverted_total`

ACKs for top commit:
  josecelano:
    ACK 7be0366

Tree-SHA512: 609264972c8a79fed53c2dd787bd2fd34cf255a27f5a9fb8f07fead4fd3296a41efce6f5a4c796d097a7692922214cb651ecdb082bb5c94943f5db047a4c5e27

Author: josecelano

packages/axum-http-tracker-server/src/environment.rs

@@ -10,7 +10,7 @@ use torrust_axum_server::tsl::make_rust_tls;
 use torrust_server_lib::registar::Registar;
 use torrust_tracker_configuration::{logging, Configuration};
 use torrust_tracker_primitives::peer;
-use torrust_tracker_swarm_coordination_registry::container::TorrentRepositoryContainer;
+use torrust_tracker_swarm_coordination_registry::container::SwarmCoordinationRegistryContainer;
 
 use crate::server::{HttpServer, Launcher, Running, Stopped};
 
@@ -144,13 +144,13 @@ impl EnvContainer {
             .expect("missing HTTP tracker configuration");
         let http_tracker_config = Arc::new(http_tracker_config[0].clone());
 
-        let torrent_repository_container = Arc::new(TorrentRepositoryContainer::initialize(
+        let swarm_coordination_registry_container = Arc::new(SwarmCoordinationRegistryContainer::initialize(
             configuration.core.tracker_usage_statistics.into(),
         ));
 
         let tracker_core_container = Arc::new(TrackerCoreContainer::initialize_from(
             &core_config,
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
         ));
 
         let http_tracker_container =

packages/axum-http-tracker-server/src/server.rs

@@ -259,7 +259,7 @@ mod tests {
     use torrust_axum_server::tsl::make_rust_tls;
     use torrust_server_lib::registar::Registar;
     use torrust_tracker_configuration::{logging, Configuration};
-    use torrust_tracker_swarm_coordination_registry::container::TorrentRepositoryContainer;
+    use torrust_tracker_swarm_coordination_registry::container::SwarmCoordinationRegistryContainer;
     use torrust_tracker_test_helpers::configuration::ephemeral_public;
 
     use crate::server::{HttpServer, Launcher};
@@ -290,13 +290,13 @@ mod tests {
             let _unused = run_event_listener(http_stats_event_bus.receiver(), &http_stats_repository);
         }
 
-        let torrent_repository_container = Arc::new(TorrentRepositoryContainer::initialize(
+        let swarm_coordination_registry_container = Arc::new(SwarmCoordinationRegistryContainer::initialize(
             configuration.core.tracker_usage_statistics.into(),
         ));
 
         let tracker_core_container = Arc::new(TrackerCoreContainer::initialize_from(
             &core_config,
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
         ));
 
         let announce_service = Arc::new(AnnounceService::new(

packages/axum-rest-tracker-api-server/src/environment.rs

@@ -12,7 +12,7 @@ use torrust_rest_tracker_api_core::container::TrackerHttpApiCoreContainer;
 use torrust_server_lib::registar::Registar;
 use torrust_tracker_configuration::{logging, Configuration};
 use torrust_tracker_primitives::peer;
-use torrust_tracker_swarm_coordination_registry::container::TorrentRepositoryContainer;
+use torrust_tracker_swarm_coordination_registry::container::SwarmCoordinationRegistryContainer;
 use torrust_udp_tracker_server::container::UdpTrackerServerContainer;
 
 use crate::server::{ApiServer, Launcher, Running, Stopped};
@@ -173,13 +173,13 @@ impl EnvContainer {
                 .clone(),
         );
 
-        let torrent_repository_container = Arc::new(TorrentRepositoryContainer::initialize(
+        let swarm_coordination_registry_container = Arc::new(SwarmCoordinationRegistryContainer::initialize(
             core_config.tracker_usage_statistics.into(),
         ));
 
         let tracker_core_container = Arc::new(TrackerCoreContainer::initialize_from(
             &core_config,
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
         ));
 
         let http_tracker_core_container =
@@ -191,7 +191,7 @@ impl EnvContainer {
         let udp_tracker_server_container = UdpTrackerServerContainer::initialize(&core_config);
 
         let tracker_http_api_core_container = TrackerHttpApiCoreContainer::initialize_from(
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
             &tracker_core_container,
             &http_tracker_core_container,
             &udp_tracker_core_container,

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

@@ -30,7 +30,10 @@ pub fn add(prefix: &str, router: Router, http_api_container: &Arc<TrackerHttpApi
                 http_api_container.tracker_core_container.in_memory_torrent_repository.clone(),
                 http_api_container.ban_service.clone(),
                 // Stats
-                http_api_container.torrent_repository_container.stats_repository.clone(),
+                http_api_container
+                    .swarm_coordination_registry_container
+                    .stats_repository
+                    .clone(),
                 http_api_container.tracker_core_container.stats_repository.clone(),
                 http_api_container.http_stats_repository.clone(),
                 http_api_container.udp_core_stats_repository.clone(),

packages/http-tracker-core/src/container.rs

@@ -2,7 +2,7 @@ use std::sync::Arc;
 
 use bittorrent_tracker_core::container::TrackerCoreContainer;
 use torrust_tracker_configuration::{Core, HttpTracker};
-use torrust_tracker_swarm_coordination_registry::container::TorrentRepositoryContainer;
+use torrust_tracker_swarm_coordination_registry::container::SwarmCoordinationRegistryContainer;
 
 use crate::event::bus::EventBus;
 use crate::event::sender::Broadcaster;
@@ -27,13 +27,13 @@ pub struct HttpTrackerCoreContainer {
 impl HttpTrackerCoreContainer {
     #[must_use]
     pub fn initialize(core_config: &Arc<Core>, http_tracker_config: &Arc<HttpTracker>) -> Arc<Self> {
-        let torrent_repository_container = Arc::new(TorrentRepositoryContainer::initialize(
+        let swarm_coordination_registry_container = Arc::new(SwarmCoordinationRegistryContainer::initialize(
             core_config.tracker_usage_statistics.into(),
         ));
 
         let tracker_core_container = Arc::new(TrackerCoreContainer::initialize_from(
             core_config,
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
         ));
 
         Self::initialize_from_tracker_core(&tracker_core_container, http_tracker_config)

packages/rest-tracker-api-core/src/container.rs

@@ -7,14 +7,14 @@ use bittorrent_udp_tracker_core::services::banning::BanService;
 use bittorrent_udp_tracker_core::{self};
 use tokio::sync::RwLock;
 use torrust_tracker_configuration::{Core, HttpApi, HttpTracker, UdpTracker};
-use torrust_tracker_swarm_coordination_registry::container::TorrentRepositoryContainer;
+use torrust_tracker_swarm_coordination_registry::container::SwarmCoordinationRegistryContainer;
 use torrust_udp_tracker_server::container::UdpTrackerServerContainer;
 
 pub struct TrackerHttpApiCoreContainer {
     pub http_api_config: Arc<HttpApi>,
 
-    // Torrent repository
-    pub torrent_repository_container: Arc<TorrentRepositoryContainer>,
+    // Swarm Coordination Registry Container
+    pub swarm_coordination_registry_container: Arc<SwarmCoordinationRegistryContainer>,
 
     // Tracker core
     pub tracker_core_container: Arc<TrackerCoreContainer>,
@@ -36,13 +36,13 @@ impl TrackerHttpApiCoreContainer {
         udp_tracker_config: &Arc<UdpTracker>,
         http_api_config: &Arc<HttpApi>,
     ) -> Arc<TrackerHttpApiCoreContainer> {
-        let torrent_repository_container = Arc::new(TorrentRepositoryContainer::initialize(
+        let swarm_coordination_registry_container = Arc::new(SwarmCoordinationRegistryContainer::initialize(
             core_config.tracker_usage_statistics.into(),
         ));
 
         let tracker_core_container = Arc::new(TrackerCoreContainer::initialize_from(
             core_config,
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
         ));
 
         let http_tracker_core_container =
@@ -54,7 +54,7 @@ impl TrackerHttpApiCoreContainer {
         let udp_tracker_server_container = UdpTrackerServerContainer::initialize(core_config);
 
         Self::initialize_from(
-            &torrent_repository_container,
+            &swarm_coordination_registry_container,
             &tracker_core_container,
             &http_tracker_core_container,
             &udp_tracker_core_container,
@@ -65,7 +65,7 @@ impl TrackerHttpApiCoreContainer {
 
     #[must_use]
     pub fn initialize_from(
-        torrent_repository_container: &Arc<TorrentRepositoryContainer>,
+        swarm_coordination_registry_container: &Arc<SwarmCoordinationRegistryContainer>,
         tracker_core_container: &Arc<TrackerCoreContainer>,
         http_tracker_core_container: &Arc<HttpTrackerCoreContainer>,
         udp_tracker_core_container: &Arc<UdpTrackerCoreContainer>,
@@ -75,8 +75,8 @@ impl TrackerHttpApiCoreContainer {
         Arc::new(TrackerHttpApiCoreContainer {
             http_api_config: http_api_config.clone(),
 
-            // Torrent repository
-            torrent_repository_container: torrent_repository_container.clone(),
+            // Swarm Coordination Registry Container
+            swarm_coordination_registry_container: swarm_coordination_registry_container.clone(),
 
             // Tracker core
             tracker_core_container: tracker_core_container.clone(),

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

@@ -165,7 +165,7 @@ mod tests {
     use tokio::sync::RwLock;
     use torrust_tracker_configuration::Configuration;
     use torrust_tracker_events::bus::SenderStatus;
-    use torrust_tracker_swarm_coordination_registry::container::TorrentRepositoryContainer;
+    use torrust_tracker_swarm_coordination_registry::container::SwarmCoordinationRegistryContainer;
     use torrust_tracker_test_helpers::configuration;
 
     use crate::statistics::metrics::{ProtocolMetrics, TorrentsMetrics};
@@ -180,9 +180,11 @@ mod tests {
         let config = tracker_configuration();
         let core_config = Arc::new(config.core.clone());
 
-        let torrent_repository_container = Arc::new(TorrentRepositoryContainer::initialize(SenderStatus::Enabled));
+        let swarm_coordination_registry_container =
+            Arc::new(SwarmCoordinationRegistryContainer::initialize(SenderStatus::Enabled));
 
-        let tracker_core_container = TrackerCoreContainer::initialize_from(&core_config, &torrent_repository_container.clone());
+        let tracker_core_container =
+            TrackerCoreContainer::initialize_from(&core_config, &swarm_coordination_registry_container.clone());
 
         let ban_service = Arc::new(RwLock::new(BanService::new(MAX_CONNECTION_ID_ERRORS_PER_IP)));
 

packages/swarm-coordination-registry/src/container.rs

@@ -8,17 +8,17 @@ use crate::event::{self};
 use crate::statistics::repository::Repository;
 use crate::{statistics, Registry};
 
-pub struct TorrentRepositoryContainer {
+pub struct SwarmCoordinationRegistryContainer {
     pub swarms: Arc<Registry>,
     pub event_bus: Arc<event::bus::EventBus>,
     pub stats_event_sender: event::sender::Sender,
     pub stats_repository: Arc<statistics::repository::Repository>,
 }
 
-impl TorrentRepositoryContainer {
+impl SwarmCoordinationRegistryContainer {
     #[must_use]
     pub fn initialize(sender_status: SenderStatus) -> Self {
-        // Torrent repository stats
+        // // Swarm Coordination Registry Container stats
         let broadcaster = Broadcaster::default();
         let stats_repository = Arc::new(Repository::new());
 

packages/swarm-coordination-registry/src/lib.rs

@@ -22,7 +22,7 @@ pub(crate) type CurrentClock = clock::Working;
 #[allow(dead_code)]
 pub(crate) type CurrentClock = clock::Stopped;
 
-pub const TORRENT_REPOSITORY_LOG_TARGET: &str = "TORRENT_REPOSITORY";
+pub const SWARM_COORDINATION_REGISTRY_LOG_TARGET: &str = "SWARM_COORDINATION_REGISTRY";
 
 #[cfg(test)]
 pub(crate) mod tests {

packages/swarm-coordination-registry/src/statistics/activity_metrics_updater.rs

@@ -10,7 +10,7 @@ use torrust_tracker_primitives::DurationSinceUnixEpoch;
 use tracing::instrument;
 
 use super::repository::Repository;
-use crate::statistics::{TORRENT_REPOSITORY_PEERS_INACTIVE_TOTAL, TORRENT_REPOSITORY_TORRENTS_INACTIVE_TOTAL};
+use crate::statistics::{SWARM_COORDINATION_REGISTRY_PEERS_INACTIVE_TOTAL, SWARM_COORDINATION_REGISTRY_TORRENTS_INACTIVE_TOTAL};
 use crate::{CurrentClock, Registry};
 
 #[must_use]
@@ -81,7 +81,7 @@ async fn update_inactive_peers_total(stats_repository: &Arc<Repository>, inactiv
 
     let _unused = stats_repository
         .set_gauge(
-            &metric_name!(TORRENT_REPOSITORY_PEERS_INACTIVE_TOTAL),
+            &metric_name!(SWARM_COORDINATION_REGISTRY_PEERS_INACTIVE_TOTAL),
             &LabelSet::default(),
             inactive_peers_total,
             CurrentClock::now(),
@@ -95,7 +95,7 @@ async fn update_inactive_torrents_total(stats_repository: &Arc<Repository>, inac
 
     let _unused = stats_repository
         .set_gauge(
-            &metric_name!(TORRENT_REPOSITORY_TORRENTS_INACTIVE_TOTAL),
+            &metric_name!(SWARM_COORDINATION_REGISTRY_TORRENTS_INACTIVE_TOTAL),
             &LabelSet::default(),
             inactive_torrents_total,
             CurrentClock::now(),