feat: [torrust#1424] add ServiceBinding to UDP events

Author: josecelano

packages/udp-tracker-core/benches/helpers/sync.rs

@@ -4,21 +4,23 @@ use std::time::{Duration, Instant};
 
 use bittorrent_udp_tracker_core::services::connect::ConnectService;
 use bittorrent_udp_tracker_core::statistics;
+use torrust_tracker_primitives::service_binding::{Protocol, ServiceBinding};
 
 use crate::helpers::utils::{sample_ipv4_remote_addr, sample_issue_time};
 
 #[allow(clippy::unused_async)]
 pub async fn connect_once(samples: u64) -> Duration {
     let client_socket_addr = sample_ipv4_remote_addr();
     let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969);
+    let server_service_binding = ServiceBinding::new(Protocol::UDP, server_socket_addr).unwrap();
 
     let (udp_core_stats_event_sender, _udp_core_stats_repository) = statistics::setup::factory(false);
     let udp_core_stats_event_sender = Arc::new(udp_core_stats_event_sender);
     let connect_service = Arc::new(ConnectService::new(udp_core_stats_event_sender));
     let start = Instant::now();
 
     for _ in 0..samples {
-        let _response = connect_service.handle_connect(client_socket_addr, server_socket_addr, sample_issue_time());
+        let _response = connect_service.handle_connect(client_socket_addr, server_service_binding.clone(), sample_issue_time());
     }
 
     start.elapsed()

packages/udp-tracker-core/src/event/mod.rs

@@ -1,5 +1,7 @@
 use std::net::SocketAddr;
 
+use torrust_tracker_primitives::service_binding::ServiceBinding;
+
 pub mod sender;
 
 /// A UDP core event.
@@ -13,15 +15,15 @@ pub enum Event {
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct ConnectionContext {
     pub client_socket_addr: SocketAddr,
-    pub server_socket_addr: SocketAddr,
+    pub server_service_binding: ServiceBinding,
 }
 
 impl ConnectionContext {
     #[must_use]
-    pub fn new(client_socket_addr: SocketAddr, server_socket_addr: SocketAddr) -> Self {
+    pub fn new(client_socket_addr: SocketAddr, server_service_binding: ServiceBinding) -> Self {
         Self {
             client_socket_addr,
-            server_socket_addr,
+            server_service_binding,
         }
     }
 
@@ -32,6 +34,6 @@ impl ConnectionContext {
 
     #[must_use]
     pub fn server_socket_addr(&self) -> SocketAddr {
-        self.server_socket_addr
+        self.server_service_binding.bind_address()
     }
 }

packages/udp-tracker-core/src/services/announce.rs

@@ -18,6 +18,7 @@ use bittorrent_tracker_core::error::{AnnounceError, WhitelistError};
 use bittorrent_tracker_core::whitelist;
 use bittorrent_udp_tracker_protocol::peer_builder;
 use torrust_tracker_primitives::core::AnnounceData;
+use torrust_tracker_primitives::service_binding::ServiceBinding;
 
 use crate::connection_cookie::{check, gen_remote_fingerprint, ConnectionCookieError};
 use crate::event::{self, ConnectionContext, Event};
@@ -58,7 +59,7 @@ impl AnnounceService {
     pub async fn handle_announce(
         &self,
         client_socket_addr: SocketAddr,
-        server_socket_addr: SocketAddr,
+        server_service_binding: ServiceBinding,
         request: &AnnounceRequest,
         cookie_valid_range: Range<f64>,
     ) -> Result<AnnounceData, UdpAnnounceError> {
@@ -79,7 +80,7 @@ impl AnnounceService {
             .announce(&info_hash, &mut peer, &remote_client_ip, &peers_wanted)
             .await?;
 
-        self.send_event(client_socket_addr, server_socket_addr).await;
+        self.send_event(client_socket_addr, server_service_binding).await;
 
         Ok(announce_data)
     }
@@ -100,11 +101,11 @@ impl AnnounceService {
         self.whitelist_authorization.authorize(info_hash).await
     }
 
-    async fn send_event(&self, client_socket_addr: SocketAddr, server_socket_addr: SocketAddr) {
+    async fn send_event(&self, client_socket_addr: SocketAddr, server_service_binding: ServiceBinding) {
         if let Some(udp_stats_event_sender) = self.opt_udp_core_stats_event_sender.as_deref() {
             udp_stats_event_sender
                 .send_event(Event::UdpAnnounce {
-                    context: ConnectionContext::new(client_socket_addr, server_socket_addr),
+                    context: ConnectionContext::new(client_socket_addr, server_service_binding),
                 })
                 .await;
         }

packages/udp-tracker-core/src/services/connect.rs

@@ -5,6 +5,7 @@ use std::net::SocketAddr;
 use std::sync::Arc;
 
 use aquatic_udp_protocol::ConnectionId;
+use torrust_tracker_primitives::service_binding::ServiceBinding;
 
 use crate::connection_cookie::{gen_remote_fingerprint, make};
 use crate::event::{self, ConnectionContext, Event};
@@ -33,7 +34,7 @@ impl ConnectService {
     pub async fn handle_connect(
         &self,
         client_socket_addr: SocketAddr,
-        server_socket_addr: SocketAddr,
+        server_service_binding: ServiceBinding,
         cookie_issue_time: f64,
     ) -> ConnectionId {
         let connection_id =
@@ -42,7 +43,7 @@ impl ConnectService {
         if let Some(udp_stats_event_sender) = self.opt_udp_core_stats_event_sender.as_deref() {
             udp_stats_event_sender
                 .send_event(Event::UdpConnect {
-                    context: ConnectionContext::new(client_socket_addr, server_socket_addr),
+                    context: ConnectionContext::new(client_socket_addr, server_service_binding),
                 })
                 .await;
         }
@@ -61,6 +62,7 @@ mod tests {
         use std::sync::Arc;
 
         use mockall::predicate::eq;
+        use torrust_tracker_primitives::service_binding::{Protocol, ServiceBinding};
 
         use crate::connection_cookie::make;
         use crate::event::{ConnectionContext, Event};
@@ -74,14 +76,15 @@ mod tests {
         #[tokio::test]
         async fn a_connect_response_should_contain_the_same_transaction_id_as_the_connect_request() {
             let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969);
+            let server_service_binding = ServiceBinding::new(Protocol::UDP, server_socket_addr).unwrap();
 
             let (udp_core_stats_event_sender, _udp_core_stats_repository) = statistics::setup::factory(false);
             let udp_core_stats_event_sender = Arc::new(udp_core_stats_event_sender);
 
             let connect_service = Arc::new(ConnectService::new(udp_core_stats_event_sender));
 
             let response = connect_service
-                .handle_connect(sample_ipv4_remote_addr(), server_socket_addr, sample_issue_time())
+                .handle_connect(sample_ipv4_remote_addr(), server_service_binding, sample_issue_time())
                 .await;
 
             assert_eq!(
@@ -93,14 +96,15 @@ mod tests {
         #[tokio::test]
         async fn a_connect_response_should_contain_a_new_connection_id() {
             let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969);
+            let server_service_binding = ServiceBinding::new(Protocol::UDP, server_socket_addr).unwrap();
 
             let (udp_core_stats_event_sender, _udp_core_stats_repository) = statistics::setup::factory(false);
             let udp_core_stats_event_sender = Arc::new(udp_core_stats_event_sender);
 
             let connect_service = Arc::new(ConnectService::new(udp_core_stats_event_sender));
 
             let response = connect_service
-                .handle_connect(sample_ipv4_remote_addr(), server_socket_addr, sample_issue_time())
+                .handle_connect(sample_ipv4_remote_addr(), server_service_binding, sample_issue_time())
                 .await;
 
             assert_eq!(
@@ -113,14 +117,15 @@ mod tests {
         async fn a_connect_response_should_contain_a_new_connection_id_ipv6() {
             let client_socket_addr = sample_ipv6_remote_addr();
             let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969);
+            let server_service_binding = ServiceBinding::new(Protocol::UDP, server_socket_addr).unwrap();
 
             let (udp_core_stats_event_sender, _udp_core_stats_repository) = statistics::setup::factory(false);
             let udp_core_stats_event_sender = Arc::new(udp_core_stats_event_sender);
 
             let connect_service = Arc::new(ConnectService::new(udp_core_stats_event_sender));
 
             let response = connect_service
-                .handle_connect(client_socket_addr, server_socket_addr, sample_issue_time())
+                .handle_connect(client_socket_addr, server_service_binding, sample_issue_time())
                 .await;
 
             assert_eq!(
@@ -133,12 +138,13 @@ mod tests {
         async fn it_should_send_the_upd4_connect_event_when_a_client_tries_to_connect_using_a_ip4_socket_address() {
             let client_socket_addr = sample_ipv4_socket_address();
             let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969);
+            let server_service_binding = ServiceBinding::new(Protocol::UDP, server_socket_addr).unwrap();
 
             let mut udp_stats_event_sender_mock = MockUdpCoreStatsEventSender::new();
             udp_stats_event_sender_mock
                 .expect_send_event()
                 .with(eq(Event::UdpConnect {
-                    context: ConnectionContext::new(client_socket_addr, server_socket_addr),
+                    context: ConnectionContext::new(client_socket_addr, server_service_binding.clone()),
                 }))
                 .times(1)
                 .returning(|_| Box::pin(future::ready(Some(Ok(1)))));
@@ -148,20 +154,21 @@ mod tests {
             let connect_service = Arc::new(ConnectService::new(opt_udp_stats_event_sender));
 
             connect_service
-                .handle_connect(client_socket_addr, server_socket_addr, sample_issue_time())
+                .handle_connect(client_socket_addr, server_service_binding, sample_issue_time())
                 .await;
         }
 
         #[tokio::test]
         async fn it_should_send_the_upd6_connect_event_when_a_client_tries_to_connect_using_a_ip6_socket_address() {
             let client_socket_addr = sample_ipv6_remote_addr();
             let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969);
+            let server_service_binding = ServiceBinding::new(Protocol::UDP, server_socket_addr).unwrap();
 
             let mut udp_stats_event_sender_mock = MockUdpCoreStatsEventSender::new();
             udp_stats_event_sender_mock
                 .expect_send_event()
                 .with(eq(Event::UdpConnect {
-                    context: ConnectionContext::new(client_socket_addr, server_socket_addr),
+                    context: ConnectionContext::new(client_socket_addr, server_service_binding.clone()),
                 }))
                 .times(1)
                 .returning(|_| Box::pin(future::ready(Some(Ok(1)))));
@@ -171,7 +178,7 @@ mod tests {
             let connect_service = Arc::new(ConnectService::new(opt_udp_stats_event_sender));
 
             connect_service
-                .handle_connect(client_socket_addr, server_socket_addr, sample_issue_time())
+                .handle_connect(client_socket_addr, server_service_binding, sample_issue_time())
                 .await;
         }
     }

packages/udp-tracker-core/src/services/scrape.rs

@@ -16,6 +16,7 @@ use bittorrent_primitives::info_hash::InfoHash;
 use bittorrent_tracker_core::error::{ScrapeError, WhitelistError};
 use bittorrent_tracker_core::scrape_handler::ScrapeHandler;
 use torrust_tracker_primitives::core::ScrapeData;
+use torrust_tracker_primitives::service_binding::ServiceBinding;
 
 use crate::connection_cookie::{check, gen_remote_fingerprint, ConnectionCookieError};
 use crate::event::{self, ConnectionContext, Event};
@@ -50,7 +51,7 @@ impl ScrapeService {
     pub async fn handle_scrape(
         &self,
         client_socket_addr: SocketAddr,
-        server_socket_addr: SocketAddr,
+        server_service_binding: ServiceBinding,
         request: &ScrapeRequest,
         cookie_valid_range: Range<f64>,
     ) -> Result<ScrapeData, UdpScrapeError> {
@@ -61,7 +62,7 @@ impl ScrapeService {
             .scrape(&Self::convert_from_aquatic(&request.info_hashes))
             .await?;
 
-        self.send_event(client_socket_addr, server_socket_addr).await;
+        self.send_event(client_socket_addr, server_service_binding).await;
 
         Ok(scrape_data)
     }
@@ -82,11 +83,11 @@ impl ScrapeService {
         aquatic_infohashes.iter().map(|&x| x.into()).collect()
     }
 
-    async fn send_event(&self, client_socket_addr: SocketAddr, server_socket_addr: SocketAddr) {
+    async fn send_event(&self, client_socket_addr: SocketAddr, server_service_binding: ServiceBinding) {
         if let Some(udp_stats_event_sender) = self.opt_udp_stats_event_sender.as_deref() {
             udp_stats_event_sender
                 .send_event(Event::UdpScrape {
-                    context: ConnectionContext::new(client_socket_addr, server_socket_addr),
+                    context: ConnectionContext::new(client_socket_addr, server_service_binding),
                 })
                 .await;
         }

packages/udp-tracker-core/src/statistics/event/handler.rs

@@ -39,6 +39,8 @@ pub async fn handle_event(event: Event, stats_repository: &Repository) {
 mod tests {
     use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
 
+    use torrust_tracker_primitives::service_binding::{Protocol, ServiceBinding};
+
     use crate::event::{ConnectionContext, Event};
     use crate::statistics::event::handler::handle_event;
     use crate::statistics::repository::Repository;
@@ -51,7 +53,11 @@ mod tests {
             Event::UdpConnect {
                 context: ConnectionContext::new(
                     SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 195)), 8080),
-                    SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969),
+                    ServiceBinding::new(
+                        Protocol::UDP,
+                        SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969),
+                    )
+                    .unwrap(),
                 ),
             },
             &stats_repository,
@@ -71,7 +77,11 @@ mod tests {
             Event::UdpAnnounce {
                 context: ConnectionContext::new(
                     SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 195)), 8080),
-                    SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969),
+                    ServiceBinding::new(
+                        Protocol::UDP,
+                        SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969),
+                    )
+                    .unwrap(),
                 ),
             },
             &stats_repository,
@@ -91,7 +101,11 @@ mod tests {
             Event::UdpScrape {
                 context: ConnectionContext::new(
                     SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 195)), 8080),
-                    SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969),
+                    ServiceBinding::new(
+                        Protocol::UDP,
+                        SocketAddr::new(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 196)), 6969),
+                    )
+                    .unwrap(),
                 ),
             },
             &stats_repository,
@@ -111,7 +125,11 @@ mod tests {
             Event::UdpConnect {
                 context: ConnectionContext::new(
                     SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 195)), 8080),
-                    SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
+                    ServiceBinding::new(
+                        Protocol::UDP,
+                        SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
+                    )
+                    .unwrap(),
                 ),
             },
             &stats_repository,
@@ -131,7 +149,11 @@ mod tests {
             Event::UdpAnnounce {
                 context: ConnectionContext::new(
                     SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 195)), 8080),
-                    SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
+                    ServiceBinding::new(
+                        Protocol::UDP,
+                        SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
+                    )
+                    .unwrap(),
                 ),
             },
             &stats_repository,
@@ -151,7 +173,11 @@ mod tests {
             Event::UdpScrape {
                 context: ConnectionContext::new(
                     SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 195)), 8080),
-                    SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
+                    ServiceBinding::new(
+                        Protocol::UDP,
+                        SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
+                    )
+                    .unwrap(),
                 ),
             },
             &stats_repository,

packages/udp-tracker-server/src/event/mod.rs

@@ -1,6 +1,8 @@
 use std::net::SocketAddr;
 use std::time::Duration;
 
+use torrust_tracker_primitives::service_binding::ServiceBinding;
+
 pub mod sender;
 
 /// A UDP server event.
@@ -52,15 +54,15 @@ pub enum UdpResponseKind {
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct ConnectionContext {
     client_socket_addr: SocketAddr,
-    server_socket_addr: SocketAddr,
+    server_service_binding: ServiceBinding,
 }
 
 impl ConnectionContext {
     #[must_use]
-    pub fn new(client_socket_addr: SocketAddr, server_socket_addr: SocketAddr) -> Self {
+    pub fn new(client_socket_addr: SocketAddr, server_service_binding: ServiceBinding) -> Self {
         Self {
             client_socket_addr,
-            server_socket_addr,
+            server_service_binding,
         }
     }
 
@@ -71,6 +73,6 @@ impl ConnectionContext {
 
     #[must_use]
     pub fn server_socket_addr(&self) -> SocketAddr {
-        self.server_socket_addr
+        self.server_service_binding.bind_address()
     }
 }