use std::path::{Component, Path, PathBuf};
use serde::Deserialize;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum Share {
#[default]
Team,
Local,
}
#[derive(Debug, Clone, Deserialize)]
pub struct Entry {
pub name: String,
pub paths: Vec<String>,
#[serde(default)]
pub share: Share,
#[serde(default)]
pub experts: Vec<ExpertSource>,
#[serde(default)]
pub relay: Option<String>,
#[serde(default)]
pub mode: Option<String>,
#[serde(default)]
pub budget: Option<serde_json::Value>,
#[serde(default)]
pub risk: Option<serde_json::Value>,
}
impl Entry {
#[must_use]
pub fn budget(&self) -> Option<f64> {
self.budget.as_ref()?.as_f64().filter(|b| *b > 0.0)
}
#[must_use]
pub fn risk(&self) -> Option<f64> {
self.risk.as_ref()?.as_f64().filter(|r| (0.0..=1.0).contains(r))
}
}
#[derive(Debug, Clone, Deserialize)]
pub struct ExpertSource {
pub name: String,
pub repo: String,
#[serde(rename = "match", default)]
pub matches: Vec<String>,
#[serde(default)]
pub drone: bool,
}
impl ExpertSource {
pub fn path(&self) -> PathBuf {
expand(&self.repo)
}
}
impl Config {
pub fn experts_for(&self, cwd: &str) -> Vec<&ExpertSource> {
let Route::Collective { name, .. } = route(Some(self), cwd, Path::new("/")) else { return Vec::new() };
let Some(c) = self.collectives.iter().find(|c| c.name == name) else { return Vec::new() };
c.experts.iter().filter(|e| self.may_consult(&c.name, e)).collect()
}
pub fn may_consult(&self, collective: &str, e: &ExpertSource) -> bool {
let p = e.path();
let real = p.canonicalize().ok();
std::iter::once(p).chain(real).all(|p| {
if self.off.iter().any(|o| inside(&normal(&p), o).is_some()) {
return false;
}
!matches!(route(Some(self), &p.to_string_lossy(), Path::new("/")),
Route::Collective { name, share: Share::Local, .. } if name != collective)
})
}
}
#[derive(Debug, Clone, Deserialize)]
pub struct Config {
#[serde(default = "off")]
pub default: String,
#[serde(default)]
pub off: Vec<String>,
#[serde(default)]
pub collectives: Vec<Entry>,
#[serde(default, deserialize_with = "engineers")]
pub engineers: Vec<Engineer>,
#[serde(default)]
pub personal: Option<String>,
}
fn engineers<'de, D: serde::Deserializer<'de>>(d: D) -> Result<Vec<Engineer>, D::Error> {
Vec::<Engineer>::deserialize(d).map_err(|e| serde::de::Error::custom(format!("engineers: {e}")))
}
#[derive(Debug, Clone, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Engineer {
pub name: String,
pub emails: Vec<String>,
}
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct Aliases {
by_email: std::collections::HashMap<String, String>,
}
impl Aliases {
pub fn new(engineers: &[Engineer]) -> Aliases {
let by_email = engineers.iter().flat_map(|e| e.emails.iter().map(move |m| (m.trim().to_lowercase(), e.name.trim().to_string()))).collect();
Aliases { by_email }
}
pub fn canon(&self, email: &str) -> String {
let key = email.trim().to_lowercase();
self.by_email.get(&key).cloned().unwrap_or(key)
}
pub fn display(&self, email: &str) -> String {
self.by_email.get(&email.trim().to_lowercase()).cloned().unwrap_or_else(|| email.to_string())
}
pub fn same(&self, a: &str, b: &str) -> bool {
self.canon(a) == self.canon(b)
}
}
impl Config {
pub fn aliases(&self) -> Aliases {
Aliases::new(&self.engineers)
}
}
pub fn aliases() -> &'static Aliases {
static A: std::sync::OnceLock<Aliases> = std::sync::OnceLock::new();
A.get_or_init(|| {
if cfg!(test) {
return Aliases::default();
}
load().ok().flatten().map(|c| c.aliases()).unwrap_or_default()
})
}
fn off() -> String {
"off".into()
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Route {
Off,
Collective {
name: String,
home: PathBuf,
share: Share,
},
}
pub fn config_path() -> PathBuf {
std::env::var("BORG_CONFIG")
.map(PathBuf::from)
.unwrap_or_else(|_| PathBuf::from(std::env::var("HOME").unwrap_or_default()).join(".config/borg/collectives.json"))
}
pub fn load() -> Result<Option<Config>, String> {
load_from(&config_path())
}
pub fn load_from(p: &Path) -> Result<Option<Config>, String> {
match std::fs::read_to_string(p) {
Ok(t) => {
let cfg: Config = serde_json::from_str(&t).map_err(|e| format!("{}: {e}", p.display()))?;
cfg.check().map_err(|e| format!("{}: {e}", p.display()))?;
Ok(Some(cfg))
}
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(None),
Err(e) => Err(format!("{}: {e}", p.display())),
}
}
impl Config {
pub fn check(&self) -> Result<(), String> {
if let Some(p) = &self.personal
&& !self.collectives.iter().any(|c| &c.name == p && c.share == Share::Local)
{
return Err(format!("personal: {p:?} is not a collective with \"share\": \"local\""));
}
let mut seen: std::collections::HashMap<String, &str> = std::collections::HashMap::new();
for c in &self.collectives {
if let Some(other) = seen.insert(store_name(&c.name).to_lowercase(), &c.name) {
return Err(format!("collectives {other:?} and {:?} would share one store; rename one", c.name));
}
}
let mut names = std::collections::HashSet::new();
let mut owner: std::collections::HashMap<String, &str> = std::collections::HashMap::new();
for e in &self.engineers {
if e.name.trim().is_empty() {
return Err("engineers: an entry has no name".into());
}
if !names.insert(e.name.trim().to_lowercase()) {
return Err(format!("engineers: {:?} is listed twice; merge the entries", e.name));
}
if e.emails.is_empty() {
return Err(format!("engineers: {:?} lists no emails", e.name));
}
for m in e.emails.iter().map(|m| m.trim().to_lowercase()) {
if m.is_empty() {
return Err(format!("engineers: {:?} lists an empty email", e.name));
}
if let Some(other) = owner.insert(m.clone(), &e.name).filter(|o| *o != e.name) {
return Err(format!("engineers: {m} is listed under both {other:?} and {:?}", e.name));
}
}
}
Ok(())
}
}
pub(crate) fn expand(p: &str) -> PathBuf {
match p.strip_prefix("~/") {
Some(rest) => PathBuf::from(std::env::var("HOME").unwrap_or_default()).join(rest),
None if p == "~" => PathBuf::from(std::env::var("HOME").unwrap_or_default()),
None => PathBuf::from(p),
}
}
pub(crate) fn normal(p: &Path) -> Vec<String> {
let mut out: Vec<String> = Vec::new();
for c in p.components() {
match c {
Component::ParentDir => {
out.pop();
}
Component::Normal(s) => out.push(s.to_string_lossy().into_owned()),
_ => {}
}
}
out
}
pub(crate) fn inside(path: &[String], prefix: &str) -> Option<usize> {
let pre = normal(&expand(prefix));
(!pre.is_empty() && path.len() >= pre.len() && path[..pre.len()] == pre[..]).then_some(pre.len())
}
fn store_name(name: &str) -> String {
let safe: String = name.chars().map(|c| if c.is_ascii_alphanumeric() || c == '-' || c == '_' { c } else { '_' }).collect();
if safe == name && !safe.is_empty() {
return safe;
}
let h = name.bytes().fold(0xcbf2_9ce4_8422_2325u64, |h, b| (h ^ b as u64).wrapping_mul(0x0100_0000_01b3));
format!("{safe}-{:08x}", h as u32 ^ (h >> 32) as u32)
}
pub fn store(base: &Path, name: &str) -> PathBuf {
base.join("collectives").join(store_name(name))
}
pub fn root_of(home: &Path) -> PathBuf {
match home.parent() {
Some(p) if p.file_name().is_some_and(|n| n == "collectives") => p.parent().map_or_else(|| home.to_path_buf(), Path::to_path_buf),
_ => home.to_path_buf(),
}
}
pub const REPO_DEPTH: usize = 2;
pub fn places_of(cfg: &Config, repo: &str) -> Vec<PathBuf> {
if repo.is_empty() || repo == "." || repo == ".." || repo.contains('/') {
return Vec::new();
}
fn inside(p: &Path, repo: &str, depth: usize, out: &mut Vec<PathBuf>) {
let here = p.join(repo);
if here.is_dir() {
out.push(here);
}
if depth <= 1 {
return;
}
for d in std::fs::read_dir(p).into_iter().flatten().flatten() {
let name = d.file_name();
if name.to_string_lossy().starts_with('.') || name == repo || !d.file_type().is_ok_and(|t| t.is_dir()) {
continue;
}
inside(&d.path(), repo, depth - 1, out);
}
}
let mut out = Vec::new();
for p in cfg.collectives.iter().flat_map(|c| c.paths.iter()).chain(cfg.off.iter()).map(|p| expand(p)) {
if p.file_name().is_some_and(|n| n == repo) {
out.push(p.clone());
}
inside(&p, repo, REPO_DEPTH, &mut out);
}
out
}
pub fn route_repo(cfg: &Config, repo: &str, base: &Path) -> Option<Route> {
let mut routes = places_of(cfg, repo).into_iter().map(|p| route(Some(cfg), &p.to_string_lossy(), base));
let first = routes.next()?;
routes.all(|r| r == first).then_some(first)
}
pub fn is_store(cfg: &Config, home: &Path) -> bool {
let base = root_of(home);
cfg.collectives.iter().any(|c| store(&base, &c.name) == home)
}
pub fn local_owner_of<'a>(cfg: Option<&'a Config>, home: &Path, base: &Path) -> Option<&'a str> {
cfg?.collectives.iter().find(|c| c.share == Share::Local && store(base, &c.name) == home).map(|c| c.name.as_str())
}
fn within(cwd: &str) -> impl Fn(&str) -> Option<usize> {
let lexical = expand(cwd);
let paths: Vec<Vec<String>> = std::iter::once(normal(&lexical)).chain(lexical.canonicalize().ok().map(|p| normal(&p))).collect();
move |prefix: &str| {
let real = expand(prefix).canonicalize().ok().map(|p| p.to_string_lossy().into_owned());
let prefixes = std::iter::once(prefix.to_string()).chain(real);
prefixes.filter_map(|pre| paths.iter().filter_map(|p| inside(p, &pre)).max()).max()
}
}
pub fn route(cfg: Option<&Config>, cwd: &str, base: &Path) -> Route {
let Some(cfg) = cfg else {
return Route::Collective { name: "default".into(), home: base.to_path_buf(), share: Share::Team };
};
if cwd.trim().is_empty() {
return Route::Off; }
let within = within(cwd);
if cfg.off.iter().any(|p| within(p).is_some()) {
return Route::Off;
}
let best = cfg.collectives.iter().filter_map(|c| c.paths.iter().filter_map(|p| within(p)).max().map(|n| (n, c))).max_by_key(|(n, _)| *n).map(|(_, c)| c);
let chosen = best.or_else(|| cfg.collectives.iter().find(|c| c.name == cfg.default && cfg.default != "off"));
match chosen {
Some(c) => Route::Collective { name: c.name.clone(), home: store(base, &c.name), share: c.share },
None => Route::Off,
}
}
pub fn may_sync(r: &Route) -> bool {
matches!(r, Route::Collective { share: Share::Team, .. })
}
#[cfg(test)]
mod tests {
use super::*;
fn cfg(json: &str) -> Config {
serde_json::from_str(json).unwrap()
}
const CFG: &str = r#"{ "default": "off",
"off": ["/home/u/private/diary"],
"collectives": [
{ "name": "work", "paths": ["/home/u/work-repos"], "share": "team" },
{ "name": "private", "paths": ["/home/u/private"], "share": "local" },
{ "name": "libs", "paths": ["/home/u/work-repos/shared-libs"] } ] }"#;
fn name(r: &Route) -> &str {
match r {
Route::Off => "off",
Route::Collective { name, .. } => name,
}
}
#[test]
fn routes_by_longest_whole_component_prefix() {
let c = cfg(CFG);
let base = Path::new("/b");
assert_eq!(name(&route(Some(&c), "/home/u/work-repos/harbor_orion/src", base)), "work");
assert_eq!(name(&route(Some(&c), "/home/u/work-repos/shared-libs/x", base)), "libs", "longest prefix wins");
assert_eq!(name(&route(Some(&c), "/home/u/work", base)), "off", "no partial component match");
assert_eq!(name(&route(Some(&c), "/home/u/work-repos-old/x", base)), "off", "work-repos-old is not work-repos");
assert_eq!(name(&route(Some(&c), "/home/u/private/finances", base)), "private");
assert_eq!(name(&route(Some(&c), "/home/u/work-repos/../private/x", base)), "private", "normalised before matching");
}
#[test]
fn a_symlink_and_its_target_route_alike() {
let root = std::env::temp_dir().join(format!("borg-route-link-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&root);
std::fs::create_dir_all(root.join("real/work/secret/x")).unwrap();
std::os::unix::fs::symlink(root.join("real"), root.join("link")).unwrap();
let (real, link) = (root.join("real").display().to_string(), root.join("link").display().to_string());
let c = cfg(&format!(
r#"{{ "default": "off", "off": ["{link}/work/secret"], "collectives": [ {{ "name": "work", "paths": ["{real}/work"], "share": "team" }} ] }}"#
));
let base = Path::new("/b");
assert_eq!(route(Some(&c), &format!("{real}/work/secret/x"), base), Route::Off, "an off path written through the link");
assert_eq!(route(Some(&c), &format!("{link}/work/secret/x"), base), Route::Off);
assert_eq!(name(&route(Some(&c), &format!("{link}/work"), base)), "work", "a cwd reported through the link");
let _ = std::fs::remove_dir_all(root);
}
#[test]
fn off_wins_and_unknown_is_off() {
let c = cfg(CFG);
let base = Path::new("/b");
assert_eq!(route(Some(&c), "/home/u/private/diary/2026", base), Route::Off, "off beats the private collective above it");
assert_eq!(route(Some(&c), "/somewhere/else", base), Route::Off, "default off");
assert_eq!(route(Some(&c), "", base), Route::Off, "no cwd: never guess");
let d = cfg(r#"{ "default": "work", "collectives": [ { "name": "work", "paths": ["/w"] } ] }"#);
assert_eq!(name(&route(Some(&d), "/somewhere/else", base)), "work");
}
#[test]
fn stores_are_separate_and_local_never_syncs() {
let c = cfg(CFG);
let base = Path::new("/b");
let corp = route(Some(&c), "/home/u/work-repos/a", base);
let private = route(Some(&c), "/home/u/private/a", base);
let (Route::Collective { home: h1, .. }, Route::Collective { home: h2, .. }) = (&corp, &private) else { panic!() };
assert_ne!(h1, h2);
assert_eq!(h2, &PathBuf::from("/b/collectives/private"));
assert!(may_sync(&corp));
assert!(!may_sync(&private), "a local collective never leaves the machine");
assert!(!may_sync(&Route::Off));
}
#[test]
fn similar_names_get_separate_stores() {
let c = cfg(r#"{ "collectives": [
{ "name": "my team", "paths": ["/l"], "share": "local" },
{ "name": "my_team", "paths": ["/t"], "share": "team" } ] }"#);
let base = Path::new("/b");
let (Route::Collective { home: local, .. }, Route::Collective { home: team, .. }) = (route(Some(&c), "/l/x", base), route(Some(&c), "/t/x", base))
else {
panic!()
};
assert_ne!(local, team, "a local collective never shares a store with a team one");
assert_eq!(team, PathBuf::from("/b/collectives/my_team"), "safe names keep their store");
assert!(local.to_string_lossy().starts_with("/b/collectives/my_team-"));
assert_ne!(store_name("a.b"), store_name("a_b"));
assert_ne!(store_name("équipe"), store_name("_quipe"));
assert_eq!(store_name("a.b"), store_name("a.b"), "stable");
assert!(c.check().is_ok());
assert_eq!(local_owner_of(Some(&c), &team, base), None);
assert_eq!(local_owner_of(Some(&c), &local, base), Some("my team"));
}
#[test]
fn a_config_whose_collectives_share_a_store_is_rejected() {
for json in [
r#"{ "collectives": [ { "name": "x", "paths": ["/a"], "share": "local" }, { "name": "x", "paths": ["/b"] } ] }"#,
r#"{ "collectives": [ { "name": "Team", "paths": ["/a"], "share": "local" }, { "name": "team", "paths": ["/b"] } ] }"#,
] {
assert!(cfg(json).check().unwrap_err().contains("share one store"), "{json}");
let p = std::env::temp_dir().join(format!("borg-collective-dup-{}.json", std::process::id()));
std::fs::write(&p, json).unwrap();
assert!(load_from(&p).is_err(), "load rejects it, so everything routes off");
let _ = std::fs::remove_file(&p);
}
}
#[test]
fn expert_repos_behind_the_boundary_are_never_consulted() {
let c = cfg(r#"{ "default": "off", "off": ["/home/u/secret"],
"collectives": [
{ "name": "work", "paths": ["/home/u/work"], "share": "team", "experts": [
{ "name": "open", "repo": "/home/u/src/flowlib" },
{ "name": "mine", "repo": "/home/u/work/sdk" },
{ "name": "offrepo", "repo": "/home/u/secret/sdk" },
{ "name": "privaterepo", "repo": "/home/u/private/flowlib" },
{ "name": "sneaky", "repo": "/home/u/work/../private/x" } ] },
{ "name": "private", "paths": ["/home/u/private"], "share": "local", "experts": [
{ "name": "own", "repo": "/home/u/private/flowlib" },
{ "name": "team", "repo": "/home/u/work/sdk" },
{ "name": "off", "repo": "/home/u/secret/sdk" } ] } ] }"#);
let names = |cwd: &str| c.experts_for(cwd).iter().map(|e| e.name.clone()).collect::<Vec<_>>();
assert_eq!(names("/home/u/work/app"), ["open", "mine"], "off and local-private expert repos are dropped");
assert_eq!(names("/home/u/private/app"), ["own", "team"], "a local collective may read its own and team repos, never off ones");
assert!(names("/home/u/secret/app").is_empty());
let d = std::env::temp_dir().canonicalize().unwrap().join(format!("borg-collective-link-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&d);
std::fs::create_dir_all(d.join("secret/sdk")).unwrap();
std::os::unix::fs::symlink(d.join("secret/sdk"), d.join("link")).unwrap();
let c = cfg(&format!(
r#"{{ "off": ["{0}/secret"], "collectives": [ {{ "name": "t", "paths": ["/w"], "experts": [ {{ "name": "x", "repo": "{0}/link" }} ] }} ] }}"#,
d.display()
));
assert!(c.experts_for("/w/app").is_empty(), "a symlink into an off path");
let _ = std::fs::remove_dir_all(&d);
}
#[test]
fn engineers_map_aliases_case_insensitively() {
let c = cfg(r#"{ "engineers": [ { "name": "dana", "emails": ["Dana.Example@corp.example", "da@home.example"] } ] }"#);
assert!(c.check().is_ok());
let a = c.aliases();
assert_eq!(a.canon("dana.example@CORP.example"), "dana");
assert_eq!(a.canon(" da@home.example "), "dana");
assert!(a.same("Dana.Example@corp.example", "da@home.example"));
assert_eq!(a.canon("Ann@X"), "ann@x", "unlisted emails still compare case-insensitively");
assert_eq!(a.display("Ann@X"), "Ann@X", "and display as written");
assert_eq!(a.display("DA@home.example"), "dana");
assert_eq!(a.canon(""), "");
assert_eq!(cfg(CFG).aliases(), Aliases::default(), "absent section: no aliases");
}
#[test]
fn an_invalid_engineers_section_is_rejected_at_load() {
for (json, why) in [
(r#"{ "engineers": [ { "name": "", "emails": ["a@x"] } ] }"#, "has no name"),
(r#"{ "engineers": [ { "name": "a", "emails": [] } ] }"#, "lists no emails"),
(r#"{ "engineers": [ { "name": "a", "emails": ["a@x", " "] } ] }"#, "empty email"),
(r#"{ "engineers": [ { "name": "a", "emails": ["a@x"] }, { "name": "A", "emails": ["b@x"] } ] }"#, "listed twice"),
(r#"{ "engineers": [ { "name": "a", "emails": ["a@x"] }, { "name": "b", "emails": ["A@X"] } ] }"#, "listed under both"),
(r#"{ "engineers": [ { "name": "a", "email": ["a@x"] } ] }"#, "unknown field"),
(r#"{ "engineers": { "name": "a" } }"#, "invalid type"),
] {
let p = std::env::temp_dir().join(format!("borg-collective-eng-{}.json", std::process::id()));
std::fs::write(&p, json).unwrap();
let e = load_from(&p).unwrap_err();
assert!(e.contains(why) && e.contains(&p.display().to_string()), "{json}: {e}");
let _ = std::fs::remove_file(&p);
}
}
#[test]
fn a_repo_name_routes_only_where_no_other_place_of_it_could_be() {
let root = std::env::temp_dir().join(format!("borg-collective-repo-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&root);
for d in ["work/group/api", "work/app", "oss/api", "oss/lib", "work/a/b/deep"] {
std::fs::create_dir_all(root.join(d)).unwrap();
}
let cfg: Config = serde_json::from_value(serde_json::json!({"collectives": [
{"name": "work", "paths": [root.join("work")]}, {"name": "oss", "paths": [root.join("oss")]}]}))
.unwrap();
let base = root.join("base");
let to = |name: &str| Some(Route::Collective { name: name.into(), home: store(&base, name), share: Share::Team });
assert_eq!(route_repo(&cfg, "lib", &base), to("oss"));
assert_eq!(route_repo(&cfg, "app", &base), to("work"));
assert_eq!(route_repo(&cfg, "api", &base), None);
assert_eq!(places_of(&cfg, "api").len(), 2);
assert_eq!(route_repo(&cfg, "deep", &base), None, "deeper than REPO_DEPTH: unknown");
let _ = std::fs::remove_dir_all(root);
}
#[test]
fn no_config_keeps_one_default_collective() {
let r = route(None, "/anything", Path::new("/b"));
assert_eq!(r, Route::Collective { name: "default".into(), home: PathBuf::from("/b"), share: Share::Team });
}
}