Merge #1222: Overhaul core Tracker: reorganize code

4921f7b fix: [#1221] docs links (Jose Celano)
1db58b1 refactor: [#1221] move whitelist manager setup to whitelist context (Jose Celano)
716e7b2 refactor: [#1221] move DB setup to databases context (Jose Celano)
d830c78 refactor: [#1221] move core  torrent mod to torrent context (Jose Celano)
948cc8c refactor: [#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;