OXYGENHUB
◆ v0.3.0 oxygen / crates / oxy-core / src / tree.rs
53.6 KiB · Rust · last changed Blame prints through one buffered lock; the tree view builds in one step (refs #41) 1 month ago source blame history raw
1
//! The tree graph: nodes, placements, and modes as atoms (spec §7.1, §7.2),
2
//! with tree conflict detection and path assignment (spec §9.2).
3
4
use crate::hash::ChangeHash;
5
use crate::ids::NodeId;
6
use crate::objects::{Mode, NodeKind, OpRef, TreeOp};
7
use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
8
9
/// `(change, index into that change's tree_ops)`.
10
pub type OpKey = (ChangeHash, u32);
11
12
/// The graph's own maps: keyed by hashes and random ids, which need no
13
/// SipHash (see [`crate::fasthash`]).
14
type Map<K, V> = crate::fasthash::FastMap<K, V>;
15
16
/// A node's placement or mode atoms, sorted: nearly always one, held
17
/// without an allocation.
18
#[derive(Clone, Debug, Default, PartialEq, Eq)]
19
enum KeySet {
20
    #[default]
21
    Empty,
22
    One(OpKey),
23
    Many(Vec<OpKey>),
24
}
25
26
impl KeySet {
27
    fn insert(&mut self, k: OpKey) {
28
        match self {
29
            KeySet::Empty => *self = KeySet::One(k),
30
            KeySet::One(a) if *a == k => {}
31
            KeySet::One(a) => {
32
                let a = *a;
33
                *self = KeySet::Many(if a < k { vec![a, k] } else { vec![k, a] });
34
            }
35
            KeySet::Many(v) => {
36
                if let Err(i) = v.binary_search(&k) {
37
                    v.insert(i, k);
38
                }
39
            }
40
        }
41
    }
42
    fn remove(&mut self, k: &OpKey) {
43
        match self {
44
            KeySet::One(a) if a == k => *self = KeySet::Empty,
45
            KeySet::Many(v) => {
46
                if let Ok(i) = v.binary_search(k) {
47
                    v.remove(i);
48
                }
49
                if v.len() == 1 {
50
                    *self = KeySet::One(v[0]);
51
                } else if v.is_empty() {
52
                    *self = KeySet::Empty;
53
                }
54
            }
55
            _ => {}
56
        }
57
    }
58
    fn as_slice(&self) -> &[OpKey] {
59
        match self {
60
            KeySet::Empty => &[],
61
            KeySet::One(a) => std::slice::from_ref(a),
62
            KeySet::Many(v) => v,
63
        }
64
    }
65
    fn iter(&self) -> std::slice::Iter<'_, OpKey> {
66
        self.as_slice().iter()
67
    }
68
    fn len(&self) -> usize {
69
        self.as_slice().len()
70
    }
71
    fn is_empty(&self) -> bool {
72
        matches!(self, KeySet::Empty)
73
    }
74
}
75
76
impl<'a> IntoIterator for &'a KeySet {
77
    type Item = &'a OpKey;
78
    type IntoIter = std::slice::Iter<'a, OpKey>;
79
    fn into_iter(self) -> Self::IntoIter {
80
        self.iter()
81
    }
82
}
83
84
#[derive(Clone, Debug, PartialEq, Eq)]
85
pub struct Placement {
86
    pub node: NodeId,
87
    pub parent: NodeId,
88
    pub name: String,
89
}
90
91
#[derive(Clone, Debug, Default)]
92
struct TreeMaps {
93
    kinds: Map<NodeId, NodeKind>,
94
    introduced: Map<NodeId, ChangeHash>,
95
    placements: Map<OpKey, Placement>,
96
    modes: Map<OpKey, (NodeId, Mode)>,
97
    /// Placement atoms retired by `RemoveNode`/`Move`, and mode atoms retired
98
    /// by `SetMode`. Kept apart because `AddNode` introduces one of each
99
    /// under the same key.
100
    deleted_placements: Map<OpKey, BTreeSet<ChangeHash>>,
101
    deleted_modes: Map<OpKey, BTreeSet<ChangeHash>>,
102
    placements_of: Map<NodeId, KeySet>,
103
    modes_of: Map<NodeId, KeySet>,
104
    /// The live subsets of `placements_of` and `modes_of`, kept as changes
105
    /// apply, so the view walks what is live rather than all history.
106
    live_placements_of: Map<NodeId, KeySet>,
107
    live_modes_of: Map<NodeId, KeySet>,
108
}
109
110
#[derive(Clone, Debug, Default)]
111
pub struct TreeGraph {
112
    /// The graph itself; see [`TreeGraph::m`].
113
    maps: std::sync::OnceLock<TreeMaps>,
114
    /// A state index's encoding of `maps`, decoded when first needed: a
115
    /// command that only reads the view (a status) never needs them.
116
    raw: Option<std::sync::Arc<Vec<u8>>>,
117
    /// The introducers block of the same index, read alone while `maps`
118
    /// is not decoded: a snapshot asks for introducers but no more.
119
    raw_introduced: Option<std::sync::Arc<Vec<u8>>>,
120
    introduced_only: std::sync::OnceLock<Map<NodeId, ChangeHash>>,
121
    /// The view, once computed, with the path of each directory in it;
122
    /// kept up to date as ops apply when that is simple (see
123
    /// `update_view`), cleared otherwise.
124
    view_cache: std::sync::OnceLock<CachedView>,
125
}
126
127
#[derive(Clone, Debug, PartialEq, Eq)]
128
pub enum TreeConflict {
129
    /// Two live nodes share `(parent, name)`.
130
    Name {
131
        parent: NodeId,
132
        name: String,
133
        nodes: Vec<NodeId>,
134
    },
135
    /// One node has several live placements.
136
    MultiPlacement {
137
        node: NodeId,
138
        placements: Vec<OpKey>,
139
    },
140
    /// A live node's parent is not live.
141
    Orphan { node: NodeId, parent: NodeId },
142
    /// A directory is placed inside its own descendant.
143
    Cycle { node: NodeId },
144
    /// Several live mode atoms.
145
    Mode { node: NodeId, modes: Vec<Mode> },
146
}
147
148
/// A node as it appears in the working copy.
149
#[derive(Clone, Debug, PartialEq, Eq)]
150
pub struct TreeEntry {
151
    pub path: String,
152
    pub node: NodeId,
153
    pub kind: NodeKind,
154
    pub mode: Mode,
155
    /// The placement this entry materializes (for building `RemoveNode`/`Move`).
156
    pub placement: OpKey,
157
    /// The live mode atom (for building `SetMode`).
158
    pub mode_atom: Option<OpKey>,
159
}
160
161
#[derive(Clone, Debug, Default)]
162
struct CachedView {
163
    view: TreeView,
164
    dirs: HashMap<NodeId, String>,
165
}
166
167
impl CachedView {
168
    fn new(view: TreeView) -> CachedView {
169
        let mut dirs: HashMap<NodeId, String> = view
170
            .entries
171
            .values()
172
            .filter(|e| e.kind == NodeKind::Dir)
173
            .map(|e| (e.node, e.path.clone()))
174
            .collect();
175
        dirs.insert(NodeId::ROOT, String::new());
176
        CachedView { view, dirs }
177
    }
178
}
179
180
#[derive(Clone, Debug, Default, PartialEq, Eq)]
181
pub struct TreeView {
182
    /// Path → entry, paths use `/` and have no leading slash; conflicted
183
    /// entries carry a `.oxy-conflict-<n>` suffix. Shared, so a view is
184
    /// cheap to clone.
185
    pub entries: std::sync::Arc<BTreeMap<String, TreeEntry>>,
186
    pub conflicts: Vec<TreeConflict>,
187
}
188
189
impl TreeView {
190
    pub fn is_conflicted(&self) -> bool {
191
        !self.conflicts.is_empty()
192
    }
193
    pub fn by_node(&self) -> HashMap<NodeId, &TreeEntry> {
194
        self.entries.values().map(|e| (e.node, e)).collect()
195
    }
196
}
197
198
impl TreeGraph {
199
    pub fn new() -> Self {
200
        Self::default()
201
    }
202
203
    /// The graph's maps, decoded from a state index on first use.
204
    fn m(&self) -> &TreeMaps {
205
        self.maps.get_or_init(|| match &self.raw {
206
            Some(raw) => {
207
                TreeMaps::decode(raw).expect("a state index is checked against its hash when read")
208
            }
209
            None => TreeMaps::default(),
210
        })
211
    }
212
213
    fn m_mut(&mut self) -> &mut TreeMaps {
214
        self.m();
215
        self.maps.get_mut().expect("decoded just now")
216
    }
217
218
    /// Apply tree op `index` of `change`; `OpRef` self references must already be resolved.
219
    pub fn apply(&mut self, change: ChangeHash, index: u32, op: &TreeOp) {
220
        let cached = self.view_cache.take();
221
        // Whether the placement or mode atom this op retires was live.
222
        let was_live = match op {
223
            TreeOp::RemoveNode { placement, .. } => self.placement_live(&op_key(*placement)),
224
            TreeOp::Move { old, .. } => self.placement_live(&op_key(*old)),
225
            TreeOp::SetMode { old, .. } => self.mode_live(&op_key(*old)),
226
            TreeOp::AddNode { .. } => false,
227
        };
228
        self.apply_to_graph(change, index, op);
229
        if let Some(mut c) = cached {
230
            if self.update_view(&mut c, (change, index), op, was_live) {
231
                #[cfg(test)]
232
                assert_eq!(
233
                    c.view,
234
                    self.compute_view(),
235
                    "view kept up to date by {op:?}"
236
                );
237
                self.view_cache = std::sync::OnceLock::from(c);
238
            }
239
        }
240
    }
241
242
    fn apply_to_graph(&mut self, change: ChangeHash, index: u32, op: &TreeOp) {
243
        let key = (change, index);
244
        match op {
245
            TreeOp::AddNode {
246
                node,
247
                kind,
248
                mode,
249
                parent,
250
                name,
251
            } => {
252
                self.m_mut().kinds.insert(*node, *kind);
253
                self.m_mut().introduced.insert(*node, change);
254
                self.m_mut().placements.insert(
255
                    key,
256
                    Placement {
257
                        node: *node,
258
                        parent: *parent,
259
                        name: name.clone(),
260
                    },
261
                );
262
                self.m_mut()
263
                    .placements_of
264
                    .entry(*node)
265
                    .or_default()
266
                    .insert(key);
267
                self.index_placement(key);
268
                if *kind != NodeKind::Dir {
269
                    self.m_mut().modes.insert(key, (*node, *mode));
270
                    self.m_mut().modes_of.entry(*node).or_default().insert(key);
271
                    self.index_mode(key);
272
                }
273
            }
274
            TreeOp::RemoveNode { placement, .. } => {
275
                self.m_mut()
276
                    .deleted_placements
277
                    .entry(op_key(*placement))
278
                    .or_default()
279
                    .insert(change);
280
                self.index_placement(op_key(*placement));
281
            }
282
            TreeOp::Move {
283
                node,
284
                old,
285
                parent,
286
                name,
287
            } => {
288
                self.m_mut()
289
                    .deleted_placements
290
                    .entry(op_key(*old))
291
                    .or_default()
292
                    .insert(change);
293
                self.index_placement(op_key(*old));
294
                self.m_mut().placements.insert(
295
                    key,
296
                    Placement {
297
                        node: *node,
298
                        parent: *parent,
299
                        name: name.clone(),
300
                    },
301
                );
302
                self.m_mut()
303
                    .placements_of
304
                    .entry(*node)
305
                    .or_default()
306
                    .insert(key);
307
                self.index_placement(key);
308
            }
309
            TreeOp::SetMode { node, old, mode } => {
310
                self.m_mut()
311
                    .deleted_modes
312
                    .entry(op_key(*old))
313
                    .or_default()
314
                    .insert(change);
315
                self.index_mode(op_key(*old));
316
                self.m_mut().modes.insert(key, (*node, *mode));
317
                self.m_mut().modes_of.entry(*node).or_default().insert(key);
318
                self.index_mode(key);
319
            }
320
        }
321
    }
322
323
    /// Bring the cached view `c` up to date with `op` (already applied as
324
    /// `key`) where that is simple and the view has no conflicts; false
325
    /// when it must be computed again. `was_live`: whether the placement or
326
    /// mode atom `op` retires was live before it.
327
    fn update_view(&self, c: &mut CachedView, key: OpKey, op: &TreeOp, was_live: bool) -> bool {
328
        if !c.view.conflicts.is_empty() {
329
            return false;
330
        }
331
        match op {
332
            TreeOp::AddNode { node, .. } => self.view_add(c, *node, key),
333
            TreeOp::RemoveNode { node, placement } => {
334
                !was_live || self.view_remove(c, *node, op_key(*placement))
335
            }
336
            TreeOp::Move { node, old, .. } => {
337
                (!was_live || self.view_remove(c, *node, op_key(*old)))
338
                    && self.view_add(c, *node, key)
339
            }
340
            TreeOp::SetMode { node, .. } => {
341
                let live = self.live_placements(node);
342
                match live.as_slice() {
343
                    [] => true,
344
                    [(k, p)] => {
345
                        let Some(path) = c.dirs.get(&p.parent).map(|d| join(d, &p.name)) else {
346
                            return false;
347
                        };
348
                        let Some(mode) = self.entry_mode(node) else {
349
                            return false;
350
                        };
351
                        let entries = std::sync::Arc::make_mut(&mut c.view.entries);
352
                        match entries.get_mut(&path) {
353
                            Some(e) if e.node == *node && e.placement == *k => {
354
                                (e.mode_atom, e.mode) = mode;
355
                                true
356
                            }
357
                            _ => false,
358
                        }
359
                    }
360
                    _ => false,
361
                }
362
            }
363
        }
364
    }
365
366
    /// The view entry for `node`'s placement `key`, just made live.
367
    fn view_add(&self, c: &mut CachedView, node: NodeId, key: OpKey) -> bool {
368
        if !self.placement_live(&key) {
369
            return true;
370
        }
371
        if self
372
            .m()
373
            .live_placements_of
374
            .get(&node)
375
            .is_none_or(|s| s.len() != 1)
376
        {
377
            return false;
378
        }
379
        let Some(p) = self.m().placements.get(&key) else {
380
            return false;
381
        };
382
        let Some(path) = c.dirs.get(&p.parent).map(|d| join(d, &p.name)) else {
383
            return false;
384
        };
385
        let Some((mode_atom, mode)) = self.entry_mode(&node) else {
386
            return false;
387
        };
388
        let kind = self.kind(&node).unwrap_or(NodeKind::File);
389
        let entries = std::sync::Arc::make_mut(&mut c.view.entries);
390
        if entries.contains_key(&path) || node == NodeId::ROOT {
391
            return false;
392
        }
393
        // Nothing can be placed under a directory that was not in the view
394
        // yet: it would have been an orphan, and the view had no conflicts.
395
        if kind == NodeKind::Dir {
396
            c.dirs.insert(node, path.clone());
397
        }
398
        entries.insert(
399
            path.clone(),
400
            TreeEntry {
401
                path,
402
                node,
403
                kind,
404
                mode,
405
                placement: key,
406
                mode_atom,
407
            },
408
        );
409
        true
410
    }
411
412
    /// Drop the view entry of `node`'s placement `key`, just retired.
413
    fn view_remove(&self, c: &mut CachedView, node: NodeId, key: OpKey) -> bool {
414
        if self.m().live_placements_of.contains_key(&node) {
415
            return false;
416
        }
417
        let Some(p) = self.m().placements.get(&key) else {
418
            return false;
419
        };
420
        let Some(path) = c.dirs.get(&p.parent).map(|d| join(d, &p.name)) else {
421
            return false;
422
        };
423
        let entries = std::sync::Arc::make_mut(&mut c.view.entries);
424
        match entries.get(&path) {
425
            Some(e) if e.node == node && e.placement == key => {}
426
            _ => return false,
427
        }
428
        if entries.get(&path).is_some_and(|e| e.kind == NodeKind::Dir) {
429
            let prefix = format!("{path}/");
430
            if entries
431
                .range(prefix.clone()..)
432
                .next()
433
                .is_some_and(|(k, _)| k.starts_with(&prefix))
434
            {
435
                return false;
436
            }
437
            c.dirs.remove(&node);
438
        }
439
        entries.remove(&path);
440
        true
441
    }
442
443
    /// The mode atom and mode of `node`'s entry, as `compute_view` finds
444
    /// them; `None` when its live modes conflict.
445
    fn entry_mode(&self, node: &NodeId) -> Option<(Option<OpKey>, Mode)> {
446
        let lm = self.live_modes(node);
447
        let distinct: BTreeSet<Mode> = lm.iter().map(|(_, m)| *m).collect();
448
        if distinct.len() > 1 {
449
            return None;
450
        }
451
        let mode_atom = lm.iter().map(|(k, _)| *k).max();
452
        let mode = mode_atom
453
            .and_then(|k| self.m().modes.get(&k).map(|(_, m)| *m))
454
            .unwrap_or_default();
455
        Some((mode_atom, mode))
456
    }
457
458
    /// Bring placement `k` in the live index up to date.
459
    fn index_placement(&mut self, k: OpKey) {
460
        let Some(node) = self.m_mut().placements.get(&k).map(|p| p.node) else {
461
            return;
462
        };
463
        if self.placement_live(&k) {
464
            self.m_mut()
465
                .live_placements_of
466
                .entry(node)
467
                .or_default()
468
                .insert(k);
469
        } else if let Some(set) = self.m_mut().live_placements_of.get_mut(&node) {
470
            set.remove(&k);
471
            if set.is_empty() {
472
                self.m_mut().live_placements_of.remove(&node);
473
            }
474
        }
475
    }
476
477
    /// Bring mode atom `k` in the live index up to date.
478
    fn index_mode(&mut self, k: OpKey) {
479
        let Some(node) = self.m_mut().modes.get(&k).map(|(n, _)| *n) else {
480
            return;
481
        };
482
        if self.mode_live(&k) {
483
            self.m_mut()
484
                .live_modes_of
485
                .entry(node)
486
                .or_default()
487
                .insert(k);
488
        } else if let Some(set) = self.m_mut().live_modes_of.get_mut(&node) {
489
            set.remove(&k);
490
            if set.is_empty() {
491
                self.m_mut().live_modes_of.remove(&node);
492
            }
493
        }
494
    }
495
496
    /// Directories no longer placed anywhere, by the (parent, name) they
497
    /// were last placed at, with that placement: what an import can bring
498
    /// back rather than make a second node for one Git path.
499
    pub fn dead_dirs(&self) -> HashMap<(NodeId, String), (NodeId, OpKey)> {
500
        let mut out: HashMap<(NodeId, String), (NodeId, OpKey)> = HashMap::new();
501
        for (k, p) in &self.m().placements {
502
            if self.kind(&p.node) != Some(NodeKind::Dir)
503
                || self.placement_live(k)
504
                || !self.live_placements(&p.node).is_empty()
505
            {
506
                continue;
507
            }
508
            let slot = out
509
                .entry((p.parent, p.name.clone()))
510
                .or_insert((p.node, *k));
511
            // The newest placement, by key: the same answer in any order.
512
            if *k > slot.1 {
513
                *slot = (p.node, *k);
514
            }
515
        }
516
        out
517
    }
518
519
    /// Every placement `node` ever had, live or not, with the changes that
520
    /// retired it (none while live).
521
    pub fn placement_history(&self, node: &NodeId) -> Vec<(OpKey, &Placement, Vec<ChangeHash>)> {
522
        self.m()
523
            .placements_of
524
            .get(node)
525
            .into_iter()
526
            .flatten()
527
            .filter_map(|k| {
528
                let p = self.m().placements.get(k)?;
529
                let by = self
530
                    .m()
531
                    .deleted_placements
532
                    .get(k)
533
                    .map(|d| d.iter().copied().collect())
534
                    .unwrap_or_default();
535
                Some((*k, p, by))
536
            })
537
            .collect()
538
    }
539
540
    fn placement_live(&self, k: &OpKey) -> bool {
541
        self.m()
542
            .deleted_placements
543
            .get(k)
544
            .is_none_or(|d| d.is_empty())
545
    }
546
    fn mode_live(&self, k: &OpKey) -> bool {
547
        self.m().deleted_modes.get(k).is_none_or(|d| d.is_empty())
548
    }
549
550
    pub fn kind(&self, node: &NodeId) -> Option<NodeKind> {
551
        if node.is_root() {
552
            Some(NodeKind::Dir)
553
        } else {
554
            self.m().kinds.get(node).copied()
555
        }
556
    }
557
558
    /// The change whose `AddNode` introduced `node`.
559
    pub fn introducer(&self, node: &NodeId) -> Option<ChangeHash> {
560
        if let (None, Some(raw)) = (self.maps.get(), &self.raw_introduced) {
561
            let only = self.introduced_only.get_or_init(|| {
562
                read_introduced(raw).expect("a state index is checked against its hash when read")
563
            });
564
            #[cfg(test)]
565
            assert_eq!(
566
                only.get(node),
567
                TreeMaps::decode(self.raw.as_ref().unwrap())
568
                    .unwrap()
569
                    .introduced
570
                    .get(node),
571
                "the introducers block is the maps'"
572
            );
573
            return only.get(node).copied();
574
        }
575
        self.m().introduced.get(node).copied()
576
    }
577
578
    pub fn placement(&self, k: &OpKey) -> Option<&Placement> {
579
        self.m().placements.get(k)
580
    }
581
582
    pub fn live_placements(&self, node: &NodeId) -> Vec<(OpKey, &Placement)> {
583
        self.m()
584
            .live_placements_of
585
            .get(node)
586
            .into_iter()
587
            .flat_map(|ks| ks.iter())
588
            .filter_map(|k| self.m().placements.get(k).map(|p| (*k, p)))
589
            .collect()
590
    }
591
592
    pub fn live_modes(&self, node: &NodeId) -> Vec<(OpKey, Mode)> {
593
        self.m()
594
            .live_modes_of
595
            .get(node)
596
            .into_iter()
597
            .flat_map(|ks| ks.iter())
598
            .filter_map(|k| self.m().modes.get(k).map(|(_, m)| (*k, *m)))
599
            .collect()
600
    }
601
602
    /// Every node that has at least one live placement.
603
    pub fn placed_nodes(&self) -> impl Iterator<Item = NodeId> + '_ {
604
        self.m().live_placements_of.keys().copied()
605
    }
