dev: extract config from core::tracker

Author: da2ce7

packages/configuration/src/lib.rs

@@ -229,7 +229,7 @@
 //! [health_check_api]
 //! bind_address = "127.0.0.1:1313"
 //!```
-use std::collections::{HashMap, HashSet};
+use std::collections::HashMap;
 use std::net::IpAddr;
 use std::str::FromStr;
 use std::sync::Arc;
@@ -336,6 +336,8 @@ pub struct HttpTracker {
     pub ssl_key_path: Option<String>,
 }
 
+pub type AccessTokens = HashMap<String, String>;
+
 /// Configuration for the HTTP API.
 #[serde_as]
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
@@ -359,21 +361,13 @@ pub struct HttpApi {
     /// token and the value is the token itself. The token is used to
     /// authenticate the user. All tokens are valid for all endpoints and have
     /// the all permissions.
-    pub access_tokens: HashMap<String, String>,
+    pub access_tokens: AccessTokens,
 }
 
 impl HttpApi {
     fn override_admin_token(&mut self, api_admin_token: &str) {
         self.access_tokens.insert("admin".to_string(), api_admin_token.to_string());
     }
-
-    /// Checks if the given token is one of the token in the configuration.
-    #[must_use]
-    pub fn contains_token(&self, token: &str) -> bool {
-        let tokens: HashMap<String, String> = self.access_tokens.clone();
-        let tokens: HashSet<String> = tokens.into_values().collect();
-        tokens.contains(token)
-    }
 }
 
 /// Configuration for the Health Check API.
@@ -781,7 +775,7 @@ mod tests {
     fn http_api_configuration_should_check_if_it_contains_a_token() {
         let configuration = Configuration::default();
 
-        assert!(configuration.http_api.contains_token("MyAccessToken"));
-        assert!(!configuration.http_api.contains_token("NonExistingToken"));
+        assert!(configuration.http_api.access_tokens.values().any(|t| t == "MyAccessToken"));
+        assert!(!configuration.http_api.access_tokens.values().any(|t| t == "NonExistingToken"));
     }
 }

src/bootstrap/app.rs

@@ -61,7 +61,7 @@ pub fn initialize_static() {
 /// It's used by other higher-level components like the UDP and HTTP trackers or the tracker API.
 #[must_use]
 pub fn initialize_tracker(config: &Arc<Configuration>) -> Tracker {
-    tracker_factory(config.clone())
+    tracker_factory(&config.clone())
 }
 
 /// It initializes the log level, format and channel.

src/bootstrap/jobs/tracker_apis.rs

@@ -26,7 +26,7 @@ use std::sync::Arc;
 use axum_server::tls_rustls::RustlsConfig;
 use log::info;
 use tokio::task::JoinHandle;
-use torrust_tracker_configuration::HttpApi;
+use torrust_tracker_configuration::{AccessTokens, HttpApi};
 
 use super::make_rust_tls;
 use crate::core;
@@ -64,18 +64,25 @@ pub async fn start_job(config: &HttpApi, tracker: Arc<core::Tracker>, version: V
             .await
             .map(|tls| tls.expect("it should have a valid tracker api tls configuration"));
 
+        let access_tokens = Arc::new(config.access_tokens.clone());
+
         match version {
-            Version::V1 => Some(start_v1(bind_to, tls, tracker.clone()).await),
+            Version::V1 => Some(start_v1(bind_to, tls, tracker.clone(), access_tokens).await),
         }
     } else {
         info!("Note: Not loading Http Tracker Service, Not Enabled in Configuration.");
         None
     }
 }
 
