prisma-risk / tsoracle / 26373774737

95%

Build Type

push

github

Committed by web-flow

Commit Message

docs(consensus): make leadership_events first-item contract normative (#254) (#321)

The contract that `leadership_events` must synchronously emit the current
`LeaderState` as its first item lived only in the integration-guide prose;
the trait signature returned a bare `Stream<Item = LeaderState>`. A driver
that emits the initial state lazily stalls the server's leader-watch task,
which blocks on the first item to seed its state — a node already leading at
subscription time would never seed Serving.

Lift the requirement onto the `ConsensusDriver::leadership_events` rustdoc as
the normative source, and reword the prose guide to point at it. The `Dummy`
test impl used `stream::empty()`, modelling the violation; it now emits one
`Unknown` event so it honours the contract. The dispatch test, which asserted
an empty stream, now asserts the first item is `Unknown` with no transitions
after.

Coverage Stats

4 of 5 new or added lines in 1 file covered. (80.0%)

1 existing line in 1 file now uncovered.

11300 of 11906 relevant lines covered (94.91%)

464908.32 hits per line