606
607
    /// Resolve the tree: assign paths, find conflicts.
608
    /// The materialized tree (spec §7.1): computed once per graph and
609
    /// cloned for each caller.
610
    pub fn view(&self) -> TreeView {
611
        self.view_cache
612
            .get_or_init(|| CachedView::new(self.compute_view()))
613
            .view
614
            .clone()
615
    }
616
617
    fn compute_view(&self) -> TreeView {
618
        let mut view = TreeView::default();
619
        let mut entries: BTreeMap<String, TreeEntry> = BTreeMap::new();
620
621
        // Live placements grouped by parent.
622
        let mut children: HashMap<NodeId, Vec<(OpKey, &Placement)>> = HashMap::new();
623
        for ks in self.m().live_placements_of.values() {
624
            for k in ks {
625
                if let Some(p) = self.m().placements.get(k) {
626
                    children.entry(p.parent).or_default().push((*k, p));
627
                }
628
            }
629
        }
630
        for c in children.values_mut() {
631
            c.sort_by(|a, b| a.1.name.cmp(&b.1.name).then(a.0.cmp(&b.0)));
632
        }
633
634
        // Multi-placement and mode conflicts.
635
        // Only placed nodes: one with no live placement is not in the tree.
636
        let mut nodes: Vec<NodeId> = self.m().live_placements_of.keys().copied().collect();
637
        nodes.sort();
638
        let mut multi: HashSet<NodeId> = HashSet::new();
639
        // Each node's mode and the atom it comes from, for the entries.
640
        let mut modes: HashMap<NodeId, (Option<OpKey>, Mode)> = HashMap::new();
641
        for n in &nodes {
642
            let lp = self.live_placements(n);
643
            // One placement (nearly every node) cannot be in two places.
644
            if lp.len() > 1 {
645
                let distinct_places: BTreeSet<(&NodeId, &str)> = lp
646
                    .iter()
647
                    .map(|(_, p)| (&p.parent, p.name.as_str()))
648
                    .collect();
649
                if distinct_places.len() > 1 {
650
                    multi.insert(*n);
651
                    view.conflicts.push(TreeConflict::MultiPlacement {
652
                        node: *n,
653
                        placements: lp.iter().map(|(k, _)| *k).collect(),
654
                    });
655
                }
656
            }
657
            let lm = self.live_modes(n);
658
            if lm.len() > 1 {
659
                let distinct_modes: BTreeSet<Mode> = lm.iter().map(|(_, m)| *m).collect();
660
                if distinct_modes.len() > 1 {
661
                    view.conflicts.push(TreeConflict::Mode {
662
                        node: *n,
663
                        modes: distinct_modes.into_iter().collect(),
664
                    });
665
                }
666
            }
667
            let mode_atom = lm.iter().map(|(k, _)| *k).max();
668
            let mode = mode_atom
669
                .and_then(|k| self.m().modes.get(&k).map(|(_, m)| *m))
670
                .unwrap_or_default();
671
            modes.insert(*n, (mode_atom, mode));
672
        }
673
674
        // BFS from the root, assigning paths.
675
        let mut reached: HashSet<NodeId> = HashSet::new();
676
        reached.insert(NodeId::ROOT);
677
        let mut queue: Vec<(NodeId, String)> = vec![(NodeId::ROOT, String::new())];
678
        let mut on_path: HashSet<NodeId> = HashSet::new();
679
        while let Some((dir, dir_path)) = queue.pop() {
680
            let Some(kids) = children.get(&dir) else {
681
                continue;
682
            };
683
            // Name conflicts within this directory: the children are sorted
684
            // by name, so each name's group is a run of them.
685
            let mut groups: Vec<(&str, &[(OpKey, &Placement)])> = Vec::new();
686
            let mut start = 0;
687
            for i in 1..=kids.len() {
688
                if i == kids.len() || kids[i].1.name != kids[start].1.name {
689
                    groups.push((kids[start].1.name.as_str(), &kids[start..i]));
690
                    start = i;
691
                }
692
            }
693
            for (name, group) in groups {
694
                let distinct: BTreeSet<NodeId> = group.iter().map(|(_, p)| p.node).collect();
695
                if distinct.len() > 1 {
696
                    view.conflicts.push(TreeConflict::Name {
697
                        parent: dir,
698
                        name: name.to_string(),
699
                        nodes: distinct.iter().copied().collect(),
700
                    });
701
                }
702
                let suffixed = distinct.len() > 1;
703
                for (i, (k, p)) in group.iter().enumerate() {
704
                    let node = p.node;
705
                    if node == dir || on_path.contains(&node) {
706
                        view.conflicts.push(TreeConflict::Cycle { node });
707
                        continue;
708
                    }
709
                    let needs_suffix = suffixed || multi.contains(&node);
710
                    let leaf = if needs_suffix {
711
                        format!("{name}.oxy-conflict-{}", i + 1)
712
                    } else {
713
                        name.to_string()
714
                    };
715
                    let path = if dir_path.is_empty() {
716
                        leaf
717
                    } else {
718
                        format!("{dir_path}/{leaf}")
719
                    };
720
                    let kind = self.kind(&node).unwrap_or(NodeKind::File);
721
                    let (mode_atom, mode) = modes.get(&node).copied().unwrap_or_default();
722
                    entries.insert(
723
                        path.clone(),
724
                        TreeEntry {
725
                            path: path.clone(),
726
                            node,
727
                            kind,
728
                            mode,
729
                            placement: *k,
730
                            mode_atom,
731
                        },
732
                    );
733
                    if kind == NodeKind::Dir && reached.insert(node) {
734
                        on_path.insert(dir);
735
                        queue.push((node, path));
736
                    } else {
737
                        reached.insert(node);
738
                    }
739
                }
740
            }
741
        }
742
743
        // Nodes with live placements that were never reached: orphans or cycles.
744
        for n in &nodes {
745
            if reached.contains(n) {
746
                continue;
747
            }
748
            let lp = self.live_placements(n);
749
            if lp.is_empty() {
750
                continue;
751
            }
752
            let mut seen = HashSet::new();
753
            let mut cur = *n;
754
            let conflict = loop {
755
                if !seen.insert(cur) {
756
                    break TreeConflict::Cycle { node: *n };
757
                }
758
                let lp = self.live_placements(&cur);
759
                let Some((_, p)) = lp.first() else {
760
                    break TreeConflict::Orphan {
761
                        node: *n,
762
                        parent: cur,
763
                    };
764
                };
765
                if reached.contains(&p.parent) {
766
                    // Parent reached but this node was not: the parent is not a
767
                    // directory, so this is a name/kind problem surfaced as orphan.
768
                    break TreeConflict::Orphan {
769
                        node: *n,
770
                        parent: p.parent,
771
                    };
772
                }
773
                cur = p.parent;
774
            };
775
            if !view.conflicts.contains(&conflict) {
776
                view.conflicts.push(conflict);
777
            }
778
        }
779
        view.entries = std::sync::Arc::new(entries);
780
        view
781
    }
