lix 0.12.0

Embeddable version control for apps and AI agents.
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

use std::collections::HashMap;
use std::sync::Arc;

use async_trait::async_trait;
use tokio::sync::Mutex;

use crate::LixError;
use crate::branch::{BranchHead, BranchRefReader};

/// Statement-scoped branch-ref reader that avoids resolving the same branch
/// head through the storage more than once.
pub(super) struct CachingBranchRefReader {
    inner: Arc<dyn BranchRefReader>,
    heads: Mutex<HashMap<String, Option<BranchHead>>>,
}

impl CachingBranchRefReader {
    pub(super) fn new(inner: Arc<dyn BranchRefReader>) -> Self {
        Self {
            inner,
            heads: Mutex::new(HashMap::new()),
        }
    }

    pub(super) fn with_head(inner: Arc<dyn BranchRefReader>, head: BranchHead) -> Self {
        Self {
            inner,
            heads: Mutex::new(HashMap::from([(head.branch_id.clone(), Some(head))])),
        }
    }
}

#[async_trait]
impl BranchRefReader for CachingBranchRefReader {
    async fn load_head(&self, branch_id: &str) -> Result<Option<BranchHead>, LixError> {
        let mut heads = self.heads.lock().await;
        if let Some(head) = heads.get(branch_id) {
            return Ok(head.clone());
        }

        let head = self.inner.load_head(branch_id).await?;
        heads.insert(branch_id.to_string(), head.clone());
        Ok(head)
    }

    async fn scan_heads(&self) -> Result<Vec<BranchHead>, LixError> {
        let mut cache = self.heads.lock().await;
        let heads = self.inner.scan_heads().await?;
        for head in &heads {
            cache.insert(head.branch_id.clone(), Some(head.clone()));
        }
        Ok(heads)
    }
}

#[cfg(test)]
mod tests {
    use std::sync::atomic::{AtomicUsize, Ordering};

    use super::*;
    use crate::changelog::CommitId;

    struct CountingBranchRefReader {
        heads: Vec<BranchHead>,
        load_count: AtomicUsize,
        scan_count: AtomicUsize,
    }

    impl CountingBranchRefReader {
        fn new(heads: Vec<BranchHead>) -> Self {
            Self {
                heads,
                load_count: AtomicUsize::new(0),
                scan_count: AtomicUsize::new(0),
            }
        }
    }

    #[async_trait]
    impl BranchRefReader for CountingBranchRefReader {
        async fn load_head(&self, branch_id: &str) -> Result<Option<BranchHead>, LixError> {
            self.load_count.fetch_add(1, Ordering::Relaxed);
            Ok(self
                .heads
                .iter()
                .find(|head| head.branch_id == branch_id)
                .cloned())
        }

        async fn scan_heads(&self) -> Result<Vec<BranchHead>, LixError> {
            self.scan_count.fetch_add(1, Ordering::Relaxed);
            Ok(self.heads.clone())
        }
    }

    fn head(branch_id: &str, commit_id: &str) -> BranchHead {
        BranchHead {
            branch_id: branch_id.to_string(),
            commit_id: CommitId::for_test_label(commit_id),
        }
    }

    #[tokio::test]
    async fn repeated_load_head_uses_underlying_reader_once() {
        let inner = Arc::new(CountingBranchRefReader::new(vec![head(
            "01920000-0000-7000-8000-0000000000a1",
            "commit-a",
        )]));
        let cached = CachingBranchRefReader::new(inner.clone());

        assert_eq!(
            cached
                .load_head("01920000-0000-7000-8000-0000000000a1")
                .await
                .unwrap(),
            Some(head("01920000-0000-7000-8000-0000000000a1", "commit-a"))
        );
        assert_eq!(
            cached
                .load_head("01920000-0000-7000-8000-0000000000a1")
                .await
                .unwrap(),
            Some(head("01920000-0000-7000-8000-0000000000a1", "commit-a"))
        );
        assert_eq!(inner.load_count.load(Ordering::Relaxed), 1);
    }

    #[tokio::test]
    async fn missing_load_head_is_cached_as_none() {
        let inner = Arc::new(CountingBranchRefReader::new(Vec::new()));
        let cached = CachingBranchRefReader::new(inner.clone());

        assert_eq!(cached.load_head("missing").await.unwrap(), None);
        assert_eq!(cached.load_head("missing").await.unwrap(), None);
        assert_eq!(inner.load_count.load(Ordering::Relaxed), 1);
    }

    #[tokio::test]
    async fn scan_heads_seeds_load_head_cache() {
        let inner = Arc::new(CountingBranchRefReader::new(vec![head(
            "01920000-0000-7000-8000-0000000000a1",
            "commit-a",
        )]));
        let cached = CachingBranchRefReader::new(inner.clone());

        assert_eq!(
            cached.scan_heads().await.unwrap(),
            vec![head("01920000-0000-7000-8000-0000000000a1", "commit-a")]
        );
        assert_eq!(
            cached
                .load_head("01920000-0000-7000-8000-0000000000a1")
                .await
                .unwrap(),
            Some(head("01920000-0000-7000-8000-0000000000a1", "commit-a"))
        );
        assert_eq!(inner.scan_count.load(Ordering::Relaxed), 1);
        assert_eq!(inner.load_count.load(Ordering::Relaxed), 0);
    }
}