refactor: [torrust#1228] move statistics back from tracker-core to main lib

The statistics are only used at the higher levels: UDP and HTTP tracker.

We will move them to new packages.

Author: josecelano

Cargo.lock

@@ -20,7 +20,6 @@ bittorrent-http-protocol = { version = "3.0.0-develop", path = "../http-protocol
 bittorrent-primitives = "0.1.0"
 chrono = { version = "0", default-features = false, features = ["clock"] }
 derive_more = { version = "1", features = ["as_ref", "constructor", "from"] }
-futures = "0"
 r2d2 = "0"
 r2d2_mysql = "25"
 r2d2_sqlite = { version = "0", features = ["bundled"] }

packages/tracker-core/Cargo.toml

@@ -346,7 +346,7 @@
 //!
 //! Services are domain services on top of the core tracker domain. Right now there are two types of service:
 //!
-//! - For statistics: [`crate::core::statistics::services`]
+//! - For statistics: [`crate::packages::statistics::services`]
 //! - For torrents: [`crate::core::torrent::services`]
 //!
 //! Services usually format the data inside the tracker to make it easier to consume by other parts.
@@ -442,7 +442,6 @@ pub mod authentication;
 pub mod databases;
 pub mod error;
 pub mod scrape_handler;
-pub mod statistics;
 pub mod torrent;
 pub mod whitelist;
 

packages/tracker-core/src/lib.rs

@@ -20,26 +20,26 @@ use bittorrent_tracker_core::authentication::key::repository::persisted::Databas
 use bittorrent_tracker_core::authentication::service;
 use bittorrent_tracker_core::databases::setup::initialize_database;
 use bittorrent_tracker_core::scrape_handler::ScrapeHandler;
-use bittorrent_tracker_core::statistics;
 use bittorrent_tracker_core::torrent::manager::TorrentsManager;
 use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
 use bittorrent_tracker_core::torrent::repository::persisted::DatabasePersistentTorrentRepository;
 use bittorrent_tracker_core::whitelist::authorization::WhitelistAuthorization;
 use bittorrent_tracker_core::whitelist::repository::in_memory::InMemoryWhitelist;
 use bittorrent_tracker_core::whitelist::setup::initialize_whitelist_manager;
+use packages::statistics;
 use tokio::sync::RwLock;
 use torrust_tracker_clock::static_time;
 use torrust_tracker_configuration::validator::Validator;
 use torrust_tracker_configuration::Configuration;
 use tracing::instrument;
 
 use super::config::initialize_configuration;
-use crate::bootstrap;
 use crate::container::AppContainer;
 use crate::servers::udp::server::banning::BanService;
 use crate::servers::udp::server::launcher::MAX_CONNECTION_ID_ERRORS_PER_IP;
 use crate::shared::crypto::ephemeral_instance_keys;
 use crate::shared::crypto::keys::{self, Keeper as _};
+use crate::{bootstrap, packages};
 
 /// It loads the configuration from the environment and builds app container.
 ///

packages/tracker-core/src/statistics/mod.rs

@@ -5,16 +5,17 @@ use bittorrent_tracker_core::authentication::handler::KeysHandler;
 use bittorrent_tracker_core::authentication::service::AuthenticationService;
 use bittorrent_tracker_core::databases::Database;
 use bittorrent_tracker_core::scrape_handler::ScrapeHandler;
-use bittorrent_tracker_core::statistics::event::sender::Sender;
-use bittorrent_tracker_core::statistics::repository::Repository;
 use bittorrent_tracker_core::torrent::manager::TorrentsManager;
 use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
 use bittorrent_tracker_core::torrent::repository::persisted::DatabasePersistentTorrentRepository;
 use bittorrent_tracker_core::whitelist;
 use bittorrent_tracker_core::whitelist::manager::WhitelistManager;
+use packages::statistics::event::sender::Sender;
+use packages::statistics::repository::Repository;
 use tokio::sync::RwLock;
 use torrust_tracker_configuration::{Core, HttpApi, HttpTracker, UdpTracker};
 
+use crate::packages;
 use crate::servers::udp::server::banning::BanService;
 
 pub struct AppContainer {

src/bootstrap/app.rs

@@ -494,7 +494,7 @@ pub mod app;
 pub mod bootstrap;
 pub mod console;
 pub mod container;
-pub mod core;
+pub mod packages;
 pub mod servers;
 pub mod shared;
 

src/container.rs

@@ -1,5 +1,5 @@
-use crate::statistics::event::{Event, UdpResponseKind};
-use crate::statistics::repository::Repository;
+use crate::packages::statistics::event::{Event, UdpResponseKind};
+use crate::packages::statistics::repository::Repository;
 
 pub async fn handle_event(event: Event, stats_repository: &Repository) {
     match event {
@@ -102,9 +102,9 @@ pub async fn handle_event(event: Event, stats_repository: &Repository) {
 
 #[cfg(test)]
 mod tests {
-    use crate::statistics::event::handler::handle_event;
-    use crate::statistics::event::Event;
-    use crate::statistics::repository::Repository;
+    use crate::packages::statistics::event::handler::handle_event;
+    use crate::packages::statistics::event::Event;
+    use crate::packages::statistics::repository::Repository;
 
     #[tokio::test]
     async fn should_increase_the_tcp4_announces_counter_when_it_receives_a_tcp4_announce_event() {

src/core/statistics/mod.rs

@@ -2,7 +2,7 @@ use tokio::sync::mpsc;
 
 use super::handler::handle_event;
 use super::Event;
-use crate::statistics::repository::Repository;
+use crate::packages::statistics::repository::Repository;
 
 pub async fn dispatch_events(mut receiver: mpsc::Receiver<Event>, stats_repository: Repository) {
     while let Some(event) = receiver.recv().await {

src/lib.rs

@@ -13,10 +13,10 @@ pub trait Sender: Sync + Send {
     fn send_event(&self, event: Event) -> BoxFuture<'_, Option<Result<(), SendError<Event>>>>;
 }
 
-/// An [`statistics::EventSender`](crate::core::statistics::event::sender::Sender) implementation.
+/// An [`statistics::EventSender`](crate::packages::statistics::event::sender::Sender) implementation.
 ///
 /// It uses a channel sender to send the statistic events. The channel is created by a
-/// [`statistics::Keeper`](crate::core::statistics::keeper::Keeper)
+/// [`statistics::Keeper`](crate::packages::statistics::keeper::Keeper)
 #[allow(clippy::module_name_repetitions)]
 pub struct ChannelSender {
     pub(crate) sender: mpsc::Sender<Event>,

src/core/mod.rs src/packages/mod.rs

@@ -51,9 +51,9 @@ impl Keeper {
 
 #[cfg(test)]
 mod tests {
-    use crate::statistics::event::Event;
-    use crate::statistics::keeper::Keeper;
-    use crate::statistics::metrics::Metrics;
+    use crate::packages::statistics::event::Event;
+    use crate::packages::statistics::keeper::Keeper;
+    use crate::packages::statistics::metrics::Metrics;
 
     #[tokio::test]
     async fn should_contain_the_tracker_statistics() {

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

@@ -0,0 +1,6 @@
+pub mod event;
+pub mod keeper;
+pub mod metrics;
+pub mod repository;
+pub mod services;
+pub mod setup;

packages/tracker-core/src/statistics/event/listener.rs src/packages/statistics/event/listener.rs

@@ -2,14 +2,14 @@
 //!
 //! It includes:
 //!
-//! - A [`factory`](crate::statistics::setup::factory) function to build the structs needed to collect the tracker metrics.
-//! - A [`get_metrics`] service to get the tracker [`metrics`](crate::core::statistics::metrics::Metrics).
+//! - A [`factory`](crate::packages::statistics::setup::factory) function to build the structs needed to collect the tracker metrics.
+//! - A [`get_metrics`] service to get the tracker [`metrics`](crate::packages::statistics::metrics::Metrics).
 //!
 //! Tracker metrics are collected using a Publisher-Subscribe pattern.
 //!
 //! The factory function builds two structs:
 //!
-//! - An statistics event [`Sender`](crate::core::statistics::event::sender::Sender)
+//! - An statistics event [`Sender`](crate::packages::statistics::event::sender::Sender)
 //! - An statistics [`Repository`]
 //!
 //! ```text
@@ -21,7 +21,7 @@
 //! There is an event listener that is receiving all the events and processing them with an event handler.
 //! Then, the event handler updates the metrics depending on the received event.
 //!
-//! For example, if you send the event [`Event::Udp4Connect`](crate::core::statistics::event::Event::Udp4Connect):
+//! For example, if you send the event [`Event::Udp4Connect`](crate::packages::statistics::event::Event::Udp4Connect):
 //!
 //! ```text
 //! let result = event_sender.send_event(Event::Udp4Connect).await;
@@ -38,12 +38,13 @@
 //! ```
 use std::sync::Arc;
 
-use bittorrent_tracker_core::statistics::metrics::Metrics;
-use bittorrent_tracker_core::statistics::repository::Repository;
 use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
+use packages::statistics::metrics::Metrics;
+use packages::statistics::repository::Repository;
 use tokio::sync::RwLock;
 use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
 
+use crate::packages;
 use crate::servers::udp::server::banning::BanService;
 
 /// All the metrics collected by the tracker.
@@ -111,13 +112,14 @@ mod tests {
     use std::sync::Arc;
 
     use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
-    use bittorrent_tracker_core::{self, statistics};
+    use bittorrent_tracker_core::{self};
     use tokio::sync::RwLock;
     use torrust_tracker_configuration::Configuration;
     use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
     use torrust_tracker_test_helpers::configuration;
 
-    use crate::core::statistics::services::{get_metrics, TrackerMetrics};
+    use crate::packages::statistics;
+    use crate::packages::statistics::services::{get_metrics, TrackerMetrics};
     use crate::servers::udp::server::banning::BanService;
     use crate::servers::udp::server::launcher::MAX_CONNECTION_ID_ERRORS_PER_IP;
 

packages/tracker-core/src/statistics/event/mod.rs src/packages/statistics/event/mod.rs

@@ -1,14 +1,14 @@
 //! Setup for the tracker statistics.
 //!
 //! The [`factory`] function builds the structs needed for handling the tracker metrics.
-use crate::statistics;
+use crate::packages::statistics;
 
 /// It builds the structs needed for handling the tracker metrics.
 ///
 /// It returns:
 ///
-/// - An statistics event [`Sender`](crate::core::statistics::event::sender::Sender) that allows you to send events related to statistics.
-/// - An statistics [`Repository`](crate::core::statistics::repository::Repository) which is an in-memory repository for the tracker metrics.
+/// - An statistics event [`Sender`](crate::packages::statistics::event::sender::Sender) that allows you to send events related to statistics.
+/// - An statistics [`Repository`](crate::packages::statistics::repository::Repository) which is an in-memory repository for the tracker metrics.
 ///
 /// When the input argument `tracker_usage_statistics`is false the setup does not run the event listeners, consequently the statistics
 /// events are sent are received but not dispatched to the handler.

packages/tracker-core/src/statistics/event/sender.rs src/packages/statistics/event/sender.rs

@@ -5,13 +5,14 @@ use std::sync::Arc;
 use axum::extract::State;
 use axum::response::Response;
 use axum_extra::extract::Query;
-use bittorrent_tracker_core::statistics::repository::Repository;
 use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
+use packages::statistics::repository::Repository;
 use serde::Deserialize;
 use tokio::sync::RwLock;
 
 use super::responses::{metrics_response, stats_response};
-use crate::core::statistics::services::get_metrics;
+use crate::packages;
+use crate::packages::statistics::services::get_metrics;
 use crate::servers::udp::server::banning::BanService;
 
 #[derive(Deserialize, Debug, Default)]

packages/tracker-core/src/statistics/keeper.rs src/packages/statistics/keeper.rs

@@ -2,7 +2,7 @@
 //! API context.
 use serde::{Deserialize, Serialize};
 
-use crate::core::statistics::services::TrackerMetrics;
+use crate::packages::statistics::services::TrackerMetrics;
 
 /// It contains all the statistics generated by the tracker.
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
@@ -118,11 +118,12 @@ impl From<TrackerMetrics> for Stats {
 
 #[cfg(test)]
 mod tests {
-    use bittorrent_tracker_core::statistics::metrics::Metrics;
+    use packages::statistics::metrics::Metrics;
     use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
 
     use super::Stats;
-    use crate::core::statistics::services::TrackerMetrics;
+    use crate::packages::statistics::services::TrackerMetrics;
+    use crate::packages::{self};
 
     #[test]
     fn stats_resource_should_be_converted_from_tracker_metrics() {

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

@@ -3,7 +3,7 @@
 use axum::response::{IntoResponse, Json, Response};
 
 use super::resources::Stats;
-use crate::core::statistics::services::TrackerMetrics;
+use crate::packages::statistics::services::TrackerMetrics;
 
 /// `200` response that contains the [`Stats`] resource as json.
 #[must_use]

src/packages/statistics/mod.rs

@@ -19,9 +19,9 @@ use bittorrent_http_protocol::v1::services::peer_ip_resolver::ClientIpSources;
 use bittorrent_tracker_core::announce_handler::{AnnounceHandler, PeersWanted};
 use bittorrent_tracker_core::authentication::service::AuthenticationService;
 use bittorrent_tracker_core::authentication::Key;
-use bittorrent_tracker_core::statistics::event::sender::Sender;
 use bittorrent_tracker_core::whitelist;
 use hyper::StatusCode;
+use packages::statistics::event::sender::Sender;
 use torrust_tracker_clock::clock::Time;
 use torrust_tracker_configuration::Core;
 use torrust_tracker_primitives::core::AnnounceData;
@@ -33,7 +33,7 @@ use crate::servers::http::v1::extractors::authentication_key::Extract as Extract
 use crate::servers::http::v1::extractors::client_ip_sources::Extract as ExtractClientIpSources;
 use crate::servers::http::v1::handlers::common::auth;
 use crate::servers::http::v1::services::{self};
-use crate::CurrentClock;
+use crate::{packages, CurrentClock};
 
 /// It handles the `announce` request when the HTTP tracker does not require
 /// authentication (no PATH `key` parameter required).
@@ -256,15 +256,17 @@ mod tests {
     use bittorrent_tracker_core::authentication::service::AuthenticationService;
     use bittorrent_tracker_core::core_tests::sample_info_hash;
     use bittorrent_tracker_core::databases::setup::initialize_database;
-    use bittorrent_tracker_core::statistics;
-    use bittorrent_tracker_core::statistics::event::sender::Sender;
     use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use bittorrent_tracker_core::torrent::repository::persisted::DatabasePersistentTorrentRepository;
     use bittorrent_tracker_core::whitelist::authorization::WhitelistAuthorization;
     use bittorrent_tracker_core::whitelist::repository::in_memory::InMemoryWhitelist;
+    use packages::statistics;
+    use packages::statistics::event::sender::Sender;
     use torrust_tracker_configuration::{Configuration, Core};
     use torrust_tracker_test_helpers::configuration;
 
+    use crate::packages;
+
     struct CoreTrackerServices {
         pub core_config: Arc<Core>,
         pub announce_handler: Arc<AnnounceHandler>,

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

@@ -15,11 +15,12 @@ use bittorrent_http_protocol::v1::services::peer_ip_resolver::{self, ClientIpSou
 use bittorrent_tracker_core::authentication::service::AuthenticationService;
 use bittorrent_tracker_core::authentication::Key;
 use bittorrent_tracker_core::scrape_handler::ScrapeHandler;
-use bittorrent_tracker_core::statistics::event::sender::Sender;
 use hyper::StatusCode;
+use packages::statistics::event::sender::Sender;
 use torrust_tracker_configuration::Core;
 use torrust_tracker_primitives::core::ScrapeData;
 
+use crate::packages;
 use crate::servers::http::v1::extractors::authentication_key::Extract as ExtractKey;
 use crate::servers::http::v1::extractors::client_ip_sources::Extract as ExtractClientIpSources;
 use crate::servers::http::v1::extractors::scrape_request::ExtractRequest;
@@ -174,13 +175,15 @@ mod tests {
     use bittorrent_tracker_core::authentication::key::repository::in_memory::InMemoryKeyRepository;
     use bittorrent_tracker_core::authentication::service::AuthenticationService;
     use bittorrent_tracker_core::scrape_handler::ScrapeHandler;
-    use bittorrent_tracker_core::statistics;
     use bittorrent_tracker_core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use bittorrent_tracker_core::whitelist::authorization::WhitelistAuthorization;
     use bittorrent_tracker_core::whitelist::repository::in_memory::InMemoryWhitelist;
+    use packages::statistics;
     use torrust_tracker_configuration::{Configuration, Core};
     use torrust_tracker_test_helpers::configuration;
 
+    use crate::packages;
+
     struct CoreTrackerServices {
         pub core_config: Arc<Core>,
         pub scrape_handler: Arc<ScrapeHandler>,