OXYGENHUB
# faa9cd0579d3 oxygen / crates / oxy-core / src / state.rs
29.7 KiB · Rust · last changed Faster state loading: seeded fast hashing for the file graphs, no unused predecessor map, inline successor sets, lines moved rather than copied; OXY_TIMINGS=1 prints snapshot phase timings. Clean status at 10 000 files 0.96 s to 0.52 s, memory 657 to 239 MB 1 month ago source blame history raw
1
//! A state: a dependency-closed set of changes, applied to a tree graph and
2
//! per-node file graphs (spec §8.3), with materialization (spec §9.5, §11).
3
4
use crate::cbor::{self, Value};
5
use crate::graph::{AtomKey, DepOracle, FileGraph, Materialized, Vertex};
6
use crate::hash::KeyId;
7
use crate::hash::{ChangeHash, ObjectRef};
8
use crate::ids::NodeId;
9
use crate::objects::{
10
    self as o, AtomRef, Change, ChangeKind, Edit, Hlc, Mode, NodeKind, ObjectError, TreeOp,
11
};
12
use crate::tree::{TreeGraph, TreeView};
13
use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
14
use std::sync::{Arc, Mutex};
15
16
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
17
pub enum StateError {
18
    #[error("change {1} depends on {0}, which is not in the state")]
19
    MissingDep(ChangeHash, ChangeHash),
20
}
21
22
/// One `Replace` edit: `(change, old blob, new blob)`.
23
type ReplaceRecord = (ChangeHash, Option<ObjectRef>, Option<ObjectRef>);
24
25
/// What a state remembers about a change: everything but its operations,
26
/// which live in the graphs once applied (and in the store).
27
#[derive(Clone, Debug, PartialEq, Eq)]
28
pub struct ChangeMeta {
29
    pub change_id: crate::ids::ChangeId,
30
    pub deps: Vec<ChangeHash>,
31
    pub author: KeyId,
32
    pub hlc: Hlc,
33
    pub message: String,
34
    pub kind: ChangeKind,
35
}
36
37
impl ChangeMeta {
38
    pub fn of(c: &Change) -> ChangeMeta {
39
        ChangeMeta {
40
            change_id: c.change_id,
41
            deps: c.deps.clone(),
42
            author: c.author,
43
            hlc: c.hlc,
44
            message: c.message.clone(),
45
            kind: c.kind,
46
        }
47
    }
48
}
49
50
#[derive(Default)]
51
pub struct State {
52
    changes: HashMap<ChangeHash, ChangeMeta>,
53
    tree: TreeGraph,
54
    files: HashMap<NodeId, FileGraph>,
55
    replaces: HashMap<NodeId, Vec<ReplaceRecord>>,
56
    /// Memoised transitive dependencies. A mutex, not a `RefCell`, so a
57
    /// loaded state can be shared across threads by a host that caches it.
58
    closure: Mutex<HashMap<ChangeHash, Arc<HashSet<ChangeHash>>>>,
59
}
60
61
impl Clone for State {
62
    fn clone(&self) -> State {
63
        State {
64
            changes: self.changes.clone(),
65
            tree: self.tree.clone(),
66
            files: self.files.clone(),
67
            replaces: self.replaces.clone(),
68
            closure: Mutex::new(self.closure.lock().unwrap().clone()),
69
        }
70
    }
71
}
72
73
#[derive(Clone, Debug, PartialEq, Eq)]
74
pub enum FileContent {
75
    Text {
76
        bytes: Vec<u8>,
77
        materialized: Materialized,
78
    },
79
    /// Live blobs; more than one is a replace conflict (spec §9.3).
80
    Opaque {
81
        blobs: Vec<ObjectRef>,
82
    },
83
    Dir,
84
}
85
86
#[derive(Clone, Debug, PartialEq, Eq)]
87
pub struct FileState {
88
    pub node: NodeId,
89
    pub kind: NodeKind,
90
    pub mode: Mode,
91
    pub content: FileContent,
92
}
93
94
impl FileState {
95
    pub fn is_conflicted(&self) -> bool {
96
        match &self.content {
97
            FileContent::Text { materialized, .. } => materialized.is_conflicted(),
98
            FileContent::Opaque { blobs } => blobs.len() > 1,
99
            FileContent::Dir => false,
100
        }
101
    }
102
}
103
104
/// See `State::conflict_regions`.
105
#[derive(Clone, Debug, Default, PartialEq, Eq)]
106
pub struct ConflictRegions {
107
    pub plain: Vec<(AtomKey, Vec<u8>)>,
108
    pub region_atoms: Vec<AtomKey>,
109
    pub contributors: Vec<ChangeHash>,
110
}
111
112
/// The whole tree of a state, materialized.
113
#[derive(Clone, Debug, Default)]
114
pub struct Snapshot {
115
    pub tree: TreeView,
116
    pub files: BTreeMap<String, FileState>,
117
}
118
119
impl Snapshot {
120
    pub fn is_conflicted(&self) -> bool {
121
        self.tree.is_conflicted() || self.files.values().any(|f| f.is_conflicted())
122
    }
123
}
124
125
fn vertex(r: AtomRef) -> Vertex {
126
    match r {
127
        AtomRef::Start => Vertex::Start,
128
        AtomRef::End => Vertex::End,
129
        AtomRef::Atom { change, index } => Vertex::Atom((change, index)),
130
    }
131
}
132
133
/// Replace self references in a tree op with the concrete change hash.
134
pub fn resolve_tree_op(op: &TreeOp, me: ChangeHash) -> TreeOp {
135
    match op {
136
        TreeOp::RemoveNode { node, placement } => TreeOp::RemoveNode {
137
            node: *node,
138
            placement: placement.resolve(me),
139
        },
140
        TreeOp::Move {
141
            node,
142
            old,
143
            parent,
144
            name,
145
        } => TreeOp::Move {
146
            node: *node,
147
            old: old.resolve(me),
148
            parent: *parent,
149
            name: name.clone(),
150
        },
151
        TreeOp::SetMode { node, old, mode } => TreeOp::SetMode {
152
            node: *node,
153
            old: old.resolve(me),
154
            mode: *mode,
155
        },
156
        add @ TreeOp::AddNode { .. } => add.clone(),
157
    }
158
}
159
160
impl State {
161
    pub fn new() -> Self {
162
        Self::default()
163
    }
164
165
    pub fn len(&self) -> usize {
166
        self.changes.len()
167
    }
168
    pub fn is_empty(&self) -> bool {
169
        self.changes.is_empty()
170
    }
171
    pub fn contains(&self, h: &ChangeHash) -> bool {
172
        self.changes.contains_key(h)
173
    }
174
    pub fn get(&self, h: &ChangeHash) -> Option<&ChangeMeta> {
175
        self.changes.get(h)
176
    }
177
    pub fn changes(&self) -> impl Iterator<Item = (&ChangeHash, &ChangeMeta)> {
178
        self.changes.iter()
179
    }
180
    pub fn tree(&self) -> &TreeGraph {
181
        &self.tree
182
    }
183
    pub fn file(&self, node: &NodeId) -> Option<&FileGraph> {
184
        self.files.get(node)
185
    }
186
187
    /// Add a change whose dependencies are already present.
188
    pub fn add(&mut self, change: Change) -> Result<ChangeHash, StateError> {
189
        let h = change.hash();
190
        if self.changes.contains_key(&h) {
191
            return Ok(h);
192
        }
193
        for d in &change.deps {
194
            if !self.changes.contains_key(d) {
195
                return Err(StateError::MissingDep(*d, h));
196
            }
197
        }
198
        Ok(self.add_unchecked(change))
199
    }
200
201
    /// Add a change in any order; call `validate` once all are in.
202
    pub fn add_unchecked(&mut self, change: Change) -> ChangeHash {
203
        let h = change.hash();
204
        if self.changes.contains_key(&h) {
205
            return h;
206
        }
207
        let meta = ChangeMeta::of(&change);
208
        self.apply(h, change);
209
        self.changes.insert(h, meta);
210
        self.closure.lock().unwrap().clear();
211
        h
212
    }
213
214
    // ------------------------------------------------------------ checkpoints (spec §11)
215
216
    /// Serialize the whole state: change metadata, tree, file graphs, replaces.
217
    pub fn checkpoint_payload(&self) -> Vec<u8> {
218
        let mut hashes: Vec<&ChangeHash> = self.changes.keys().collect();
219
        hashes.sort();
220
        let changes = Value::Array(
221
            hashes
222
                .into_iter()
223
                .map(|h| {
224
                    let m = &self.changes[h];
225
                    Value::Array(vec![
226
                        Value::Bytes(h.0.to_vec()),
227
                        Value::Bytes(m.change_id.0.to_vec()),
228
                        Value::Array(m.deps.iter().map(|d| Value::Bytes(d.0.to_vec())).collect()),
229
                        Value::Text(m.message.clone()),
230
                        Value::Uint(m.hlc.wall_ms),
231
                        Value::Uint(m.hlc.logical as u64),
232
                        Value::Uint(m.kind.tag()),
233
                        Value::Bytes(m.author.0.to_vec()),
234
                    ])
235
                })
236
                .collect(),
237
        );
238
        let mut nodes: Vec<&NodeId> = self.files.keys().collect();
239
        nodes.sort();
240
        let files = Value::Array(
241
            nodes
242
                .into_iter()
243
                .map(|n| Value::Array(vec![Value::Bytes(n.0.to_vec()), self.files[n].to_value()]))
244
                .collect(),
245
        );
246
        let mut rnodes: Vec<&NodeId> = self.replaces.keys().collect();
247
        rnodes.sort();
248
        let opt =
249
            |o: &Option<ObjectRef>| o.map(|r| Value::Bytes(r.0.to_vec())).unwrap_or(Value::Null);
250
        let replaces = Value::Array(
251
            rnodes
252
                .into_iter()
253
                .map(|n| {
254
                    Value::Array(vec![
255
                        Value::Bytes(n.0.to_vec()),
256
                        Value::Array(
257
                            self.replaces[n]
258
                                .iter()
259
                                .map(|(c, o, nw)| {
260
                                    Value::Array(vec![Value::Bytes(c.0.to_vec()), opt(o), opt(nw)])
261
                                })
262
                                .collect(),
263
                        ),
264
                    ])
265
                })
266
                .collect(),
267
        );
268
        cbor::encode(&Value::map([
269
            (0, Value::Uint(o::FORMAT_VERSION)),
270
            (1, changes),
271
            (2, self.tree.to_value()),
272
            (3, files),
273
            (4, replaces),
274
        ]))
275
    }
276
277
    pub fn from_checkpoint_payload(bytes: &[u8]) -> Result<State, ObjectError> {
278
        let v = cbor::decode(bytes)?;
279
        let m = o::map(&v, "checkpoint payload")?;
280
        o::check_version(m)?;
281
        let mut st = State::new();
282
        for c in o::array(o::field(m, 1, "changes")?, "changes")? {
283
            let e = o::array(c, "change meta")?;
284
            if e.len() != 8 {
285
                return Err(ObjectError::Schema("change meta: expected 8 fields".into()));
286
            }
287
            let hash = o::oref(&e[0], "hash")?;
288
            let meta = ChangeMeta {
289
                change_id: crate::ids::ChangeId::from_slice(o::bytes(&e[1], "change id")?)
290
                    .ok_or_else(|| ObjectError::Schema("change id: expected 16 bytes".into()))?,
291
                deps: o::array(&e[2], "deps")?
292
                    .iter()
293
                    .map(|d| o::oref(d, "dep"))
294
                    .collect::<Result<Vec<_>, _>>()?,
295
                message: o::text(&e[3], "message")?.to_owned(),
296
                hlc: Hlc {
297
                    wall_ms: o::uint(&e[4], "wall")?,
298
                    logical: o::u32_(&e[5], "logical")?,
299
                },
300
                kind: ChangeKind::from_tag(o::uint(&e[6], "kind")?)?,
301
                author: o::oref(&e[7], "author")?,
302
            };
303
            st.changes.insert(hash, meta);
304
        }
305
        st.tree = TreeGraph::from_value(o::field(m, 2, "tree")?)?;
306
        for f in o::array(o::field(m, 3, "files")?, "files")? {
307
            let e = o::array(f, "file")?;
308
            if e.len() != 2 {
309
                return Err(ObjectError::Schema("file: expected [node, graph]".into()));
310
            }
311
            let node = NodeId::from_slice(o::bytes(&e[0], "node")?)
312
                .ok_or_else(|| ObjectError::Schema("node: expected 16 bytes".into()))?;
313
            st.files.insert(node, FileGraph::from_value(&e[1])?);
314
        }
315
        let opt = |v: &Value| -> Result<Option<ObjectRef>, ObjectError> {
316
            if v.is_null() {
317
                Ok(None)
318
            } else {
319
                o::oref(v, "blob").map(Some)
320
            }
321
        };
322
        for r in o::array(o::field(m, 4, "replaces")?, "replaces")? {
323
            let e = o::array(r, "replace")?;
324
            if e.len() != 2 {
325
                return Err(ObjectError::Schema(
326
                    "replace: expected [node, records]".into(),
327
                ));
328
            }
329
            let node = NodeId::from_slice(o::bytes(&e[0], "node")?)
330
                .ok_or_else(|| ObjectError::Schema("node: expected 16 bytes".into()))?;
331
            let mut recs = Vec::new();
332
            for rec in o::array(&e[1], "records")? {
333
                let x = o::array(rec, "record")?;
334
                if x.len() != 3 {
335
                    return Err(ObjectError::Schema("record: expected 3 fields".into()));
336
                }
337
                recs.push((o::oref(&x[0], "change")?, opt(&x[1])?, opt(&x[2])?));
338
            }
339
            st.replaces.insert(node, recs);
340
        }
341
        Ok(st)
342
    }
343
344
    pub fn validate(&self) -> Result<(), StateError> {
345
        for (h, c) in &self.changes {
346
            for d in &c.deps {
347
                if !self.changes.contains_key(d) {
348
                    return Err(StateError::MissingDep(*d, *h));
349
                }
350
            }
351
        }
352
        Ok(())
353
    }
354
355
    fn apply(&mut self, h: ChangeHash, c: Change) {
356
        for (i, op) in c.tree_ops.iter().enumerate() {
357
            self.tree.apply(h, i as u32, &resolve_tree_op(op, h));
358
        }
359
        let mut counters: HashMap<NodeId, u32> = HashMap::new();
360
        for e in c.edits {
361
            match e {
362
                Edit::Insert {
363
                    node,
364
                    after,
365
                    before,
366
                    lines,
367
                } => {
368
                    let idx = counters.entry(node).or_default();
369
                    let first = *idx;
370
                    *idx += lines.len() as u32;
371
                    self.files.entry(node).or_default().insert_owned(
372
                        h,
373
                        first,
374
                        vertex(after.resolve(h)),
375
                        vertex(before.resolve(h)),
376
                        lines,
377
                    );
378
                }
379
                Edit::Delete { node, atoms } => {
380
                    let g = self.files.entry(node).or_default();
381
                    for r in atoms {
382
                        g.delete(h, &r.resolve(h));
383
                    }
384
                }
385
                Edit::Replace { node, old, new } => {
386
                    self.replaces.entry(node).or_default().push((h, old, new));
387
                }
388
            }
389
        }
390
    }
391
392
    /// Transitive dependencies of `h`, excluding `h` itself.
393
    pub fn closure(&self, h: &ChangeHash) -> Arc<HashSet<ChangeHash>> {
394
        if let Some(c) = self.closure.lock().unwrap().get(h) {
395
            return c.clone();
396
        }
397
        let mut out = HashSet::new();
398
        let mut stack: Vec<ChangeHash> = self
399
            .changes
400
            .get(h)
401
            .map(|c| c.deps.clone())
402
            .unwrap_or_default();
403
        while let Some(d) = stack.pop() {
404
            if out.insert(d) {
405
                if let Some(c) = self.changes.get(&d) {
406
                    stack.extend(c.deps.iter().copied());
407
                }
408
            }
409
        }
410
        let rc = Arc::new(out);
411
        self.closure.lock().unwrap().insert(*h, rc.clone());
412
        rc
413
    }
414
415
    /// Changes that no other change depends on directly, sorted.
416
    pub fn heads(&self) -> Vec<ChangeHash> {
417
        let depended: HashSet<&ChangeHash> =
418
            self.changes.values().flat_map(|c| c.deps.iter()).collect();
419
        let mut heads: Vec<ChangeHash> = self
420
            .changes
421
            .keys()
422
            .filter(|h| !depended.contains(h))
423
            .copied()
424
            .collect();
425
        heads.sort();
426
        heads
427
    }
428
429
    /// Maximal elements among `hashes` (those not in the closure of another).
430
    pub fn maximal(&self, hashes: &[ChangeHash]) -> Vec<ChangeHash> {
431
        let set: BTreeSet<ChangeHash> = hashes.iter().copied().collect();
432
        set.iter()
433
            .filter(|h| !set.iter().any(|o| o != *h && self.closure(o).contains(h)))
434
            .copied()
435
            .collect()
436
    }
437
438
    pub fn materialize_file(&self, node: &NodeId) -> Materialized {
439
        self.files
440
            .get(node)
441
            .map(|g| g.materialize(self))
442
            .unwrap_or_default()
443
    }
444
445
    /// Live lines of a text node in materialized order.
446
    pub fn live_lines(&self, node: &NodeId) -> Vec<(AtomKey, Vec<u8>)> {
447
        let Some(g) = self.files.get(node) else {
448
            return vec![];
449
        };
450
        let m = g.materialize(self);
451
        m.live_atoms()
452
            .into_iter()
453
            .map(|a| (a, g.content(&a).unwrap_or_default().to_vec()))
454
            .collect()
455
    }
456
457
    /// Live blobs of an opaque node: every `new` that no later `Replace` retired.
458
    pub fn live_blobs(&self, node: &NodeId) -> Vec<ObjectRef> {
459
        let mut live: Vec<ObjectRef> = self
460
            .live_replaces(node)
461
            .into_iter()
462
            .map(|(_, n)| n)
463
            .collect();
464
        live.sort();
465
        live.dedup();
466
        live
467
    }
468
469
    /// The replace records whose blob is live, with the change that set it
470
    /// (spec §9.3). A record's blob is superseded by a later replacement of
471
    /// that blob: one whose change depends on the record's change, as every
472
    /// replacement depends on the change that made its old blob current
473
    /// (§8.1). Two replacements that do not know each other both stay live
474
    /// (a replace conflict), and a file reverted to an earlier blob keeps it.
475
    /// A replacement without that dependency, from before the rule, is read
476
    /// as before: it supersedes every record that did not come after it.
477
    pub fn live_replaces(&self, node: &NodeId) -> Vec<(ChangeHash, ObjectRef)> {
478
        let Some(rs) = self.replaces.get(node) else {
479
            return vec![];
480
        };
481
        let knows_its_old = |s: &ChangeHash, old: &ObjectRef| {
482
            rs.iter()
483
                .any(|(q, _, n)| n.as_ref() == Some(old) && q != s && self.closure(s).contains(q))
484
        };
485
        rs.iter()
486
            .filter_map(|(c, _, n)| n.map(|n| (*c, n)))
487
            .filter(|(c, n)| {
488
                !rs.iter().any(|(s, o, _)| {
489
                    s != c
490
                        && *o == Some(*n)
491
                        && (self.closure(s).contains(c)
492
                            || (!knows_its_old(s, n) && !self.closure(c).contains(s)))
493
                })
494
            })
495
            .collect()
496
    }
497
498
    /// Short label for conflict markers: `changeid-prefix "message"`.
499
    pub fn label(&self, h: &ChangeHash) -> String {
500
        match self.changes.get(h) {
501
            Some(c) => format!(
502
                "{} \"{}\"",
503
                c.change_id.short(8),
504
                c.message.lines().next().unwrap_or("")
505
            ),
506
            None => format!("#{}", h.short(12)),
507
        }
508
    }
509
510
    /// For resolving a conflicted text node (spec §9.6): the live atoms that
511
    /// are not part of any conflict region in order, every live atom that is
512
    /// part of a region, and every change that contributed to a region.
513
    /// The changes that introduced the live blobs of an opaque node, for a
514
    /// replace conflict (spec §9.3).
515
    pub fn blob_contributors(&self, node: &NodeId, blobs: &[ObjectRef]) -> Vec<ChangeHash> {
516
        let mut out: Vec<ChangeHash> = Vec::new();
517
        for (h, _, new) in self.replaces.get(node).map(|v| v.as_slice()).unwrap_or(&[]) {
518
            if new.is_some_and(|b| blobs.contains(&b)) && !out.contains(h) {
519
                out.push(*h);
520
            }
521
        }
522
        out.sort();
523
        out
524
    }
525
526
    pub fn conflict_regions(&self, node: &NodeId) -> ConflictRegions {
527
        let mut out = ConflictRegions::default();
528
        let Some(g) = self.files.get(node) else {
529
            return out;
530
        };
531
        let m = g.materialize(self);
532
        let mut contributors = BTreeSet::new();
533
        for seg in &m.segments {
534
            match seg {
535
                crate::graph::Segment::Lines(atoms) => {
536
                    for a in atoms {
537
                        out.plain
538
                            .push((*a, g.content(a).unwrap_or_default().to_vec()));
539
                    }
540
                }
541
                crate::graph::Segment::Conflict(sides) => {
542
                    for side in sides {
543
                        for a in side {
544
                            out.region_atoms.push(*a);
545
                            contributors.insert(a.0);
546
                        }
547
                    }
548
                }
549
                crate::graph::Segment::Zombie { deleted, inserted } => {
550
                    for a in deleted {
551
                        contributors.insert(a.0);
552
                        contributors.extend(g.deleters(a).copied());
553
                    }
554
                    for a in inserted {
555
                        out.region_atoms.push(*a);
556
                        contributors.insert(a.0);
557
                    }
558
                }
559
            }
560
        }
561
        out.contributors = contributors.into_iter().collect();
562
        out
563
    }
564
565
    pub fn render_file(&self, node: &NodeId) -> (Vec<u8>, Materialized) {
566
        let Some(g) = self.files.get(node) else {
567
            return (Vec::new(), Materialized::default());
568
        };
569
        let m = g.materialize(self);
570
        let bytes = g.render(&m, &|h| self.label(h));
571
        (bytes, m)
572
    }
573
574
    pub fn materialize(&self) -> Snapshot {
575
        let tree = self.tree.view();
576
        let mut files = BTreeMap::new();
577
        for (path, e) in &tree.entries {
578
            let content = match e.kind {
579
                NodeKind::Dir => FileContent::Dir,
580
                NodeKind::Symlink | NodeKind::Subrepo => FileContent::Opaque {
581
                    blobs: self.live_blobs(&e.node),
582
                },
583
                NodeKind::File if e.mode.opaque => FileContent::Opaque {
584
                    blobs: self.live_blobs(&e.node),
585
                },
586
                NodeKind::File => {
587
                    let (bytes, materialized) = self.render_file(&e.node);
588
                    FileContent::Text {
589
                        bytes,
590
                        materialized,
591
                    }
592
                }
593
            };
594
            files.insert(
595
                path.clone(),
596
                FileState {
597
                    node: e.node,
598
                    kind: e.kind,
599
                    mode: e.mode,
600
                    content,
601
                },
602
            );
603
        }
604
        Snapshot { tree, files }
605
    }
606
}
607
608
impl DepOracle for State {
609
    fn depends_on(&self, a: &ChangeHash, b: &ChangeHash) -> bool {
610
        a == b || self.closure(a).contains(b)
611
    }
612
}
613
614
#[cfg(test)]
615
mod tests {
616
    use super::*;
617
    use crate::ids::ChangeId;
618
    use crate::objects::{AtomRange, ChangeKind, Hlc, OpRef};
619
620
    fn change(deps: Vec<ChangeHash>, tree_ops: Vec<TreeOp>, edits: Vec<Edit>) -> Change {
621
        let mut c = Change {
622
            change_id: ChangeId::random(),
623
            deps,
624
            author: ObjectRef::ZERO,
625
            hlc: Hlc {
626
                wall_ms: 1,
627
                logical: 0,
628
            },
629
            message: "m".into(),
630
            tree_ops,
631
            edits,
632
            kind: ChangeKind::Normal,
633
        };
634
        c.normalize();
635
        c
636
    }
637
638
    #[test]
639
    fn build_edit_and_materialize() {
640
        let mut st = State::new();
641
        let f = NodeId::random();
642
        let c1 = change(
643
            vec![],
644
            vec![TreeOp::AddNode {
645
                node: f,
646
                kind: NodeKind::File,
647
                mode: Mode::TEXT,
648
                parent: NodeId::ROOT,
649
                name: "a.txt".into(),
650
            }],
651
            vec![Edit::Insert {
652
                node: f,
653
                after: AtomRef::Start,
654
                before: AtomRef::End,
655
                lines: vec![b"one\n".to_vec(), b"two\n".to_vec()],
656
            }],
657
        );
658
        let h1 = st.add(c1).unwrap();
659
        // Depends on h1: append a line and delete "one".
660
        let c2 = change(
661
            vec![h1],
662
            vec![],
663
            vec![
664
                Edit::Delete {
665
                    node: f,
666
                    atoms: vec![AtomRange {
667
                        change: h1,
668
                        from: 0,
669
                        to: 1,
670
                    }],
671
                },
672
                Edit::Insert {
673
                    node: f,
674
                    after: AtomRef::Atom {
675
                        change: h1,
676
                        index: 1,
677
                    },
678
                    before: AtomRef::End,
679
                    lines: vec![b"three\n".to_vec()],
680
                },
681
            ],
682
        );
683
        let h2 = st.add(c2).unwrap();
684
        assert_eq!(st.heads(), vec![h2]);
685
        assert!(st.depends_on(&h2, &h1));
686
        assert!(!st.depends_on(&h1, &h2));
687
        let snap = st.materialize();
688
        assert!(!snap.is_conflicted());
689
        let a = &snap.files["a.txt"];
690
        assert!(matches!(&a.content, FileContent::Text { bytes, .. } if bytes == b"two\nthree\n"));
691
        assert_eq!(st.live_lines(&f).len(), 2);
692
    }
693
694
    #[test]
695
    fn missing_dependency_is_rejected() {
696
        let mut st = State::new();
697
        let c = change(vec![ObjectRef([1; 32])], vec![], vec![]);
698
        assert!(matches!(st.add(c), Err(StateError::MissingDep(..))));
699
    }
700
701
    #[test]
702
    fn self_references_and_multi_insert_indexing() {
703
        let mut st = State::new();
704
        let f = NodeId::random();
705
        let me = OpRef {
706
            change: ObjectRef::ZERO,
707
            index: 0,
708
        };
709
        let c1 = change(
710
            vec![],
711
            vec![
712
                TreeOp::AddNode {
713
                    node: f,
714
                    kind: NodeKind::File,
715
                    mode: Mode::TEXT,
716
                    parent: NodeId::ROOT,
717
                    name: "x".into(),
718
                },
719
                TreeOp::SetMode {
720
                    node: f,
721
                    old: me,
722
                    mode: Mode {
723
                        exec: true,
724
                        opaque: false,
725
                    },
726
                },
727
            ],
728
            vec![
729
                Edit::Insert {
730
                    node: f,
731
                    after: AtomRef::Start,
732
                    before: AtomRef::End,
733
                    lines: vec![b"a\n".to_vec(), b"c\n".to_vec()],
734
                },
735
                // Insert between the two lines just inserted, using self references.
736
                Edit::Insert {
737
                    node: f,
738
                    after: AtomRef::Atom {
739
                        change: ObjectRef::ZERO,
740
                        index: 0,
741
                    },
742
                    before: AtomRef::Atom {
743
                        change: ObjectRef::ZERO,
744
                        index: 1,
745
                    },
746
                    lines: vec![b"b\n".to_vec()],
747
                },
748
            ],
749
        );
750
        st.add(c1).unwrap();
751
        let snap = st.materialize();
752
        let x = &snap.files["x"];
753
        assert_eq!(
754
            x.mode,
755
            Mode {
756
                exec: true,
757
                opaque: false
758
            }
759
        );
760
        assert!(matches!(&x.content, FileContent::Text { bytes, .. } if bytes == b"a\nb\nc\n"));
761
    }
762
763
    #[test]
764
    fn opaque_replace_and_conflict() {
765
        let mut st = State::new();
766
        let f = NodeId::random();
767
        let b1 = ObjectRef([1; 32]);
768
        let b2 = ObjectRef([2; 32]);
769
        let b3 = ObjectRef([3; 32]);
770
        let h1 = st
771
            .add(change(
772
                vec![],
773
                vec![TreeOp::AddNode {
774
                    node: f,
775
                    kind: NodeKind::File,
776
                    mode: Mode::OPAQUE,
777
                    parent: NodeId::ROOT,
778
                    name: "img".into(),
779
                }],
780
                vec![Edit::Replace {
781
                    node: f,
782
                    old: None,
783
                    new: Some(b1),
784
                }],
785
            ))
786
            .unwrap();
787
        assert_eq!(st.live_blobs(&f), vec![b1]);
788
        st.add(change(
789
            vec![h1],
790
            vec![],
791
            vec![Edit::Replace {
792
                node: f,
793
                old: Some(b1),
794
                new: Some(b2),
795
            }],
796
        ))
797
        .unwrap();
798
        st.add(change(
799
            vec![h1],
800
            vec![],
801
            vec![Edit::Replace {
802
                node: f,
803
                old: Some(b1),
804
                new: Some(b3),
805
            }],
806
        ))
807
        .unwrap();
808
        let snap = st.materialize();
809
        assert!(snap.is_conflicted());
810
        assert!(
811
            matches!(&snap.files["img"].content, FileContent::Opaque { blobs } if blobs == &vec![b2, b3])
812
        );
813
    }
814
815
    #[test]
816
    fn checkpoint_payload_round_trip_and_replay() {
817
        let mut st = State::new();
818
        let f = NodeId::random();
819
        let h1 = st
820
            .add(change(
821
                vec![],
822
                vec![TreeOp::AddNode {
823
                    node: f,
824
                    kind: NodeKind::File,
825
                    mode: Mode::TEXT,
826
                    parent: NodeId::ROOT,
827
                    name: "a".into(),
828
                }],
829
                vec![Edit::Insert {
830
                    node: f,
831
                    after: AtomRef::Start,
832
                    before: AtomRef::End,
833
                    lines: vec![b"1\n".to_vec(), b"2\n".to_vec()],
834
                }],
835
            ))
836
            .unwrap();
837
        let h2 = st
838
            .add(change(
839
                vec![h1],
840
                vec![],
841
                vec![Edit::Delete {
842
                    node: f,
843
                    atoms: vec![AtomRange {
844
                        change: h1,
845
                        from: 0,
846
                        to: 1,
847
                    }],
848
                }],
849
            ))
850
            .unwrap();
851
        let payload = st.checkpoint_payload();
852
        let back = State::from_checkpoint_payload(&payload).unwrap();
853
        assert_eq!(back.len(), 2);
854
        assert_eq!(back.heads(), vec![h2]);
855
        assert_eq!(back.get(&h1).unwrap().message, "m");
856
        assert_eq!(back.checkpoint_payload(), payload, "deterministic");
857
        // Replaying a further change onto the restored state equals a full build.
858
        let c3 = change(
859
            vec![h2],
860
            vec![],
861
            vec![Edit::Insert {
862
                node: f,
863
                after: AtomRef::Atom {
864
                    change: h1,
865
                    index: 1,
866
                },
867
                before: AtomRef::End,
868
                lines: vec![b"3\n".to_vec()],
869
            }],
870
        );
871
        let mut full = st.clone();
872
        full.add(c3.clone()).unwrap();
873
        let mut restored = back;
874
        restored.add(c3).unwrap();
875
        let (a, b) = (full.materialize(), restored.materialize());
876
        assert_eq!(
877
            a.files.keys().collect::<Vec<_>>(),
878
            b.files.keys().collect::<Vec<_>>()
879
        );
880
        assert_eq!(a.files["a"].content, b.files["a"].content);
881
        assert!(
882
            matches!(&b.files["a"].content, FileContent::Text { bytes, .. } if bytes == b"2\n3\n")
883
        );
884
        assert!(State::from_checkpoint_payload(b"nonsense").is_err());
885
    }
886
887
    #[test]
888
    fn maximal_elements() {
889
        let mut st = State::new();
890
        let h1 = st.add(change(vec![], vec![], vec![])).unwrap();
891
        let h2 = st.add(change(vec![h1], vec![], vec![])).unwrap();
892
        let h3 = st.add(change(vec![], vec![], vec![])).unwrap();
893
        let mut m = st.maximal(&[h1, h2, h3]);
894
        m.sort();
895
        let mut want = vec![h2, h3];
896
        want.sort();
897
        assert_eq!(m, want);
898
        assert_eq!(st.heads(), want);
899
    }
900
}