OXYGENHUB

Coverage / crates/oxy-core/src/repo/config.rs 83.3%

195 of 234 lines run, 38 of 64 functions · run #365 on main · run missed

1
//! Layered configuration: defaults, the user file, the repository file.
2
3
use super::*;
4
5
/// Effective settings: defaults, then the user file (`~/.config/oxy/config.toml`,
6
/// spec §19), then the repository file (`.oxy/config`). Both files are
7
/// `key = "value"` lines. `save` writes only the repository layer.
8
#[derive(Clone, Debug, PartialEq, Eq)]
9
pub struct Config {
10
    /// Keys set in the repository file (or via `set`), written by `save`.
11
    repo_layer: BTreeMap<String, String>,
12
    pub author_name: String,
13
    pub author_email: String,
14
    /// The KeyId of the author's identity, once `create_identity` has run.
15
    pub author_key: Option<KeyId>,
16
    /// `author.signer` (or `$OXY_SIGNER`): the key that signs and seals in
17
    /// place of `author.key`, whose identity lists it as a delegate. An
18
    /// agent sets it to its own key, so its changes carry the human as
19
    /// author and the agent's signature (spec §14.2, agent workflows §2).
20
    pub signer_key: Option<KeyId>,
21
    /// `author.signer = "keyless"`: sign with fresh keys the hub certifies
22
    /// under the agent's grant, keeping no key on disk (spec §14.7,
23
    /// oxygenhub#241).
24
    pub signer_keyless: bool,
25
    /// `keyless.hub`: the hub that certifies them (default: the default
26
    /// remote's hub).
27
    pub keyless_hub: Option<String>,
28
    /// `core.sign`: sign every change at commit (`true`) or leave signing to
29
    /// push-time seals (`false`, the spec default).
30
    pub sign_changes: bool,
31
    pub bookmark: String,
32
    /// `remote.<name>.url`.
33
    pub remotes: BTreeMap<String, String>,
34
    /// `remote.<name>.token`: bearer token for HTTP pushes.
35
    pub remote_tokens: BTreeMap<String, String>,
36
    /// `remote.<name>.ca`: PEM file of extra roots to trust for that remote.
37
    pub remote_cas: BTreeMap<String, String>,
38
    /// `core.remote`: the remote `pull`, `fetch` and `push` use when none is
39
    /// named, for a repository whose remotes include no `origin`.
40
    pub default_remote: Option<String>,
41
    /// `git.claim`: a Git import authors the commits whose Git author email
42
    /// is this repository's identity's with its key (oxygen#97).
43
    pub git_claim: bool,
44
    /// `core.op-retention`: days for which operations keep their states reachable (spec §12.1, §21).
45
    pub op_retention_days: u64,
46
    /// `core.gc-grace`: days an unreachable object survives, protecting concurrent writers (spec §21).
47
    pub gc_grace_days: u64,
48
    /// `core.snapshot-retention`: days for which past operations keep their
49
    /// working copies reachable (oxygen#98); each workspace's current one is
50
    /// always kept. A file only ever in a working copy goes with it.
51
    pub snapshot_retention_days: u64,
52
    /// `snapshot.max-new-file-size`: a new, untracked file larger than this
53
    /// is left out of working-copy snapshots and named instead (oxygen#98);
54
    /// 0 takes in files of any size.
55
    pub max_new_file: u64,
56
    /// `core.checkpoint-interval`: changes between automatic checkpoints (spec §11).
57
    pub checkpoint_interval: u64,
58
    /// `push.batch-bytes`: about how many bytes of changes and their texts
59
    /// one request of a long push carries (spec §16.3).
60
    pub push_batch_bytes: u64,
61
    /// `filter.max-blob`: blobs larger than this many bytes are fetched lazily (spec §17).
62
    pub max_blob: Option<u64>,
63
    /// `filter.paths`: only these subtrees are materialized (spec §17); empty means everything.
64
    pub sparse_paths: Vec<String>,
65
    /// `hooks.semantic-deps`: run the semantic-deps hook at commit (spec §20).
66
    pub semantic_deps: bool,
67
    /// `revset.<name>`: a saved revset, used as `name()`.
68
    pub revsets: BTreeMap<String, String>,
69
    /// `storage.url`: the store the repository's objects and operation
70
    /// head are kept on (`dir://`, `s3://`, …) instead of `.oxy/objects`
71
    /// (oxygen#68).
72
    pub storage_url: Option<String>,
73
    /// `storage.cache`: the most the local cache in front of that store
74
    /// holds, in bytes.
75
    pub storage_cache: u64,
76
}
77
78
impl Config {
79
    /// Whether the repository's own file sets `key` (as against the user
80
    /// config or a default).
812×
    pub fn is_repo_set(&self, key: &str) -> bool {
822×
        self.repo_layer.contains_key(key)
832×
    }
84
853140×
    pub(super) fn default_for_user() -> Config {
863140×
        let user = std::env::var("USER").unwrap_or_else(|_| "unknown".into());
87
        Config {
883140×
            repo_layer: BTreeMap::new(),
893140×
            author_name: std::env::var("OXY_AUTHOR_NAME").unwrap_or_else(|_| user.clone()),
903140×
            author_email: std::env::var("OXY_AUTHOR_EMAIL")
913140×
                .unwrap_or_else(|_| format!("{user}@localhost")),
923140×
            author_key: None,
933140×
            signer_key: std::env::var("OXY_SIGNER")
943140×
                .ok()
953140×
                .and_then(|v| KeyId::from_hex(&v)),
963140×
            signer_keyless: std::env::var("OXY_SIGNER").is_ok_and(|v| v == "keyless"),
973140×
            keyless_hub: None,
98
            sign_changes: false,
993140×
            bookmark: "main".into(),
1003140×
            remotes: BTreeMap::new(),
1013140×
            remote_tokens: BTreeMap::new(),
1023140×
            remote_cas: BTreeMap::new(),
1033140×
            default_remote: None,
104
            git_claim: false,
105
            op_retention_days: 90,
106
            gc_grace_days: 14,
1073140×
            max_new_file: 100 << 20,
108
            snapshot_retention_days: 7,
109
            checkpoint_interval: 256,
1103140×
            push_batch_bytes: 256 << 20,
1113140×
            max_blob: None,
1123140×
            sparse_paths: Vec::new(),
113
            semantic_deps: false,
1143140×
            revsets: BTreeMap::new(),
1153140×
            storage_url: None,
116
            storage_cache: DEFAULT_STORAGE_CACHE,
117
        }
1183140×
    }
119
120
    /// Set a key in the repository layer, as `oxy config` does.
121516×
    pub fn set(&mut self, key: &str, value: &str) -> Result<()> {
122516×
        self.apply(key, value)?;
123516×
        if value.is_empty() {
1244×
            self.repo_layer.remove(key);
125512×
        } else {
126512×
            self.repo_layer.insert(key.to_string(), value.to_string());
127512×
        }
128516×
        Ok(())
129516×
    }
130
131
    /// Set a key in the user file without touching any repository.
132178×
    pub fn set_user(user_path: &Path, key: &str, value: &str) -> Result<()> {
133178×
        Config::default_for_user().apply(key, value)?;
134177×
        let mut entries = read_config_file(user_path)?;
135177×
        if value.is_empty() {
1360×
            entries.remove(key);
137177×
        } else {
138177×
            entries.insert(key.to_string(), value.to_string());
139177×
        }
140177×
        if let Some(parent) = user_path.parent() {
141177×
            fs::create_dir_all(parent)?;
1420×
        }
143177×
        write_config_file(user_path, &entries)
144178×
    }
145
146
    /// Apply a key to the effective values.
1471891×
    pub(super) fn apply(&mut self, key: &str, value: &str) -> Result<()> {
1483×
        match key {
1491891×
            "author.name" => self.author_name = value.into(),
1501563×
            "author.email" => self.author_email = value.into(),
1511235×
            "author.key" => {
152334×
                self.author_key = if value.is_empty() {
1530×
                    None
154
                } else {
155334×
                    Some(KeyId::from_hex(value).ok_or_else(|| {
1560×
                        RepoError::Msg("author.key must be a 64-character hex KeyId".into())
1570×
                    })?)
158
                }
159
            }
160901×
            "author.signer" => {
16119×
                self.signer_keyless = value == "keyless";
16219×
                self.signer_key = if value.is_empty() || self.signer_keyless {
1632×
                    None
164
                } else {
16517×
                    Some(KeyId::from_hex(value).ok_or_else(|| {
1660×
                        RepoError::Msg(
1670×
                            "author.signer must be a 64-character hex KeyId, or \"keyless\"".into(),
1680×
                        )
1690×
                    })?)
170
                }
171
            }
172882×
            "core.sign" => {
17395×
                self.sign_changes = match value {
17495×
                    "change" => true,
175
                    // Empty: unset, the default.
1767×
                    "seal" | "" => false,
1770×
                    _ => return fail("core.sign must be \"change\" or \"seal\""),
178
                }
179
            }
180787×
            "workspace.bookmark" => self.bookmark = value.into(),
181783×
            "keyless.hub" => self.keyless_hub = (!value.is_empty()).then(|| value.to_string()),
182
            // Read by the credential store from the user file.
183783×
            "auth.helper" => {}
184783×
            "core.op-retention" => self.op_retention_days = parse_days(value)?,
185771×
            "core.gc-grace" => self.gc_grace_days = parse_days(value)?,
186771×
            "snapshot.max-new-file-size" => self.max_new_file = parse_size(value)?,
187771×
            "core.snapshot-retention" => self.snapshot_retention_days = parse_days(value)?,
188771×
            "filter.max-blob" => {
1895×
                self.max_blob = if value.is_empty() {
1900×
                    None
191
                } else {
1925×
                    Some(parse_size(value)?)
193
                }
194
            }
195766×
            "storage.url" => {
1965×
                self.storage_url = (!value.is_empty()).then(|| value.to_string());
197
            }
198761×
            "storage.cache" => {
1990×
                self.storage_cache = if value.is_empty() {
2000×
                    DEFAULT_STORAGE_CACHE
201
                } else {
2020×
                    parse_size(value)?
203
                }
204
            }
205761×
            "core.remote" => {
2061×
                self.default_remote = (!value.is_empty()).then(|| value.to_string());
207
            }
208760×
            "hooks.semantic-deps" => self.semantic_deps = matches!(value, "true" | "1" | "yes"),
209759×
            "git.claim" => self.git_claim = matches!(value, "true" | "1" | "yes"),
210757×
            "filter.paths" => {
2113×
                self.sparse_paths = value
2123×
                    .split(',')
2134×
                    .map(|p| {
2144×
                        p.trim()
2154×
                            .trim_start_matches("./")
2164×
                            .trim_matches('/')
2174×
                            .to_string()
2184×
                    })
2194×
                    .filter(|p| !p.is_empty())
2203×
                    .collect();
221
            }
222754×
            "core.checkpoint-interval" => {
2233×
                self.checkpoint_interval = value
2243×
                    .parse()
2253×
                    .map_err(|_| RepoError::Msg(format!("expected a number, got {value:?}")))?;
226
            }
227751×
            "push.batch-bytes" => {
2281×
                self.push_batch_bytes = value.parse().ok().filter(|n| *n > 0).ok_or_else(|| {
2290×
                    RepoError::Msg(format!("expected a number of bytes, got {value:?}"))
2300×
                })?;
231
            }
232750×
            k if k.starts_with("remote.") => {
233747×
                let rest = &k["remote.".len()..];
234747×
                let Some((name, field)) = rest.rsplit_once('.') else {
2350×
                    return fail(format!("unknown configuration key {key:?}"));
236
                };
237747×
                if name.is_empty() || name.contains('/') {
2380×
                    return fail(format!("invalid remote name in {key:?}"));
239747×
                }
240747×
                let map = match field {
241747×
                    "url" => &mut self.remotes,
24214×
                    "token" => &mut self.remote_tokens,
2434×
                    "ca" => &mut self.remote_cas,
2440×
                    _ => return fail(format!("unknown configuration key {key:?}")),
245
                };
246747×
                if value.is_empty() {
2474×
                    map.remove(name);
2484×
                    if field == "url" {
2493×
                        self.remote_tokens.remove(name);
2503×
                        self.remote_cas.remove(name);
2513×
                    }
252743×
                } else {
253743×
                    map.insert(name.to_string(), value.into());
254743×
                }
255
            }
2563×
            k if k.starts_with("revset.") => {
2573×
                let name = &k["revset.".len()..];
2583×
                if name.is_empty()
2593×
                    || !name
2603×
                        .chars()
26111×
                        .all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
262
                {
2630×
                    return fail(format!(
264
                        "a revset's name is letters, digits, _ and -: {key:?}"
265
                    ));
2663×
                }
2673×
                if value.is_empty() {
2680×
                    self.revsets.remove(name);
2690×
                } else {
2703×
                    crate::revset::parse(value)
2713×
                        .map_err(|e| RepoError::Msg(format!("{key} = {value:?}: {e}")))?;
2722×
                    self.revsets.insert(name.to_string(), value.into());
273
                }
274
            }
2750×
            _ => return fail(format!("unknown configuration key {key:?}")),
276
        }
2771890×
        Ok(())
2781891×
    }
279
280
    /// Defaults, then the user file if it exists, then the repository file.
2812962×
    pub(super) fn load(user_path: Option<&Path>, repo_path: &Path) -> Result<Config> {
2822962×
        let mut c = Config::default_for_user();
2832962×
        if let Some(u) = user_path {
2842962×
            for (k, v) in read_config_file(u)? {
285443×
                let _ = c.apply(&k, &v);
286443×
            }
2870×
        }
2882962×
        for (k, v) in read_config_file(repo_path)? {
289754×
            if c.apply(&k, &v).is_ok() {
290754×
                c.repo_layer.insert(k, v);
291754×
            }
292
        }
2932962×
        Ok(c)
2942962×
    }
295
296983×
    pub(super) fn save(&self, path: &Path) -> Result<()> {
297983×
        write_config_file(path, &self.repo_layer)
298983×
    }
299
300
    /// Keys explicitly set for this repository.
30121×
    pub fn repo_layer(&self) -> &BTreeMap<String, String> {
30221×
        &self.repo_layer
30321×
    }
304
}
305
306
/// A byte count with an optional `K`, `M`, or `G` suffix (binary units).
307
/// `storage.cache` when unset: 2 GiB.
308
pub const DEFAULT_STORAGE_CACHE: u64 = 2 << 30;
309
3107×
pub fn parse_size(v: &str) -> Result<u64> {
3117×
    let v = v.trim();
3127×
    let (num, mult) = match v.chars().last() {
3131×
        Some('K' | 'k') => (&v[..v.len() - 1], 1u64 << 10),
3141×
        Some('M' | 'm') => (&v[..v.len() - 1], 1u64 << 20),
3150×
        Some('G' | 'g') => (&v[..v.len() - 1], 1u64 << 30),
3165×
        _ => (v, 1),
317
    };
3187×
    let n: u64 = num
3197×
        .trim()
3207×
        .parse()
3217×
        .map_err(|_| RepoError::Msg(format!("expected a size like 1M, got {v:?}")))?;
3226×
    Ok(n * mult)
3237×
}
324
325
/// A count of days, optionally suffixed `d`.
32612×
fn parse_days(v: &str) -> Result<u64> {
32712×
    v.trim_end_matches('d')
32812×
        .parse()
32912×
        .map_err(|_| RepoError::Msg(format!("expected a number of days, got {v:?}")))
33012×
}
331
332
/// Read `key = "value"` lines; a missing file is empty.
3336652×
pub fn read_config_file(path: &Path) -> Result<BTreeMap<String, String>> {
3346652×
    let text = match fs::read_to_string(path) {
3352667×
        Ok(t) => t,
3363985×
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(BTreeMap::new()),
3370×
        Err(e) => return Err(e.into()),
338
    };
3392667×
    let mut out = BTreeMap::new();
3402667×
    for line in text.lines() {
3411546×
        let line = line.trim();
3421546×
        if line.is_empty() || line.starts_with('#') {
3430×
            continue;
3441546×
        }
3451546×
        let Some((k, v)) = line.split_once('=') else {
3460×
            continue;
347
        };
3481546×
        out.insert(k.trim().to_string(), v.trim().trim_matches('"').to_string());
349
    }
3502667×
    Ok(out)
3516652×
}
352
3531160×
fn write_config_file(path: &Path, entries: &BTreeMap<String, String>) -> Result<()> {
3541160×
    let text: String = entries
3551160×
        .iter()
3561160×
        .map(|(k, v)| format!("{k} = \"{v}\"\n"))
3571160×
        .collect();
3581160×
    write_atomic(path, text.as_bytes())
3591160×
}