feat(deps): replace aquatic_udp_protocol with in-house implementation (#1732) by josecelano · Pull Request #1733 · torrust/torrust-tracker

josecelano · 2026-05-05T18:47:33Z

Replaces the external aquatic_udp_protocol and aquatic_peer_id dependencies with in-house maintained packages and completes the post-migration refactor/cleanup for issue #1732.

This removes the upstream maintenance bottleneck, keeps dependency/security updates under Torrust control, and preserves behavior across protocol and domain consumers.

Why this change

Upstream Aquatic crates appear unmaintained for our needs, while this tracker must continue evolving and receiving dependency/security updates.

Relevant upstream context:

What was delivered

Replaced upstream aquatic dependencies with in-house maintained packages.
Completed udp-protocol refactor into action-oriented modules.
Completed primitives module refactor (announce / scrape split, cleanup).
Removed temporary compatibility wrappers after consumer migration.
Extracted duplicated PeerId / PeerClient logic into shared in-house package:
- packages/peer-id (bittorrent-peer-id)
Integrated bittorrent-peer-id into:
- packages/udp-protocol
- packages/primitives (compatibility re-export preserved)
Split packages/peer-id internals into focused modules while keeping public API stable.
Updated package documentation and provenance notes for:
- packages/udp-protocol/README.md
- packages/peer-id/README.md
Added package-level license file for packages/peer-id and clarified notices/acknowledgment.

Architecture outcome

udp-protocol no longer owns duplicated peer-id logic.
primitives no longer owns duplicated peer-id logic.
peer-id is the canonical owner of PeerId/PeerClient logic.
Dependency direction remains correct (udp-protocol does not depend on primitives).

Validation

All required checks were run and passed during the final slices:

cargo check --workspace
cargo test --workspace
cargo test --doc --workspace
linter all

Attribution and licensing

Code originates from Aquatic crates (Apache-2.0), with in-house maintenance and required notices retained.

Special acknowledgment to greatest-ape (Joakim Frostegård) for significant contributions to the BitTorrent ecosystem.

Closes #1732

…ust#1732)

…p-protocol (step 1a of torrust#1732) These are verbatim copies of aquatic_peer_id 0.9.0 and aquatic_udp_protocol 0.9.0 (Apache 2.0), registered in the workspace Cargo.toml as path packages. No dependent package has been switched to use them yet — that is Step 1b. Each source file carries an inline attribution header crediting Joakim Frostegård (greatest-ape) and linking to the original crates.io release.

…ps (step 1b of torrust#1732) All 13 packages that previously depended on `aquatic_udp_protocol = "0"` (crates.io) now use `path = "../aquatic-udp-protocol"` (or `../../packages/aquatic-udp-protocol` for `console/tracker-client`). Build is clean and all tests pass.

…ent homes (torrust#1732) Split Step 4 into 4a (UDP protocol types → udp-protocol) and 4b (peer ID types → primitives). This reflects the fact that PeerId is a domain concept used by HTTP tracker, REST API, and core logic—not UDP-protocol-specific. Peer ID types belong in primitives with other peer-related domain types.

…orks (torrust#1732)

Copilot

Pull request overview

This PR introduces in-workspace forks of the unmaintained aquatic_udp_protocol / aquatic_peer_id crates and switches Torrust Tracker packages to consume those forks via path dependencies, as the first step toward unblocking the zerocopy 0.8 upgrade and reducing external maintenance risk.

Changes:

Added new internal fork crates under packages/aquatic-udp-protocol and packages/aquatic-peer-id (source + LICENSE + README).
Updated multiple workspace crates to use the internal fork via path dependency instead of crates.io.
Added workspace wiring/docs updates (Cargo.toml workspace members + patch, analysis docs, word list updates).

Reviewed changes

Copilot reviewed 28 out of 29 changed files in this pull request and generated 17 comments.

Show a summary per file

File	Description
`Cargo.toml`	Adds fork crates to workspace members and adds a crates.io patch override for `aquatic_*`.
`Cargo.lock`	Removes registry sourcing for `aquatic_*` and records additional resolved deps for fork test/dev usage.
`project-words.txt`	Updates spellchecker allowlist for new terms used in the migration/docs/tests.
`console/tracker-client/Cargo.toml`	Switches console client to use forked `aquatic_udp_protocol` via path.
`packages/udp-tracker-server/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/udp-tracker-core/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/udp-protocol/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/tracker-core/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/tracker-client/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/torrent-repository-benchmarking/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/swarm-coordination-registry/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/primitives/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/http-tracker-core/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/http-protocol/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/axum-rest-tracker-api-server/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/axum-http-tracker-server/Cargo.toml`	Switches dependency to forked `aquatic_udp_protocol` via path.
`packages/aquatic-udp-protocol/Cargo.toml`	New fork crate manifest for `aquatic_udp_protocol`.
`packages/aquatic-udp-protocol/src/lib.rs`	New fork crate module exports and lint allowances to preserve upstream code verbatim.
`packages/aquatic-udp-protocol/src/common.rs`	Forked shared protocol types/helpers.
`packages/aquatic-udp-protocol/src/request.rs`	Forked request parsing/serialization implementation + tests.
`packages/aquatic-udp-protocol/src/response.rs`	Forked response parsing/serialization implementation + tests.
`packages/aquatic-udp-protocol/README.md`	Documents purpose and provenance of the fork.
`packages/aquatic-udp-protocol/LICENSE`	Adds Apache-2.0 license text for the fork.
`packages/aquatic-peer-id/Cargo.toml`	New fork crate manifest for `aquatic_peer_id`.
`packages/aquatic-peer-id/src/lib.rs`	Forked peer-id parsing/client identification implementation.
`packages/aquatic-peer-id/README.md`	Documents purpose and provenance of the fork.
`packages/aquatic-peer-id/LICENSE`	Adds Apache-2.0 license text for the fork.
`docs/issues/1732-replace-aquatic-udp-protocol/ISSUE.md`	Adds in-repo migration plan/issue documentation.
`docs/issues/1732-replace-aquatic-udp-protocol/step-2-analysis.md`	Records Step 2 “unused code” analysis for the forks.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

codecov · 2026-05-05T19:08:30Z

Codecov Report

❌ Patch coverage is 75.87719% with 165 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.52%. Comparing base (0e71e40) to head (7a587dd).

Files with missing lines	Patch %	Lines
packages/peer-id/src/peer_client.rs	71.12%	40 Missing and 1 partial ⚠️
packages/udp-protocol/src/common.rs	57.97%	28 Missing and 1 partial ⚠️
packages/udp-protocol/src/response.rs	82.23%	13 Missing and 14 partials ⚠️
packages/udp-protocol/src/announce.rs	54.28%	13 Missing and 3 partials ⚠️
packages/peer-id/src/peer_id.rs	16.66%	15 Missing ⚠️
packages/udp-protocol/src/request.rs	94.53%	6 Missing and 4 partials ⚠️
packages/http-protocol/src/v1/requests/announce.rs	12.50%	7 Missing ⚠️
packages/udp-protocol/src/scrape.rs	46.15%	0 Missing and 7 partials ⚠️
packages/udp-protocol/src/connect.rs	54.54%	0 Missing and 5 partials ⚠️
...r-client/src/console/clients/checker/checks/udp.rs	0.00%	3 Missing ⚠️
... and 2 more

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1733      +/-   ##
===========================================
- Coverage    79.69%   79.52%   -0.17%     
===========================================
  Files          359      368       +9     
  Lines        26411    27049     +638     
  Branches     26411    27049     +638     
===========================================
+ Hits         21048    21511     +463     
- Misses        5117     5258     +141     
- Partials       246      280      +34

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- In ISSUE.md: replace the 'Related future work' callout in Step 4 with a leaner 'See also' note linking to the step-3 analysis doc; add new Step 4c checklist 'Consolidate InfoHash into bittorrent-primitives' with concrete action items (swap inner field to [u8;20], drop aquatic_udp_protocol dep, update impls/tests, publish, remove fork/patch entry). - In step-3-bittorrent-primitives-problem.md: rename 'Consolidate InfoHash' subsection to reference Step 4c explicitly; rename 'Update bittorrent-primitives after Step 4a' to 'Update bittorrent-primitives dependency after Step 4c' with matching explanation.

…orrust#1732)

…rate

Copilot

Pull request overview

Copilot reviewed 105 out of 106 changed files in this pull request and generated 9 comments.

- New skill: process-copilot-suggestions for end-to-end workflow - Updated existing skills to reference comprehensive workflow - Added helper scripts in contrib/dev-tools/github-api-scripts/ * get-pr-review-threads.sh: fetch PR review threads * list-unresolved-threads.sh: filter unresolved threads * resolve-all-unresolved-threads.sh: batch resolve threads - Created template and workflow documentation in docs/pr-reviews/ - Example: completed PR torrust#1733 copilot suggestions audit - Includes reusable process for future PR reviews

josecelano · 2026-05-06T14:22:49Z

ACK 7a587dd

josecelano added 5 commits May 5, 2026 18:18

docs(issues): add issue spec for replacing aquatic_udp_protocol (torr…

d4e3fda

…ust#1732)

docs(issues): document step 2 analysis — no unused code in internal f…

56fd418

…orks (torrust#1732)

josecelano temporarily deployed to coverage May 5, 2026 18:47 — with GitHub Actions Inactive

josecelano self-assigned this May 5, 2026

josecelano requested review from Copilot and da2ce7 May 5, 2026 18:48

Copilot started reviewing on behalf of josecelano May 5, 2026 18:50 View session

Copilot AI reviewed May 5, 2026

View reviewed changes

josecelano added 2 commits May 5, 2026 21:36

feat(deps): apply zerocopy 0.8 migration to internal forks (step 3 of t…

757ba54

…orrust#1732)

josecelano temporarily deployed to coverage May 5, 2026 20:40 — with GitHub Actions Inactive

josecelano added 3 commits May 6, 2026 09:22

docs(issue-1732): refine step 4 plan to break protocol-primitives cycle

4c04c51

refactor(udp-protocol): migrate consumers to workspace udp protocol c…

d5f42a6

…rate

refactor(primitives): define peer domain types natively

43739a4

josecelano temporarily deployed to coverage May 6, 2026 09:05 — with GitHub Actions Inactive

josecelano added 3 commits May 6, 2026 10:06

refactor(udp-tracker-core): move peer builder out of udp protocol

18e4757

refactor(udp-protocol): absorb interim aquatic fork sources

978327c

chore(deps): remove unused dependencies and fix doctest types

4c04033

josecelano temporarily deployed to coverage May 6, 2026 09:29 — with GitHub Actions Inactive

josecelano added 3 commits May 6, 2026 10:32

docs(issue-1732): update step 4 progress and validation status

94f3307

refactor(bittorrent-primitives): make InfoHash self-contained

88fc017

chore(deps): remove unused hex-literal from console/tracker-client

c170e4d

josecelano temporarily deployed to coverage May 6, 2026 10:26 — with GitHub Actions Inactive

josecelano added 3 commits May 6, 2026 11:45

chore(deps): use published bittorrent-primitives 0.2.0

9a05943

docs(issue-1732): refine step 5 implementation strategy

f5567bf

refactor(udp-protocol): move connect types to connect module

0071129

josecelano added 17 commits May 6, 2026 12:25

docs(udp-protocol): document shared common wire type mirrors

38298c1

docs(udp-protocol): finalize ErrorResponse ownership decision

328671b

docs(issue-1732): update step 5 progress tracking

3bd5c63

docs(issue-1732): document final udp-protocol module layout

3fe50c1

docs(issue-1732): add primitives refactor plan

5b6423b

refactor(primitives): add announce and scrape modules

d9f63ae

refactor(primitives): move AnnounceData to announce module

4e20c20

refactor(primitives): move AnnounceEvent to announce module

cd714a9

refactor(primitives): move ScrapeData to scrape module

6c64e0a

docs(issue-1732): document final primitives module layout

64cf147

refactor(primitives): remove compatibility wrapper modules

95b6ce0

docs(issue-1732): add peer-id extraction plan

91c6478

refactor(peer-id): create in-house crate and migrate udp-protocol

0b6ba10

refactor(primitives): integrate extracted peer-id crate

511932c

chore(workspace): rely on auto-discovered peer-id member

49b5c9f

refactor(peer-id): split crate into focused internal modules

3068b9e

docs(issue-1732): document final peer-id ownership

c37276d

josecelano marked this pull request as ready for review May 6, 2026 13:01

docs(packages): clarify aquatic provenance and acknowledgments

7265f0d

josecelano temporarily deployed to coverage May 6, 2026 13:03 — with GitHub Actions Inactive

josecelano requested a review from Copilot May 6, 2026 13:03

Copilot started reviewing on behalf of josecelano May 6, 2026 13:06 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

chore(review): address remaining PR torrust#1733 suggestions

fdcb817

josecelano temporarily deployed to coverage May 6, 2026 13:58 — with GitHub Actions Inactive

josecelano requested a review from a team as a code owner May 6, 2026 14:21

josecelano temporarily deployed to coverage May 6, 2026 14:22 — with GitHub Actions Inactive

josecelano merged commit 2007330 into torrust:develop May 6, 2026
25 of 26 checks passed

Uh oh!

Conversation

josecelano commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why this change

What was delivered

Architecture outcome

Validation

Attribution and licensing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josecelano commented May 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

josecelano commented May 5, 2026 •

edited

Loading

codecov Bot commented May 5, 2026 •

edited

Loading