Merge torrust#1222: Overhaul core Tracker: reorganize code

4921f7b fix: [torrust#1221] docs links (Jose Celano)
1db58b1 refactor: [torrust#1221] move whitelist manager setup to whitelist context (Jose Celano)
716e7b2 refactor: [torrust#1221] move DB setup to databases context (Jose Celano)
d830c78 refactor: [torrust#1221] move core  torrent mod to torrent context (Jose Celano)
948cc8c refactor: [torrust#1221] move core statistics mod to statistics context (Jose Celano)

Pull request description:

  Overhaul core Tracker: reorganize code

ACKs for top commit:
  josecelano:
    ACK 4921f7b

Tree-SHA512: 5497f4318f80404ce5f4f4826b0bb99b3f633ec918c625b8acecc2bb0811e4cb82da80d0b06df3c733b68ff605bfd449736dd64c522aa2217f5391185826516f

Author: josecelano

src/bootstrap/app.rs

@@ -27,13 +27,15 @@ use crate::core::authentication::handler::KeysHandler;
 use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
 use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
 use crate::core::authentication::service;
+use crate::core::databases::setup::initialize_database;
 use crate::core::scrape_handler::ScrapeHandler;
-use crate::core::services::{initialize_database, initialize_whitelist_manager, statistics};
+use crate::core::statistics;
 use crate::core::torrent::manager::TorrentsManager;
 use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
 use crate::core::torrent::repository::persisted::DatabasePersistentTorrentRepository;
 use crate::core::whitelist::authorization::WhitelistAuthorization;
 use crate::core::whitelist::repository::in_memory::InMemoryWhitelist;
+use crate::core::whitelist::setup::initialize_whitelist_manager;
 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;

src/core/announce_handler.rs

@@ -414,7 +414,7 @@ mod tests {
             use crate::core::announce_handler::tests::the_announce_handler::peer_ip;
             use crate::core::announce_handler::{AnnounceHandler, PeersWanted};
             use crate::core::core_tests::{sample_info_hash, sample_peer};
-            use crate::core::services::initialize_database;
+            use crate::core::databases::setup::initialize_database;
             use crate::core::torrent::manager::TorrentsManager;
             use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
             use crate::core::torrent::repository::persisted::DatabasePersistentTorrentRepository;

src/core/authentication/handler.rs

@@ -246,7 +246,7 @@ mod tests {
         use crate::core::authentication::handler::KeysHandler;
         use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
         use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
-        use crate::core::services::initialize_database;
+        use crate::core::databases::setup::initialize_database;
 
         fn instantiate_keys_handler() -> KeysHandler {
             let config = configuration::ephemeral_private();

src/core/authentication/mod.rs

@@ -27,7 +27,7 @@ mod tests {
         use crate::core::authentication::key::repository::persisted::DatabaseKeyRepository;
         use crate::core::authentication::service;
         use crate::core::authentication::service::AuthenticationService;
-        use crate::core::services::initialize_database;
+        use crate::core::databases::setup::initialize_database;
 
         fn instantiate_keys_manager_and_authentication() -> (Arc<KeysHandler>, Arc<AuthenticationService>) {
             let config = configuration::ephemeral_private();

src/core/core_tests.rs

@@ -9,8 +9,8 @@ use torrust_tracker_primitives::peer::Peer;
 use torrust_tracker_primitives::DurationSinceUnixEpoch;
 
 use super::announce_handler::AnnounceHandler;
+use super::databases::setup::initialize_database;
 use super::scrape_handler::ScrapeHandler;
-use super::services::initialize_database;
 use super::torrent::repository::in_memory::InMemoryTorrentRepository;
 use super::torrent::repository::persisted::DatabasePersistentTorrentRepository;
 use super::whitelist::repository::in_memory::InMemoryWhitelist;

src/core/databases/mod.rs

@@ -46,6 +46,7 @@
 pub mod driver;
 pub mod error;
 pub mod mysql;
+pub mod setup;
 pub mod sqlite;
 
 use std::marker::PhantomData;

src/core/databases/setup.rs

@@ -0,0 +1,20 @@
+use std::sync::Arc;
+
+use torrust_tracker_configuration::v2_0_0::database;
+use torrust_tracker_configuration::Configuration;
+
+use super::driver::{self, Driver};
+use super::Database;
+
+/// # Panics
+///
+/// Will panic if database cannot be initialized.
+#[must_use]
+pub fn initialize_database(config: &Configuration) -> Arc<Box<dyn Database>> {
+    let driver = match config.core.database.driver {
+        database::Driver::Sqlite3 => Driver::Sqlite3,
+        database::Driver::MySQL => Driver::MySQL,
+    };
+
+    Arc::new(driver::build(&driver, &config.core.database.path).expect("Database driver build failed."))
+}

src/core/mod.rs

@@ -344,10 +344,10 @@
 //!
 //! # Services
 //!
-//! Services are domain services on top of the core tracker. Right now there are two types of service:
+//! Services are domain services on top of the core tracker domain. Right now there are two types of service:
 //!
-//! - For statistics
-//! - For torrents
+//! - For statistics: [`crate::core::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.
 //! They also decouple the internal data structure, used by the tracker, from the way we deliver that data to the consumers.
@@ -356,8 +356,6 @@
 //!
 //! Services can include extra features like pagination, for example.
 //!
-//! Refer to [`services`] module for more information about services.
-//!
 //! # Authentication
 //!
 //! One of the core `Tracker` responsibilities is to create and keep authentication keys. Auth keys are used by HTTP trackers
@@ -444,7 +442,6 @@ pub mod authentication;
 pub mod databases;
 pub mod error;
 pub mod scrape_handler;
-pub mod services;
 pub mod statistics;
 pub mod torrent;
 pub mod whitelist;

src/core/services/mod.rs

@@ -28,3 +28,5 @@ pub mod event;
 pub mod keeper;
 pub mod metrics;
 pub mod repository;
+pub mod services;
+pub mod setup;

src/core/statistics/mod.rs

@@ -2,7 +2,7 @@
 //!
 //! It includes:
 //!
-//! - A [`factory`](crate::core::services::statistics::setup::factory) function to build the structs needed to collect the tracker metrics.
+//! - A [`factory`](crate::core::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).
 //!
 //! Tracker metrics are collected using a Publisher-Subscribe pattern.
@@ -36,8 +36,6 @@
 //!     // ...
 //! }
 //! ```
-pub mod setup;
-
 use std::sync::Arc;
 
 use tokio::sync::RwLock;
@@ -117,9 +115,9 @@ mod tests {
     use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
     use torrust_tracker_test_helpers::configuration;
 
-    use crate::core::services::statistics::{self, get_metrics, TrackerMetrics};
+    use crate::core::statistics::services::{get_metrics, TrackerMetrics};
     use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
-    use crate::core::{self};
+    use crate::core::{self, statistics};
     use crate::servers::udp::server::banning::BanService;
     use crate::servers::udp::server::launcher::MAX_CONNECTION_ID_ERRORS_PER_IP;
 

src/core/services/statistics/mod.rs src/core/statistics/services.rs

@@ -27,6 +27,7 @@
 //!
 pub mod manager;
 pub mod repository;
+pub mod services;
 
 use torrust_tracker_torrent_repository::TorrentsSkipMapMutexStd;
 

src/core/services/statistics/setup.rs src/core/statistics/setup.rs

@@ -135,9 +135,9 @@ mod tests {
 
         use bittorrent_primitives::info_hash::InfoHash;
 
-        use crate::core::services::torrent::tests::sample_peer;
-        use crate::core::services::torrent::{get_torrent_info, Info};
         use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
+        use crate::core::torrent::services::tests::sample_peer;
+        use crate::core::torrent::services::{get_torrent_info, Info};
 
         #[tokio::test]
         async fn should_return_none_if_the_tracker_does_not_have_the_torrent() {
@@ -184,9 +184,9 @@ mod tests {
 
         use bittorrent_primitives::info_hash::InfoHash;
 
-        use crate::core::services::torrent::tests::sample_peer;
-        use crate::core::services::torrent::{get_torrents_page, BasicInfo, Pagination};
         use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
+        use crate::core::torrent::services::tests::sample_peer;
+        use crate::core::torrent::services::{get_torrents_page, BasicInfo, Pagination};
 
         #[tokio::test]
         async fn should_return_an_empty_result_if_the_tracker_does_not_have_any_torrent() {

src/core/torrent/mod.rs

@@ -1,6 +1,7 @@
 pub mod authorization;
 pub mod manager;
 pub mod repository;
+pub mod setup;
 pub mod whitelist_tests;
 
 #[cfg(test)]

src/core/services/torrent.rs src/core/torrent/services.rs

@@ -0,0 +1,15 @@
+use std::sync::Arc;
+
+use super::manager::WhitelistManager;
+use super::repository::in_memory::InMemoryWhitelist;
+use super::repository::persisted::DatabaseWhitelist;
+use crate::core::databases::Database;
+
+#[must_use]
+pub fn initialize_whitelist_manager(
+    database: Arc<Box<dyn Database>>,
+    in_memory_whitelist: Arc<InMemoryWhitelist>,
+) -> Arc<WhitelistManager> {
+    let database_whitelist = Arc::new(DatabaseWhitelist::new(database));
+    Arc::new(WhitelistManager::new(database_whitelist, in_memory_whitelist))
+}

src/core/whitelist/mod.rs

@@ -5,7 +5,8 @@ use torrust_tracker_configuration::Configuration;
 use super::authorization::WhitelistAuthorization;
 use super::manager::WhitelistManager;
 use super::repository::in_memory::InMemoryWhitelist;
-use crate::core::services::{initialize_database, initialize_whitelist_manager};
+use crate::core::databases::setup::initialize_database;
+use crate::core::whitelist::setup::initialize_whitelist_manager;
 
 #[must_use]
 pub fn initialize_whitelist_services(config: &Configuration) -> (Arc<WhitelistAuthorization>, Arc<WhitelistManager>) {

src/core/whitelist/setup.rs

@@ -9,8 +9,8 @@ use serde::Deserialize;
 use tokio::sync::RwLock;
 
 use super::responses::{metrics_response, stats_response};
-use crate::core::services::statistics::get_metrics;
 use crate::core::statistics::repository::Repository;
+use crate::core::statistics::services::get_metrics;
 use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
 use crate::servers::udp::server::banning::BanService;
 

src/core/whitelist/whitelist_tests.rs

@@ -2,7 +2,7 @@
 //! API context.
 use serde::{Deserialize, Serialize};
 
-use crate::core::services::statistics::TrackerMetrics;
+use crate::core::statistics::services::TrackerMetrics;
 
 /// It contains all the statistics generated by the tracker.
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
@@ -121,8 +121,8 @@ mod tests {
     use torrust_tracker_primitives::torrent_metrics::TorrentsMetrics;
 
     use super::Stats;
-    use crate::core::services::statistics::TrackerMetrics;
     use crate::core::statistics::metrics::Metrics;
+    use crate::core::statistics::services::TrackerMetrics;
 
     #[test]
     fn stats_resource_should_be_converted_from_tracker_metrics() {

src/servers/apis/v1/context/stats/handlers.rs

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

src/servers/apis/v1/context/stats/resources.rs

@@ -13,8 +13,8 @@ use thiserror::Error;
 use torrust_tracker_primitives::pagination::Pagination;
 
 use super::responses::{torrent_info_response, torrent_list_response, torrent_not_known_response};
-use crate::core::services::torrent::{get_torrent_info, get_torrents, get_torrents_page};
 use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
+use crate::core::torrent::services::{get_torrent_info, get_torrents, get_torrents_page};
 use crate::servers::apis::v1::responses::invalid_info_hash_param_response;
 use crate::servers::apis::InfoHashParam;
 

src/servers/apis/v1/context/stats/responses.rs

@@ -6,7 +6,7 @@
 //!   the JSON response.
 use serde::{Deserialize, Serialize};
 
-use crate::core::services::torrent::{BasicInfo, Info};
+use crate::core::torrent::services::{BasicInfo, Info};
 
 /// `Torrent` API resource.
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
@@ -102,7 +102,7 @@ mod tests {
     use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch};
 
     use super::Torrent;
-    use crate::core::services::torrent::{BasicInfo, Info};
+    use crate::core::torrent::services::{BasicInfo, Info};
     use crate::servers::apis::v1::context::torrent::resources::peer::Peer;
     use crate::servers::apis::v1::context::torrent::resources::torrent::ListItem;
 

src/servers/apis/v1/context/torrent/handlers.rs

@@ -4,7 +4,7 @@ use axum::response::{IntoResponse, Json, Response};
 use serde_json::json;
 
 use super::resources::torrent::{ListItem, Torrent};
-use crate::core::services::torrent::{BasicInfo, Info};
+use crate::core::torrent::services::{BasicInfo, Info};
 
 /// `200` response that contains an array of
 /// [`ListItem`]

src/servers/apis/v1/context/torrent/resources/torrent.rs

@@ -257,7 +257,8 @@ mod tests {
     use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
     use crate::core::authentication::service::AuthenticationService;
     use crate::core::core_tests::sample_info_hash;
-    use crate::core::services::{initialize_database, statistics};
+    use crate::core::databases::setup::initialize_database;
+    use crate::core::statistics;
     use crate::core::statistics::event::sender::Sender;
     use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use crate::core::torrent::repository::persisted::DatabasePersistentTorrentRepository;

src/servers/apis/v1/context/torrent/responses.rs

@@ -177,7 +177,7 @@ mod tests {
     use crate::core::authentication::key::repository::in_memory::InMemoryKeyRepository;
     use crate::core::authentication::service::AuthenticationService;
     use crate::core::scrape_handler::ScrapeHandler;
-    use crate::core::services::statistics;
+    use crate::core::statistics;
     use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use crate::core::whitelist::authorization::WhitelistAuthorization;
     use crate::core::whitelist::repository::in_memory::InMemoryWhitelist;

src/servers/http/v1/handlers/announce.rs

@@ -65,7 +65,8 @@ mod tests {
     use torrust_tracker_test_helpers::configuration;
 
     use crate::core::announce_handler::AnnounceHandler;
-    use crate::core::services::{initialize_database, statistics};
+    use crate::core::databases::setup::initialize_database;
+    use crate::core::statistics;
     use crate::core::statistics::event::sender::Sender;
     use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use crate::core::torrent::repository::persisted::DatabasePersistentTorrentRepository;
@@ -137,7 +138,7 @@ mod tests {
         use super::{sample_peer_using_ipv4, sample_peer_using_ipv6};
         use crate::core::announce_handler::{AnnounceHandler, PeersWanted};
         use crate::core::core_tests::sample_info_hash;
-        use crate::core::services::initialize_database;
+        use crate::core::databases::setup::initialize_database;
         use crate::core::statistics;
         use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
         use crate::core::torrent::repository::persisted::DatabasePersistentTorrentRepository;

src/servers/http/v1/handlers/scrape.rs

@@ -82,8 +82,8 @@ mod tests {
 
     use crate::core::announce_handler::AnnounceHandler;
     use crate::core::core_tests::sample_info_hash;
+    use crate::core::databases::setup::initialize_database;
     use crate::core::scrape_handler::ScrapeHandler;
-    use crate::core::services::initialize_database;
     use crate::core::torrent::repository::in_memory::InMemoryTorrentRepository;
     use crate::core::torrent::repository::persisted::DatabasePersistentTorrentRepository;
     use crate::core::whitelist::authorization::WhitelistAuthorization;
@@ -153,7 +153,7 @@ mod tests {
 
         #[tokio::test]
         async fn it_should_return_the_scrape_data_for_a_torrent() {
-            let (stats_event_sender, _stats_repository) = crate::core::services::statistics::setup::factory(false);
+            let (stats_event_sender, _stats_repository) = crate::core::statistics::setup::factory(false);
             let stats_event_sender = Arc::new(stats_event_sender);
 
             let (announce_handler, scrape_handler) = initialize_announce_and_scrape_handlers_for_public_tracker();
@@ -236,7 +236,7 @@ mod tests {
 
         #[tokio::test]
         async fn it_should_always_return_the_zeroed_scrape_data_for_a_torrent() {
-            let (stats_event_sender, _stats_repository) = crate::core::services::statistics::setup::factory(false);
+            let (stats_event_sender, _stats_repository) = crate::core::statistics::setup::factory(false);
             let stats_event_sender = Arc::new(stats_event_sender);
 
             let (announce_handler, _scrape_handler) = initialize_announce_and_scrape_handlers_for_public_tracker();