Merge #1321: Refactor: move code from axum-http-tracker-server package to http-protocol package

229f9ee refactor: [#1320] move code from axum-http-tracker-server pkg to http-protocol pkg (Jose Celano)

Pull request description:

  Refactor: move code from `axum-http-tracker-server` package to `http-protocol` package.

ACKs for top commit:
  josecelano:
    ACK 229f9ee

Tree-SHA512: bf6497646561b6b0006c209cf34899b377a25127a697317d36b612d360aa546feb91350aa4f32695f97060b61cfdbf1d8ad7080e9444a8b5c28903740964b1aa

Author: josecelano

Cargo.lock

@@ -27,7 +27,6 @@ futures = "0"
 hyper = "1"
 reqwest = { version = "0", features = ["json"] }
 serde = { version = "1", features = ["derive"] }
-thiserror = "2"
 tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
 torrust-axum-server = { version = "3.0.0-develop", path = "../axum-server" }
 torrust-server-lib = { version = "3.0.0-develop", path = "../server-lib" }

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

@@ -49,13 +49,11 @@ use axum::extract::rejection::PathRejection;
 use axum::extract::{FromRequestParts, Path};
 use axum::http::request::Parts;
 use axum::response::{IntoResponse, Response};
-use bittorrent_http_tracker_protocol::v1::responses;
+use bittorrent_http_tracker_protocol::v1::{auth, responses};
 use bittorrent_tracker_core::authentication::Key;
 use hyper::StatusCode;
 use serde::Deserialize;
 
-use crate::v1::handlers::common::auth;
-
 /// Extractor for the [`Key`] struct.
 pub struct Extract(pub Key);
 

packages/axum-http-tracker-server/src/v1/extractors/authentication_key.rs

@@ -1,5 +1,4 @@
 //! Axum [`handlers`](axum#handlers) for the HTTP server.
 pub mod announce;
-pub mod common;
 pub mod health_check;
 pub mod scrape;

packages/axum-http-tracker-server/src/v1/handlers/common/auth.rs

@@ -0,0 +1,17 @@
+use std::panic::Location;
+
+use thiserror::Error;
+
+/// Authentication error.
+///
+/// When the tracker is private, the authentication key is required in the URL
+/// path. These are the possible errors that can occur when extracting the key
+/// from the URL path.
+#[derive(Debug, Error)]
+pub enum Error {
+    #[error("Invalid format for authentication key param. Error in {location}")]
+    InvalidKeyFormat { location: &'static Location<'static> },
+
+    #[error("Cannot extract authentication key param from URL path. Error in {location}")]
+    CannotExtractKeyParam { location: &'static Location<'static> },
+}

packages/axum-http-tracker-server/src/v1/handlers/common/mod.rs

@@ -1,3 +1,4 @@
+pub mod auth;
 pub mod query;
 pub mod requests;
 pub mod responses;

packages/axum-http-tracker-server/src/v1/handlers/common/peer_ip.rs

@@ -13,6 +13,7 @@
 //! > code.
 use serde::Serialize;
 
+use crate::v1::auth;
 use crate::v1::services::peer_ip_resolver::PeerIpResolutionError;
 
 /// `Error` response for the HTTP tracker.
@@ -47,6 +48,14 @@ impl Error {
     }
 }
 
+impl From<auth::Error> for Error {
+    fn from(err: auth::Error) -> Self {
+        Self {
+            failure_reason: format!("Tracker authentication error: {err}"),
+        }
+    }
+}
+
 impl From<PeerIpResolutionError> for Error {
     fn from(err: PeerIpResolutionError) -> Self {
         Self {
@@ -89,8 +98,11 @@ impl From<bittorrent_tracker_core::authentication::Error> for Error {
 
 #[cfg(test)]
 mod tests {
+    use std::panic::Location;
 
     use super::Error;
+    use crate::v1::responses;
+    use crate::v1::services::peer_ip_resolver::PeerIpResolutionError;
 
     #[test]
     fn http_tracker_errors_can_be_bencoded() {
@@ -100,4 +112,20 @@ mod tests {
 
         assert_eq!(err.write(), "d14:failure reason13:error messagee"); // cspell:disable-line
     }
+
+    fn assert_error_response(error: &responses::error::Error, error_message: &str) {
+        assert!(
+            error.failure_reason.contains(error_message),
+            "Error response does not contain message: '{error_message}'. Error: {error:?}"
+        );
+    }
+
+    #[test]
+    fn it_should_map_a_peer_ip_resolution_error_into_an_error_response() {
+        let response = responses::error::Error::from(PeerIpResolutionError::MissingRightMostXForwardedForIp {
+            location: Location::caller(),
+        });
+
+        assert_error_response(&response, "Error resolving peer IP");
+    }
 }