dev: refactor: rename tracker mod to core

packages/configuration/src/lib.rs

@@ -30,10 +30,10 @@
 //!
 //! Each section in the toml structure is mapped to a data structure. For
 //! example, the `[http_api]` section (configuration for the tracker HTTP API)
-//! is mapped to the [`HttpApi`](HttpApi) structure.
+//! is mapped to the [`HttpApi`] structure.
 //!
 //! > **NOTICE**: some sections are arrays of structures. For example, the
-//! > `[[udp_trackers]]` section is an array of [`UdpTracker`](UdpTracker) since
+//! > `[[udp_trackers]]` section is an array of [`UdpTracker`] since
 //! > you can have multiple running UDP trackers bound to different ports.
 //!
 //! Please refer to the documentation of each structure for more information
@@ -394,7 +394,7 @@ pub struct Configuration {
     /// Logging level. Possible values are: `Off`, `Error`, `Warn`, `Info`,
     /// `Debug` and `Trace`. Default is `Info`.
     pub log_level: Option<String>,
-    /// Tracker mode. See [`TrackerMode`](torrust_tracker_primitives::TrackerMode) for more information.
+    /// Tracker mode. See [`TrackerMode`] for more information.
     pub mode: TrackerMode,
 
     // Database configuration

src/app.rs

@@ -28,16 +28,16 @@ use tokio::task::JoinHandle;
 use torrust_tracker_configuration::Configuration;
 
 use crate::bootstrap::jobs::{health_check_api, http_tracker, torrent_cleanup, tracker_apis, udp_tracker};
+use crate::core;
 use crate::servers::http::Version;
-use crate::tracker;
 
 /// # Panics
 ///
 /// Will panic if:
 ///
 /// - Can't retrieve tracker keys from database.
 /// - Can't load whitelist from database.
-pub async fn start(config: Arc<Configuration>, tracker: Arc<tracker::Tracker>) -> Vec<JoinHandle<()>> {
+pub async fn start(config: Arc<Configuration>, tracker: Arc<core::Tracker>) -> Vec<JoinHandle<()>> {
     let mut jobs: Vec<JoinHandle<()>> = Vec::new();
 
     // Load peer keys

src/bootstrap/app.rs

@@ -17,10 +17,10 @@ use torrust_tracker_configuration::Configuration;
 
 use super::config::initialize_configuration;
 use crate::bootstrap;
+use crate::core::services::tracker_factory;
+use crate::core::Tracker;
 use crate::shared::clock::static_time;
 use crate::shared::crypto::ephemeral_instance_keys;
-use crate::tracker::services::tracker_factory;
-use crate::tracker::Tracker;
 
 /// It loads the configuration from the environment and builds the main domain [`Tracker`] struct.
 #[must_use]

src/bootstrap/jobs/http_tracker.rs

@@ -19,9 +19,9 @@ use tokio::sync::oneshot;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::HttpTracker;
 
+use crate::core;
 use crate::servers::http::v1::launcher;
 use crate::servers::http::Version;
-use crate::tracker;
 
 /// This is the message that the "**launcher**" spawned task sends to the main application process to notify that the HTTP server was successfully started.
 ///
@@ -33,7 +33,7 @@ pub struct ServerJobStarted();
 ///
 /// Right now there is only one version but in the future we could support more than one HTTP tracker version at the same time.
 /// This feature allows supporting breaking changes on `BitTorrent` BEPs.
-pub async fn start_job(config: &HttpTracker, tracker: Arc<tracker::Tracker>, version: Version) -> JoinHandle<()> {
+pub async fn start_job(config: &HttpTracker, tracker: Arc<core::Tracker>, version: Version) -> JoinHandle<()> {
     match version {
         Version::V1 => start_v1(config, tracker.clone()).await,
     }
@@ -42,7 +42,7 @@ pub async fn start_job(config: &HttpTracker, tracker: Arc<tracker::Tracker>, ver
 /// # Panics
 ///
 /// It would panic if the `config::HttpTracker` struct would contain inappropriate values.
-async fn start_v1(config: &HttpTracker, tracker: Arc<tracker::Tracker>) -> JoinHandle<()> {
+async fn start_v1(config: &HttpTracker, tracker: Arc<core::Tracker>) -> JoinHandle<()> {
     let bind_addr = config
         .bind_address
         .parse::<std::net::SocketAddr>()

src/bootstrap/jobs/torrent_cleanup.rs

@@ -17,15 +17,15 @@ use log::info;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::Configuration;
 
-use crate::tracker;
+use crate::core;
 
 /// It starts a jobs for cleaning up the torrent data in the tracker.
 ///
 /// The cleaning task is executed on an `inactive_peer_cleanup_interval`.
 ///
 /// Refer to [`torrust-tracker-configuration documentation`](https://docs.rs/torrust-tracker-configuration) for more info about that option.
 #[must_use]
-pub fn start_job(config: &Arc<Configuration>, tracker: &Arc<tracker::Tracker>) -> JoinHandle<()> {
+pub fn start_job(config: &Arc<Configuration>, tracker: &Arc<core::Tracker>) -> JoinHandle<()> {
     let weak_tracker = std::sync::Arc::downgrade(tracker);
     let interval = config.inactive_peer_cleanup_interval;
 

src/bootstrap/jobs/tracker_apis.rs

@@ -28,8 +28,8 @@ use tokio::sync::oneshot;
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::HttpApi;
 
+use crate::core;
 use crate::servers::apis::server;
-use crate::tracker;
 
 /// This is the message that the "launcher" spawned task sends to the main
 /// application process to notify the API server was successfully started.
@@ -49,7 +49,7 @@ pub struct ApiServerJobStarted();
 /// # Panics
 ///
 /// It would panic if unable to send the  `ApiServerJobStarted` notice.
-pub async fn start_job(config: &HttpApi, tracker: Arc<tracker::Tracker>) -> JoinHandle<()> {
+pub async fn start_job(config: &HttpApi, tracker: Arc<core::Tracker>) -> JoinHandle<()> {
     let bind_addr = config
         .bind_address
         .parse::<std::net::SocketAddr>()

src/bootstrap/jobs/udp_tracker.rs

@@ -12,14 +12,14 @@ use log::{error, info, warn};
 use tokio::task::JoinHandle;
 use torrust_tracker_configuration::UdpTracker;
 
+use crate::core;
 use crate::servers::udp::server::Udp;
-use crate::tracker;
 
 /// It starts a new UDP server with the provided configuration.
 ///
 /// It spawns a new asynchronous task for the new UDP server.
 #[must_use]
-pub fn start_job(config: &UdpTracker, tracker: Arc<tracker::Tracker>) -> JoinHandle<()> {
+pub fn start_job(config: &UdpTracker, tracker: Arc<core::Tracker>) -> JoinHandle<()> {
     let bind_addr = config.bind_address.clone();
 
     tokio::spawn(async move {

src/tracker/auth.rs → src/core/auth.rs

@@ -12,7 +12,7 @@
 //! Keys are stored in this struct:
 //!
 //! ```rust,no_run
-//! use torrust_tracker::tracker::auth::Key;
+//! use torrust_tracker::core::auth::Key;
 //! use torrust_tracker::shared::clock::DurationSinceUnixEpoch;
 //!
 //! pub struct ExpiringKey {
@@ -26,7 +26,7 @@
 //! You can generate a new key valid for `9999` seconds and `0` nanoseconds from the current time with the following:
 //!
 //! ```rust,no_run
-//! use torrust_tracker::tracker::auth;
+//! use torrust_tracker::core::auth;
 //! use std::time::Duration;
 //!
 //! let expiring_key = auth::generate(Duration::new(9999, 0));
@@ -138,7 +138,7 @@ pub struct Key(String);
 /// Error returned when a key cannot be parsed from a string.
 ///
 /// ```rust,no_run
-/// use torrust_tracker::tracker::auth::Key;
+/// use torrust_tracker::core::auth::Key;
 /// use std::str::FromStr;
 ///
 /// let key_string = "YZSl4lMZupRuOpSRC3krIKR5BPB14nrJ";
@@ -164,7 +164,7 @@ impl FromStr for Key {
     }
 }
 
-/// Verification error. Error returned when an [`ExpiringKey`] cannot be verified with the [`verify(...)`](crate::tracker::auth::verify) function.
+/// Verification error. Error returned when an [`ExpiringKey`] cannot be verified with the [`verify(...)`](crate::core::auth::verify) function.
 ///
 #[derive(Debug, Error)]
 #[allow(dead_code)]
@@ -196,7 +196,7 @@ mod tests {
     mod key {
         use std::str::FromStr;
 
-        use crate::tracker::auth::Key;
+        use crate::core::auth::Key;
 
         #[test]
         fn should_be_parsed_from_an_string() {
@@ -212,8 +212,8 @@ mod tests {
         use std::str::FromStr;
         use std::time::Duration;
 
+        use crate::core::auth;
         use crate::shared::clock::{Current, StoppedTime};
-        use crate::tracker::auth;
 
         #[test]
         fn should_be_parsed_from_an_string() {

src/tracker/databases/driver.rs → src/core/databases/driver.rs

@@ -1,6 +1,6 @@
 //! Database driver factory.
 //!
-//! See [`databases::driver::build`](crate::tracker::databases::driver::build)
+//! See [`databases::driver::build`](crate::core::databases::driver::build)
 //! function for more information.
 use torrust_tracker_primitives::DatabaseDriver;
 
@@ -14,7 +14,7 @@ use super::{Builder, Database};
 /// Example for `SQLite3`:
 ///
 /// ```rust,no_run
-/// use torrust_tracker::tracker::databases;
+/// use torrust_tracker::core::databases;
 /// use torrust_tracker_primitives::DatabaseDriver;
 ///
 /// let db_driver = DatabaseDriver::Sqlite3;
@@ -25,7 +25,7 @@ use super::{Builder, Database};
 /// Example for `MySQL`:
 ///
 /// ```rust,no_run
-/// use torrust_tracker::tracker::databases;
+/// use torrust_tracker::core::databases;
 /// use torrust_tracker_primitives::DatabaseDriver;
 ///
 /// let db_driver = DatabaseDriver::MySQL;

src/tracker/databases/error.rs → src/core/databases/error.rs

@@ -1,6 +1,6 @@
 //! Database errors.
 //!
-//! This module contains the [Database errors](crate::tracker::databases::error::Error).
+//! This module contains the [Database errors](crate::core::databases::error::Error).
 use std::panic::Location;
 use std::sync::Arc;
 

src/tracker/databases/mod.rs → src/core/databases/mod.rs

@@ -4,8 +4,8 @@
 //!
 //! There are two implementations of the trait (two drivers):
 //!
-//! - [`Mysql`](crate::tracker::databases::mysql::Mysql)
-//! - [`Sqlite`](crate::tracker::databases::sqlite::Sqlite)
+//! - [`Mysql`](crate::core::databases::mysql::Mysql)
+//! - [`Sqlite`](crate::core::databases::sqlite::Sqlite)
 //!
 //! > **NOTICE**: There are no database migrations. If there are any changes,
 //! we will implemented them or provide a script to migrate to the new schema.
@@ -22,7 +22,7 @@
 //! ---|---|---
 //!  `id`          | 1                                        | Autoincrement id
 //!  `info_hash`   | `c1277613db1d28709b034a017ab2cae4be07ae10` | `BitTorrent` infohash V1
-//!  `completed`   | 20                                       | The number of peers that have ever completed downloading the torrent associated to this entry. See [`Entry`](crate::tracker::torrent::Entry) for more information.
+//!  `completed`   | 20                                       | The number of peers that have ever completed downloading the torrent associated to this entry. See [`Entry`](crate::core::torrent::Entry) for more information.
 //!
 //! > **NOTICE**: The peer list for a torrent is not persisted. Since peer have to re-announce themselves on intervals, the data is be
 //! regenerated again after some minutes.
@@ -53,8 +53,8 @@ use std::marker::PhantomData;
 use async_trait::async_trait;
 
 use self::error::Error;
+use crate::core::auth::{self, Key};
 use crate::shared::bit_torrent::info_hash::InfoHash;
-use crate::tracker::auth::{self, Key};
 
 struct Builder<T>
 where
@@ -116,9 +116,9 @@ pub trait Database: Sync + Send {
     ///
     /// It returns an array of tuples with the torrent
     /// [`InfoHash`] and the
-    /// [`completed`](crate::tracker::torrent::Entry::completed) counter
+    /// [`completed`](crate::core::torrent::Entry::completed) counter
     /// which is the number of times the torrent has been downloaded.
-    /// See [`Entry::completed`](crate::tracker::torrent::Entry::completed).
+    /// See [`Entry::completed`](crate::core::torrent::Entry::completed).
     ///
     /// # Context: Torrent Metrics
     ///
@@ -200,8 +200,8 @@ pub trait Database: Sync + Send {
 
     /// It gets an expiring authentication key from the database.
     ///
-    /// It returns `Some(ExpiringKey)` if a [`ExpiringKey`](crate::tracker::auth::ExpiringKey)
-    /// with the input [`Key`](crate::tracker::auth::Key) exists, `None` otherwise.
+    /// It returns `Some(ExpiringKey)` if a [`ExpiringKey`](crate::core::auth::ExpiringKey)
+    /// with the input [`Key`](crate::core::auth::Key) exists, `None` otherwise.
     ///
     /// # Context: Authentication Keys
     ///