refactor(http-protocol): restructure scrape responses into layered modules

josecelano · josecelano · commit fe14598ae83f · 2026-07-14T13:55:39.000+01:00
Flat scrape.rs and scrape_deserialization.rs replaced by scrape/{data,encoding,deserialization}.rs directory module.

- data.rs - DTO layer: SwarmMetadata, ScrapeData
- encoding.rs - Encoding layer: Bencoded struct + tests
- deserialization.rs - Client-side: Response, File, ResponseBuilder, BencodeParseError
- Deleted both old flat files
- Updated all 7 import sites
- All linters and tests pass
- Progress: T12-T14 done, spec updated
diff --git a/console/tracker-client/src/console/clients/checker/checks/http.rs b/console/tracker-client/src/console/clients/checker/checks/http.rs
@@ -7,7 +7,7 @@ use torrust_tracker_client::http::client::Client;
 use torrust_tracker_http_protocol::v1::requests::announce::AnnounceBuilder;
 use torrust_tracker_http_protocol::v1::requests::scrape_builder;
 use torrust_tracker_http_protocol::v1::responses::announce::deserialization::DeserializedNormal;
-use torrust_tracker_http_protocol::v1::responses::scrape_deserialization;
+use torrust_tracker_http_protocol::v1::responses::scrape::deserialization;
 use url::Url;
 
 use crate::console::clients::http::Error;
@@ -83,7 +83,7 @@ async fn check_http_announce(url: &Url, timeout: Duration) -> Result<Deserialize
     Ok(response)
 }
 
