Committed before review so Windows and WSL builds can start. Each fix was tested and mutation-checked here; the codex review of each item is still to come, so tasks/BUGS.md stays unticked. M-02 is mid-review: round 1 findings are fixed (apps/ely-mark/src/tally.rs). K-01 stays deferred. The ElyMark window test mark-outside.sh failed once at its crash-recovery step in the last run; not yet looked into.
115 lines
3.0 KiB
Rust
115 lines
3.0 KiB
Rust
//! Which page reports count, by page load and by version.
|
|
|
|
use std::collections::HashMap;
|
|
|
|
/// One page load's change counts and the renders it owes.
|
|
pub struct Tally<R> {
|
|
load: u64,
|
|
/// The newest change the page announced.
|
|
changed: u64,
|
|
/// The change whose text arrived.
|
|
reported: u64,
|
|
renders: HashMap<u64, R>,
|
|
asked: u64,
|
|
}
|
|
|
|
impl<R> Tally<R> {
|
|
pub fn new() -> Self {
|
|
Tally { load: 0, changed: 0, reported: 0, renders: HashMap::new(), asked: 0 }
|
|
}
|
|
|
|
pub fn load(&self) -> u64 {
|
|
self.load
|
|
}
|
|
|
|
pub fn changed(&self) -> u64 {
|
|
self.changed
|
|
}
|
|
|
|
/// Every change's text has arrived.
|
|
pub fn settled(&self) -> bool {
|
|
self.reported == self.changed
|
|
}
|
|
|
|
/// A reload or refresh: older reports lapse, owed renders end.
|
|
pub fn restart(&mut self) -> Vec<R> {
|
|
self.load += 1;
|
|
(self.changed, self.reported) = (0, 0);
|
|
self.lapse()
|
|
}
|
|
|
|
/// The renders owed, as the page fails or restarts.
|
|
pub fn lapse(&mut self) -> Vec<R> {
|
|
self.renders.drain().map(|(_, render)| render).collect()
|
|
}
|
|
|
|
/// Whether a report from page load `generation` still counts.
|
|
pub fn current(&self, generation: Option<u64>) -> bool {
|
|
generation.is_none_or(|load| load == self.load)
|
|
}
|
|
|
|
pub fn change(&mut self, version: u64) {
|
|
self.changed = self.changed.max(version);
|
|
}
|
|
|
|
/// Takes text `version` if it is the newest.
|
|
pub fn text(&mut self, version: u64) -> bool {
|
|
let newest = version >= self.reported;
|
|
if newest {
|
|
self.reported = version;
|
|
}
|
|
newest
|
|
}
|
|
|
|
/// Owes `render`; its number goes to the page.
|
|
pub fn ask(&mut self, render: R) -> u64 {
|
|
self.asked += 1;
|
|
self.renders.insert(self.asked, render);
|
|
self.asked
|
|
}
|
|
|
|
pub fn answered(&mut self, ask: u64) -> Option<R> {
|
|
self.renders.remove(&ask)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::Tally;
|
|
|
|
#[test]
|
|
fn a_key_from_before_a_refresh_leaves_it_settled() {
|
|
let mut tally = Tally::<()>::new();
|
|
let old = tally.load();
|
|
tally.restart();
|
|
// The renderer's change for the old text lands late.
|
|
if tally.current(Some(old)) {
|
|
tally.change(1);
|
|
}
|
|
assert!(tally.settled(), "an old change does not count");
|
|
// The refreshed page's own edits count again.
|
|
tally.change(1);
|
|
assert!(!tally.settled());
|
|
assert!(tally.text(1));
|
|
assert!(tally.settled());
|
|
}
|
|
|
|
#[test]
|
|
fn a_restart_ends_every_owed_render() {
|
|
let mut tally = Tally::new();
|
|
let ask = tally.ask("export");
|
|
assert_eq!(tally.restart(), vec!["export"]);
|
|
// Its late answer finds nobody waiting.
|
|
assert_eq!(tally.answered(ask), None);
|
|
}
|
|
|
|
#[test]
|
|
fn only_the_newest_text_counts() {
|
|
let mut tally = Tally::<()>::new();
|
|
tally.change(2);
|
|
assert!(tally.text(2));
|
|
assert!(!tally.text(1), "an older text is dropped");
|
|
assert!(tally.settled());
|
|
}
|
|
}
|