-
Notifications
You must be signed in to change notification settings - Fork 55
feat(tracker-client): add UDP response format option and testing skill links #1756
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
josecelano
merged 3 commits into
torrust:develop
from
josecelano:1563-udp-tracker-client-format-option
May 11, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
113 changes: 113 additions & 0 deletions
113
.github/skills/dev/testing/public-trackers-for-testing/SKILL.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| --- | ||
| name: public-trackers-for-testing | ||
| description: Public tracker targets for manual testing and debugging of tracker clients. Use when validating announce/scrape behavior against live services, comparing local vs public behavior, or diagnosing network timeouts. Triggers on "public tracker", "test against demo tracker", "debug tracker timeout", or "which tracker should I use". | ||
| metadata: | ||
| author: torrust | ||
| version: "1.0" | ||
| --- | ||
|
|
||
| # Public Trackers for Testing | ||
|
|
||
| ## Skill Links | ||
|
|
||
| This skill depends on these artifacts. If any of them change, review this skill. | ||
|
|
||
| - `console/tracker-client/src/console/clients/udp/app.rs` | ||
| - `console/tracker-client/src/console/clients/http/app.rs` | ||
| - `.github/skills/dev/environment-setup/run-tracker-locally/SKILL.md` | ||
|
|
||
| Use the marker `skill-link: public-trackers-for-testing` in affected artifacts. | ||
|
|
||
| ## Purpose | ||
|
|
||
| Use this skill to choose reliable public tracker endpoints for manual verification and debugging. | ||
|
|
||
| It provides: | ||
|
|
||
| - preferred endpoint order | ||
| - copy-paste test commands | ||
| - timeout triage and fallback workflow | ||
|
|
||
| ## Preferred Target Order | ||
|
|
||
| When testing against public services, use this order: | ||
|
|
||
| 1. Tracker demo (newer, usually lower load) | ||
| 2. Index+Tracker demo (older, can be busy) | ||
| 3. Local tracker fallback for deterministic checks | ||
|
|
||
| ## Public Endpoints | ||
|
|
||
| ### Tracker Demo (preferred) | ||
|
|
||
| Repository: <https://github.com/torrust/torrust-tracker-demo> | ||
|
|
||
| - HTTP: `https://http1.torrust-tracker-demo.com:443/announce` | ||
| - HTTP: `https://http1.torrust-tracker-demo.com:443` | ||
| - UDP: `udp://udp1.torrust-tracker-demo.com:6969/announce` | ||
|
|
||
| ### Index+Tracker Demo (secondary) | ||
|
|
||
| Repository: <https://github.com/torrust/torrust-demo> | ||
|
|
||
| - HTTP: `https://tracker.torrust-demo.com/announce` | ||
| - HTTP: `https://tracker.torrust-demo.com` | ||
| - UDP: `udp://tracker.torrust-demo.com:6969/announce` | ||
|
|
||
| ## Quick Commands | ||
|
|
||
| Use a test info hash: | ||
|
|
||
| ```bash | ||
| INFO_HASH=000620bbc6c52d5a96d98f6c0f1dfa523a40df82 | ||
| ``` | ||
|
|
||
| ### UDP scrape (preferred public demo) | ||
|
|
||
| ```bash | ||
| cargo run -q -p torrust-tracker-client --bin udp_tracker_client scrape \ | ||
| udp://udp1.torrust-tracker-demo.com:6969/scrape \ | ||
| "$INFO_HASH" \ | ||
| --format pretty | ||
| ``` | ||
|
|
||
| ### UDP announce (preferred public demo) | ||
|
|
||
| ```bash | ||
| cargo run -q -p torrust-tracker-client --bin udp_tracker_client announce \ | ||
| udp://udp1.torrust-tracker-demo.com:6969/announce \ | ||
| "$INFO_HASH" \ | ||
| --format compact | ||
| ``` | ||
|
|
||
| ### HTTP announce (preferred public demo) | ||
|
|
||
| ```bash | ||
| cargo run -q -p torrust-tracker-client --bin http_tracker_client announce \ | ||
| https://http1.torrust-tracker-demo.com:443 \ | ||
| "$INFO_HASH" | ||
| ``` | ||
|
|
||
| ## Timeout Triage | ||
|
|
||
| If a public target times out: | ||
|
|
||
| 1. Retry once against the same target. | ||
| 2. Retry against the other public demo. | ||
| 3. If both fail, run locally and verify behavior deterministically. | ||
|
|
||
| Do not assume client regression from a single public timeout. | ||
|
|
||
| ## Local Fallback | ||
|
|
||
| Use this workflow when public trackers are unavailable or overloaded: | ||
|
|
||
| - `.github/skills/dev/environment-setup/run-tracker-locally/SKILL.md` | ||
|
|
||
| Then re-run the same client command against `127.0.0.1`. | ||
|
|
||
| ## Notes | ||
|
|
||
| - Public demo load varies over time. | ||
| - Trackers may contain existing swarm state, so results can differ from clean local runs. | ||
| - Prefer local checks for acceptance criteria that require deterministic values. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| //! HTTP Tracker client: | ||
| //! skill-link: public-trackers-for-testing | ||
| //! | ||
| //! Examples: | ||
| //! | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.