Skip to main content

aver/replay/
entry.rs

1//! Parsing and serialising of user-supplied entry-point expressions
2//! for record mode. Shared by the `aver run --expr` CLI path and the
3//! playground's custom-entry recording API.
4
5use std::sync::Arc;
6
7use crate::ast::{Expr, Literal, Spanned};
8use crate::lexer::Lexer;
9use crate::parser::Parser;
10use crate::replay::{JsonValue, value_to_json};
11use crate::value::Value;
12
13/// Parse a CLI `--expr` / playground entry expression.
14///
15/// Accepts a single function call of the form `name(arg1, arg2, ...)` where
16/// each argument is a literal (`String` / `Int` / `Float` / `Bool` / `Unit`).
17/// Returns `(function_name, evaluated_args)`.
18///
19/// Complex argument expressions (arithmetic, record construction, nested
20/// calls) are rejected because recordings store entry args in the
21/// `input` JSON field which only round-trips values. Users needing richer
22/// inputs wrap the call in a helper function and point the entry at that.
23pub fn parse_entry_call(src: &str) -> Result<(String, Vec<Value>), String> {
24    let mut lexer = Lexer::new(src);
25    let tokens = lexer
26        .tokenize()
27        .map_err(|e| format!("lex error in entry expression: {}", e))?;
28    let mut parser = Parser::new(tokens);
29    let spanned = parser
30        .parse_expr()
31        .map_err(|e| format!("parse error in entry expression: {}", e))?;
32
33    let (target, args) = match spanned.node {
34        Expr::FnCall(target, args) => (target, args),
35        _ => {
36            return Err(
37                "entry expression must be a function call like 'loadTaxRate(\"PL\")'".to_string(),
38            );
39        }
40    };
41
42    let fn_name = match &target.node {
43        Expr::Ident(name) => name.clone(),
44        _ => {
45            return Err("entry expression target must be a bare function name \
46                 (qualified paths not supported yet)"
47                .to_string());
48        }
49    };
50
51    let mut values = Vec::with_capacity(args.len());
52    for (idx, arg) in args.iter().enumerate() {
53        let val = expr_to_value(&arg.node).map_err(|e| format!("arg #{}: {}", idx + 1, e))?;
54        values.push(val);
55    }
56
57    Ok((fn_name, values))
58}
59
60/// Convert a parsed expression to a runtime `Value` without running the VM.
61/// Supports literals, tuples, lists, and ADT constructors (both built-in
62/// Result/Option/None and user-defined variants). Rejects arbitrary
63/// expressions (function calls, arithmetic, variables, records) so entry
64/// arguments stay round-trippable through the replay JSON schema.
65fn expr_to_value(expr: &Expr) -> Result<Value, String> {
66    match expr {
67        Expr::Literal(lit) => Ok(literal_to_value(lit)),
68        // Unary minus on a numeric literal: support `-300.0` in --expr args.
69        // Anything other than a literal operand is rejected — entry-arg
70        // expressions must be round-trippable through the JSON schema.
71        Expr::Neg(inner) => match &inner.node {
72            Expr::Literal(Literal::Int(n)) => Ok(Value::Int(-*n)),
73            Expr::Literal(Literal::Float(f)) => Ok(Value::Float(-*f)),
74            _ => Err("unary '-' must be applied to a numeric literal in entry args".to_string()),
75        },
76        Expr::Ident(name) if is_upper_camel(name) => constructor_value(name, &[]),
77        Expr::Attr(_, _) if dotted_upper_path(expr).is_some() => {
78            let path = dotted_upper_path(expr).unwrap();
79            constructor_value(&path, &[])
80        }
81        Expr::Constructor(name, arg) => {
82            let fields = constructor_arg_fields(arg.as_deref())?;
83            constructor_value(name, &fields)
84        }
85        Expr::FnCall(target, args) if dotted_upper_path(&target.node).is_some() => {
86            let path = dotted_upper_path(&target.node).unwrap();
87            let mut fields = Vec::with_capacity(args.len());
88            for a in args {
89                fields.push(expr_to_value(&a.node)?);
90            }
91            constructor_value(&path, &fields)
92        }
93        Expr::List(items) => {
94            let mut out = Vec::with_capacity(items.len());
95            for e in items {
96                out.push(expr_to_value(&e.node)?);
97            }
98            Ok(Value::List(aver_rt::AverList::from_vec(out)))
99        }
100        Expr::Tuple(items) => {
101            let mut out = Vec::with_capacity(items.len());
102            for e in items {
103                out.push(expr_to_value(&e.node)?);
104            }
105            Ok(Value::Tuple(out))
106        }
107        _ => Err(
108            "unsupported expression shape (supported: literals, lists, tuples, \
109             ADT constructors like Shape.Circle(1.0) / Result.Ok(x) / Option.None)"
110                .to_string(),
111        ),
112    }
113}
114
115fn literal_to_value(lit: &Literal) -> Value {
116    match lit {
117        Literal::Int(i) => Value::Int(*i),
118        Literal::Float(f) => Value::Float(*f),
119        Literal::Str(s) => Value::Str(s.clone()),
120        Literal::Bool(b) => Value::Bool(*b),
121        Literal::Unit => Value::Unit,
122    }
123}
124
125fn is_upper_camel(name: &str) -> bool {
126    name.chars().next().is_some_and(|c| c.is_ascii_uppercase())
127}
128
129fn dotted_upper_path(expr: &Expr) -> Option<String> {
130    match expr {
131        Expr::Ident(name) if is_upper_camel(name) => Some(name.clone()),
132        Expr::Attr(inner, field) if is_upper_camel(field) => {
133            let base = dotted_upper_path(&inner.node)?;
134            Some(format!("{}.{}", base, field))
135        }
136        _ => None,
137    }
138}
139
140fn constructor_arg_fields(arg: Option<&Spanned<Expr>>) -> Result<Vec<Value>, String> {
141    match arg {
142        None => Ok(Vec::new()),
143        Some(inner) => match &inner.node {
144            Expr::Tuple(items) => {
145                let mut out = Vec::with_capacity(items.len());
146                for e in items {
147                    out.push(expr_to_value(&e.node)?);
148                }
149                Ok(out)
150            }
151            _ => Ok(vec![expr_to_value(&inner.node)?]),
152        },
153    }
154}
155
156fn constructor_value(path: &str, fields: &[Value]) -> Result<Value, String> {
157    // Built-in wrapper constructors: accept both qualified (`Result.Ok`)
158    // and bare (`Ok`) forms mirroring what the parser produces.
159    match path {
160        "Result.Ok" | "Ok" => {
161            require_arity(path, fields, 1)?;
162            Ok(Value::Ok(Box::new(fields[0].clone())))
163        }
164        "Result.Err" | "Err" => {
165            require_arity(path, fields, 1)?;
166            Ok(Value::Err(Box::new(fields[0].clone())))
167        }
168        "Option.Some" | "Some" => {
169            require_arity(path, fields, 1)?;
170            Ok(Value::Some(Box::new(fields[0].clone())))
171        }
172        "Option.None" | "None" => {
173            require_arity(path, fields, 0)?;
174            Ok(Value::None)
175        }
176        _ => {
177            let mut parts = path.rsplitn(2, '.');
178            let variant = parts.next().ok_or("empty constructor path")?.to_string();
179            let type_name = parts
180                .next()
181                .ok_or_else(|| {
182                    format!(
183                        "constructor '{}' needs a type prefix (e.g. 'Shape.Circle')",
184                        path
185                    )
186                })?
187                .to_string();
188            Ok(Value::Variant {
189                type_name,
190                variant,
191                fields: Arc::<[Value]>::from(fields.to_vec()),
192            })
193        }
194    }
195}
196
197fn require_arity(path: &str, fields: &[Value], expected: usize) -> Result<(), String> {
198    if fields.len() != expected {
199        return Err(format!(
200            "constructor '{}' expects {} argument{}, got {}",
201            path,
202            expected,
203            if expected == 1 { "" } else { "s" },
204            fields.len()
205        ));
206    }
207    Ok(())
208}
209
210/// Serialise entry-call arguments into the replay schema's `input` field.
211///
212/// Matches `decode_entry_args` on the replay side:
213/// - empty arg list → `JsonValue::Null`
214/// - single arg → the single value directly
215/// - multiple args → a JSON array
216pub fn encode_entry_args(args: &[Value]) -> Result<JsonValue, String> {
217    match args.len() {
218        0 => Ok(JsonValue::Null),
219        1 => value_to_json(&args[0]),
220        _ => {
221            let jsons: Result<Vec<_>, _> = args.iter().map(value_to_json).collect();
222            jsons.map(JsonValue::Array)
223        }
224    }
225}
226
227/// Derive a readable filename stem from an entry call.
228/// Simple literal args produce a visible slug (`"fetchUser-alice"`);
229/// complex cases fall back to a stable hash-based stem.
230pub fn recording_stem(fn_name: &str, args: &[Value]) -> String {
231    fn value_slug(v: &Value) -> Option<String> {
232        match v {
233            Value::Str(s) if is_slug_safe(s) && s.len() <= 32 => Some(s.clone()),
234            Value::Int(i) => Some(i.to_string()),
235            Value::Float(f) if f.is_finite() => Some(format!("{}", f).replace('.', "_")),
236            Value::Bool(b) => Some(if *b { "true".into() } else { "false".into() }),
237            _ => None,
238        }
239    }
240    fn is_slug_safe(s: &str) -> bool {
241        !s.is_empty()
242            && s.chars()
243                .all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '_')
244    }
245
246    let slugs: Option<Vec<String>> = args.iter().map(value_slug).collect();
247    match slugs {
248        Some(parts) if !parts.is_empty() => format!("{}-{}", fn_name, parts.join("-")),
249        Some(_) => fn_name.to_string(),
250        None => {
251            use std::collections::hash_map::DefaultHasher;
252            use std::hash::{Hash, Hasher};
253            let mut hasher = DefaultHasher::new();
254            fn_name.hash(&mut hasher);
255            for v in args {
256                format!("{:?}", v).hash(&mut hasher);
257            }
258            let h = hasher.finish();
259            format!("{}-{:08x}", fn_name, (h & 0xffff_ffff) as u32)
260        }
261    }
262}
263
264#[cfg(test)]
265mod tests {
266    use super::*;
267
268    fn parse(src: &str) -> (String, Vec<Value>) {
269        parse_entry_call(src).expect("should parse")
270    }
271
272    fn parse_err(src: &str) -> String {
273        parse_entry_call(src)
274            .expect_err("should reject")
275            .to_string()
276    }
277
278    #[test]
279    fn literal_args() {
280        let (name, args) = parse(r#"greet("Alice", 42, 3.14, true)"#);
281        assert_eq!(name, "greet");
282        assert_eq!(args.len(), 4);
283        assert!(matches!(args[0], Value::Str(ref s) if s == "Alice"));
284        assert!(matches!(args[1], Value::Int(42)));
285        let expected = 314.0 / 100.0;
286        assert!(matches!(args[2], Value::Float(f) if (f - expected).abs() < 1e-9));
287        assert!(matches!(args[3], Value::Bool(true)));
288    }
289
290    #[test]
291    fn negative_numeric_literals() {
292        let (_, args) = parse("loadTempBounds(-300.0, -40)");
293        assert!(matches!(args[0], Value::Float(f) if (f + 300.0).abs() < 1e-9));
294        assert!(matches!(args[1], Value::Int(-40)));
295    }
296
297    #[test]
298    fn negative_on_non_literal_is_rejected() {
299        let msg = parse_err("foo(-Shape.Circle(1.0))");
300        assert!(msg.contains("numeric literal"), "got: {}", msg);
301    }
302
303    #[test]
304    fn user_variant_single_and_multi_field() {
305        let (_, args) = parse("area(Shape.Circle(1.0))");
306        let Value::Variant {
307            type_name,
308            variant,
309            fields,
310        } = &args[0]
311        else {
312            panic!("expected Variant, got {:?}", args[0]);
313        };
314        assert_eq!(type_name, "Shape");
315        assert_eq!(variant, "Circle");
316        assert_eq!(fields.len(), 1);
317        assert!(matches!(fields[0], Value::Float(f) if (f - 1.0).abs() < 1e-9));
318
319        let (_, args) = parse("area(Shape.Rectangle(3.0, 4.0))");
320        let Value::Variant { fields, .. } = &args[0] else {
321            panic!("expected Variant");
322        };
323        assert_eq!(fields.len(), 2);
324    }
325
326    #[test]
327    fn builtin_wrapper_constructors() {
328        let (_, args) = parse(r#"handle(Result.Ok(5))"#);
329        assert!(matches!(&args[0], Value::Ok(inner) if matches!(**inner, Value::Int(5))));
330
331        let (_, args) = parse(r#"handle(Result.Err("bad"))"#);
332        assert!(
333            matches!(&args[0], Value::Err(inner) if matches!(**inner, Value::Str(ref s) if s == "bad"))
334        );
335
336        let (_, args) = parse("handle(Option.Some(1))");
337        assert!(matches!(&args[0], Value::Some(inner) if matches!(**inner, Value::Int(1))));
338
339        let (_, args) = parse("handle(Option.None)");
340        assert!(matches!(&args[0], Value::None));
341    }
342
343    #[test]
344    fn nested_constructors() {
345        let (_, args) = parse("handle(Result.Ok(Shape.Circle(2.0)))");
346        let Value::Ok(inner) = &args[0] else {
347            panic!("expected Ok");
348        };
349        let Value::Variant {
350            type_name, variant, ..
351        } = &**inner
352        else {
353            panic!("expected inner Variant");
354        };
355        assert_eq!(type_name, "Shape");
356        assert_eq!(variant, "Circle");
357    }
358
359    #[test]
360    fn list_and_tuple_args() {
361        let (_, args) = parse("sumAll([1, 2, 3])");
362        assert!(matches!(args[0], Value::List(_)));
363
364        let (_, args) = parse(r#"describe((1, "x"))"#);
365        assert!(matches!(args[0], Value::Tuple(ref items) if items.len() == 2));
366    }
367
368    #[test]
369    fn arity_mismatch_on_builtin_wrapper() {
370        let msg = parse_err("handle(Result.Ok(1, 2))");
371        assert!(msg.contains("Result.Ok"), "got: {}", msg);
372    }
373
374    #[test]
375    fn zero_arg_call_is_accepted() {
376        let (name, args) = parse("tick()");
377        assert_eq!(name, "tick");
378        assert!(args.is_empty());
379    }
380
381    #[test]
382    fn top_level_must_be_a_call() {
383        let msg = parse_err("42");
384        assert!(msg.contains("function call"), "got: {}", msg);
385    }
386
387    #[test]
388    fn arithmetic_arg_rejected() {
389        let msg = parse_err("foo(1 + 2)");
390        assert!(msg.contains("arg #1"), "got: {}", msg);
391    }
392
393    #[test]
394    fn function_call_arg_rejected() {
395        // Lowercase `helper` = function ref, not constructor. Rejected.
396        let msg = parse_err("foo(helper(5))");
397        assert!(msg.contains("arg #1"), "got: {}", msg);
398    }
399
400    #[test]
401    fn variable_arg_rejected() {
402        let msg = parse_err("foo(x)");
403        assert!(msg.contains("arg #1"), "got: {}", msg);
404    }
405
406    #[test]
407    fn qualified_target_rejected() {
408        let msg = parse_err("Math.abs(-5)");
409        assert!(msg.contains("bare function name"), "got: {}", msg);
410    }
411
412    #[test]
413    fn encode_entry_args_shape() {
414        use crate::replay::JsonValue;
415
416        match encode_entry_args(&[]).unwrap() {
417            JsonValue::Null => {}
418            other => panic!("expected Null for empty, got {:?}", other),
419        }
420
421        let single = encode_entry_args(&[Value::Int(5)]).unwrap();
422        assert!(matches!(single, JsonValue::Int(5)), "got: {:?}", single);
423
424        let multi = encode_entry_args(&[Value::Int(1), Value::Str("x".into())]).unwrap();
425        assert!(
426            matches!(&multi, JsonValue::Array(v) if v.len() == 2),
427            "got: {:?}",
428            multi
429        );
430    }
431
432    #[test]
433    fn recording_stem_literal_args() {
434        assert_eq!(
435            recording_stem("loadPort", &[Value::Str("PL".into())]),
436            "loadPort-PL"
437        );
438        assert_eq!(recording_stem("fib", &[Value::Int(10)]), "fib-10");
439        assert_eq!(recording_stem("flag", &[Value::Bool(false)]), "flag-false");
440    }
441
442    #[test]
443    fn recording_stem_complex_args_fall_back_to_hash() {
444        let stem = recording_stem(
445            "area",
446            &[Value::Variant {
447                type_name: "Shape".into(),
448                variant: "Circle".into(),
449                fields: Arc::<[Value]>::from(vec![Value::Float(1.0)]),
450            }],
451        );
452        assert!(stem.starts_with("area-"), "got: {}", stem);
453        assert_eq!(stem.len(), "area-".len() + 8, "expected 8-hex suffix");
454    }
455}