Merge #1313: Refactor packages: changes needed to extract new packages (part 2)

d6e7a92 refactor: [#1311] initialize statics in each package (Jose Celano)
025f100 refactor: [#1311] move static initialization to the module where the static values are used (Jose Celano)

Pull request description:

  Refactor packages: changes needed to extract new packages (part 2).

ACKs for top commit:
  josecelano:
    ACK d6e7a92

Tree-SHA512: 02f7bfe0a54681a194843ac7195ae8ab054bbd0aa6ada3651bf8045a018f86dbbbbe1be04c56216bd7c371cc33cd59c21df31baaaec451dd8cc8936f5dcc161e

Author: josecelano

Cargo.lock

@@ -52,7 +52,6 @@ figment = "0"
 futures = "0"
 futures-util = "0"
 hyper = "1"
-lazy_static = "1"
 parking_lot = "0"
 percent-encoding = "2"
 r2d2 = "0"

Cargo.toml

@@ -38,4 +38,5 @@ tower-http = { version = "0", features = ["compression-full", "cors", "propagate
 tracing = "0"
 
 [dev-dependencies]
+torrust-tracker-clock = { version = "3.0.0-develop", path = "../clock" }
 torrust-tracker-test-helpers = { version = "3.0.0-develop", path = "../test-helpers" }

packages/axum-http-tracker-server/Cargo.toml

@@ -250,7 +250,7 @@ mod tests {
     use bittorrent_tracker_core::whitelist::repository::in_memory::InMemoryWhitelist;
     use torrust_axum_server::tsl::make_rust_tls;
     use torrust_server_lib::registar::Registar;
-    use torrust_tracker_configuration::Configuration;
+    use torrust_tracker_configuration::{logging, Configuration};
     use torrust_tracker_test_helpers::configuration::ephemeral_public;
 
     use crate::server::{HttpServer, Launcher};
@@ -306,6 +306,15 @@ mod tests {
         }
     }
 
+    fn initialize_global_services(configuration: &Configuration) {
+        initialize_static();
+        logging::setup(&configuration.logging);
+    }
+
+    fn initialize_static() {
+        torrust_tracker_clock::initialize_static();
+    }
+
     #[tokio::test]
     async fn it_should_be_able_to_start_and_stop() {
         let configuration = Arc::new(ephemeral_public());
@@ -317,7 +326,7 @@ mod tests {
 
         let http_tracker_config = &http_trackers[0];
 
-        //initialize_global_services(&cfg); // not needed for this test
+        initialize_global_services(&configuration);
 
         let http_tracker_container = Arc::new(initialize_container(&configuration));
 

packages/axum-http-tracker-server/src/server.rs

@@ -18,6 +18,7 @@ version.workspace = true
 [dependencies]
 chrono = { version = "0", default-features = false, features = ["clock"] }
 lazy_static = "1"
+tracing = "0"
 
 torrust-tracker-primitives = { version = "3.0.0-develop", path = "../primitives" }
 

packages/clock/Cargo.toml

@@ -22,14 +22,15 @@
 //! > **NOTICE**: the timestamp does not depend on the time zone. That gives you
 //! > the ability to use the clock regardless of the underlying system time zone
 //! > configuration. See [Unix time Wikipedia entry](https://en.wikipedia.org/wiki/Unix_time).
-
 pub mod clock;
 pub mod conv;
 pub mod static_time;
 
 #[macro_use]
 extern crate lazy_static;
 
+use tracing::instrument;
+
 /// This code needs to be copied into each crate.
 /// Working version, for production.
 #[cfg(not(test))]
@@ -40,3 +41,16 @@ pub(crate) type CurrentClock = clock::Working;
 #[cfg(test)]
 #[allow(dead_code)]
 pub(crate) type CurrentClock = clock::Stopped;
+
+/// It initializes the application static values.
+///
+/// These values are accessible throughout the entire application:
+///
+/// - The time when the application started.
+/// - An ephemeral instance random seed. This seed is used for encryption and
+///   it's changed when the main application process is restarted.
+#[instrument(skip())]
+pub fn initialize_static() {
+    // Set the time of Torrust app starting
+    lazy_static::initialize(&static_time::TIME_AT_APP_START);
+}

packages/clock/src/lib.rs

@@ -4,6 +4,9 @@ pub mod crypto;
 pub mod services;
 pub mod statistics;
 
+use crypto::ephemeral_instance_keys;
+use tracing::instrument;
+
 #[macro_use]
 extern crate lazy_static;
 
@@ -12,3 +15,16 @@ extern crate lazy_static;
 pub const MAX_CONNECTION_ID_ERRORS_PER_IP: u32 = 10;
 
 pub const UDP_TRACKER_LOG_TARGET: &str = "UDP TRACKER";
+
+/// It initializes the static values.
+#[instrument(skip())]
+pub fn initialize_static() {
+    // Initialize the Ephemeral Instance Random Seed
+    lazy_static::initialize(&ephemeral_instance_keys::RANDOM_SEED);
+
+    // Initialize the Ephemeral Instance Random Cipher
+    lazy_static::initialize(&ephemeral_instance_keys::RANDOM_CIPHER_BLOWFISH);
+
+    // Initialize the Zeroed Cipher
+    lazy_static::initialize(&ephemeral_instance_keys::ZEROED_TEST_CIPHER_BLOWFISH);
+}

packages/udp-tracker-core/src/lib.rs

@@ -11,9 +11,7 @@
 //! 2. Initialize static variables.
 //! 3. Initialize logging.
 //! 4. Initialize the domain tracker.
-use bittorrent_udp_tracker_core::crypto::ephemeral_instance_keys;
 use bittorrent_udp_tracker_core::crypto::keys::{self, Keeper as _};
-use torrust_tracker_clock::static_time;
 use torrust_tracker_configuration::validator::Validator;
 use torrust_tracker_configuration::{logging, Configuration};
 use tracing::instrument;
@@ -71,18 +69,10 @@ pub fn initialize_global_services(configuration: &Configuration) {
 /// These values are accessible throughout the entire application:
 ///
 /// - The time when the application started.
-/// - An ephemeral instance random seed. This seed is used for encryption and it's changed when the main application process is restarted.
+/// - An ephemeral instance random seed. This seed is used for encryption and
+///   it's changed when the main application process is restarted.
 #[instrument(skip())]
 pub fn initialize_static() {
-    // Set the time of Torrust app starting
-    lazy_static::initialize(&static_time::TIME_AT_APP_START);
-
-    // Initialize the Ephemeral Instance Random Seed
-    lazy_static::initialize(&ephemeral_instance_keys::RANDOM_SEED);
-
-    // Initialize the Ephemeral Instance Random Cipher
-    lazy_static::initialize(&ephemeral_instance_keys::RANDOM_CIPHER_BLOWFISH);
-
-    // Initialize the Zeroed Cipher
-    lazy_static::initialize(&ephemeral_instance_keys::ZEROED_TEST_CIPHER_BLOWFISH);
+    torrust_tracker_clock::initialize_static();
+    bittorrent_udp_tracker_core::initialize_static();
 }

src/bootstrap/app.rs

@@ -297,11 +297,21 @@ mod tests {
     use torrust_axum_server::tsl::make_rust_tls;
     use torrust_server_lib::registar::Registar;
     use torrust_tracker_api_core::container::TrackerHttpApiCoreContainer;
+    use torrust_tracker_configuration::{logging, Configuration};
     use torrust_tracker_test_helpers::configuration::ephemeral_public;
 
-    use crate::bootstrap::app::initialize_global_services;
     use crate::servers::apis::server::{ApiServer, Launcher};
 
+    fn initialize_global_services(configuration: &Configuration) {
+        initialize_static();
+        logging::setup(&configuration.logging);
+    }
+
+    fn initialize_static() {
+        torrust_tracker_clock::initialize_static();
+        bittorrent_udp_tracker_core::initialize_static();
+    }
+
     #[tokio::test]
     async fn it_should_be_able_to_start_and_stop() {
         let cfg = Arc::new(ephemeral_public());

src/servers/apis/server.rs

@@ -59,11 +59,21 @@ mod tests {
 
     use bittorrent_udp_tracker_core::container::UdpTrackerCoreContainer;
     use torrust_server_lib::registar::Registar;
+    use torrust_tracker_configuration::{logging, Configuration};
     use torrust_tracker_test_helpers::configuration::ephemeral_public;
 
     use super::spawner::Spawner;
     use super::Server;
-    use crate::bootstrap::app::initialize_global_services;
+
+    fn initialize_global_services(configuration: &Configuration) {
+        initialize_static();
+        logging::setup(&configuration.logging);
+    }
+
+    fn initialize_static() {
+        torrust_tracker_clock::initialize_static();
+        bittorrent_udp_tracker_core::initialize_static();
+    }
 
     #[tokio::test]
     async fn it_should_be_able_to_start_and_stop() {

src/servers/udp/server/mod.rs

@@ -10,8 +10,7 @@ use torrust_axum_server::tsl::make_rust_tls;
 use torrust_server_lib::registar::Registar;
 use torrust_tracker_api_client::connection_info::{ConnectionInfo, Origin};
 use torrust_tracker_api_core::container::TrackerHttpApiCoreContainer;
-use torrust_tracker_configuration::Configuration;
-use torrust_tracker_lib::bootstrap::app::initialize_global_services;
+use torrust_tracker_configuration::{logging, Configuration};
 use torrust_tracker_lib::servers::apis::server::{ApiServer, Launcher, Running, Stopped};
 use torrust_tracker_primitives::peer;
 
@@ -162,3 +161,13 @@ impl EnvContainer {
         }
     }
 }
+
+fn initialize_global_services(configuration: &Configuration) {
+    initialize_static();
+    logging::setup(&configuration.logging);
+}
+
+fn initialize_static() {
+    torrust_tracker_clock::initialize_static();
+    bittorrent_udp_tracker_core::initialize_static();
+}

tests/servers/api/environment.rs

@@ -7,8 +7,7 @@ use futures::executor::block_on;
 use torrust_axum_http_tracker_server::server::{HttpServer, Launcher, Running, Stopped};
 use torrust_axum_server::tsl::make_rust_tls;
 use torrust_server_lib::registar::Registar;
-use torrust_tracker_configuration::Configuration;
-use torrust_tracker_lib::bootstrap::app::initialize_global_services;
+use torrust_tracker_configuration::{logging, Configuration};
 use torrust_tracker_primitives::peer;
 
 pub struct Environment<S> {
@@ -106,3 +105,12 @@ impl EnvContainer {
         }
     }
 }
+
+fn initialize_global_services(configuration: &Configuration) {
+    initialize_static();
+    logging::setup(&configuration.logging);
+}
+
+fn initialize_static() {
+    torrust_tracker_clock::initialize_static();
+}

tests/servers/http/environment.rs

@@ -5,8 +5,7 @@ use bittorrent_primitives::info_hash::InfoHash;
 use bittorrent_tracker_core::container::TrackerCoreContainer;
 use bittorrent_udp_tracker_core::container::UdpTrackerCoreContainer;
 use torrust_server_lib::registar::Registar;
-use torrust_tracker_configuration::{Configuration, DEFAULT_TIMEOUT};
-use torrust_tracker_lib::bootstrap::app::initialize_global_services;
+use torrust_tracker_configuration::{logging, Configuration, DEFAULT_TIMEOUT};
 use torrust_tracker_lib::servers::udp::server::spawner::Spawner;
 use torrust_tracker_lib::servers::udp::server::states::{Running, Stopped};
 use torrust_tracker_lib::servers::udp::server::Server;
@@ -120,6 +119,16 @@ impl EnvContainer {
     }
 }
 
+fn initialize_global_services(configuration: &Configuration) {
+    initialize_static();
+    logging::setup(&configuration.logging);
+}
+
+fn initialize_static() {
+    torrust_tracker_clock::initialize_static();
+    bittorrent_udp_tracker_core::initialize_static();
+}
+
 #[cfg(test)]
 mod tests {
     use std::time::Duration;