refactor: [#508] move UDP tracker client to production code

We will use the UDP tracker connection request to check if the UDP
tracker service is healthy.

Author: josecelano

src/servers/udp/mod.rs

@@ -652,9 +652,3 @@ pub type Port = u16;
 /// The transaction id. A random number generated byt the peer that is used to
 /// match requests and responses.
 pub type TransactionId = i64;
-
-/// The maximum number of bytes in a UDP packet.
-pub const MAX_PACKET_SIZE: usize = 1496;
-/// 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;

src/servers/udp/server.rs

@@ -30,7 +30,7 @@ use tokio::task::JoinHandle;
 
 use crate::servers::signals::shutdown_signal;
 use crate::servers::udp::handlers::handle_packet;
-use crate::servers::udp::MAX_PACKET_SIZE;
+use crate::shared::bit_torrent::udp::MAX_PACKET_SIZE;
 use crate::tracker::Tracker;
 
 /// Error that can occur when starting or stopping the UDP server.

src/shared/bit_torrent/mod.rs

@@ -69,3 +69,4 @@
 //!Bencode & bdecode in your browser | <https://github.com/Chocobo1/bencode_online>
 pub mod common;
 pub mod info_hash;
+pub mod udp;

tests/servers/udp/client.rs src/shared/bit_torrent/udp/client.rs

@@ -3,32 +3,49 @@ use std::sync::Arc;
 
 use aquatic_udp_protocol::{Request, Response};
 use tokio::net::UdpSocket;
-use torrust_tracker::servers::udp::MAX_PACKET_SIZE;
 
-use crate::servers::udp::source_address;
+use crate::shared::bit_torrent::udp::{source_address, MAX_PACKET_SIZE};
 
 #[allow(clippy::module_name_repetitions)]
 pub struct UdpClient {
     pub socket: Arc<UdpSocket>,
 }
 
 impl UdpClient {
+    /// # Panics
+    ///
+    /// Will panic if the local address can't be bound.
     pub async fn bind(local_address: &str) -> Self {
         let socket = UdpSocket::bind(local_address).await.unwrap();
         Self {
             socket: Arc::new(socket),
         }
     }
 
+    /// # Panics
+    ///
+    /// Will panic if can't connect to the socket.
     pub async fn connect(&self, remote_address: &str) {
         self.socket.connect(remote_address).await.unwrap();
     }
 
+    /// # Panics
+    ///
+    /// Will panic if:
+    ///
+    /// - Can't write to the socket.
+    /// - Can't send data.
     pub async fn send(&self, bytes: &[u8]) -> usize {
         self.socket.writable().await.unwrap();
         self.socket.send(bytes).await.unwrap()
     }
 
+    /// # Panics
+    ///
+    /// Will panic if:
+    ///
+    /// - Can't read from the socket.
+    /// - Can't receive data.
     pub async fn receive(&self, bytes: &mut [u8]) -> usize {
         self.socket.readable().await.unwrap();
         self.socket.recv(bytes).await.unwrap()
@@ -49,6 +66,9 @@ pub struct UdpTrackerClient {
 }
 
 impl UdpTrackerClient {
+    /// # Panics
+    ///
+    /// Will panic if can't write request to bytes.
     pub async fn send(&self, request: Request) -> usize {
         // Write request into a buffer
         let request_buffer = vec![0u8; MAX_PACKET_SIZE];
@@ -68,6 +88,9 @@ impl UdpTrackerClient {
         self.udp_client.send(request_data).await
     }
 
+    /// # Panics
+    ///
+    /// Will panic if can't create response from the received payload (bytes buffer).
     pub async fn receive(&self) -> Response {
         let mut response_buffer = [0u8; MAX_PACKET_SIZE];
 

src/shared/bit_torrent/udp/mod.rs

@@ -0,0 +1,12 @@
+pub mod client;
+
+/// The maximum number of bytes in a UDP packet.
+pub const MAX_PACKET_SIZE: usize = 1496;
+/// 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;
+
+/// Generates the source address for the UDP client
+fn source_address(port: u16) -> String {
+    format!("127.0.0.1:{port}")
+}

tests/servers/udp/contract.rs

@@ -6,11 +6,11 @@
 use core::panic;
 
 use aquatic_udp_protocol::{ConnectRequest, ConnectionId, Response, TransactionId};
-use torrust_tracker::servers::udp::MAX_PACKET_SIZE;
+use torrust_tracker::shared::bit_torrent::udp::client::{new_udp_client_connected, UdpTrackerClient};
+use torrust_tracker::shared::bit_torrent::udp::MAX_PACKET_SIZE;
 use torrust_tracker_test_helpers::configuration;
 
 use crate::servers::udp::asserts::is_error_response;
-use crate::servers::udp::client::{new_udp_client_connected, UdpTrackerClient};
 use crate::servers::udp::test_environment::running_test_environment;
 
 fn empty_udp_request() -> [u8; MAX_PACKET_SIZE] {
@@ -51,10 +51,10 @@ async fn should_return_a_bad_request_response_when_the_client_sends_an_empty_req
 
 mod receiving_a_connection_request {
     use aquatic_udp_protocol::{ConnectRequest, TransactionId};
+    use torrust_tracker::shared::bit_torrent::udp::client::new_udp_tracker_client_connected;
     use torrust_tracker_test_helpers::configuration;
 
     use crate::servers::udp::asserts::is_connect_response;
-    use crate::servers::udp::client::new_udp_tracker_client_connected;
     use crate::servers::udp::test_environment::running_test_environment;
 
     #[tokio::test]
@@ -82,10 +82,10 @@ mod receiving_an_announce_request {
         AnnounceEvent, AnnounceRequest, ConnectionId, InfoHash, NumberOfBytes, NumberOfPeers, PeerId, PeerKey, Port,
         TransactionId,
     };
+    use torrust_tracker::shared::bit_torrent::udp::client::new_udp_tracker_client_connected;
     use torrust_tracker_test_helpers::configuration;
 
     use crate::servers::udp::asserts::is_ipv4_announce_response;
-    use crate::servers::udp::client::new_udp_tracker_client_connected;
     use crate::servers::udp::contract::send_connection_request;
     use crate::servers::udp::test_environment::running_test_environment;
 
@@ -124,10 +124,10 @@ mod receiving_an_announce_request {
 
 mod receiving_an_scrape_request {
     use aquatic_udp_protocol::{ConnectionId, InfoHash, ScrapeRequest, TransactionId};
+    use torrust_tracker::shared::bit_torrent::udp::client::new_udp_tracker_client_connected;
     use torrust_tracker_test_helpers::configuration;
 
     use crate::servers::udp::asserts::is_scrape_response;
-    use crate::servers::udp::client::new_udp_tracker_client_connected;
     use crate::servers::udp::contract::send_connection_request;
     use crate::servers::udp::test_environment::running_test_environment;
 

tests/servers/udp/mod.rs

@@ -1,9 +1,3 @@
 pub mod asserts;
-pub mod client;
 pub mod contract;
 pub mod test_environment;
-
-/// Generates the source address for the UDP client
-fn source_address(port: u16) -> String {
-    format!("127.0.0.1:{port}")
-}