sapling-dag 0.1.0

An implementation of a DAG used for source control.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

use std::sync::Arc;

use crate::dag::AbstractDag;
use crate::lifecycle::LifecycleId;
use crate::IdDag;
use crate::IdDagStore;

/// State to build a new `AbstractDag`.
pub struct DagBuilder<M, D, P, S> {
    map: M,
    dag: D,
    path: P,
    state: S,
    id: String,
}

impl<M, D> DagBuilder<M, D, (), ()> {
    /// Create the builder with specified `IdMap` and `IdDag`.
    ///
    /// The callsite must ensure the `IdMap` and `IdMap` are
    /// in sync.
    pub fn new_with_idmap_dag(map: M, dag: D) -> Self {
        Self {
            map,
            dag,
            path: (),
            id: String::new(),
            state: (),
        }
    }
}

impl<M, D, P, S> DagBuilder<M, D, P, S> {
    /// Set the `path`, used to re-open the `Dag`.
    pub fn with_path<P2>(self, path: P2) -> DagBuilder<M, D, P2, S> {
        DagBuilder {
            map: self.map,
            dag: self.dag,
            path,
            id: self.id,
            state: self.state,
        }
    }

    /// Set the `state`, additional state maintained used by the callsite.
    pub fn with_state<S2>(self, state: S2) -> DagBuilder<M, D, P, S2> {
        DagBuilder {
            map: self.map,
            dag: self.dag,
            path: self.path,
            id: self.id,
            state,
        }
    }

    /// Set the `id`, used for debugging.
    pub fn with_id(self, id: String) -> DagBuilder<M, D, P, S> {
        DagBuilder {
            map: self.map,
            dag: self.dag,
            path: self.path,
            id,
            state: self.state,
        }
    }
}

impl<IS, M, P, S> DagBuilder<M, IdDag<IS>, P, S>
where
    M: Send + Sync,
    IS: IdDagStore,
    P: Send + Sync,
    S: Send + Sync,
{
    /// Build the `AbstractDag`.
    pub fn build(self) -> crate::Result<AbstractDag<IdDag<IS>, M, P, S>> {
        let persisted_id_set = self.dag.all()?;
        let overlay_map_id_set = self.dag.master_group()?;
        let dag = AbstractDag {
            dag: self.dag,
            map: self.map,
            path: self.path,
            state: self.state,
            id: self.id,

            snapshot: Default::default(),
            pending_heads: Default::default(),
            persisted_id_set,
            overlay_map: Default::default(),
            overlay_map_id_set,
            overlay_map_paths: Default::default(),
            remote_protocol: Arc::new(()),
            managed_virtual_group: None,

            missing_vertexes_confirmed_by_remote: Default::default(),

            lifecycle_id: LifecycleId::new_with_type_name("Dag"),
            internal_stats: Default::default(),
        };
        Ok(dag)
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::*;
    use crate::iddag::IdDag;
    use crate::idmap::MemIdMap;
    use crate::ops::DagAddHeads;
    use crate::VertexListWithOptions;

    #[tokio::test]
    async fn test_builder_absent_path_state_can_use_add_heads() {
        let dag = IdDag::new_in_memory();
        let map = MemIdMap::new();
        let builder = DagBuilder::new_with_idmap_dag(map, dag);
        let mut dag = builder.build().unwrap();
        dag.add_heads(&HashMap::new(), &VertexListWithOptions::default())
            .await
            .unwrap();
    }
}