Isolate configuration and primitives in their own crates

Cargo.toml

@@ -41,15 +41,19 @@ aquatic_udp_protocol = "0.2"
 uuid = { version = "1", features = ["v4"] }
 axum = "0.6.1"
 axum-server = { version = "0.4.4", features = ["tls-rustls"] }
+torrust-tracker-primitives = { path = "packages/primitives" }
+torrust-tracker-configuration = { path = "packages/configuration" }
 
 [dev-dependencies]
 mockall = "0.11"
 reqwest = { version = "0.11.13", features = ["json"] }
-test-helpers = { path = "test-helpers" }
+torrust-tracker-test-helpers = { path = "packages/test-helpers" }
 
 [workspace]
 members = [
-    "test-helpers"
+    "packages/configuration",
+    "packages/primitives",
+    "packages/test-helpers"
 ]
 
 [profile.dev]

packages/configuration/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "torrust-tracker-configuration"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+
+[dependencies]
+serde = { version = "1.0", features = ["derive"] }
+serde_with = "2.0"
+config = "0.13"
+toml = "0.5"
+torrust-tracker-primitives = { path = "../primitives" }

src/config.rs → packages/configuration/src/lib.rs

@@ -7,10 +7,7 @@ use std::{env, fs};
 use config::{Config, ConfigError, File, FileFormat};
 use serde::{Deserialize, Serialize};
 use serde_with::{serde_as, NoneAsEmptyString};
