Skip to content

development.md

Latest commit

 

History

History
102 lines (71 loc) · 2.87 KB

development.md

File metadata and controls

102 lines (71 loc) · 2.87 KB
Raw

Development

Common commands

Build:

nix develop -c cargo build

Format, lint, and test:

nix develop -c cargo fmt --check
nix develop -c cargo clippy --all-features -- -D warnings
nix develop -c cargo nextest run

Use cargo test when you need doctests, exact filtering, or -- --nocapture debugging output.

Dependency and advisory triage:

nix develop -c scripts/audit-advisories

See security-advisories.md for ignore policy and revisit expectations.

Pre-commit hook

The pre-commit hook runs cargo fmt --check and cargo clippy --all-features -- -D warnings. Install it with:

./scripts/install-git-hooks.sh

If Nix is available, the hook re-enters the dev shell automatically for consistent tooling.

Nix

If you use the flake/dev shell:

nix develop

Build the packaged binary with Nix:

nix build .#default

Response Handling Work

Use RFC 3977 and RFC 4643 when protocol behavior is unclear. In this codebase, response shape is request-scoped: check RequestContext::has_response_body() instead of inferring multiline behavior from a status code alone.

Keep multiline response boundary logic in src/session/multiline_framing.rs. Benchmarks and tests should import production framing and request-classification code instead of reimplementing terminator scanners or local command parsers.

AI-facing repository rules are intentionally short. See AGENTS.md and .github/copilot-instructions.md.

Current response responsibilities:

  • src/protocol/request.rs owns RequestContext, route classes, response-body expectations, and request-scoped response/cache metadata.
  • src/protocol/response.rs owns three-digit status parsing.
  • src/protocol/responses.rs owns local single-line response constants and small formatting helpers.
  • src/session/multiline_framing.rs owns all response-boundary detection, packed-next-response preservation, ordered response emission, capture, observe, and write operations.
  • src/session/backend.rs is the facade over backend execution and framer-owned operations.
  • src/session/response_transfer.rs maps transfer outcomes to backend connection reuse decisions.
  • src/cache/article.rs and src/cache/hybrid_codec.rs store semantic article payload sections and render cache-hit responses back to NNTP wire bytes.

Benchmarks

Published benchmark numbers were intentionally removed from the docs until they are rerun.

When you want fresh numbers:

  • microbenchmarks live under benches/
  • end-to-end cache-miss benchmarking uses scripts/bench-release-cache-miss-e2e.sh
  • profiling helpers include scripts/parse_perfdata and scripts/parse_flamegraph

Do not treat old README benchmark values as current project guarantees.

Manual smoke test

telnet localhost 8119
HELP
QUIT