782
}
783
784
impl TreeGraph {
785
    /// Serialize for a checkpoint.
786
    pub fn to_value(&self) -> crate::cbor::Value {
787
        use crate::cbor::Value;
788
        let opkey = |k: &OpKey| vec![Value::Bytes(k.0 .0.to_vec()), Value::Uint(k.1 as u64)];
789
        let deleters = |m: &Map<OpKey, BTreeSet<ChangeHash>>| {
790
            let mut ks: Vec<&OpKey> = m.keys().collect();
791
            ks.sort();
792
            Value::Array(
793
                ks.into_iter()
794
                    .map(|k| {
795
                        let mut v = opkey(k);
796
                        v.push(Value::Array(
797
                            m[k].iter().map(|d| Value::Bytes(d.0.to_vec())).collect(),
798
                        ));
799
                        Value::Array(v)
800
                    })
801
                    .collect(),
802
            )
803
        };
804
        let mut nodes: Vec<&NodeId> = self.m().kinds.keys().collect();
805
        nodes.sort();
806
        let mut pks: Vec<&OpKey> = self.m().placements.keys().collect();
807
        pks.sort();
808
        let mut mks: Vec<&OpKey> = self.m().modes.keys().collect();
809
        mks.sort();
810
        Value::map([
811
            (
812
                0,
813
                Value::Array(
814
                    nodes
815
                        .into_iter()
816
                        .map(|n| {
817
                            Value::Array(vec![
818
                                Value::Bytes(n.0.to_vec()),
819
                                Value::Uint(self.m().kinds[n].tag()),
820
                                self.m()
821
                                    .introduced
822
                                    .get(n)
823
                                    .map(|h| Value::Bytes(h.0.to_vec()))
824
                                    .unwrap_or(Value::Null),
825
                            ])
826
                        })
827
                        .collect(),
828
                ),
829
            ),
830
            (
831
                1,
832
                Value::Array(
833
                    pks.into_iter()
834
                        .map(|k| {
835
                            let p = &self.m().placements[k];
836
                            let mut v = opkey(k);
837
                            v.extend([
838
                                Value::Bytes(p.node.0.to_vec()),
839
                                Value::Bytes(p.parent.0.to_vec()),
840
                                Value::Text(p.name.clone()),
841
                            ]);
842
                            Value::Array(v)
843
                        })
844
                        .collect(),
845
                ),
846
            ),
847
            (2, deleters(&self.m().deleted_placements)),
848
            (
849
                3,
850
                Value::Array(
851
                    mks.into_iter()
852
                        .map(|k| {
853
                            let (n, m) = &self.m().modes[k];
854
                            let mut v = opkey(k);
855
                            v.extend([Value::Bytes(n.0.to_vec()), Value::Uint(m.bits())]);
856
                            Value::Array(v)
857
                        })
858
                        .collect(),
859
                ),
860
            ),
861
            (4, deleters(&self.m().deleted_modes)),
862
        ])
863
    }
864
865
    pub fn from_value(v: &crate::cbor::Value) -> Result<TreeGraph, crate::objects::ObjectError> {
866
        use crate::objects::{array, bytes, field, map, oref, text, u32_, uint, ObjectError};
867
        let m = map(v, "tree graph")?;
868
        let node = |v: &crate::cbor::Value| {
869
            NodeId::from_slice(bytes(v, "node")?)
870
                .ok_or_else(|| ObjectError::Schema("node: expected 16 bytes".into()))
871
        };
872
        let opkey = |e: &[crate::cbor::Value]| -> Result<OpKey, ObjectError> {
873
            Ok((oref(&e[0], "op change")?, u32_(&e[1], "op index")?))
874
        };
875
        let mut g = TreeGraph::default();
876
        for n in array(field(m, 0, "nodes")?, "nodes")? {
877
            let e = array(n, "node entry")?;
878
            if e.len() != 3 {
879
                return Err(ObjectError::Schema("node entry: expected 3 fields".into()));
880
            }
881
            let id = node(&e[0])?;
882
            g.m_mut()
883
                .kinds
884
                .insert(id, NodeKind::from_tag(uint(&e[1], "kind")?)?);
885
            if !e[2].is_null() {
886
                g.m_mut().introduced.insert(id, oref(&e[2], "introducer")?);
887
            }
888
        }
889
        for p in array(field(m, 1, "placements")?, "placements")? {
890
            let e = array(p, "placement")?;
891
            if e.len() != 5 {
892
                return Err(ObjectError::Schema("placement: expected 5 fields".into()));
893
            }
894
            let k = opkey(e)?;
895
            let pl = Placement {
896
                node: node(&e[2])?,
897
                parent: node(&e[3])?,
898
                name: text(&e[4], "name")?.to_owned(),
899
            };
900
            g.m_mut()
901
                .placements_of
902
                .entry(pl.node)
903
                .or_default()
904
                .insert(k);
905
            g.m_mut().placements.insert(k, pl);
906
        }
907
        let deleters = |v: &crate::cbor::Value,
908
                        what: &str|
909
         -> Result<Map<OpKey, BTreeSet<ChangeHash>>, ObjectError> {
910
            let mut out = Map::default();
911
            for d in array(v, what)? {
912
                let e = array(d, what)?;
913
                if e.len() != 3 {
914
                    return Err(ObjectError::Schema(format!("{what}: expected 3 fields")));
915
                }
916
                out.insert(
917
                    opkey(e)?,
918
                    array(&e[2], "deleters")?
919
                        .iter()
920
                        .map(|x| oref(x, "deleter"))
921
                        .collect::<Result<BTreeSet<_>, _>>()?,
922
                );
923
            }
924
            Ok(out)
925
        };
926
        g.m_mut().deleted_placements =
927
            deleters(field(m, 2, "deleted placements")?, "deleted placement")?;
928
        for md in array(field(m, 3, "modes")?, "modes")? {
929
            let e = array(md, "mode")?;
930
            if e.len() != 4 {
931
                return Err(ObjectError::Schema("mode: expected 4 fields".into()));
932
            }
933
            let k = opkey(e)?;
934
            let n = node(&e[2])?;
935
            g.m_mut()
936
                .modes
937
                .insert(k, (n, Mode::from_bits(uint(&e[3], "mode bits")?)?));
938
            g.m_mut().modes_of.entry(n).or_default().insert(k);
939
        }
940
        g.m_mut().deleted_modes = deleters(field(m, 4, "deleted modes")?, "deleted mode")?;
941
        let keys: Vec<OpKey> = g.m_mut().placements.keys().copied().collect();
942
        for k in keys {
943
            g.index_placement(k);
944
        }
945
        let keys: Vec<OpKey> = g.m_mut().modes.keys().copied().collect();
946
        for k in keys {
947
            g.index_mode(k);
948
        }
949
        Ok(g)
950
    }
951
}
952
953
/// The tree in the flat layout of a local index (oxygen#41), with its view
954
/// when that has no conflicts, so a loaded tree need not work it out again.
955
impl TreeGraph {
956
    pub(crate) fn write_flat(&self, w: &mut crate::flat::Writer) {
957
        let key = |w: &mut crate::flat::Writer, k: &OpKey| {
958
            w.object(&k.0);
959
            w.u32(k.1);
960
        };
961
        // The maps as a block of their own: a reader keeps it undecoded
962
        // until something needs them.
963
        let outer = std::mem::take(w);
964
        let mut kinds: Vec<(&NodeId, &NodeKind)> = self.m().kinds.iter().collect();
965
        kinds.sort_by_key(|(n, _)| **n);
966
        w.count(kinds.len());
967
        for (n, k) in kinds {
968
            w.fixed(&n.0);
969
            w.u8(k.tag() as u8);
970
        }
971
        let mut intro: Vec<(&NodeId, &ChangeHash)> = self.m().introduced.iter().collect();
972
        intro.sort();
973
        w.count(intro.len());
974
        for (n, c) in intro {
975
            w.fixed(&n.0);
976
            w.object(c);
977
        }
978
        let mut pl: Vec<(&OpKey, &Placement)> = self.m().placements.iter().collect();
979
        pl.sort_by_key(|(k, _)| **k);
980
        w.count(pl.len());
981
        for (k, p) in pl {
982
            key(w, k);
983
            w.fixed(&p.node.0);
984
            w.fixed(&p.parent.0);
985
            w.bytes(p.name.as_bytes());
986
        }
987
        let mut modes: Vec<(&OpKey, &(NodeId, Mode))> = self.m().modes.iter().collect();
988
        modes.sort_by_key(|(k, _)| **k);
989
        w.count(modes.len());
990
        for (k, (n, m)) in modes {
991
            key(w, k);
992
            w.fixed(&n.0);
993
            w.u8(m.bits() as u8);
994
        }
995
        for m in [&self.m().deleted_placements, &self.m().deleted_modes] {
996
            let mut ks: Vec<(&OpKey, &BTreeSet<ChangeHash>)> = m.iter().collect();
997
            ks.sort_by_key(|(k, _)| **k);
998
            w.count(ks.len());
999
            for (k, by) in ks {
1000
                key(w, k);
1001
                w.count(by.len());
1002
                for c in by {
1003
                    w.object(c);
1004
                }
1005
            }
1006
        }
1007
        let maps = std::mem::replace(w, outer);
1008
        w.bytes(&maps.0);
1009
        // The introducers again, alone, for a reader that needs no more.
1010
        let mut iw = crate::flat::Writer::default();
1011
        let mut intro: Vec<(&NodeId, &ChangeHash)> = self.m().introduced.iter().collect();
1012
        intro.sort();
1013
        iw.count(intro.len());
1014
        for (n, c) in intro {
1015
            iw.fixed(&n.0);
1016
            iw.object(c);
1017
        }
1018
        w.bytes(&iw.0);
1019
        // The view as a block of its own.
1020
        let outer = std::mem::take(w);
1021
        let view = self.view();
1022
        if view.conflicts.is_empty() {
1023
            w.u8(1);
1024
            w.count(view.entries.len());
1025
            for (path, e) in view.entries.iter() {
1026
                w.bytes(path.as_bytes());
1027
                w.fixed(&e.node.0);
1028
                w.u8(e.kind.tag() as u8);
1029
                w.u8(e.mode.bits() as u8);
1030
                key(w, &e.placement);
1031
                match &e.mode_atom {
1032
                    None => w.u8(0),
1033
                    Some(k) => {
1034
                        w.u8(1);
1035
                        key(w, k);
1036
                    }
1037
                }
1038
            }
1039
        } else {
1040
            w.u8(0);
1041
        }
1042
        let view_bytes = std::mem::replace(w, outer);
1043
        w.bytes(&view_bytes.0);
1044
    }
1045
1046
    pub(crate) fn read_flat(
1047
        r: &mut crate::flat::Reader,
1048
    ) -> Result<TreeGraph, crate::objects::ObjectError> {
1049
        let maps = r.bytes()?;
1050
        let introduced = r.bytes()?;
1051
        let view = Self::read_view(r.bytes()?)?;
1052
        let mut g = TreeGraph {
1053
            raw: Some(std::sync::Arc::new(maps.to_vec())),
1054
            raw_introduced: Some(std::sync::Arc::new(introduced.to_vec())),
1055
            ..TreeGraph::default()
1056
        };
1057
        if let Some(view) = view {
1058
            // Checked on a copy, so the graph itself stays undecoded.
1059
            #[cfg(test)]
1060
            assert_eq!(
1061
                view,
1062
                TreeGraph {
1063
                    raw: g.raw.clone(),
1064
                    ..TreeGraph::default()
1065
                }
1066
                .compute_view(),
1067
                "an index's view is the tree's"
1068
            );
1069
            g.view_cache = std::sync::OnceLock::from(CachedView::new(view));
1070
        }
1071
        Ok(g)
1072
    }
1073
}
1074
1075
impl TreeMaps {
1076
    /// The maps block of a tree's flat form.
1077
    fn decode(bytes: &[u8]) -> Result<TreeMaps, crate::objects::ObjectError> {
1078
        use crate::objects::ObjectError;
1079
        let _t = crate::timing::phase("index: tree maps");
1080
        let node = |r: &mut crate::flat::Reader| -> Result<NodeId, ObjectError> {
1081
            Ok(NodeId(r.fixed::<16>()?))
1082
        };
1083
        let key = |r: &mut crate::flat::Reader| -> Result<OpKey, ObjectError> {
1084
            Ok((r.object()?, r.u32()?))
1085
        };
1086
        let r = &mut crate::flat::Reader::new(bytes);
1087
        let mut g = TreeGraph::new();
1088
        for _ in 0..r.count()? {
1089
            let n = node(r)?;
1090
            g.m_mut()
1091
                .kinds
1092
                .insert(n, NodeKind::from_tag(r.u8()? as u64)?);
1093
        }
1094
        for _ in 0..r.count()? {
1095
            let n = node(r)?;
1096
            g.m_mut().introduced.insert(n, r.object()?);
1097
        }
1098
        for _ in 0..r.count()? {
1099
            let k = key(r)?;
1100
            let p = Placement {
1101
                node: node(r)?,
1102
                parent: node(r)?,
1103
                name: r.text()?,
1104
            };
1105
            g.m_mut().placements_of.entry(p.node).or_default().insert(k);
1106
            g.m_mut().placements.insert(k, p);
1107
        }
1108
        for _ in 0..r.count()? {
1109
            let k = key(r)?;
1110
            let n = node(r)?;
1111
            g.m_mut()
1112
                .modes
1113
                .insert(k, (n, Mode::from_bits(r.u8()? as u64)?));
1114
            g.m_mut().modes_of.entry(n).or_default().insert(k);
1115
        }
1116
        for i in 0..2 {
1117
            let mut m: Map<OpKey, BTreeSet<ChangeHash>> = Map::default();
1118
            for _ in 0..r.count()? {
1119
                let k = key(r)?;
1120
                let mut by = BTreeSet::new();
1121
                for _ in 0..r.count()? {
1122
                    by.insert(r.object()?);
1123
                }
1124
                m.insert(k, by);
1125
            }
1126
            if i == 0 {
1127
                g.m_mut().deleted_placements = m;
1128
            } else {
1129
                g.m_mut().deleted_modes = m;
1130
            }
1131
        }
1132
        if !r.at_end() {
1133
            return Err(ObjectError::Schema("state index: tree maps".into()));
1134
        }
1135
        let keys: Vec<OpKey> = g.m().placements.keys().copied().collect();
1136
        for k in keys {
1137
            g.index_placement(k);
1138
        }
1139
        let keys: Vec<OpKey> = g.m().modes.keys().copied().collect();
1140
        for k in keys {
1141
            g.index_mode(k);
1142
        }
1143
        Ok(g.maps.into_inner().unwrap_or_default())
1144
    }
1145
}
1146
1147
impl TreeGraph {
1148
    /// The view block of a tree's flat form, when it holds one.
1149
    fn read_view(bytes: &[u8]) -> Result<Option<TreeView>, crate::objects::ObjectError> {
1150
        let _t = crate::timing::phase("index: view");
1151
        let mut r = crate::flat::Reader::new(bytes);
1152
        if r.u8()? != 1 {
1153
            return Ok(None);
1154
        }
1155
        let key = |r: &mut crate::flat::Reader| -> Result<OpKey, crate::objects::ObjectError> {
1156
            Ok((r.object()?, r.u32()?))
1157
        };
1158
        let n = r.count()?;
1159
        // Collected, then built in one step: the map is made from sorted
1160
        // input in a single pass rather than by searching for each insert.
1161
        let mut entries = Vec::with_capacity(n);
1162
        for _ in 0..n {
1163
            let path = r.text()?;
1164
            let e = TreeEntry {
1165
                path: path.clone(),
1166
                node: NodeId(r.fixed::<16>()?),
1167
                kind: NodeKind::from_tag(r.u8()? as u64)?,
1168
                mode: Mode::from_bits(r.u8()? as u64)?,
1169
                placement: key(&mut r)?,
1170
                mode_atom: match r.u8()? {
1171
                    0 => None,
1172
                    _ => Some(key(&mut r)?),
1173
                },
1174
            };
1175
            entries.push((path, e));
1176
        }
1177
        Ok(Some(TreeView {
1178
            entries: std::sync::Arc::new(entries.into_iter().collect()),
1179
            conflicts: Vec::new(),
1180
        }))
1181
    }
1182
}
1183
1184
/// The introducers block of a tree's flat form.
1185
fn read_introduced(bytes: &[u8]) -> Result<Map<NodeId, ChangeHash>, crate::objects::ObjectError> {
1186
    let r = &mut crate::flat::Reader::new(bytes);
1187
    let n = r.count()?;
1188
    let mut m = Map::default();
1189
    m.reserve(n);
1190
    for _ in 0..n {
1191
        let node = NodeId(r.fixed::<16>()?);
1192
        m.insert(node, r.object()?);
1193
    }
1194
    Ok(m)
1195
}
1196
1197
fn join(dir: &str, name: &str) -> String {
1198
    if dir.is_empty() {
1199
        name.to_string()
1200
    } else {
1201
        format!("{dir}/{name}")
1202
    }
1203
}
1204
1205
pub fn op_key(r: OpRef) -> OpKey {
1206
    (r.change, r.index)
1207
}
1208
1209
#[cfg(test)]
1210
mod tests {
1211
    use super::*;
1212
    use crate::hash::ObjectRef;
1213
1214
    fn h(n: u8) -> ChangeHash {
1215
        ObjectRef([n; 32])
1216
    }
1217
    fn nid(n: u8) -> NodeId {
1218
        NodeId([n; 16])
1219
    }
1220
    fn add(g: &mut TreeGraph, c: u8, i: u32, node: u8, kind: NodeKind, parent: NodeId, name: &str) {
1221
        g.apply(
1222
            h(c),
1223
            i,
1224
            &TreeOp::AddNode {
1225
                node: nid(node),
1226
                kind,
1227
                mode: Mode::TEXT,
1228
                parent,
1229
                name: name.into(),
1230
            },
1231
        );
1232
    }
1233
    fn paths(v: &TreeView) -> Vec<String> {
1234
        v.entries.keys().cloned().collect()
1235
    }
1236
1237
    /// Each op applied to a graph whose view is cached keeps it up to date
1238
    /// or drops it: `apply` checks every kept view against a full one.
1239
    #[test]
1240
    fn cached_view_follows_ops() {
1241
        let at = |c: u8, i: u32| OpRef {
1242
            change: h(c),
1243
            index: i,
1244
        };
1245
        let mut g = TreeGraph::new();
1246
        let ops = [
1247
            TreeOp::AddNode {
1248
                node: nid(1),
1249
                kind: NodeKind::Dir,
1250
                mode: Mode::TEXT,
1251
                parent: NodeId::ROOT,
1252
                name: "src".into(),
1253
            },
1254
            TreeOp::AddNode {
1255
                node: nid(2),
1256
                kind: NodeKind::File,
1257
                mode: Mode::TEXT,
1258
                parent: nid(1),
1259
                name: "a.rs".into(),
1260
            },
1261
            TreeOp::SetMode {
1262
                node: nid(2),
1263
                old: at(1, 1),
1264
                mode: Mode {
1265
                    exec: true,
1266
                    opaque: false,
1267
                },
1268
            },
1269
            TreeOp::Move {
1270
                node: nid(2),
1271
                old: at(1, 1),
1272
                parent: NodeId::ROOT,
1273
                name: "b.rs".into(),
1274
            },
1275
            // Moving an empty directory, then removing it.
1276
            TreeOp::Move {
1277
                node: nid(1),
1278
                old: at(1, 0),
1279
                parent: NodeId::ROOT,
1280
                name: "lib".into(),
1281
            },
1282
            TreeOp::RemoveNode {
1283
                node: nid(1),
1284
                placement: at(1, 4),
1285
            },
1286
            // A name taken twice: a conflict, so the view is computed again.
1287
            TreeOp::AddNode {
1288
                node: nid(3),
1289
                kind: NodeKind::File,
1290
                mode: Mode::TEXT,
1291
                parent: NodeId::ROOT,
1292
                name: "b.rs".into(),
1293
            },
1294
        ];
1295
        for (i, op) in ops.iter().enumerate() {
1296
            let _ = g.view();
1297
            g.apply(h(1), i as u32, op);
1298
            assert_eq!(g.view(), g.compute_view());
1299
        }
1300
        let v = g.view();
1301
        assert_eq!(paths(&v), ["b.rs.oxy-conflict-1", "b.rs.oxy-conflict-2"]);
1302
        assert!(v.entries.values().any(|e| e.mode.exec));
1303
    }
1304
1305
    #[test]
1306
    fn nested_paths_and_rename() {
1307
        let mut g = TreeGraph::new();
1308
        add(&mut g, 1, 0, 1, NodeKind::Dir, NodeId::ROOT, "src");
1309
        add(&mut g, 1, 1, 2, NodeKind::File, nid(1), "main.rs");
1310
        add(&mut g, 1, 2, 3, NodeKind::File, NodeId::ROOT, "README");
1311
        let v = g.view();
1312
        assert_eq!(paths(&v), ["README", "src", "src/main.rs"]);
1313
        assert!(!v.is_conflicted());
1314
1315
        // Rename src/main.rs → src/lib.rs, move src → lib (subtree follows).
1316
        g.apply(
1317
            h(2),
1318
            0,
1319
            &TreeOp::Move {
1320
                node: nid(2),
1321
                old: OpRef {
1322
                    change: h(1),
1323
                    index: 1,
1324
                },
1325
                parent: nid(1),
1326
                name: "lib.rs".into(),
1327
            },
1328
        );
1329
        g.apply(
1330
            h(2),
1331
            1,
1332
            &TreeOp::Move {
1333
                node: nid(1),
1334
                old: OpRef {
1335
                    change: h(1),
1336
                    index: 0,
1337
                },
1338
                parent: NodeId::ROOT,
1339
                name: "lib".into(),
1340
            },
1341
        );
1342
        let v = g.view();
1343
        assert_eq!(paths(&v), ["README", "lib", "lib/lib.rs"]);
1344
        assert_eq!(v.entries["lib/lib.rs"].placement, (h(2), 0));
1345
1346
        g.apply(
1347
            h(3),
1348
            0,
1349
            &TreeOp::RemoveNode {
1350
                node: nid(3),
1351
                placement: OpRef {
1352
                    change: h(1),
1353
                    index: 2,
1354
                },
1355
            },
1356
        );
1357
        assert_eq!(paths(&g.view()), ["lib", "lib/lib.rs"]);
1358
    }
1359
1360
    #[test]
1361
    fn name_conflict_gets_suffixes() {
1362
        let mut g = TreeGraph::new();
1363
        add(&mut g, 1, 0, 1, NodeKind::File, NodeId::ROOT, "a.txt");
1364
        add(&mut g, 2, 0, 2, NodeKind::File, NodeId::ROOT, "a.txt");
1365
        let v = g.view();
1366
        assert_eq!(paths(&v), ["a.txt.oxy-conflict-1", "a.txt.oxy-conflict-2"]);
1367
        assert_eq!(
1368
            v.conflicts,
1369
            vec![TreeConflict::Name {
1370
                parent: NodeId::ROOT,
1371
                name: "a.txt".into(),
1372
                nodes: vec![nid(1), nid(2)]
1373
            }]
1374
        );
1375
    }
1376
1377
    #[test]
1378
    fn concurrent_renames_are_multi_placement() {
1379
        let mut g = TreeGraph::new();
1380
        add(&mut g, 1, 0, 1, NodeKind::File, NodeId::ROOT, "a");
1381
        g.apply(
1382
            h(2),
1383
            0,
1384
            &TreeOp::Move {
1385
                node: nid(1),
1386
                old: OpRef {
1387
                    change: h(1),
1388
                    index: 0,
1389
                },
1390
                parent: NodeId::ROOT,
1391
                name: "b".into(),
1392
            },
1393
        );
1394
        g.apply(
1395
            h(3),
1396
            0,
1397
            &TreeOp::Move {
1398
                node: nid(1),
1399
                old: OpRef {
1400
                    change: h(1),
1401
                    index: 0,
1402
                },
1403
                parent: NodeId::ROOT,
1404
                name: "c".into(),
1405
            },
1406
        );
1407
        let v = g.view();
1408
        assert_eq!(paths(&v), ["b.oxy-conflict-1", "c.oxy-conflict-1"]);
1409
        assert!(
1410
            matches!(v.conflicts[0], TreeConflict::MultiPlacement { node, .. } if node == nid(1))
1411
        );
1412
    }
1413
1414
    #[test]
1415
    fn orphan_and_cycle() {
1416
        let mut g = TreeGraph::new();
1417
        add(&mut g, 1, 0, 1, NodeKind::Dir, NodeId::ROOT, "d");
1418
        add(&mut g, 1, 1, 2, NodeKind::File, nid(1), "f");
1419
        // Concurrently: 2 removes d, 3 adds d/g.
1420
        g.apply(
1421
            h(2),
1422
            0,
1423
            &TreeOp::RemoveNode {
1424
                node: nid(1),
1425
                placement: OpRef {
1426
                    change: h(1),
1427
                    index: 0,
1428
                },
1429
            },
1430
        );
1431
        add(&mut g, 3, 0, 3, NodeKind::File, nid(1), "g");
1432
        let v = g.view();
1433
        assert_eq!(paths(&v), Vec::<String>::new());
1434
        assert!(v.conflicts.contains(&TreeConflict::Orphan {
1435
            node: nid(2),
1436
            parent: nid(1)
1437
        }));
1438
        assert!(v.conflicts.contains(&TreeConflict::Orphan {
1439
            node: nid(3),
1440
            parent: nid(1)
1441
        }));
1442
1443
        // Cycle: a/b, then concurrently move a under b and b under a's parent... simplest: move a into b.
1444
        let mut g = TreeGraph::new();
1445
        add(&mut g, 1, 0, 1, NodeKind::Dir, NodeId::ROOT, "a");
1446
        add(&mut g, 1, 1, 2, NodeKind::Dir, nid(1), "b");
1447
        g.apply(
1448
            h(2),
1449
            0,
1450
            &TreeOp::Move {
1451
                node: nid(1),
1452
                old: OpRef {
1453
                    change: h(1),
1454
                    index: 0,
1455
                },
1456
                parent: nid(2),
1457
                name: "a".into(),
1458
            },
1459
        );
1460
        let v = g.view();
1461
        assert!(
1462
            v.conflicts
1463
                .iter()
1464
                .any(|c| matches!(c, TreeConflict::Cycle { .. })),
1465
            "{:?}",
1466
            v.conflicts
1467
        );
1468
    }
1469
1470
    #[test]
1471
    fn serialization_round_trip() {
1472
        let mut g = TreeGraph::new();
1473
        add(&mut g, 1, 0, 1, NodeKind::Dir, NodeId::ROOT, "src");
1474
        add(&mut g, 1, 1, 2, NodeKind::File, nid(1), "main.rs");
1475
        g.apply(
1476
            h(2),
1477
            0,
1478
            &TreeOp::Move {
1479
                node: nid(2),
1480
                old: OpRef {
1481
                    change: h(1),
1482
                    index: 1,
1483
                },
1484
                parent: nid(1),
1485
                name: "lib.rs".into(),
1486
            },
1487
        );
1488
        g.apply(
1489
            h(3),
1490
            0,
1491
            &TreeOp::SetMode {
1492
                node: nid(2),
1493
                old: OpRef {
1494
                    change: h(1),
1495
                    index: 1,
1496
                },
1497
                mode: Mode {
1498
                    exec: true,
1499
                    opaque: false,
1500
                },
1501
            },
1502
        );
1503
        let bytes = crate::cbor::encode(&g.to_value());
1504
        let back = TreeGraph::from_value(&crate::cbor::decode(&bytes).unwrap()).unwrap();
1505
        assert_eq!(back.view(), g.view());
1506
        assert_eq!(back.introducer(&nid(2)), Some(h(1)));
1507
        assert_eq!(crate::cbor::encode(&back.to_value()), bytes);
1508
    }
1509
1510
    #[test]
1511
    fn mode_conflict_and_resolution() {
1512
        let mut g = TreeGraph::new();
1513
        add(&mut g, 1, 0, 1, NodeKind::File, NodeId::ROOT, "run.sh");
1514
        g.apply(
1515
            h(2),
1516
            0,
1517
            &TreeOp::SetMode {
1518
                node: nid(1),
1519
                old: OpRef {
1520
                    change: h(1),
1521
                    index: 0,
1522
                },
1523
                mode: Mode {
1524
                    exec: true,
1525
                    opaque: false,
1526
                },
1527
            },
1528
        );
1529
        g.apply(
1530
            h(3),
1531
            0,
1532
            &TreeOp::SetMode {
1533
                node: nid(1),
1534
                old: OpRef {
1535
                    change: h(1),
1536
                    index: 0,
1537
                },
1538
                mode: Mode {
1539
                    exec: false,
1540
                    opaque: true,
1541
                },
1542
            },
1543
        );
1544
        let v = g.view();
1545
        assert!(matches!(v.conflicts[0], TreeConflict::Mode { .. }));
1546
        // Materialized with the greatest mode atom.
1547
        assert_eq!(
1548
            v.entries["run.sh"].mode,
1549
            Mode {
1550
                exec: false,
1551
                opaque: true
1552
            }
1553
        );
1554
        // The placement introduced by the same AddNode is unaffected.
1555
        assert_eq!(v.entries["run.sh"].placement, (h(1), 0));
1556
        // Resolution: retire both live mode atoms; identical live values do not conflict.
1557
        g.apply(
1558
            h(4),
1559
            0,
1560
            &TreeOp::SetMode {
1561
                node: nid(1),
1562
                old: OpRef {
1563
                    change: h(2),
1564
                    index: 0,
1565
                },
1566
                mode: Mode {
1567
                    exec: true,
1568
                    opaque: false,
1569
                },
1570
            },
1571
        );
1572
        g.apply(
1573
            h(4),
1574
            1,
1575
            &TreeOp::SetMode {
1576
                node: nid(1),
1577
                old: OpRef {
1578
                    change: h(3),
1579
                    index: 0,
1580
                },
1581
                mode: Mode {
1582
                    exec: true,
1583
                    opaque: false,
1584
                },
1585
            },
1586
        );
1587
        let v = g.view();
1588
        assert!(!v.is_conflicted(), "{:?}", v.conflicts);
1589
        assert_eq!(
1590
            v.entries["run.sh"].mode,
1591
            Mode {
1592
                exec: true,
1593
                opaque: false
1594
            }
1595
        );
1596
    }
1597
}