feat: [torrust#1491] copy torrent repo benchmarking into a new pkg

It will be removed from the `torrent-repository` package, keeping only
data strcutures used in production.

Author: josecelano

.github/workflows/deployment.yaml

@@ -78,5 +78,6 @@ jobs:
           cargo publish -p torrust-tracker-metrics
           cargo publish -p torrust-tracker-primitives
           cargo publish -p torrust-tracker-test-helpers
+          cargo publish -p torrust-tracker-torrent-benchmarking
           cargo publish -p torrust-tracker-torrent-repository
           cargo publish -p torrust-udp-tracker-server

Cargo.lock

@@ -68,7 +68,7 @@ torrust-rest-tracker-api-client = { version = "3.0.0-develop", path = "packages/
 torrust-tracker-test-helpers = { version = "3.0.0-develop", path = "packages/test-helpers" }
 
 [workspace]
-members = ["console/tracker-client"]
+members = ["console/tracker-client", "packages/torrent-repository-benchmarking"]
 
 [profile.dev]
 debug = 1

Cargo.toml

@@ -0,0 +1,38 @@
+[package]
+description = "A library to runt benchmarking for different implementations of a repository of torrents files and their peers."
+keywords = ["library", "repository", "torrents"]
+name = "torrust-tracker-torrent-repository-benchmarking"
+readme = "README.md"
+
+authors.workspace = true
+categories.workspace = true
+documentation.workspace = true
+edition.workspace = true
+homepage.workspace = true
+license.workspace = true
+publish.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+version.workspace = true
+
+[dependencies]
+aquatic_udp_protocol = "0"
+bittorrent-primitives = "0.1.0"
+crossbeam-skiplist = "0"
+dashmap = "6"
+futures = "0"
+parking_lot = "0"
+tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
+torrust-tracker-clock = { version = "3.0.0-develop", path = "../clock" }
+torrust-tracker-configuration = { version = "3.0.0-develop", path = "../configuration" }
+torrust-tracker-primitives = { version = "3.0.0-develop", path = "../primitives" }
+zerocopy = "0.7"
+
+[dev-dependencies]
+async-std = { version = "1", features = ["attributes", "tokio1"] }
+criterion = { version = "0", features = ["async_tokio"] }
+rstest = "0"
+
+[[bench]]
+harness = false
+name = "repository_benchmark"

packages/torrent-repository-benchmarking/Cargo.toml

@@ -0,0 +1,32 @@
+# Torrust Tracker Torrent Repository Benchmarking
+
+A library to runt benchmarking for different implementations of a repository of torrents files and their peers. Torrent repositories are used by the [Torrust Tracker](https://github.com/torrust/torrust-tracker).
+
+## Benchmarking
+
+```console
+cargo bench -p torrust-tracker-torrent-repository
+```
+
+Example partial output:
+
+```output
+     Running benches/repository_benchmark.rs (target/release/deps/repository_benchmark-a9b0013c8d09c3c3)
+add_one_torrent/RwLockStd
+                        time:   [63.057 ns 63.242 ns 63.506 ns]
+Found 12 outliers among 100 measurements (12.00%)
+  2 (2.00%) low severe
+  2 (2.00%) low mild
+  2 (2.00%) high mild
+  6 (6.00%) high severe
+add_one_torrent/RwLockStdMutexStd
+                        time:   [62.505 ns 63.077 ns 63.817 ns]
+```
+
+## Documentation
+
+[Crate documentation](https://docs.rs/torrust-tracker-torrent-repository).
+
+## License
+
+The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).

packages/torrent-repository-benchmarking/README.md

@@ -0,0 +1,153 @@
+use std::sync::Arc;
+use std::time::{Duration, Instant};
+
+use bittorrent_primitives::info_hash::InfoHash;
+use futures::stream::FuturesUnordered;
+use torrust_tracker_torrent_repository_benchmarking::repository::RepositoryAsync;
+
+use super::utils::{generate_unique_info_hashes, DEFAULT_PEER};
+
+pub async fn add_one_torrent<V, T>(samples: u64) -> Duration
+where
+    V: RepositoryAsync<T> + Default,
+{
+    let start = Instant::now();
+
+    for _ in 0..samples {
+        let torrent_repository = V::default();
+
+        let info_hash = InfoHash::default();
+
+        torrent_repository.upsert_peer(&info_hash, &DEFAULT_PEER, None).await;
+
+        torrent_repository.get_swarm_metadata(&info_hash).await;
+    }
+
+    start.elapsed()
+}
+
+// Add one torrent ten thousand times in parallel (depending on the set worker threads)
+pub async fn update_one_torrent_in_parallel<V, T>(runtime: &tokio::runtime::Runtime, samples: u64, sleep: Option<u64>) -> Duration
+where
+    V: RepositoryAsync<T> + Default,
+    Arc<V>: Clone + Send + Sync + 'static,
+{
+    let torrent_repository = Arc::<V>::default();
+    let info_hash = InfoHash::default();
+    let handles = FuturesUnordered::new();
+
+    // Add the torrent/peer to the torrent repository
+    torrent_repository.upsert_peer(&info_hash, &DEFAULT_PEER, None).await;
+
+    torrent_repository.get_swarm_metadata(&info_hash).await;
+
+    let start = Instant::now();
+
+    for _ in 0..samples {
+        let torrent_repository_clone = torrent_repository.clone();
+
+        let handle = runtime.spawn(async move {
+            torrent_repository_clone.upsert_peer(&info_hash, &DEFAULT_PEER, None).await;
+
+            torrent_repository_clone.get_swarm_metadata(&info_hash).await;
+
+            if let Some(sleep_time) = sleep {
+                let start_time = std::time::Instant::now();
+
+                while start_time.elapsed().as_nanos() < u128::from(sleep_time) {}
+            }
+        });
+
+        handles.push(handle);
+    }
+
+    // Await all tasks
+    futures::future::join_all(handles).await;
+
+    start.elapsed()
+}
+
+// Add ten thousand torrents in parallel (depending on the set worker threads)
+pub async fn add_multiple_torrents_in_parallel<V, T>(
+    runtime: &tokio::runtime::Runtime,
+    samples: u64,
+    sleep: Option<u64>,
+) -> Duration
+where
+    V: RepositoryAsync<T> + Default,
+    Arc<V>: Clone + Send + Sync + 'static,
+{
+    let torrent_repository = Arc::<V>::default();
+    let info_hashes = generate_unique_info_hashes(samples.try_into().expect("it should fit in a usize"));
+    let handles = FuturesUnordered::new();
+
+    let start = Instant::now();
+
+    for info_hash in info_hashes {
+        let torrent_repository_clone = torrent_repository.clone();
+
+        let handle = runtime.spawn(async move {
+            torrent_repository_clone.upsert_peer(&info_hash, &DEFAULT_PEER, None).await;
+
+            torrent_repository_clone.get_swarm_metadata(&info_hash).await;
+
+            if let Some(sleep_time) = sleep {
+                let start_time = std::time::Instant::now();
+
+                while start_time.elapsed().as_nanos() < u128::from(sleep_time) {}
+            }
+        });
+
+        handles.push(handle);
+    }
+
+    // Await all tasks
+    futures::future::join_all(handles).await;
+
+    start.elapsed()
+}
+
+// Async update ten thousand torrents in parallel (depending on the set worker threads)
+pub async fn update_multiple_torrents_in_parallel<V, T>(
+    runtime: &tokio::runtime::Runtime,
+    samples: u64,
+    sleep: Option<u64>,
+) -> Duration
+where
+    V: RepositoryAsync<T> + Default,
+    Arc<V>: Clone + Send + Sync + 'static,
+{
+    let torrent_repository = Arc::<V>::default();
+    let info_hashes = generate_unique_info_hashes(samples.try_into().expect("it should fit in usize"));
+    let handles = FuturesUnordered::new();
+
+    // Add the torrents/peers to the torrent repository
+    for info_hash in &info_hashes {
+        torrent_repository.upsert_peer(info_hash, &DEFAULT_PEER, None).await;
+        torrent_repository.get_swarm_metadata(info_hash).await;
+    }
+
+    let start = Instant::now();
+
+    for info_hash in info_hashes {
+        let torrent_repository_clone = torrent_repository.clone();
+
+        let handle = runtime.spawn(async move {
+            torrent_repository_clone.upsert_peer(&info_hash, &DEFAULT_PEER, None).await;
+            torrent_repository_clone.get_swarm_metadata(&info_hash).await;
+
+            if let Some(sleep_time) = sleep {
+                let start_time = std::time::Instant::now();
+
+                while start_time.elapsed().as_nanos() < u128::from(sleep_time) {}
+            }
+        });
+
+        handles.push(handle);
+    }
+
+    // Await all tasks
+    futures::future::join_all(handles).await;
+
+    start.elapsed()
+}

packages/torrent-repository-benchmarking/benches/helpers/asyn.rs

@@ -0,0 +1,3 @@
+pub mod asyn;
+pub mod sync;
+pub mod utils;