Add Timeouts to Tracker Client

.vscode/settings.json

@@ -31,5 +31,6 @@
   "evenBetterToml.formatter.trailingNewline": true,
   "evenBetterToml.formatter.reorderKeys": true,
   "evenBetterToml.formatter.reorderArrays": true,
+  "rust-analyzer.showUnlinkedFileNotification": false,
 
 }

Cargo.toml

@@ -62,15 +62,14 @@ serde_bytes = "0"
 serde_json = "1"
 serde_repr = "0"
 thiserror = "1"
-tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
-torrust-tracker-configuration = { version = "3.0.0-alpha.12-develop", path = "packages/configuration" }
+tokio = { version = "1", features = ["macros", "rt-multi-thread", "signal", "sync"] }
 torrust-tracker-clock = { version = "3.0.0-alpha.12-develop", path = "packages/clock" }
+torrust-tracker-configuration = { version = "3.0.0-alpha.12-develop", path = "packages/configuration" }
 torrust-tracker-contrib-bencode = { version = "3.0.0-alpha.12-develop", path = "contrib/bencode" }
 torrust-tracker-located-error = { version = "3.0.0-alpha.12-develop", path = "packages/located-error" }
 torrust-tracker-primitives = { version = "3.0.0-alpha.12-develop", path = "packages/primitives" }
 torrust-tracker-torrent-repository = { version = "3.0.0-alpha.12-develop", path = "packages/torrent-repository" }
 tower-http = { version = "0", features = ["compression-full", "cors", "propagate-header", "request-id", "trace"] }
-trace = "0"
 tracing = "0"
 url = "2"
 uuid = { version = "1", features = ["v4"] }
@@ -90,7 +89,7 @@ members = [
     "packages/located-error",
     "packages/primitives",
     "packages/test-helpers",
-    "packages/torrent-repository"
+    "packages/torrent-repository",
 ]
 
 [profile.dev]
@@ -105,4 +104,4 @@ opt-level = 3
 
 [target.x86_64-unknown-linux-gnu]
 linker = "/usr/bin/clang"
-rustflags = ["-Clink-arg=-fuse-ld=lld", "-Clink-arg=-Wl,--no-rosegment"]
+rustflags = ["-Clink-arg=-Wl,--no-rosegment", "-Clink-arg=-fuse-ld=lld"]

cSpell.json

@@ -29,6 +29,7 @@
         "certbot",
         "chrono",
         "clippy",
+        "Cloneable",
         "codecov",
         "codegen",
         "completei",
@@ -69,8 +70,8 @@
         "infoschema",
         "Intermodal",
         "intervali",
-        "kcachegrind",
         "Joakim",
+        "kcachegrind",
         "keyout",
         "lcov",
         "leecher",

packages/configuration/src/lib.rs

@@ -233,6 +233,7 @@ use std::collections::HashMap;
 use std::net::IpAddr;
 use std::str::FromStr;
 use std::sync::Arc;
+use std::time::Duration;
 use std::{env, fs};
 
 use config::{Config, ConfigError, File, FileFormat};
@@ -246,6 +247,19 @@ use torrust_tracker_primitives::{DatabaseDriver, TrackerMode};
 /// The maximum number of returned peers for a torrent.
 pub const TORRENT_PEERS_LIMIT: usize = 74;
 
+/// Client Timeout
+pub const CLIENT_TIMEOUT_DEFAULT: Duration = Duration::from_secs(5);
+
+/// The maximum number of bytes in a UDP packet.
+pub const MAX_PACKET_SIZE: usize = 1496;
+
+/// The a free port is dynamically chosen by the operating system.
+pub const PORT_ASSIGNED_BY_OS: u16 = 0;
+
+/// A magic 64-bit integer constant defined in the protocol that is used to
+/// identify the protocol.
+pub const PROTOCOL_ID: i64 = 0x0417_2710_1980;
+
 #[derive(Copy, Clone, Debug, PartialEq, Constructor)]
 pub struct TrackerPolicy {
     pub remove_peerless_torrents: bool,

packages/primitives/src/announce_event.rs

@@ -2,19 +2,24 @@
 //!
 //! Distributed under Apache 2.0 license
 
+use derive_more::Display;
 use serde::{Deserialize, Serialize};
 
 /// Announce events. Described on  the
 /// [BEP 3. The `BitTorrent` Protocol Specification](https://www.bittorrent.org/beps/bep_0003.html)
-#[derive(Hash, Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
+#[derive(Hash, Clone, Copy, Debug, Display, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub enum AnnounceEvent {
     /// The peer has started downloading the torrent.
+    #[display(fmt = "started")]
     Started,
     /// The peer has ceased downloading the torrent.
+    #[display(fmt = "stopped")]
     Stopped,
     /// The peer has completed downloading the torrent.
+    #[display(fmt = "completed")]
     Completed,
     /// This is one of the announcements done at regular intervals.
+    #[display(fmt = "")]
     None,
 }
 