-async fn check_http_scrape(url: &Url, timeout: Duration) -> Result<scrape_deserialization::Response, Error> {
+async fn check_http_scrape(url: &Url, timeout: Duration) -> Result<deserialization::Response, Error> {
     let info_hashes: Vec<String> = vec!["9c38422213e30bff212b30c360d26f9a02136422".to_string()]; // DevSkim: ignore DS173237
     let query = scrape_builder::Query::try_from(info_hashes).expect("a valid array of info-hashes is required");
 
@@ -93,7 +93,7 @@ async fn check_http_scrape(url: &Url, timeout: Duration) -> Result<scrape_deseri
 
     let response = response.bytes().await.map_err(|e| Error::ResponseError { err: e.into() })?;
 
-    let response = scrape_deserialization::Response::try_from_bencoded(&response).map_err(|e| Error::BencodeParseError {
+    let response = deserialization::Response::try_from_bencoded(&response).map_err(|e| Error::BencodeParseError {
         data: response,
         err: e.into(),
     })?;
diff --git a/console/tracker-client/src/console/clients/http/app.rs b/console/tracker-client/src/console/clients/http/app.rs
@@ -82,7 +82,7 @@ use torrust_tracker_client::http::client::Client;
 use torrust_tracker_http_protocol::v1::requests::announce::{AnnounceBuilder, Compact, Event};
 use torrust_tracker_http_protocol::v1::requests::scrape_builder;
 use torrust_tracker_http_protocol::v1::responses::announce::deserialization::{DeserializedCompact, DeserializedNormal};
-use torrust_tracker_http_protocol::v1::responses::scrape_deserialization;
+use torrust_tracker_http_protocol::v1::responses::scrape::deserialization;
 
 use crate::DEFAULT_NETWORK_TIMEOUT;
 
@@ -345,7 +345,7 @@ async fn scrape_command(
 
     let body = response.bytes().await?;
 
-    let Ok(scrape_response) = scrape_deserialization::Response::try_from_bencoded(&body) else {
+    let Ok(scrape_response) = deserialization::Response::try_from_bencoded(&body) else {
         let fallback = bencode_to_fallback_json_or_raw_bytes(&body, output_format)
             .context("failed to serialize fallback scrape response into JSON")?;
 
diff --git a/console/tracker-client/src/console/clients/http/mod.rs b/console/tracker-client/src/console/clients/http/mod.rs
@@ -2,7 +2,7 @@ use std::sync::Arc;
 
 use serde::Serialize;
 use thiserror::Error;
-use torrust_tracker_http_protocol::v1::responses::scrape_deserialization::BencodeParseError;
+use torrust_tracker_http_protocol::v1::responses::scrape::deserialization::BencodeParseError;
 
 pub mod app;
 
diff --git a/console/tracker-client/src/console/clients/unified/http.rs b/console/tracker-client/src/console/clients/unified/http.rs
@@ -12,7 +12,7 @@ use torrust_tracker_client::http::client::Client;
 use torrust_tracker_http_protocol::v1::requests::announce::{AnnounceBuilder, Compact, Event};
 use torrust_tracker_http_protocol::v1::requests::scrape_builder;
 use torrust_tracker_http_protocol::v1::responses::announce::deserialization::{DeserializedCompact, DeserializedNormal};
-use torrust_tracker_http_protocol::v1::responses::scrape_deserialization;
+use torrust_tracker_http_protocol::v1::responses::scrape::deserialization;
 
 use super::app::OutputFormat;
 use crate::DEFAULT_NETWORK_TIMEOUT;
@@ -218,7 +218,7 @@ async fn scrape_command(
 
     let body = response.bytes().await?;
 
-    let Ok(scrape_response) = scrape_deserialization::Response::try_from_bencoded(&body) else {
+    let Ok(scrape_response) = deserialization::Response::try_from_bencoded(&body) else {
         let fallback = bencode_to_fallback_json_or_raw_bytes(&body, output_format)
             .context("failed to serialize fallback scrape response into JSON")?;
 
diff --git a/docs/issues/open/1965-1669-si-34-consolidate-duplicate-http-types/ISSUE.md b/docs/issues/open/1965-1669-si-34-consolidate-duplicate-http-types/ISSUE.md
@@ -226,9 +226,9 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`.
 |     |        | **Response-side restructuring (DD7 + DD8)**           |                                                                                                                                                                                                                                                                                                                                                 |
 | T10 | DONE   | Restructure announce responses into layered module    | Created `announce/{data,encoding}.rs` with `mod.rs` re-exports. Deleted old `announce.rs`. No call sites needed updating (backward compatible)                                                                                                                                                                                                  |
 | T11 | DONE   | Partial merge of announce DTO layer                   | Moved deserialization types into `announce/deserialization.rs`. Renamed `Announce` → `DeserializedNormal`, `Compact` → `DeserializedCompactParsed`. Added `peers6` to `DeserializedCompact`. Replaced `CompactPeer` (IPv4-only struct) with shared `encoding::CompactPeer` enum. Deleted `announce_deserialization.rs`. Updated 8 import sites. |
-| T12 | TODO   | Restructure scrape responses into layered module      | Same pattern: `scrape/{data,encoding,deserialization}.rs`                                                                                                                                                                                                                                                                                       |
-| T13 | TODO   | Partial merge of scrape DTO layer                     | Same pattern as announce                                                                                                                                                                                                                                                                                                                        |
-| T14 | TODO   | Update all call sites for restructured response types | Update imports in tracker-client, axum-http-server tests, CLI apps                                                                                                                                                                                                                                                                              |
+| T12 | DONE   | Restructure scrape responses into layered module      | Created `scrape/{data,encoding,deserialization}.rs`. Deleted `scrape.rs` and `scrape_deserialization.rs`. Updated 7 import sites. Backward compatible re-exports.                                                                                                                                                                               |
+| T13 | DONE   | Partial merge of scrape DTO layer                     | Merged `scrape_deserialization.rs` into `scrape/deserialization.rs`. Updated all import sites. Done together with T12.                                                                                                                                                                                                                          |
+| T14 | DONE   | Update all call sites for restructured response types | Updated all import sites for both announce and scrape restructuring. Done together with T10-T13.                                                                                                                                                                                                                                                |
 | T15 | TODO   | Run full verification after response restructure      | `linter all`, `cargo test --workspace`, pre-commit, pre-push                                                                                                                                                                                                                                                                                    |
 |     |        | **Finalization**                                      |                                                                                                                                                                                                                                                                                                                                                 |
 | T16 | TODO   | Replace duplicate HTTP test client (DD9)              | Remove `packages/axum-http-server/tests/server/client.rs`; update tests to use `tracker-client` package                                                                                                                                                                                                                                         |
@@ -260,6 +260,7 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`.
 - 2026-07-14 10:00 UTC - Copilot - Implementation (T7-T9) completed: merged `announce_builder::Query` into `Announce`, updated all call sites, all verifications passed.
 - 2026-07-14 14:00 UTC - Copilot - Implementation (T10) completed: restructured announce responses into `announce/{data,encoding}.rs` layered module.
 - 2026-07-14 15:00 UTC - Copilot - Implementation (T11) completed: partial merge of announce DTO layer into `announce/deserialization.rs`.
+- 2026-07-14 16:00 UTC - Copilot - Implementation (T12-T14) completed: restructured scrape responses into `scrape/{data,encoding,deserialization}.rs`, merged DTO layer, updated all import sites.
 
 ## Acceptance Criteria
 
diff --git a/packages/axum-http-server/tests/server/asserts.rs b/packages/axum-http-server/tests/server/asserts.rs
@@ -5,7 +5,7 @@ use torrust_tracker_http_protocol::v1::responses::announce::deserialization::{
     DeserializedCompact, DeserializedCompactParsed, DeserializedNormal,
 };
 use torrust_tracker_http_protocol::v1::responses::error::Error;
-use torrust_tracker_http_protocol::v1::responses::scrape_deserialization;
+use torrust_tracker_http_protocol::v1::responses::scrape::deserialization;
 
 pub fn assert_bencoded_error(response_text: &String, expected_failure_reason: &str, location: &'static Location<'static>) {
     let error_failure_reason = serde_bencode::from_str::<Error>(response_text)
@@ -59,10 +59,10 @@ pub async fn assert_compact_announce_response(response: Response, expected_respo
 /// ```text
 /// b"d5:filesd20:\x9c8B\"\x13\xe3\x0b\xff!+0\xc3`\xd2o\x9a\x02\x13d\"d8:completei1e10:downloadedi0e10:incompletei0eeee"
 /// ```
-pub async fn assert_scrape_response(response: Response, expected_response: &scrape_deserialization::Response) {
+pub async fn assert_scrape_response(response: Response, expected_response: &deserialization::Response) {
     assert_eq!(response.status(), 200);
 
-    let scrape_response = scrape_deserialization::Response::try_from_bencoded(&response.bytes().await.unwrap()).unwrap();
+    let scrape_response = deserialization::Response::try_from_bencoded(&response.bytes().await.unwrap()).unwrap();
 
     assert_eq!(scrape_response, *expected_response);
 }
diff --git a/packages/axum-http-server/tests/server/v1/contract.rs b/packages/axum-http-server/tests/server/v1/contract.rs
@@ -1145,7 +1145,7 @@ mod for_all_config_modes {
         use torrust_info_hash::InfoHash;
         use torrust_tracker_axum_http_server::testing::environment::Started;
         use torrust_tracker_http_protocol::v1::requests::scrape_builder::QueryBuilder;
-        use torrust_tracker_http_protocol::v1::responses::scrape_deserialization::{self, File, ResponseBuilder};
+        use torrust_tracker_http_protocol::v1::responses::scrape::deserialization::{self, File, ResponseBuilder};
         use torrust_tracker_primitives::PeerId;
         use torrust_tracker_primitives::peer::fixture::PeerBuilder;
         use torrust_tracker_test_helpers::{configuration, logging};
@@ -1288,11 +1288,7 @@ mod for_all_config_modes {
                 .scrape(&QueryBuilder::default().with_one_info_hash(&info_hash).query())
                 .await;
 
-            assert_scrape_response(
-                response,
-                &scrape_deserialization::Response::with_one_file(info_hash, File::zeroed()),
-            )
-            .await;
+            assert_scrape_response(response, &deserialization::Response::with_one_file(info_hash, File::zeroed())).await;
 
             env.stop().await;
         }
@@ -1467,7 +1463,7 @@ mod configured_as_whitelisted {
         use torrust_info_hash::InfoHash;
         use torrust_tracker_axum_http_server::testing::environment::Started;
         use torrust_tracker_http_protocol::v1::requests::scrape_builder::QueryBuilder;
-        use torrust_tracker_http_protocol::v1::responses::scrape_deserialization::{File, ResponseBuilder};
+        use torrust_tracker_http_protocol::v1::responses::scrape::deserialization::{File, ResponseBuilder};
         use torrust_tracker_primitives::PeerId;
         use torrust_tracker_primitives::peer::fixture::PeerBuilder;
         use torrust_tracker_test_helpers::logging::logs_contains_a_line_with;
@@ -1678,7 +1674,7 @@ mod configured_as_private {
         use torrust_tracker_axum_http_server::testing::environment::Started;
         use torrust_tracker_core::authentication::Key;
         use torrust_tracker_http_protocol::v1::requests::scrape_builder::QueryBuilder;
-        use torrust_tracker_http_protocol::v1::responses::scrape_deserialization::{File, ResponseBuilder};
+        use torrust_tracker_http_protocol::v1::responses::scrape::deserialization::{File, ResponseBuilder};
         use torrust_tracker_primitives::PeerId;
         use torrust_tracker_primitives::peer::fixture::PeerBuilder;
         use torrust_tracker_test_helpers::{configuration, logging};
diff --git a/packages/http-protocol/src/v1/responses/mod.rs b/packages/http-protocol/src/v1/responses/mod.rs
@@ -2,6 +2,5 @@
 pub mod announce;
 pub mod error;
 pub mod scrape;
-pub mod scrape_deserialization;
 
 pub use announce::{Announce, Compact, Normal};
diff --git a/packages/http-protocol/src/v1/responses/scrape/data.rs b/packages/http-protocol/src/v1/responses/scrape/data.rs
@@ -0,0 +1,35 @@
+//! Data types for the `Scrape` response.
+//!
+//! These protocol DTOs intentionally mirror some domain fields but must remain
+//! protocol-owned. Keeping this type local avoids protocol->domain coupling and
+//! confines translation to boundary adapters.
+use std::collections::BTreeMap;
+
+use torrust_info_hash::InfoHash;
+
+// Intentional boundary duplication: this represents scrape response payload
+// semantics for the HTTP protocol crate, not tracker-domain semantics.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
+pub struct SwarmMetadata {
+    pub complete: u32,
+    pub downloaded: u32,
+    pub incomplete: u32,
+}
+
+// Intentional boundary duplication: this represents scrape response payload
+// semantics for the HTTP protocol crate, not tracker-domain semantics.
+#[derive(Clone, Debug, PartialEq, Default)]
+pub struct ScrapeData {
+    pub files: BTreeMap<InfoHash, SwarmMetadata>,
+}
+
+impl ScrapeData {
+    #[must_use]
+    pub fn empty() -> Self {
+        Self::default()
+    }
+
+    pub fn add_file(&mut self, info_hash: &InfoHash, swarm_metadata: SwarmMetadata) {
+        self.files.insert(*info_hash, swarm_metadata);
+    }
+}
diff --git a/packages/http-protocol/src/v1/responses/scrape/deserialization.rs b/packages/http-protocol/src/v1/responses/scrape/deserialization.rs
diff --git a/packages/http-protocol/src/v1/responses/scrape/encoding.rs b/packages/http-protocol/src/v1/responses/scrape/encoding.rs
@@ -1,39 +1,11 @@
-//! `Scrape` response for the HTTP tracker [`scrape`](crate::v1::requests::scrape::Scrape) request.
+//! Encoding layer for the `Scrape` response.
 //!
-//! Data structures and logic to build the `scrape` response.
+//! Contains the `Bencoded` struct and its conversion from `ScrapeData`.
 use std::borrow::Cow;
-use std::collections::BTreeMap;
 
 use torrust_bencode::{BMutAccess, ben_int, ben_map};
-use torrust_info_hash::InfoHash;
-
-// These protocol DTOs intentionally mirror some domain fields but must remain
-// protocol-owned. Keeping this type local avoids protocol->domain coupling and
-// confines translation to boundary adapters.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
-pub struct SwarmMetadata {
-    pub complete: u32,
-    pub downloaded: u32,
-    pub incomplete: u32,
-}
-
-// Intentional boundary duplication: this represents scrape response payload
-// semantics for the HTTP protocol crate, not tracker-domain semantics.
-#[derive(Clone, Debug, PartialEq, Default)]
-pub struct ScrapeData {
-    pub files: BTreeMap<InfoHash, SwarmMetadata>,
-}
-
-impl ScrapeData {
-    #[must_use]
-    pub fn empty() -> Self {
-        Self::default()
-    }
 
-    pub fn add_file(&mut self, info_hash: &InfoHash, swarm_metadata: SwarmMetadata) {
-        self.files.insert(*info_hash, swarm_metadata);
-    }
-}
+use crate::v1::responses::scrape::data::ScrapeData;
 
 /// The `Scrape` response for the HTTP tracker.
 ///
diff --git a/packages/http-protocol/src/v1/responses/scrape/mod.rs b/packages/http-protocol/src/v1/responses/scrape/mod.rs
@@ -0,0 +1,8 @@
+//! Scrape response types for the HTTP tracker.
+pub mod data;
+pub mod deserialization;
+pub mod encoding;
+
+pub use data::{ScrapeData, SwarmMetadata};
+pub use deserialization::{BencodeParseError, File, Response, ResponseBuilder};
+pub use encoding::Bencoded;