-async fn start_v1(socket: SocketAddr, tls: Option<RustlsConfig>, tracker: Arc<core::Tracker>) -> JoinHandle<()> {
+async fn start_v1(
+    socket: SocketAddr,
+    tls: Option<RustlsConfig>,
+    tracker: Arc<core::Tracker>,
+    access_tokens: Arc<AccessTokens>,
+) -> JoinHandle<()> {
     let server = ApiServer::new(Launcher::new(socket, tls))
-        .start(tracker)
+        .start(tracker, access_tokens)
         .await
         .expect("it should be able to start to the tracker api");
 

src/core/mod.rs

@@ -445,7 +445,9 @@ use std::panic::Location;
 use std::sync::Arc;
 use std::time::Duration;
 
+use derive_more::Constructor;
 use futures::future::join_all;
+use log::debug;
 use tokio::sync::mpsc::error::SendError;
 use torrust_tracker_configuration::Configuration;
 use torrust_tracker_primitives::TrackerMode;
@@ -471,17 +473,19 @@ pub const TORRENT_PEERS_LIMIT: usize = 74;
 /// Typically, the `Tracker` is used by a higher application service that handles
 /// the network layer.
 pub struct Tracker {
-    /// `Tracker` configuration. See [`torrust-tracker-configuration`](torrust_tracker_configuration)
-    pub config: Arc<Configuration>,
+    announce_policy: AnnouncePolicy,
     /// A database driver implementation: [`Sqlite3`](crate::core::databases::sqlite)
     /// or [`MySQL`](crate::core::databases::mysql)
     pub database: Arc<Box<dyn Database>>,
     mode: TrackerMode,
+    policy: TrackerPolicy,
     keys: tokio::sync::RwLock<std::collections::HashMap<Key, auth::ExpiringKey>>,
     whitelist: tokio::sync::RwLock<std::collections::HashSet<InfoHash>>,
     pub torrents: Arc<RepositoryAsyncSingle>,
     stats_event_sender: Option<Box<dyn statistics::EventSender>>,
     stats_repository: statistics::Repo,
+    external_ip: Option<IpAddr>,
+    on_reverse_proxy: bool,
 }
 
 /// Structure that holds general `Tracker` torrents metrics.
@@ -499,21 +503,35 @@ pub struct TorrentsMetrics {
     pub torrents: u64,
 }
 
+#[derive(Copy, Clone, Debug, PartialEq, Default, Constructor)]
+pub struct TrackerPolicy {
+    pub remove_peerless_torrents: bool,
+    pub max_peer_timeout: u32,
+    pub persistent_torrent_completed_stat: bool,
+}
+
+/// Tracker policy for Announcements
+#[derive(Copy, Clone, Debug, PartialEq, Default, Constructor)]
+pub struct AnnouncePolicy {
+    /// The interval in seconds that the client should wait between sending
+    /// regular requests to the tracker.
+    /// Refer to [`announce_interval`](torrust_tracker_configuration::Configuration::announce_interval).
+    pub interval: u32,
+    /// The minimum announce interval in seconds that the client should wait.
+    /// Refer to [`min_announce_interval`](torrust_tracker_configuration::Configuration::min_announce_interval).
+    pub interval_min: u32,
+}
+
 /// Structure that holds the data returned by the `announce` request.
 #[derive(Debug, PartialEq, Default)]
 pub struct AnnounceData {
+    /// Tracker policy for Announcements
+    pub policy: AnnouncePolicy,
     /// The list of peers that are downloading the same torrent.
     /// It excludes the peer that made the request.
     pub peers: Vec<Peer>,
     /// Swarm statistics
     pub swarm_stats: SwarmStats,
-    /// The interval in seconds that the client should wait between sending
-    /// regular requests to the tracker.
-    /// Refer to [`announce_interval`](torrust_tracker_configuration::Configuration::announce_interval).
-    pub interval: u32,
-    /// The minimum announce interval in seconds that the client should wait.
-    /// Refer to [`min_announce_interval`](torrust_tracker_configuration::Configuration::min_announce_interval).
-    pub interval_min: u32,
 }
 
 /// Structure that holds the data returned by the `scrape` request.
@@ -561,7 +579,7 @@ impl Tracker {
     ///
     /// Will return a `databases::error::Error` if unable to connect to database. The `Tracker` is responsible for the persistence.
     pub fn new(
-        config: Arc<Configuration>,
+        config: &Arc<Configuration>,
         stats_event_sender: Option<Box<dyn statistics::EventSender>>,
         stats_repository: statistics::Repo,
     ) -> Result<Tracker, databases::error::Error> {
@@ -570,14 +588,22 @@ impl Tracker {
         let mode = config.mode;
 
         Ok(Tracker {
-            config,
+            //config,
+            announce_policy: AnnouncePolicy::new(config.announce_interval, config.min_announce_interval),
             mode,
             keys: tokio::sync::RwLock::new(std::collections::HashMap::new()),
             whitelist: tokio::sync::RwLock::new(std::collections::HashSet::new()),
             torrents: Arc::new(RepositoryAsyncSingle::new()),
             stats_event_sender,
             stats_repository,
             database,
+            external_ip: config.get_ext_ip(),
+            policy: TrackerPolicy::new(
+                config.remove_peerless_torrents,
+                config.max_peer_timeout,
+                config.persistent_torrent_completed_stat,
+            ),
+            on_reverse_proxy: config.on_reverse_proxy,
         })
     }
 
@@ -601,6 +627,19 @@ impl Tracker {
         self.is_private()
     }
 
+    /// Returns `true` is the tracker is in whitelisted mode.
+    pub fn is_behind_reverse_proxy(&self) -> bool {
+        self.on_reverse_proxy
+    }
+
+    pub fn get_announce_policy(&self) -> AnnouncePolicy {
+        self.announce_policy
+    }
+
+    pub fn get_maybe_external_ip(&self) -> Option<IpAddr> {
+        self.external_ip
+    }
+
     /// It handles an announce request.
     ///
     /// # Context: Tracker
@@ -622,17 +661,19 @@ impl Tracker {
         // we are actually handling authentication at the handlers level. So I would extract that
         // responsibility into another authentication service.
 
-        peer.change_ip(&assign_ip_address_to_peer(remote_client_ip, self.config.get_ext_ip()));
+        debug!("Before: {peer:?}");
+        peer.change_ip(&assign_ip_address_to_peer(remote_client_ip, self.external_ip));
+        debug!("After: {peer:?}");
 
+        // we should update the torrent and get the stats before we get the peer list.
         let swarm_stats = self.update_torrent_with_peer_and_get_stats(info_hash, peer).await;
 
         let peers = self.get_torrent_peers_for_peer(info_hash, peer).await;
 
         AnnounceData {
+            policy: self.announce_policy,
             peers,
             swarm_stats,
-            interval: self.config.announce_interval,
-            interval_min: self.config.min_announce_interval,
         }
     }
 
@@ -731,7 +772,7 @@ impl Tracker {
 
         let (stats, stats_updated) = self.torrents.update_torrent_with_peer_and_get_stats(info_hash, peer).await;
 
-        if self.config.persistent_torrent_completed_stat && stats_updated {
+        if self.policy.persistent_torrent_completed_stat && stats_updated {
             let completed = stats.completed;
             let info_hash = *info_hash;
 
@@ -792,17 +833,17 @@ impl Tracker {
         let mut torrents_lock = self.torrents.get_torrents_mut().await;
 
         // If we don't need to remove torrents we will use the faster iter
-        if self.config.remove_peerless_torrents {
+        if self.policy.remove_peerless_torrents {
             let mut cleaned_torrents_map: BTreeMap<InfoHash, torrent::Entry> = BTreeMap::new();
 
             for (info_hash, torrent_entry) in &mut *torrents_lock {
-                torrent_entry.remove_inactive_peers(self.config.max_peer_timeout);
+                torrent_entry.remove_inactive_peers(self.policy.max_peer_timeout);
 
                 if torrent_entry.peers.is_empty() {
                     continue;
                 }
 
-                if self.config.persistent_torrent_completed_stat && torrent_entry.completed == 0 {
+                if self.policy.persistent_torrent_completed_stat && torrent_entry.completed == 0 {
                     continue;
                 }
 
@@ -812,7 +853,7 @@ impl Tracker {
             *torrents_lock = cleaned_torrents_map;
         } else {
             for torrent_entry in (*torrents_lock).values_mut() {
-                torrent_entry.remove_inactive_peers(self.config.max_peer_timeout);
+                torrent_entry.remove_inactive_peers(self.policy.max_peer_timeout);
             }
         }
     }
@@ -1077,21 +1118,21 @@ mod tests {
         use crate::shared::clock::DurationSinceUnixEpoch;
 
         fn public_tracker() -> Tracker {
-            tracker_factory(configuration::ephemeral_mode_public().into())
+            tracker_factory(&configuration::ephemeral_mode_public().into())
         }
 
         fn private_tracker() -> Tracker {
-            tracker_factory(configuration::ephemeral_mode_private().into())
+            tracker_factory(&configuration::ephemeral_mode_private().into())
         }
 
         fn whitelisted_tracker() -> Tracker {
-            tracker_factory(configuration::ephemeral_mode_whitelisted().into())
+            tracker_factory(&configuration::ephemeral_mode_whitelisted().into())
         }
 
         pub fn tracker_persisting_torrents_in_database() -> Tracker {
             let mut configuration = configuration::ephemeral();
             configuration.persistent_torrent_completed_stat = true;
-            tracker_factory(Arc::new(configuration))
+            tracker_factory(&Arc::new(configuration))
         }
 
         fn sample_info_hash() -> InfoHash {

src/core/services/mod.rs

@@ -19,7 +19,7 @@ use crate::core::Tracker;
 ///
 /// Will panic if tracker cannot be instantiated.
 #[must_use]
-pub fn tracker_factory(config: Arc<Configuration>) -> Tracker {
+pub fn tracker_factory(config: &Arc<Configuration>) -> Tracker {
     // Initialize statistics
     let (stats_event_sender, stats_repository) = statistics::setup::factory(config.tracker_usage_statistics);
 

src/core/services/statistics/mod.rs

@@ -98,7 +98,7 @@ mod tests {
 
     #[tokio::test]
     async fn the_statistics_service_should_return_the_tracker_metrics() {
-        let tracker = Arc::new(tracker_factory(tracker_configuration()));
+        let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
         let tracker_metrics = get_metrics(tracker.clone()).await;
 

src/core/services/torrent.rs

@@ -174,7 +174,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_return_none_if_the_tracker_does_not_have_the_torrent() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let torrent_info = get_torrent_info(
                 tracker.clone(),
@@ -187,7 +187,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_return_the_torrent_info_if_the_tracker_has_the_torrent() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let hash = "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_owned();
             let info_hash = InfoHash::from_str(&hash).unwrap();
@@ -229,7 +229,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_return_an_empty_result_if_the_tracker_does_not_have_any_torrent() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let torrents = get_torrents(tracker.clone(), &Pagination::default()).await;
 
@@ -238,7 +238,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_return_a_summarized_info_for_all_torrents() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let hash = "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_owned();
             let info_hash = InfoHash::from_str(&hash).unwrap();
@@ -262,7 +262,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_allow_limiting_the_number_of_torrents_in_the_result() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let hash1 = "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_owned();
             let info_hash1 = InfoHash::from_str(&hash1).unwrap();
@@ -286,7 +286,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_allow_using_pagination_in_the_result() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let hash1 = "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_owned();
             let info_hash1 = InfoHash::from_str(&hash1).unwrap();
@@ -319,7 +319,7 @@ mod tests {
 
         #[tokio::test]
         async fn should_return_torrents_ordered_by_info_hash() {
-            let tracker = Arc::new(tracker_factory(tracker_configuration()));
+            let tracker = Arc::new(tracker_factory(&tracker_configuration()));
 
             let hash1 = "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_owned();
             let info_hash1 = InfoHash::from_str(&hash1).unwrap();