packages/primitives/src/info_hash.rs

@@ -3,29 +3,18 @@ use std::panic::Location;
 
 use thiserror::Error;
 
+pub type ByteArray20 = [u8; 20];
+
 /// `BitTorrent` Info Hash v1
 #[derive(PartialEq, Eq, Hash, Clone, Copy, Default, Debug)]
-pub struct InfoHash(pub [u8; 20]);
+pub struct InfoHash(pub ByteArray20);
 
 pub const INFO_HASH_BYTES_LEN: usize = 20;
 
 impl InfoHash {
-    /// Create a new `InfoHash` from a byte slice.
-    ///
-    /// # Panics
-    ///
-    /// Will panic if byte slice does not contains the exact amount of bytes need for the `InfoHash`.
-    #[must_use]
-    pub fn from_bytes(bytes: &[u8]) -> Self {
-        assert_eq!(bytes.len(), INFO_HASH_BYTES_LEN);
-        let mut ret = Self([0u8; INFO_HASH_BYTES_LEN]);
-        ret.0.clone_from_slice(bytes);
-        ret
-    }
-
     /// Returns the `InfoHash` internal byte array.
     #[must_use]
-    pub fn bytes(&self) -> [u8; 20] {
+    pub fn bytes(&self) -> ByteArray20 {
         self.0
     }
 
@@ -57,14 +46,30 @@ impl std::fmt::Display for InfoHash {
 }
 
 impl std::str::FromStr for InfoHash {
-    type Err = binascii::ConvertError;
+    type Err = ConversionError;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
+        const INFO_HASH_CHAR_LEN: usize = INFO_HASH_BYTES_LEN * 2;
         let mut i = Self([0u8; 20]);
-        if s.len() != 40 {
-            return Err(binascii::ConvertError::InvalidInputLength);
+
+        if s.len() < INFO_HASH_CHAR_LEN {
+            return Err(ConversionError::NotEnoughBytes {
+                location: Location::caller(),
+                message: format! {"got {} string, expected {}", s.len(), INFO_HASH_CHAR_LEN},
+            });
         }
-        binascii::hex2bin(s.as_bytes(), &mut i.0)?;
+        if s.len() > INFO_HASH_CHAR_LEN {
+            return Err(ConversionError::TooManyBytes {
+                location: Location::caller(),
+                message: format! {"got {} string, expected {}", s.len(), INFO_HASH_CHAR_LEN},
+            });
+        }
+
+        binascii::hex2bin(s.as_bytes(), &mut i.0).map_err(|e| ConversionError::HexToBinError {
+            location: Location::caller(),
+            message: format! {"got {e:?} error"},
+        })?;
+
         Ok(i)
     }
 }
@@ -89,15 +94,15 @@ impl std::convert::From<&DefaultHasher> for InfoHash {
     }
 }
 
-impl std::convert::From<&i32> for InfoHash {
-    fn from(n: &i32) -> InfoHash {
+impl std::convert::From<i32> for InfoHash {
+    fn from(n: i32) -> InfoHash {
         let n = n.to_le_bytes();
         InfoHash([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, n[0], n[1], n[2], n[3]])
     }
 }
 
-impl std::convert::From<[u8; 20]> for InfoHash {
-    fn from(val: [u8; 20]) -> Self {
+impl std::convert::From<ByteArray20> for InfoHash {
+    fn from(val: ByteArray20) -> Self {
         InfoHash(val)
     }
 }
@@ -117,6 +122,12 @@ pub enum ConversionError {
         location: &'static Location<'static>,
         message: String,
     },
+
+    #[error("hex to bin didn't parse: {message} {location}")]
+    HexToBinError {
+        location: &'static Location<'static>,
+        message: String,
+    },
 }
 
 impl TryFrom<Vec<u8>> for InfoHash {
@@ -135,7 +146,7 @@ impl TryFrom<Vec<u8>> for InfoHash {
                 message: format! {"got {} bytes, expected {}", bytes.len(), INFO_HASH_BYTES_LEN},
             });
         }
-        Ok(Self::from_bytes(&bytes))
+        Ok((*bytes).into())
     }
 }
 

packages/primitives/src/peer.rs

@@ -392,13 +392,14 @@ pub mod fixture {
 
         #[allow(dead_code)]
         #[must_use]
-        pub fn build(self) -> Peer {
-            self.into()
+        pub fn with_event(mut self, event: AnnounceEvent) -> Self {
+            self.peer.event = event;
+            self
         }
 
         #[allow(dead_code)]
         #[must_use]
-        pub fn into(self) -> Peer {
+        pub fn build(self) -> Peer {
             self.peer
         }
     }

packages/torrent-repository/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 description = "A library that provides a repository of torrents files and their peers."
-keywords = ["torrents", "repository", "library"]
+keywords = ["library", "repository", "torrents"]
 name = "torrust-tracker-torrent-repository"
 readme = "README.md"
 
@@ -17,15 +17,15 @@ version.workspace = true
 
 [dependencies]
 futures = "0.3.29"
-tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
-torrust-tracker-primitives = { version = "3.0.0-alpha.12-develop", path = "../primitives" }
-torrust-tracker-configuration = { version = "3.0.0-alpha.12-develop", path = "../configuration" }
+tokio = { version = "1", features = ["macros", "rt-multi-thread", "sync"] }
 torrust-tracker-clock = { version = "3.0.0-alpha.12-develop", path = "../clock" }
+torrust-tracker-configuration = { version = "3.0.0-alpha.12-develop", path = "../configuration" }
+torrust-tracker-primitives = { version = "3.0.0-alpha.12-develop", path = "../primitives" }
 
 [dev-dependencies]
+async-std = { version = "1", features = ["attributes", "tokio1"] }
 criterion = { version = "0", features = ["async_tokio"] }
 rstest = "0"
-async-std = {version = "1", features = ["attributes", "tokio1"] }
 
 [[bench]]
 harness = false

packages/torrent-repository/tests/repository/mod.rs

@@ -115,7 +115,7 @@ fn many_out_of_order() -> Entries {
         let mut entry = EntrySingle::default();
         entry.insert_or_update_peer(&a_started_peer(i));
 
-        entries.insert((InfoHash::from(&i), entry));
+        entries.insert((InfoHash::from(i), entry));
     }
 
     // we keep the random order from the hashed set for the vector.

src/console/clients/checker/app.rs

@@ -53,7 +53,7 @@ pub async fn run() -> Result<Vec<CheckResult>> {
         console: console_printer,
     };
 
-    Ok(service.run_checks().await)
+    service.run_checks().await
 }
 
 fn setup_logging(level: LevelFilter) {
@@ -78,15 +78,17 @@ fn setup_logging(level: LevelFilter) {
 }
 
 fn setup_config(args: Args) -> Result<Configuration> {
-    match (args.config_path, args.config_content) {
-        (Some(config_path), _) => load_config_from_file(&config_path),
-        (_, Some(config_content)) => parse_from_json(&config_content).context("invalid config format"),
-        _ => Err(anyhow::anyhow!("no configuration provided")),
+    // If a config is directly supplied, we use it.
+    if let Some(config) = args.config_content {
+        parse_from_json(&config).context("invalid config format")
+    }
+    // or we load it from a file...
+    else if let Some(path) = args.config_path {
+        let file_content = std::fs::read_to_string(path.clone()).with_context(|| format!("can't read config file {path:?}"))?;
+        parse_from_json(&file_content).context("invalid config format")
+    }
+    // but we cannot run without any config...
+    else {
+        Err(anyhow::anyhow!("no configuration provided"))
     }
-}
-
-fn load_config_from_file(path: &PathBuf) -> Result<Configuration> {
-    let file_content = std::fs::read_to_string(path).with_context(|| format!("can't read config file {path:?}"))?;
-
-    parse_from_json(&file_content).context("invalid config format")
 }