acropolis 0.2.2

UNDER CONSTRUCTION: A safe local-first Rust Cardano node scaffold.
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

use std::time::SystemTime;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TraceMark {
    pub name: String,
    pub when: SystemTime,
    pub fields: Vec<(String, String)>,
}

impl TraceMark {
    pub fn render_line(&self) -> String {
        let fields = self
            .fields
            .iter()
            .map(|(key, value)| format!("{key}={value}"))
            .collect::<Vec<_>>()
            .join(" ");
        if fields.is_empty() {
            self.name.clone()
        } else {
            format!("{} {}", self.name, fields)
        }
    }
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct TraceBook {
    marks: Vec<TraceMark>,
}

impl TraceBook {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn mark(&mut self, name: impl Into<String>) {
        self.marks.push(TraceMark {
            name: name.into(),
            when: SystemTime::now(),
            fields: Vec::new(),
        });
    }

    pub fn mark_with_fields(
        &mut self,
        name: impl Into<String>,
        fields: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>,
    ) {
        self.marks.push(TraceMark {
            name: name.into(),
            when: SystemTime::now(),
            fields: fields
                .into_iter()
                .map(|(key, value)| (key.into(), value.into()))
                .collect(),
        });
    }

    pub fn marks(&self) -> &[TraceMark] {
        &self.marks
    }

    pub fn clear(&mut self) {
        self.marks.clear();
    }

    pub fn render_lines(&self) -> Vec<String> {
        self.marks.iter().map(TraceMark::render_line).collect()
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TraceExportPlan {
    pub destination: String,
    pub enabled: bool,
    pub blocked_reason: Option<String>,
    pub mark_count: usize,
}

impl TraceExportPlan {
    pub fn from_guard(destination: impl Into<String>, book: &TraceBook, allow_paths: bool) -> Self {
        let destination = destination.into();
        if allow_paths {
            Self {
                destination,
                enabled: true,
                blocked_reason: None,
                mark_count: book.marks.len(),
            }
        } else {
            Self {
                destination,
                enabled: false,
                blocked_reason: Some("trace export is disabled by safety config".to_string()),
                mark_count: book.marks.len(),
            }
        }
    }

    pub fn render_local(&self, book: &TraceBook) -> TraceExportArtifact {
        TraceExportArtifact {
            destination: self.destination.clone(),
            enabled: self.enabled,
            mark_count: self.mark_count,
            lines: book.render_lines(),
            blocked_reason: self.blocked_reason.clone(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TraceExportArtifact {
    pub destination: String,
    pub enabled: bool,
    pub mark_count: usize,
    pub lines: Vec<String>,
    pub blocked_reason: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn trace_book_records_local_marks_only() {
        let mut book = TraceBook::new();
        book.mark_with_fields("sync", [("peer", "a")]);
        assert_eq!(book.marks().len(), 1);
        assert_eq!(book.marks()[0].name, "sync");
        assert_eq!(
            book.marks()[0].fields,
            vec![("peer".to_string(), "a".to_string())]
        );
    }

    #[test]
    fn trace_export_plan_is_closed_by_default() {
        let mut book = TraceBook::new();
        book.mark("chain");
        let plan = TraceExportPlan::from_guard("local-trace", &book, false);
        assert!(!plan.enabled);
        assert_eq!(plan.mark_count, 1);
        assert!(plan.blocked_reason.is_some());
    }

    #[test]
    fn trace_export_renders_local_artifact_without_writing() {
        let mut book = TraceBook::new();
        book.mark_with_fields("sync", [("peer", "a"), ("slot", "10")]);
        let plan = TraceExportPlan::from_guard("local-trace", &book, false);

        let artifact = plan.render_local(&book);
        assert!(!artifact.enabled);
        assert_eq!(artifact.mark_count, 1);
        assert_eq!(artifact.lines, vec!["sync peer=a slot=10"]);
        assert!(artifact.blocked_reason.is_some());
    }
}