1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
|
//! A store held in memory (`docs/store.md`): a checkpoint, the events it keeps, and the
//! events taken after it, each judged at its history.
use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
use super::{Fold, Id, Refused};
/// Why a store doesn't take an event.
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum Refusal {
/// Its bytes are none of the fold's events.
None,
/// The fold refuses it at its history.
Judged(Refused),
/// It builds on an event the store refuses.
BuiltOn(Id),
/// It isn't above the checkpoint's heads: it builds on what came before them, or on
/// nothing.
NotAbove,
/// Its history takes it, but the node doesn't, by what it took before.
Own,
/// Its operator had the node drop it.
Dropped,
}
/// What became of an event offered to a store.
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum Offered {
/// Taken, with the events that waited on it, in the order taken.
Taken(Vec<Id>),
/// Held already: taken, kept by the checkpoint, or one of its heads.
Held,
/// Waiting for dependencies the store doesn't hold.
Waiting,
/// Refused, and why; what waited on it is refused with it.
Refused(Refusal),
}
struct Event {
bytes: Vec<u8>,
dependencies: Vec<Id>,
}
/// A store and what it holds, of a fold `F`.
pub(crate) struct Store<F: Fold> {
/// The store's ID: its root's.
id: Id,
/// The checkpoint it holds, as bytes.
checkpoint: Vec<u8>,
/// The heads every event after the checkpoint builds on: the checkpoint's, or, for a
/// root, the root's own ID.
heads: BTreeSet<Id>,
/// The events the checkpoint keeps.
kept: BTreeMap<Id, Vec<u8>>,
/// What the checkpoint and the events it keeps read as.
start: F::State,
/// The events taken after the checkpoint.
events: HashMap<Id, Event>,
/// Those events in the order taken: each after its dependencies.
order: Vec<Id>,
/// What everything held reads as.
state: F::State,
/// Events waiting for dependencies, and, by dependency, the events waiting for it.
waiting: HashMap<Id, Event>,
waits_for: HashMap<Id, BTreeSet<Id>>,
/// The events refused, and why.
refused: HashMap<Id, Refusal>,
}
impl<F: Fold> Store<F> {
/// A store starting from its root, with the events the root keeps.
pub(crate) fn new(root: Vec<u8>, kept: Vec<Vec<u8>>) -> Result<Self, Refused> {
let id = Id::of(&root);
let (_, keeps) = F::parts(&root).ok_or_else(|| Refused::new("no checkpoint"))?;
let kept = matched(&keeps, kept)?;
let start = F::start(&root, &kept.clone().into_iter().collect::<Vec<_>>())?;
Ok(Self {
id,
checkpoint: root,
heads: BTreeSet::from([id]),
kept,
state: start.clone(),
start,
events: HashMap::new(),
order: Vec::new(),
waiting: HashMap::new(),
waits_for: HashMap::new(),
refused: HashMap::new(),
})
}
/// The store's ID: its root's.
pub(crate) fn id(&self) -> Id {
self.id
}
/// The checkpoint the store holds, as bytes.
pub(crate) fn checkpoint(&self) -> &[u8] {
&self.checkpoint
}
/// What everything the store holds reads as.
pub(crate) fn state(&self) -> &F::State {
&self.state
}
/// The events taken after the checkpoint, in the order taken.
pub(crate) fn taken(&self) -> &[Id] {
&self.order
}
/// The bytes of an event the store holds: taken, or kept by its checkpoint.
pub(crate) fn get(&self, id: &Id) -> Option<&[u8]> {
self.events
.get(id)
.map(|event| event.bytes.as_slice())
.or_else(|| self.kept.get(id).map(Vec::as_slice))
}
/// Why the store refused an event, where it did.
pub(crate) fn refusal(&self, id: &Id) -> Option<&Refusal> {
self.refused.get(id)
}
/// Whether an event waits for dependencies the store doesn't hold.
pub(crate) fn is_waiting(&self, id: &Id) -> bool {
self.waiting.contains_key(id)
}
/// What a new event builds on: the events nothing else held builds on, or the
/// checkpoint's heads where nothing came after it.
pub(crate) fn heads(&self) -> Vec<Id> {
let built_on: HashSet<&Id> = self
.events
.values()
.flat_map(|event| &event.dependencies)
.collect();
let heads: Vec<Id> = self
.order
.iter()
.filter(|id| !built_on.contains(id))
.copied()
.collect();
if heads.is_empty() {
self.heads.iter().copied().collect()
} else {
heads
}
}
/// Offers an event: it is taken once the store holds its dependencies, where the fold
/// takes it at its history.
pub(crate) fn offer(&mut self, bytes: Vec<u8>) -> Offered {
let id = Id::of(&bytes);
if self.events.contains_key(&id) || self.kept.contains_key(&id) || self.heads.contains(&id)
{
return Offered::Held;
}
if let Some(refusal) = self.refused.get(&id) {
return Offered::Refused(refusal.clone());
}
if self.waiting.contains_key(&id) {
return Offered::Waiting;
}
let Some(dependencies) = F::dependencies(&bytes) else {
return self.refuse(id, Refusal::None);
};
self.consider(
id,
Event {
bytes,
dependencies,
},
)
}
/// What the events of a history read as: those of `ids`, and all they build on.
pub(crate) fn state_at(&self, ids: &[Id]) -> F::State {
let history = self.history(ids);
let mut state = self.start.clone();
for id in self.order.iter().filter(|id| history.contains(id)) {
F::add(&mut state, id, &self.events[id].bytes);
}
state
}
/// The events taken after the checkpoint among `ids` and all they build on.
fn history(&self, ids: &[Id]) -> HashSet<Id> {
let mut history = HashSet::new();
let mut todo: Vec<Id> = ids.to_vec();
while let Some(id) = todo.pop() {
if let Some(event) = self.events.get(&id)
&& history.insert(id)
{
todo.extend(&event.dependencies);
}
}
history
}
fn consider(&mut self, id: Id, event: Event) -> Offered {
let mut taken = Vec::new();
let mut todo = vec![(id, event)];
let mut first = None;
while let Some((id, event)) = todo.pop() {
let offered = self.judged(id, event, &mut taken);
if matches!(offered, Offered::Taken(_)) {
todo.extend(self.woken(&id));
}
first.get_or_insert(offered);
}
match first.expect("one event considered") {
Offered::Taken(_) => Offered::Taken(taken),
other => other,
}
}
/// The events that waited for `id` alone, now to be considered again.
fn woken(&mut self, id: &Id) -> Vec<(Id, Event)> {
let Some(waiters) = self.waits_for.remove(id) else {
return Vec::new();
};
let mut woken = Vec::new();
for waiter in waiters {
let still = self
.waits_for
.values()
.any(|waiting| waiting.contains(&waiter));
if !still && let Some(event) = self.waiting.remove(&waiter) {
woken.push((waiter, event));
}
}
woken
}
fn judged(&mut self, id: Id, event: Event, taken: &mut Vec<Id>) -> Offered {
if let Some(refused) = event
.dependencies
.iter()
.find(|dependency| self.refused.contains_key(dependency))
{
let refused = *refused;
return self.refuse(id, Refusal::BuiltOn(refused));
}
let before = |dependency: &Id| {
self.kept.contains_key(dependency) && !self.heads.contains(dependency)
};
if event.dependencies.iter().any(before) {
return self.refuse(id, Refusal::NotAbove);
}
let missing: Vec<Id> = event
.dependencies
.iter()
.filter(|dependency| {
!self.events.contains_key(dependency) && !self.heads.contains(dependency)
})
.copied()
.collect();
if !missing.is_empty() {
for dependency in missing {
self.waits_for.entry(dependency).or_default().insert(id);
}
self.waiting.insert(id, event);
return Offered::Waiting;
}
let above = event
.dependencies
.iter()
.any(|dependency| self.events.contains_key(dependency))
|| self
.heads
.iter()
.all(|head| event.dependencies.contains(head));
if !above {
return self.refuse(id, Refusal::NotAbove);
}
let at = self.state_at(&event.dependencies);
if let Err(why) = F::judge(&at, &id, &event.bytes) {
return self.refuse(id, Refusal::Judged(why));
}
if !F::keeps(&self.state, &id, &event.bytes) {
return self.refuse(id, Refusal::Own);
}
F::add(&mut self.state, &id, &event.bytes);
self.events.insert(id, event);
self.order.push(id);
taken.push(id);
Offered::Taken(vec![id])
}
/// The events refused, and why: for reports.
pub(crate) fn refused(&self) -> impl Iterator<Item = (&Id, &Refusal)> {
self.refused.iter()
}
/// Drops events taken after the checkpoint, with everything built on them, as their
/// operator has the node do: it refuses them from then on, until its operator allows
/// them again. What the checkpoint keeps, or holds by ID, it drops not: every event
/// after it builds on that. Returns what it dropped, in the order taken.
pub(crate) fn drop_taken(&mut self, ids: &[Id]) -> Result<Vec<Id>, Refused> {
if let Some(id) = ids.iter().find(|id| !self.events.contains_key(id)) {
return Err(Refused::new(format!(
"{id} isn't an event taken after the checkpoint"
)));
}
let mut dropped: HashMap<Id, Refusal> =
ids.iter().map(|id| (*id, Refusal::Dropped)).collect();
for id in &self.order {
if dropped.contains_key(id) {
continue;
}
if let Some(on) = self.events[id]
.dependencies
.iter()
.find(|dependency| dropped.contains_key(dependency))
{
let on = *on;
dropped.insert(*id, Refusal::BuiltOn(on));
}
}
let order: Vec<Id> = self
.order
.iter()
.filter(|id| dropped.contains_key(id))
.copied()
.collect();
self.order.retain(|id| !dropped.contains_key(id));
for id in &order {
self.events.remove(id);
}
self.refused.extend(dropped);
let mut state = self.start.clone();
for id in &self.order {
F::add(&mut state, id, &self.events[id].bytes);
}
self.state = state;
Ok(order)
}
/// Takes back what the node refused of its own, or dropped, as its operator says
/// otherwise: `ids`, and what was refused for being built on them. They are taken when
/// offered again, where the store takes them then.
pub(crate) fn allow(&mut self, ids: &[Id]) {
let mut todo: Vec<Id> = ids
.iter()
.filter(|id| matches!(self.refused.get(id), Some(Refusal::Own | Refusal::Dropped)))
.copied()
.collect();
while let Some(id) = todo.pop() {
self.refused.remove(&id);
todo.extend(
self.refused
.iter()
.filter(|(_, why)| **why == Refusal::BuiltOn(id))
.map(|(waiter, _)| *waiter),
);
}
}
/// Refuses an event, and what waits for it.
fn refuse(&mut self, id: Id, why: Refusal) -> Offered {
self.refused.insert(id, why.clone());
let mut todo = vec![id];
while let Some(refused) = todo.pop() {
for waiter in self.waits_for.remove(&refused).unwrap_or_default() {
if let Some(event) = self.waiting.remove(&waiter) {
for dependency in &event.dependencies {
if let Some(waiting) = self.waits_for.get_mut(dependency) {
waiting.remove(&waiter);
}
}
self.refused.insert(waiter, Refusal::BuiltOn(refused));
todo.push(waiter);
}
}
}
Offered::Refused(why)
}
}
/// The events a checkpoint keeps, by ID: each of `keeps` given once, and nothing else.
fn matched(keeps: &[Id], kept: Vec<Vec<u8>>) -> Result<BTreeMap<Id, Vec<u8>>, Refused> {
let kept: BTreeMap<Id, Vec<u8>> = kept
.into_iter()
.map(|bytes| (Id::of(&bytes), bytes))
.collect();
let wanted: BTreeSet<&Id> = keeps.iter().collect();
if kept.keys().collect::<BTreeSet<_>>() != wanted {
return Err(Refused::new(
"the events given aren't those the checkpoint keeps",
));
}
Ok(kept)
}
#[cfg(test)]
mod tests {
use super::super::testfold::{self, TestFold};
use super::*;
fn store() -> Store<TestFold> {
Store::new(testfold::root("tests"), Vec::new()).expect("a root")
}
fn taken(offered: Offered) -> Id {
match offered {
Offered::Taken(ids) => ids[0],
other => panic!("not taken: {other:?}"),
}
}
#[test]
fn an_event_on_the_root_is_taken() {
let mut store = store();
let root = store.id();
let a = taken(store.offer(testfold::put(&[root], "a", "1")));
assert_eq!(store.heads(), vec![a]);
assert_eq!(store.state().counts()["a"], "1");
assert_eq!(store.offer(testfold::put(&[root], "a", "1")), Offered::Held);
}
#[test]
fn what_is_none_or_on_nothing_is_refused() {
let mut store = store();
assert_eq!(
store.offer(b"not an event".to_vec()),
Offered::Refused(Refusal::None)
);
assert_eq!(
store.offer(testfold::put(&[], "a", "1")),
Offered::Refused(Refusal::NotAbove)
);
let root = store.id();
assert!(matches!(
store.offer(testfold::junk(&[root])),
Offered::Refused(Refusal::Judged(_))
));
}
#[test]
fn an_event_waits_for_what_it_builds_on() {
let mut store = store();
let root = store.id();
let first = testfold::put(&[root], "a", "1");
let a = Id::of(&first);
let second = testfold::put(&[a], "a", "2");
let b = Id::of(&second);
assert_eq!(store.offer(second), Offered::Waiting);
assert!(store.is_waiting(&b));
assert_eq!(store.offer(first), Offered::Taken(vec![a, b]));
assert_eq!(store.taken(), &[a, b]);
assert_eq!(store.state().counts()["a"], "2");
}
#[test]
fn what_builds_on_a_refused_event_is_refused() {
let mut store = store();
let root = store.id();
let bad = testfold::junk(&[root]);
let junk = Id::of(&bad);
let waiting = testfold::put(&[junk], "a", "1");
let waiter = Id::of(&waiting);
assert_eq!(store.offer(waiting), Offered::Waiting);
assert!(matches!(store.offer(bad), Offered::Refused(_)));
assert_eq!(store.refusal(&waiter), Some(&Refusal::BuiltOn(junk)));
assert_eq!(
store.offer(testfold::put(&[junk], "b", "1")),
Offered::Refused(Refusal::BuiltOn(junk))
);
}
#[test]
fn an_event_is_judged_at_its_history() {
let mut store = store();
let root = store.id();
let locked = taken(store.offer(testfold::lock(&[root], "a")));
// Built on the lock: refused there.
assert!(matches!(
store.offer(testfold::put(&[locked], "a", "1")),
Offered::Refused(Refusal::Judged(_))
));
// Written beside it: taken, as nothing was locked at its history.
let beside = taken(store.offer(testfold::put(&[root], "a", "2")));
assert_eq!(store.state().counts()["a"], "2");
assert!(store.state_at(&[beside]).locks().is_empty());
assert!(store.state().locks().contains("a"));
}
#[test]
fn a_node_keeps_the_first_of_two_eras_of_one_number() {
let mut store = store();
let root = store.id();
let one = taken(store.offer(testfold::era(&[root], 1, "one")));
let other = testfold::era(&[root], 1, "other");
let beside = Id::of(&other);
assert_eq!(store.offer(other.clone()), Offered::Refused(Refusal::Own));
assert_eq!(
store.offer(testfold::put(&[beside], "a", "1")),
Offered::Refused(Refusal::BuiltOn(beside))
);
// The same era written again, at another history before it, is one the node
// took; at a history after it, it is no era there.
let elsewhere = taken(store.offer(testfold::put(&[root], "b", "1")));
assert!(matches!(
store.offer(testfold::era(&[elsewhere], 1, "one")),
Offered::Taken(_)
));
assert!(matches!(
store.offer(testfold::era(&[one], 1, "one")),
Offered::Refused(Refusal::Judged(_))
));
assert_eq!(store.state().era(), (1, Some(&"one".to_owned())));
}
#[test]
fn an_operator_drops_what_its_node_took_and_takes_the_other() {
let mut store = store();
let root = store.id();
let one = taken(store.offer(testfold::era(&[root], 1, "one")));
let on = taken(store.offer(testfold::put(&[one], "a", "1")));
let unrelated = taken(store.offer(testfold::put(&[root], "b", "1")));
let other = testfold::era(&[root], 1, "other");
let beside = Id::of(&other);
assert_eq!(store.offer(other.clone()), Offered::Refused(Refusal::Own));
assert_eq!(store.drop_taken(&[one]), Ok(vec![one, on]));
assert_eq!(store.taken(), &[unrelated]);
assert_eq!(store.state().era(), (0, Some(&String::new())));
assert_eq!(store.refusal(&on), Some(&Refusal::BuiltOn(one)));
store.allow(&[beside]);
assert_eq!(store.offer(other), Offered::Taken(vec![beside]));
assert_eq!(store.state().era(), (1, Some(&"other".to_owned())));
assert_eq!(
store.offer(testfold::era(&[root], 1, "one")),
Offered::Refused(Refusal::Dropped)
);
assert!(store.drop_taken(&[root]).is_err());
}
#[test]
fn an_event_waits_until_all_it_builds_on_is_held() {
let mut store = store();
let root = store.id();
let one = testfold::put(&[root], "a", "1");
let two = testfold::put(&[root], "b", "1");
let both = testfold::put(&[Id::of(&one), Id::of(&two)], "c", "1");
assert_eq!(store.offer(both.clone()), Offered::Waiting);
assert!(matches!(store.offer(one), Offered::Taken(ids) if ids.len() == 1));
assert!(store.is_waiting(&Id::of(&both)));
assert!(matches!(store.offer(two), Offered::Taken(ids) if ids.len() == 2));
assert_eq!(store.heads(), vec![Id::of(&both)]);
}
}
|