Skip to content

README: say WHY redaction is TS+Rust, so it stops reading as a parity gap #116

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.

Sign up for GitHub

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
brentrager merged 1 commit into from
Aug 20, 2026
Merged

README: say WHY redaction is TS+Rust, so it stops reading as a parity gap #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,18 @@ Every port carries the shared core: **retries with backoff + jitter, `Retry-Afte

Where a port leans on a battle-tested ecosystem library (mollitia, Polly), it says so above; the others implement retry/breaker/rate-limit logic natively, with each port's own test suite covering the shared behaviors.

### Credential redaction is scoped to what each port actually logs

| Language | What it logs about a request | Redaction |
| ---------- | ------------------------------------------------------------------------------------------- | ------------------------------------------- |
| TypeScript | method, host, path, query string, **headers**, **request body**, and the URL in the message | full — headers, query, URL and body |
| Rust | method and URL, on one `tracing::debug!` event | URL only (userinfo password + query params) |
| Python | nothing | n/a — no logging sink |
| Go | nothing | n/a — no logging sink |
| .NET | nothing (an `ILogger<SmooFetch>` is held for DI but never called) | n/a — no logging sink |

**This is not a parity gap.** Redaction exists in exactly the two ports that have something to redact. Adding a scrubber to Python, Go or .NET would be code no call site reaches — which reads as a guarantee while guaranteeing nothing. The shared cases in [`spec/redaction-corpus.json`](spec/redaction-corpus.json) are loaded by the TypeScript and Rust suites, and that file states the rule for anyone extending it: **if a logging sink is ever added to another port, wire it to this corpus in the same PR.**

---

## 📖 Smart defaults
Expand Down
Loading