lex_trace/
recorder.rs

1//! Trace recorder — implements `lex_bytecode::vm::Tracer` and builds a
2//! `TraceTree` as the VM executes.
3
4use indexmap::IndexMap;
5use lex_bytecode::vm::Tracer;
6use lex_bytecode::Value;
7use serde::{Deserialize, Serialize};
8use std::sync::{Arc, Mutex};
9
10#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
11pub struct RunId(pub String);
12
13impl RunId {
14    pub fn new(seed: &str) -> Self {
15        use sha2::{Digest, Sha256};
16        let mut h = Sha256::new();
17        h.update(seed.as_bytes());
18        h.update(format!("{:?}", std::time::SystemTime::now()).as_bytes());
19        let r = h.finalize();
20        let mut hex = String::with_capacity(64);
21        for b in r { hex.push_str(&format!("{:02x}", b)); }
22        RunId(hex)
23    }
24}
25
26#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
27#[serde(rename_all = "snake_case")]
28pub enum TraceNodeKind { Call, Effect }
29
30#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
31pub struct TraceNode {
32    pub node_id: String,
33    pub kind: TraceNodeKind,
34    /// For `Call`: the function name. For `Effect`: `kind.op` (e.g. `io.print`).
35    pub target: String,
36    pub input: serde_json::Value,
37    /// `Some` on success; `None` if the node ended in error.
38    #[serde(default, skip_serializing_if = "Option::is_none")]
39    pub output: Option<serde_json::Value>,
40    #[serde(default, skip_serializing_if = "Option::is_none")]
41    pub error: Option<String>,
42    pub started_at: u64,
43    pub ended_at: u64,
44    #[serde(default)]
45    pub children: Vec<TraceNode>,
46}
47
48#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
49pub struct TraceTree {
50    pub run_id: String,
51    pub root_target: String,
52    pub root_input: serde_json::Value,
53    pub root_output: Option<serde_json::Value>,
54    pub root_error: Option<String>,
55    pub started_at: u64,
56    pub ended_at: u64,
57    pub nodes: Vec<TraceNode>,
58}
59
60impl TraceTree {
61    /// Find a node by `NodeId`, depth-first.
62    pub fn find(&self, node_id: &str) -> Option<&TraceNode> {
63        for n in &self.nodes {
64            if let Some(found) = find_in(n, node_id) { return Some(found); }
65        }
66        None
67    }
68}
69
70fn find_in<'a>(n: &'a TraceNode, target: &str) -> Option<&'a TraceNode> {
71    if n.node_id == target { return Some(n); }
72    for c in &n.children {
73        if let Some(f) = find_in(c, target) { return Some(f); }
74    }
75    None
76}
77
78/// Tracer that builds a `TraceTree`. The tree is shared via `Arc<Mutex>`
79/// so callers can read it after the VM finishes.
80pub struct Recorder {
81    state: Arc<Mutex<RecorderState>>,
82}
83
84pub(crate) struct RecorderState {
85    /// Open frames: each entry has its inputs filled in but `output`/
86    /// `error`/`ended_at` not yet known. Children of an open frame are
87    /// staged into a sibling buffer; on `exit`, they get attached to the
88    /// node that's closing.
89    open: Vec<OpenFrame>,
90    /// Top-level finished nodes (the call we're tracing might span the
91    /// whole VM run, so this is normally a single node tree).
92    completed: Vec<TraceNode>,
93    /// Effect overrides for replay; keyed by NodeId.
94    pub(crate) overrides: IndexMap<String, serde_json::Value>,
95}
96
97struct OpenFrame {
98    node: TraceNode,
99    /// Children that have completed under this frame.
100    children: Vec<TraceNode>,
101}
102
103impl Recorder {
104    pub fn new() -> Self {
105        Self {
106            state: Arc::new(Mutex::new(RecorderState {
107                open: Vec::new(),
108                completed: Vec::new(),
109                overrides: IndexMap::new(),
110            })),
111        }
112    }
113
114    /// Returned handle stays valid after the tracer is moved into the VM.
115    pub fn handle(&self) -> Handle {
116        Handle { state: Arc::clone(&self.state) }
117    }
118
119    /// Pre-load effect overrides for replay.
120    pub fn with_overrides(self, overrides: IndexMap<String, serde_json::Value>) -> Self {
121        self.state.lock().unwrap().overrides = overrides;
122        self
123    }
124}
125
126impl Default for Recorder { fn default() -> Self { Self::new() } }
127
128#[derive(Clone)]
129pub struct Handle {
130    state: Arc<Mutex<RecorderState>>,
131}
132
133impl Handle {
134    /// Drain the recorder into a finished `TraceTree`. Call after the VM
135    /// run returns. `root_target` and `root_input` describe the top-level
136    /// call (e.g. the `lex run` entry).
137    pub fn finalize(
138        &self,
139        root_target: impl Into<String>,
140        root_input: serde_json::Value,
141        root_output: Option<serde_json::Value>,
142        root_error: Option<String>,
143        started_at: u64,
144        ended_at: u64,
145    ) -> TraceTree {
146        let st = self.state.lock().unwrap();
147        TraceTree {
148            run_id: RunId::new(&format!("{}-{}", started_at, ended_at)).0,
149            root_target: root_target.into(),
150            root_input,
151            root_output,
152            root_error,
153            started_at,
154            ended_at,
155            nodes: st.completed.clone(),
156        }
157    }
158}
159
160fn now_unix() -> u64 {
161    use std::time::{SystemTime, UNIX_EPOCH};
162    SystemTime::now().duration_since(UNIX_EPOCH).map(|d| d.as_secs()).unwrap_or(0)
163}
164
165fn values_to_json(args: &[Value]) -> serde_json::Value {
166    serde_json::Value::Array(args.iter().map(value_to_json).collect())
167}
168
169fn value_to_json(v: &Value) -> serde_json::Value {
170    use serde_json::Value as J;
171    match v {
172        Value::Int(n) => J::from(*n),
173        Value::Float(f) => J::from(*f),
174        Value::Bool(b) => J::Bool(*b),
175        Value::Str(s) => J::String(s.clone()),
176        Value::Bytes(b) => J::String(b.iter().map(|b| format!("{:02x}", b)).collect()),
177        Value::Unit => J::Null,
178        Value::List(items) => J::Array(items.iter().map(value_to_json).collect()),
179        Value::Tuple(items) => J::Array(items.iter().map(value_to_json).collect()),
180        Value::Record(fields) => {
181            let mut m = serde_json::Map::new();
182            for (k, v) in fields { m.insert(k.clone(), value_to_json(v)); }
183            J::Object(m)
184        }
185        Value::Variant { name, args } => {
186            let mut m = serde_json::Map::new();
187            m.insert("$variant".into(), J::String(name.clone()));
188            m.insert("args".into(), J::Array(args.iter().map(value_to_json).collect()));
189            J::Object(m)
190        }
191        Value::Closure { fn_id, .. } => J::String(format!("<closure fn_{fn_id}>")),
192        Value::F64Array { rows, cols, data } => {
193            let mut m = serde_json::Map::new();
194            m.insert("$f64_array".into(), J::Bool(true));
195            m.insert("rows".into(), J::from(*rows));
196            m.insert("cols".into(), J::from(*cols));
197            m.insert("data".into(), J::Array(data.iter().map(|f| J::from(*f)).collect()));
198            J::Object(m)
199        }
200        Value::Map(m) => {
201            let mut o = serde_json::Map::new();
202            o.insert("$map".into(), J::Bool(true));
203            o.insert("entries".into(), J::Array(m.iter().map(|(k, v)| {
204                J::Array(vec![value_to_json(&k.as_value()), value_to_json(v)])
205            }).collect()));
206            J::Object(o)
207        }
208        Value::Set(s) => {
209            let mut o = serde_json::Map::new();
210            o.insert("$set".into(), J::Bool(true));
211            o.insert("items".into(), J::Array(
212                s.iter().map(|k| value_to_json(&k.as_value())).collect()));
213            J::Object(o)
214        }
215        Value::Deque(items) => {
216            let mut o = serde_json::Map::new();
217            o.insert("$deque".into(), J::Bool(true));
218            o.insert("items".into(), J::Array(
219                items.iter().map(value_to_json).collect()));
220            J::Object(o)
221        }
222    }
223}
224
225pub(crate) fn json_to_value(v: &serde_json::Value) -> Value {
226    use serde_json::Value as J;
227    match v {
228        J::Null => Value::Unit,
229        J::Bool(b) => Value::Bool(*b),
230        J::Number(n) => {
231            if let Some(i) = n.as_i64() { Value::Int(i) }
232            else if let Some(f) = n.as_f64() { Value::Float(f) }
233            else { Value::Unit }
234        }
235        J::String(s) => Value::Str(s.clone()),
236        J::Array(items) => Value::List(items.iter().map(json_to_value).collect()),
237        J::Object(map) => {
238            // Detect the $variant shape we emit on the way out.
239            if let (Some(serde_json::Value::String(name)), Some(serde_json::Value::Array(args))) =
240                (map.get("$variant"), map.get("args"))
241            {
242                return Value::Variant {
243                    name: name.clone(),
244                    args: args.iter().map(json_to_value).collect(),
245                };
246            }
247            let mut out = indexmap::IndexMap::new();
248            for (k, v) in map { out.insert(k.clone(), json_to_value(v)); }
249            Value::Record(out)
250        }
251    }
252}
253
254impl Tracer for Recorder {
255    fn enter_call(&mut self, node_id: &str, name: &str, args: &[Value]) {
256        push_call_frame(&self.state, node_id, name, args);
257    }
258    fn enter_effect(&mut self, node_id: &str, kind: &str, op: &str, args: &[Value]) {
259        push_effect_frame(&self.state, node_id, kind, op, args);
260    }
261    fn exit_ok(&mut self, value: &Value) { exit_ok_frame(&self.state, value); }
262    fn exit_err(&mut self, message: &str) { exit_err_frame(&self.state, message); }
263    fn exit_call_tail(&mut self) { exit_tail_frame(&self.state); }
264    fn override_effect(&mut self, node_id: &str) -> Option<Value> {
265        lookup_override(&self.state, node_id)
266    }
267}
268
269/// Tracer impl for the recorder's shareable handle (#199). Multiple
270/// `Vm` instances driven against the same `Recorder` — for example,
271/// the spec-checker's per-`SpecExpr::Call` Vms — can each take their
272/// own `Box<dyn Tracer>` cloned from this handle, and the events
273/// will fold into the same trace tree.
274impl Tracer for Handle {
275    fn enter_call(&mut self, node_id: &str, name: &str, args: &[Value]) {
276        push_call_frame(&self.state, node_id, name, args);
277    }
278    fn enter_effect(&mut self, node_id: &str, kind: &str, op: &str, args: &[Value]) {
279        push_effect_frame(&self.state, node_id, kind, op, args);
280    }
281    fn exit_ok(&mut self, value: &Value) { exit_ok_frame(&self.state, value); }
282    fn exit_err(&mut self, message: &str) { exit_err_frame(&self.state, message); }
283    fn exit_call_tail(&mut self) { exit_tail_frame(&self.state); }
284    fn override_effect(&mut self, node_id: &str) -> Option<Value> {
285        lookup_override(&self.state, node_id)
286    }
287}
288
289// ---- Tracer body, factored so Recorder and Handle share it. ------
290
291fn push_call_frame(state: &Mutex<RecorderState>, node_id: &str, name: &str, args: &[Value]) {
292    let mut st = state.lock().unwrap();
293    st.open.push(OpenFrame {
294        node: TraceNode {
295            node_id: node_id.to_string(),
296            kind: TraceNodeKind::Call,
297            target: name.to_string(),
298            input: values_to_json(args),
299            output: None,
300            error: None,
301            started_at: now_unix(),
302            ended_at: 0,
303            children: Vec::new(),
304        },
305        children: Vec::new(),
306    });
307}
308
309fn push_effect_frame(state: &Mutex<RecorderState>, node_id: &str, kind: &str, op: &str, args: &[Value]) {
310    let mut st = state.lock().unwrap();
311    st.open.push(OpenFrame {
312        node: TraceNode {
313            node_id: node_id.to_string(),
314            kind: TraceNodeKind::Effect,
315            target: format!("{kind}.{op}"),
316            input: values_to_json(args),
317            output: None,
318            error: None,
319            started_at: now_unix(),
320            ended_at: 0,
321            children: Vec::new(),
322        },
323        children: Vec::new(),
324    });
325}
326
327fn exit_ok_frame(state: &Mutex<RecorderState>, value: &Value) {
328    let mut st = state.lock().unwrap();
329    if let Some(mut frame) = st.open.pop() {
330        frame.node.ended_at = now_unix();
331        frame.node.output = Some(value_to_json(value));
332        frame.node.children = frame.children;
333        attach_completed(&mut st, frame.node);
334    }
335}
336
337fn exit_err_frame(state: &Mutex<RecorderState>, message: &str) {
338    let mut st = state.lock().unwrap();
339    if let Some(mut frame) = st.open.pop() {
340        frame.node.ended_at = now_unix();
341        frame.node.error = Some(message.to_string());
342        frame.node.children = frame.children;
343        attach_completed(&mut st, frame.node);
344    }
345}
346
347fn exit_tail_frame(state: &Mutex<RecorderState>) {
348    let mut st = state.lock().unwrap();
349    if let Some(mut frame) = st.open.pop() {
350        frame.node.ended_at = now_unix();
351        frame.node.output = Some(serde_json::Value::Null);
352        frame.node.children = frame.children;
353        attach_completed(&mut st, frame.node);
354    }
355}
356
357fn lookup_override(state: &Mutex<RecorderState>, node_id: &str) -> Option<Value> {
358    let st = state.lock().unwrap();
359    st.overrides.get(node_id).map(json_to_value)
360}
361
362fn attach_completed(st: &mut RecorderState, node: TraceNode) {
363    if let Some(parent) = st.open.last_mut() {
364        parent.children.push(node);
365    } else {
366        st.completed.push(node);
367    }
368}
lex_trace/recorder.rs

lex_trace/
recorder.rs