-use {std, toml};
-
-use crate::databases::driver::Driver;
-use crate::tracker::mode;
+use torrust_tracker_primitives::{DatabaseDriver, TrackerMode};
 
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
 pub struct UdpTracker {
@@ -56,8 +53,8 @@ impl HttpApi {
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
 pub struct Configuration {
     pub log_level: Option<String>,
-    pub mode: mode::Mode,
-    pub db_driver: Driver,
+    pub mode: TrackerMode,
+    pub db_driver: DatabaseDriver,
     pub db_path: String,
     pub announce_interval: u32,
     pub min_announce_interval: u32,
@@ -127,8 +124,8 @@ impl Default for Configuration {
     fn default() -> Self {
         let mut configuration = Configuration {
             log_level: Option::from(String::from("info")),
-            mode: mode::Mode::Public,
-            db_driver: Driver::Sqlite3,
+            mode: TrackerMode::Public,
+            db_driver: DatabaseDriver::Sqlite3,
             db_path: String::from("./storage/database/data.db"),
             announce_interval: 120,
             min_announce_interval: 120,
@@ -187,7 +184,7 @@ impl Configuration {
         let config_builder = Config::builder();
 
         #[allow(unused_assignments)]
-        let mut config = Config::default();
+            let mut config = Config::default();
 
         if Path::new(path).exists() {
             config = config_builder
@@ -242,7 +239,7 @@ impl Configuration {
 
 #[cfg(test)]
 mod tests {
-    use crate::config::{Configuration, Error};
+    use crate::{Configuration, Error};
 
     #[cfg(test)]
     fn default_config_toml() -> String {
@@ -281,10 +278,10 @@ mod tests {
                                 [http_api.access_tokens]
                                 admin = "MyAccessToken"
         "#
-        .lines()
-        .map(str::trim_start)
-        .collect::<Vec<&str>>()
-        .join("\n");
+            .lines()
+            .map(str::trim_start)
+            .collect::<Vec<&str>>()
+            .join("\n");
         config
     }
 

packages/primitives/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "torrust-tracker-primitives"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+
+[dependencies]
+serde = { version = "1.0", features = ["derive"] }

src/tracker/mode.rs → packages/primitives/src/lib.rs

@@ -1,8 +1,14 @@
-use serde;
-use serde::{Deserialize, Serialize};
+use serde::{Serialize, Deserialize};
+
+// TODO: Move to the database crate once that gets its own crate.
+#[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
+pub enum DatabaseDriver {
+    Sqlite3,
+    MySQL,
+}
 
 #[derive(Serialize, Deserialize, Copy, Clone, PartialEq, Eq, Debug)]
-pub enum Mode {
+pub enum TrackerMode {
     // Will track every new info hash and serve every peer.
     #[serde(rename = "public")]
     Public,

test-helpers/Cargo.toml → packages/test-helpers/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "test-helpers"
+name = "torrust-tracker-test-helpers"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true

src/apis/middlewares/auth.rs

@@ -5,9 +5,9 @@ use axum::http::Request;
 use axum::middleware::Next;
 use axum::response::{IntoResponse, Response};
 use serde::Deserialize;
+use torrust_tracker_configuration::{Configuration, HttpApi};
 
 use crate::apis::responses::unhandled_rejection_response;
-use crate::config::{Configuration, HttpApi};
 
 #[derive(Deserialize, Debug)]
 pub struct QueryParams {

src/databases/mod.rs

@@ -1,11 +1,10 @@
-pub mod driver;
 pub mod error;
 pub mod mysql;
 pub mod sqlite;
 
 use async_trait::async_trait;
+use torrust_tracker_primitives::DatabaseDriver;
 
-use self::driver::Driver;
 use self::error::Error;
 use crate::databases::mysql::Mysql;
 use crate::databases::sqlite::Sqlite;
@@ -15,13 +14,13 @@ use crate::tracker::auth;
 /// # Errors
 ///
 /// Will return `r2d2::Error` if `db_path` is not able to create a database.
-pub fn connect(db_driver: &Driver, db_path: &str) -> Result<Box<dyn Database>, r2d2::Error> {
+pub fn connect(db_driver: &DatabaseDriver, db_path: &str) -> Result<Box<dyn Database>, r2d2::Error> {
     let database: Box<dyn Database> = match db_driver {
-        Driver::Sqlite3 => {
+        DatabaseDriver::Sqlite3 => {
             let db = Sqlite::new(db_path)?;
             Box::new(db)
         }
-        Driver::MySQL => {
+        DatabaseDriver::MySQL => {
             let db = Mysql::new(db_path)?;
             Box::new(db)
         }

src/jobs/http_tracker.rs

@@ -3,8 +3,8 @@ use std::sync::Arc;
 
 use log::{info, warn};
 use tokio::task::JoinHandle;
+use torrust_tracker_configuration::HttpTracker;
 
-use crate::config::HttpTracker;
 use crate::http::server::Http;
 use crate::tracker;
 

src/jobs/torrent_cleanup.rs

@@ -3,8 +3,8 @@ use std::sync::Arc;
 use chrono::Utc;
 use log::info;
 use tokio::task::JoinHandle;
+use torrust_tracker_configuration::Configuration;
 
-use crate::config::Configuration;
 use crate::tracker;
 
 #[must_use]

src/jobs/tracker_apis.rs

@@ -4,9 +4,9 @@ use axum_server::tls_rustls::RustlsConfig;
 use log::info;
 use tokio::sync::oneshot;
 use tokio::task::JoinHandle;
+use torrust_tracker_configuration::HttpApi;
 
 use crate::apis::server;
-use crate::config::HttpApi;
 use crate::tracker;
 
 #[derive(Debug)]

src/jobs/udp_tracker.rs

@@ -2,8 +2,8 @@ use std::sync::Arc;
 
 use log::{error, info, warn};
 use tokio::task::JoinHandle;
+use torrust_tracker_configuration::UdpTracker;
 
-use crate::config::UdpTracker;
 use crate::tracker;
 use crate::udp::server::Udp;
 

src/lib.rs

@@ -1,5 +1,4 @@
 pub mod apis;
-pub mod config;
 pub mod databases;
 pub mod http;
 pub mod jobs;

src/logging.rs

@@ -2,8 +2,7 @@ use std::str::FromStr;
 use std::sync::Once;
 
 use log::{info, LevelFilter};
-
-use crate::config::Configuration;
+use torrust_tracker_configuration::Configuration;
 
 static INIT: Once = Once::new();
 

src/main.rs

@@ -2,9 +2,9 @@ use std::env;
 use std::sync::Arc;
 
 use log::info;
-use torrust_tracker::config::Configuration;
 use torrust_tracker::stats::setup_statistics;
 use torrust_tracker::{ephemeral_instance_keys, logging, setup, static_time, tracker};
+use torrust_tracker_configuration::Configuration;
 
 #[tokio::main]
 async fn main() {

src/setup.rs

@@ -2,8 +2,8 @@ use std::sync::Arc;
 
 use log::warn;
 use tokio::task::JoinHandle;
+use torrust_tracker_configuration::Configuration;
 
-use crate::config::Configuration;
 use crate::jobs::{http_tracker, torrent_cleanup, tracker_apis, udp_tracker};
 use crate::tracker;
 

src/tracker/mod.rs

@@ -1,5 +1,4 @@
 pub mod auth;
-pub mod mode;
 pub mod peer;
 pub mod services;
 pub mod statistics;
@@ -13,14 +12,15 @@ use std::time::Duration;
 
 use tokio::sync::mpsc::error::SendError;
 use tokio::sync::{RwLock, RwLockReadGuard};
+use torrust_tracker_configuration::Configuration;
+use torrust_tracker_primitives::TrackerMode;
 
-use crate::config::Configuration;
 use crate::databases::{self, Database};
 use crate::protocol::info_hash::InfoHash;
 
 pub struct Tracker {
     pub config: Arc<Configuration>,
-    mode: mode::Mode,
+    mode: TrackerMode,
     keys: RwLock<std::collections::HashMap<String, auth::Key>>,
     whitelist: RwLock<std::collections::HashSet<InfoHash>>,
     torrents: RwLock<std::collections::BTreeMap<InfoHash, torrent::Entry>>,
@@ -61,15 +61,15 @@ impl Tracker {
     }
 
     pub fn is_public(&self) -> bool {
-        self.mode == mode::Mode::Public
+        self.mode == TrackerMode::Public
     }
 
     pub fn is_private(&self) -> bool {
-        self.mode == mode::Mode::Private || self.mode == mode::Mode::PrivateListed
+        self.mode == TrackerMode::Private || self.mode == TrackerMode::PrivateListed
     }
 
     pub fn is_whitelisted(&self) -> bool {
-        self.mode == mode::Mode::Listed || self.mode == mode::Mode::PrivateListed
+        self.mode == TrackerMode::Listed || self.mode == TrackerMode::PrivateListed
     }
 
     /// # Errors
@@ -366,10 +366,10 @@ impl Tracker {
 #[cfg(test)]
 mod tests {
     use std::sync::Arc;
+    use torrust_tracker_configuration::{Configuration, ephemeral_configuration};
 
     use super::statistics::Keeper;
     use super::{TorrentsMetrics, Tracker};
-    use crate::config::{ephemeral_configuration, Configuration};
 
     pub fn tracker_configuration() -> Arc<Configuration> {
         Arc::new(ephemeral_configuration())

src/tracker/services/common.rs

@@ -1,6 +1,6 @@
 use std::sync::Arc;
+use torrust_tracker_configuration::Configuration;
 
-use crate::config::Configuration;
 use crate::tracker::statistics::Keeper;
 use crate::tracker::Tracker;
 

src/tracker/services/statistics.rs

@@ -35,8 +35,8 @@ pub async fn get_metrics(tracker: Arc<Tracker>) -> TrackerMetrics {
 #[cfg(test)]
 mod tests {
     use std::sync::Arc;
+    use torrust_tracker_configuration::{Configuration, ephemeral_configuration};
 
-    use crate::config::{ephemeral_configuration, Configuration};
     use crate::tracker;
     use crate::tracker::services::common::tracker_factory;
     use crate::tracker::services::statistics::{get_metrics, TrackerMetrics};