xbp 10.38.0

XBP is a zero-config build pack that can also interact with proxies, kafka, sockets, synthetic monitors.
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

//! Project-local ledger for idempotent TODO → issue mapping.

use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
use std::fs;
use std::path::{Path, PathBuf};

const LEDGER_VERSION: u32 = 1;

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TodoLedger {
    #[serde(default = "default_version")]
    pub version: u32,
    #[serde(default)]
    pub entries: BTreeMap<String, TodoLedgerEntry>,
}

fn default_version() -> u32 {
    LEDGER_VERSION
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TodoLedgerEntry {
    pub fingerprint: String,
    pub kind: String,
    pub path: String,
    pub line: usize,
    pub text: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub linear: Option<LinearIssueRef>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub github: Option<GithubIssueRef>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LinearIssueRef {
    pub id: String,
    pub identifier: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GithubIssueRef {
    pub number: u64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
}

pub fn ledger_path(project_root: &Path) -> PathBuf {
    project_root.join(".xbp").join("todo-issues.json")
}

pub fn load_ledger(project_root: &Path) -> Result<TodoLedger, String> {
    let path = ledger_path(project_root);
    if !path.exists() {
        return Ok(TodoLedger {
            version: LEDGER_VERSION,
            entries: BTreeMap::new(),
        });
    }
    let content = fs::read_to_string(&path)
        .map_err(|e| format!("Failed to read {}: {e}", path.display()))?;
    let mut ledger: TodoLedger = serde_json::from_str(&content)
        .map_err(|e| format!("Failed to parse {}: {e}", path.display()))?;
    ledger.version = LEDGER_VERSION;
    Ok(ledger)
}

pub fn save_ledger(project_root: &Path, ledger: &TodoLedger) -> Result<(), String> {
    let path = ledger_path(project_root);
    if let Some(parent) = path.parent() {
        fs::create_dir_all(parent)
            .map_err(|e| format!("Failed to create {}: {e}", parent.display()))?;
    }
    let content = serde_json::to_string_pretty(ledger)
        .map_err(|e| format!("Failed to serialize todo ledger: {e}"))?;
    fs::write(&path, content + "\n")
        .map_err(|e| format!("Failed to write {}: {e}", path.display()))?;
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::{SystemTime, UNIX_EPOCH};

    #[test]
    fn roundtrip_ledger() {
        let stamp = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_nanos();
        let dir = std::env::temp_dir().join(format!("xbp-todo-ledger-{stamp}"));
        fs::create_dir_all(dir.join(".xbp")).unwrap();
        let mut ledger = TodoLedger::default();
        ledger.entries.insert(
            "abc".into(),
            TodoLedgerEntry {
                fingerprint: "abc".into(),
                kind: "TODO".into(),
                path: "src/a.rs".into(),
                line: 1,
                text: "hello".into(),
                linear: Some(LinearIssueRef {
                    id: "id".into(),
                    identifier: "XLX-1".into(),
                    url: None,
                }),
                github: None,
                created_at: None,
                updated_at: None,
            },
        );
        save_ledger(&dir, &ledger).unwrap();
        let loaded = load_ledger(&dir).unwrap();
        assert_eq!(loaded.entries.len(), 1);
        assert_eq!(
            loaded.entries["abc"].linear.as_ref().unwrap().identifier,
            "XLX-1"
        );
        let _ = fs::remove_dir_all(dir);
    }
}