Skip to content

chore: phase 4 audit fixes and documentation updates - #35

Merged
kacy merged 1 commit into
mainfrom
chore/phase4-audit-fixes
Feb 6, 2026
Merged

chore: phase 4 audit fixes and documentation updates#35
kacy merged 1 commit into
mainfrom
chore/phase4-audit-fixes

Conversation

@kacy

@kacy kacy commented Feb 6, 2026

Copy link
Copy Markdown
Owner

Summary

post-phase-4 code audit with fixes and documentation updates:

code fixes:

  • gossip event channel sends now log warnings when they fail (previously silently ignored with let _)
  • removed semantically incorrect SlotRange::is_empty() method (always returned false)
  • added #[allow(clippy::len_without_is_empty)] with proper invariant documentation

documentation updates:

  • updated README.md to reflect phase 4 completion (574 tests, ~18k LOC)
  • rewrote ember-cluster README with full feature list, command table, usage examples
  • added invariant documentation to SlotRange

Tested

  • cargo test --workspace - 574 tests pass
  • cargo clippy --workspace - no warnings
  • cargo fmt --all - formatted

Design considerations

what was intentionally deferred:

  • raft log persistence (in-memory for now, noted in docs)
  • server integration (modules complete, wiring deferred to phase 5)
  • replication.rs (primary-replica sync)
  • BLPOP/BRPOP (blocking ops require async coordination)

audit findings addressed:

  • silent channel errors in gossip → now logged
  • SlotRange semantic issue → removed is_empty(), documented invariant
  • outdated READMEs → updated with current status

fixes:
- log warnings when gossip event channel sends fail (was silently ignored)
- remove semantically incorrect SlotRange::is_empty() method
- add clippy allow for len_without_is_empty with proper documentation

documentation:
- update README.md: phase 4 complete, 574 tests, ~18k LOC
- rewrite ember-cluster README with full feature list and usage
- add invariant documentation to SlotRange
@kacy
kacy merged commit af43f4b into main Feb 6, 2026
5 checks passed
@kacy
kacy deleted the chore/phase4-audit-fixes branch February 7, 2026 20:06
kacy added a commit that referenced this pull request Feb 11, 2026
chore: phase 4 audit fixes and documentation updates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant