feat: resolve issues #27, #29, #30, #31, #33, #34 - #35
Open
IFindMe wants to merge 1 commit into
Open
Conversation
…vx#33, stanvx#34 - stanvx#27: reconcile docs to code; add authoritative "## Module ownership" section to CONTEXT.md and align CLAUDE/ARCHITECTURE/PROTOCOL/ROADMAP/ README/BUILDING/PERFORMANCE with the codebase; add ADR-0006 "what-not-to-borrow". - stanvx#29: delete the unwired poll-based hotplug module and its tests; defer device hot-plug detection to v1.1 per ADR-0005. - stanvx#30: collapse the discovery TXT wire format into a single usbip_core::discovery_txt seam (encode+decode) used by both the server (advertise) and client (browse). - stanvx#31: delete the four never-wired Prometheus statics, keeping the live /metrics router and ENCRYPTION_ENABLED gauge. - stanvx#33: add per-thread high-water-mark latency sampling in the URB receive loop (private HighWaterMark, broadcast only on new global peak) plus a CAS-reduction criterion bench; no public API change, LatencySample shape unchanged. - stanvx#34: audit decrypt call sites confirming in-place AEAD is the production decrypt path; add an in-place-vs-allocating criterion bench. Verified via Docker (rust:1.98): cargo test/clippy/fmt all green; bench binaries build. Windows crate excluded on Linux (unchanged). Signed-off-by: opencode <opencode@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR: resolve issues #27, #29, #30, #31, #33, #34
Branch:
issues/27-29-30-31-33-34(offmain, commit9d21d37)Base:
mainSummary
One coordinated batch that reconciles docs to code and closes six open issues.
All Rust changes were verified in a
rust:1.98container (Linux CI scope:--workspace --exclude anyplug, matching upstream CI).Issues closed
section to
CONTEXT.mdnaming one owner per concern; alignedCLAUDE.md/ARCHITECTURE.md/PROTOCOL.md/ROADMAP.md/README.md/docs/BUILDING.md/docs/PERFORMANCE.mdwith the code; addeddocs/adr/0006-what-not-to-borrow.md.hotplug module and its tests were removed; USB hot-plug detection is deferred
to v1.1, blueprint preserved in
ADR-0005.deviceTXT wireformat into
usbip_core::discovery_txt(encode + decode +DiscoveredDevice).Server advertises and delegates encode; client now decodes discovery responses.
Prometheus statics; kept the live
/metricsrouter andENCRYPTION_ENABLED.high-water-mark latency sampling (
latency_hwm.rs) in the URB receive loop,broadcasting a
LatencySampleonly on a new global peak (cuts cross-threadCAS/broadcast on ~99% of packets), plus a criterion bench. No public API
change;
LatencySampleshape unchanged.decrypt_in_placeis the production decrypt path (crypto_stream.rs:146);added audit comments and an in-place-vs-allocating criterion bench.
What changed
shared/usbip-core/src/discovery_txt.rs,server/usbip-server/src/latency_hwm.rs,shared/usbip-core/benches/aead_inplace_bench.rs,server/usbip-server/benches/urb_high_water_mark.rs,docs/adr/0006-what-not-to-borrow.md.server/usbip-server/src/hotplug.rs,server/usbip-server/tests/hotplug_integration.rs.metrics.rs; server &client wired to the discovery TXT seam; URB loop threaded latency HWM.
Verification (all GREEN, Linux CI scope)
cargo test --release --workspace --exclude anyplug→ passcargo clippy --workspace --exclude anyplug -- -D warnings→ cleancargo fmt --all -- --check→ cleancargo bench --no-run --workspace --exclude anyplug→ builds (new benches)Notes
windowscrate is not built on Linux (CI-excluded); itsMdnsBrowserpublic surface used by
windows/src/actions.rsis unchanged (new decodehelpers are purely additive).
AgentsReport/reviewer/2026-09-04_batch-review.md.