fosk 0.1.6

In-memory SQL-like query engine and lightweight data store for testing and prototyping.
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
use ordered_float::NotNan;
use serde_json::Value;

use crate::parser::{
    analyzer::{AnalysisContext, AnalyzerError, ColumnResolver},
    ast::{Function, Literal, ScalarExpr}
};

pub struct ScalarResolver;

impl ScalarResolver {
    pub fn scalar_literal(expr: &ScalarExpr) -> Option<Literal> {
        match expr {
            ScalarExpr::Literal(l) => Some(l.clone()),
            // you can add folding for nested functions here later
            _ => None
        }
    }

    pub fn fold_scalar(expr: &ScalarExpr) -> ScalarExpr {
        match expr {
            ScalarExpr::Function(Function { name, args , distinct}) => {
                let lname = name.to_ascii_lowercase();
                if matches!(lname.as_str(), "count" | "sum" | "avg" | "min" | "max") {
                    return ScalarExpr::Function(Function { name: name.clone(), args: args.clone(), distinct: *distinct });
                }

                // Fold args first
                let folded_args: Vec<ScalarExpr> = args.iter().map(Self::fold_scalar).collect();

                // If all literals, try to fold
                let mut lit_args = Vec::with_capacity(folded_args.len());
                for arg in &folded_args {
                    if let ScalarExpr::Literal(l) = arg { lit_args.push(l.clone()); } else {
                        return ScalarExpr::Function(Function { name: name.clone(), args: folded_args, distinct: *distinct });
                    }
                }

                let folded = match (lname.as_str(), lit_args.as_slice()) {
                    ("upper",  [Literal::String(value)]) => Some(Literal::String(value.to_uppercase())),
                    ("lower",  [Literal::String(value)]) => Some(Literal::String(value.to_lowercase())),
                    ("trim",   [Literal::String(value)]) => Some(Literal::String(value.trim().to_string())),
                    ("length", [Literal::String(value)]) => Some(Literal::Int(value.chars().count() as i64)),
                    _ => None,
                };

                folded.map(ScalarExpr::Literal)
                      .unwrap_or_else(|| ScalarExpr::Function(Function { name: name.clone(), args: folded_args, distinct: *distinct }))
            }
            _ => expr.clone()
        }
    }

    pub fn qualify_scalar(expr: &ScalarExpr, ctx: &mut AnalysisContext, allow_args: bool) -> Result<ScalarExpr, AnalyzerError> {
        match expr {
            ScalarExpr::Column(c) => Ok(ScalarExpr::Column(ColumnResolver::qualify_column(c, ctx)?.0)),

            ScalarExpr::Function(Function { name, args, distinct }) => {
                let lname = name.to_ascii_lowercase();

                // Special-case COUNT(*) so we don't try to qualify the wildcard
                if lname == "count" && args.len() == 1 && matches!(args[0], ScalarExpr::WildCard) {
                    return Ok(ScalarExpr::Function(Function {
                        name: name.clone(),
                        args: vec![ScalarExpr::WildCard], // keep as-is
                        distinct: *distinct,
                    }));
                }

                // Otherwise, qualify all args normally (wildcards are illegal outside COUNT)
                let mut new_args = Vec::with_capacity(args.len());
                for arg in args {
                    new_args.push(Self::qualify_scalar(arg, ctx, true)?);
                }
                Ok(ScalarExpr::Function(Function { name: name.clone(), args: new_args, distinct: *distinct }))
            },

            ScalarExpr::Parameter => {
                Self::qualify_parameter(ctx, allow_args)
            },

            // Wildcards should already have been expanded — except COUNT(*), handled above.
            ScalarExpr::WildCard | ScalarExpr::WildCardWithCollection(_) => {
                Err(AnalyzerError::Other("wildcards must be expanded before qualification".into()))
            },

            _ => Ok(expr.clone()),
        }
    }

    fn qualify_parameter(ctx: &mut AnalysisContext, allow_args: bool) -> Result<ScalarExpr, AnalyzerError> {
        let value = match &ctx.parameters {
            Value::Array(values) => {
                if ctx.current_param >= values.len() {
                    return Err(AnalyzerError::InvalidParameterValue);
                }

                &values[ctx.current_param]
            },
            _ => {
                if ctx.current_param > 0 {
                    return Err(AnalyzerError::InvalidParameterValue);
                }

                &ctx.parameters
            },
        };

        match Self::expand_parameter_value(value, allow_args) {
            Some(value) => {
                ctx.current_param += 1;
                Ok(value)
            },
            None => Err(AnalyzerError::InvalidParameterValue),
        }
    }

    fn expand_parameter_value(json_value: &Value, allow_args: bool) -> Option<ScalarExpr> {
        match json_value {
            Value::Null => Some(ScalarExpr::Literal(Literal::Null)),
            Value::Bool(value) => Some(ScalarExpr::Literal(Literal::Bool(*value))),
            Value::Number(number) => {
                if number.is_f64() {
                    Some(ScalarExpr::Literal(Literal::Float(NotNan::new(number.as_f64().unwrap()).unwrap())))
                } else if number.is_i64() {
                    Some(ScalarExpr::Literal(Literal::Int(number.as_i64().unwrap())))
                } else {
                    None
                }
            },
            Value::String(value) => Some(ScalarExpr::Literal(Literal::String(value.clone()))),
            Value::Array(values) => {
                if !allow_args {
                    return None;
                }
                let mut args: Vec<ScalarExpr> = vec![];
                for value in values {
                    if let Some(arg) = Self::expand_parameter_value(value, false) {
                        args.push(arg);
                    } else {
                        return None;
                    }
                }
                Some(ScalarExpr::Args(args))
            },
            _ => None,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{database::{FieldInfo, SchemaProvider}, parser::ast::Column, JsonPrimitive, SchemaDict};

    use super::*;
    use indexmap::IndexMap;
    use serde_json::json;

    // ---- minimal schema provider & context helpers ----
    struct DummySchemas {
        by_name: std::collections::HashMap<String, SchemaDict>,
    }
    impl DummySchemas {
        fn new() -> Self { Self { by_name: std::collections::HashMap::new() } }
        fn with(mut self, name: &str, fields: Vec<(&str, JsonPrimitive, bool)>) -> Self {
            let mut m = IndexMap::new();
            for (k, ty, nullable) in fields {
                m.insert(k.to_string(), FieldInfo { ty, nullable });
            }
            self.by_name.insert(name.to_string(), SchemaDict { fields: m });
            self
        }
    }
    impl SchemaProvider for DummySchemas {
        fn schema_of(&self, backing_collection: &str) -> Option<SchemaDict> {
            self.by_name.get(backing_collection).cloned()
        }
    }

    fn ctx_for_single_table<'a>(sp: &'a DummySchemas, table: &'a str, alias: Option<&'a str>) -> AnalysisContext<'a> {
        // Build a tiny context with 1 collection (optionally aliased)
        let mut ctx = AnalysisContext::new(sp);
        let visible = alias.unwrap_or(table).to_string();
        ctx.add_collection(visible, table.to_string());
        ctx
    }

    // ---- tests ----

    #[test]
    fn scalar_literal_only_for_literal() {
        assert_eq!(
            ScalarResolver::scalar_literal(&ScalarExpr::Literal(Literal::Int(42))),
            Some(Literal::Int(42))
        );
        assert!(ScalarResolver::scalar_literal(&ScalarExpr::Column(
            Column::Name { name: "x".into() }
        )).is_none());
    }

    #[test]
    fn fold_scalar_folds_simple_and_nested_scalar_functions() {
        // upper(lower(trim("  HeLLo "))) -> "HELLO"
        let expr = ScalarExpr::Function(Function {
            name: "upper".into(),
            distinct: false,
            args: vec![ScalarExpr::Function(Function {
                name: "lower".into(),
                distinct: false,
                args: vec![ScalarExpr::Function(Function {
                    name: "trim".into(),
                    distinct: false,
                    args: vec![ScalarExpr::Literal(Literal::String("  HeLLo ".into()))],
                })],
            })],
        });

        let folded = ScalarResolver::fold_scalar(&expr);
        assert_eq!(folded, ScalarExpr::Literal(Literal::String("hello".to_uppercase())));
    }

    #[test]
    fn fold_scalar_does_not_fold_when_args_not_all_literals() {
        // length(name) where name is a column → should remain a function (after recursive attempt)
        let expr = ScalarExpr::Function(Function {
            name: "length".into(),
            distinct: false,
            args: vec![ScalarExpr::Column(Column::Name { name: "name".into() })],
        });
        let folded = ScalarResolver::fold_scalar(&expr);
        assert!(matches!(folded, ScalarExpr::Function(Function { name, .. }) if name.eq_ignore_ascii_case("length")));
    }

    #[test]
    fn fold_scalar_does_not_fold_aggregates() {
        // sum(1) must remain a function (aggregates are never constant-folded)
        let expr = ScalarExpr::Function(Function {
            name: "sum".into(),
            distinct: false,
            args: vec![ScalarExpr::Literal(Literal::Int(1))],
        });
        let folded = ScalarResolver::fold_scalar(&expr);
        assert_eq!(folded, expr);
    }

    #[test]
    fn qualify_scalar_allows_count_star_and_keeps_wildcard() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);

        let expr = ScalarExpr::Function(Function {
            name: "COUNT".into(), // case-insensitive
            distinct: false,
            args: vec![ScalarExpr::WildCard],
        });

        let qualified = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify COUNT(*)");
        // Wildcard should be preserved inside COUNT
        match qualified {
            ScalarExpr::Function(Function { name, args, .. }) => {
                assert_eq!(name.to_ascii_lowercase(), "count");
                assert_eq!(args.len(), 1);
                assert!(matches!(args[0], ScalarExpr::WildCard));
            }
            other => panic!("expected Function(count,*), got {other:?}"),
        }
    }

    #[test]
    fn qualify_scalar_errors_on_wildcard_outside_count() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);

        let expr = ScalarExpr::Function(Function {
            name: "length".into(),
            distinct: false,
            args: vec![ScalarExpr::WildCard],
        });

        let err = ScalarResolver::qualify_scalar(&expr, &mut ctx, false);
        assert!(err.is_err(), "wildcard outside COUNT should error");
        let msg = format!("{err:?}").to_lowercase();
        assert!(msg.contains("wildcards must be expanded"), "unexpected error: {msg}");
    }

    #[test]
    fn qualify_scalar_qualifies_columns_inside_function_args() {
        // table t(name string)
        let sp = DummySchemas::new().with("t", vec![
            ("name", JsonPrimitive::String, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);

        // upper(name) → argument must become Column::WithCollection { collection:"t", name:"name" }
        let expr = ScalarExpr::Function(Function {
            name: "upper".into(),
            distinct: false,
            args: vec![ScalarExpr::Column(Column::Name { name: "name".into() })],
        });

        let qualified = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify");
        match qualified {
            ScalarExpr::Function(Function { name, args, .. }) => {
                assert_eq!(name.to_ascii_lowercase(), "upper");
                assert_eq!(args.len(), 1);
                match &args[0] {
                    ScalarExpr::Column(Column::WithCollection { collection, name }) => {
                        assert_eq!(collection, "t");
                        assert_eq!(name, "name");
                    }
                    other => panic!("expected qualified column in arg, got {other:?}"),
                }
            }
            other => panic!("expected Function, got {other:?}"),
        }
    }

    #[test]
    fn qualify_scalar_parameter_one() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);
        ctx.parameters = json!([1]);

        let expr = ScalarExpr::Parameter;

        let qualified = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");

        match qualified {
            ScalarExpr::Literal(Literal::Int(value)) => {
                assert_eq!(value, 1);
            }
            other => panic!("expected Literal::Int(1), got {other:?}"),
        }
    }

    #[test]
    fn qualify_scalar_parameter_three() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);
        ctx.parameters = json!([1, "value", true]);

        let expr = ScalarExpr::Parameter;

        let qualified1 = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");
        let qualified2 = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");
        let qualified3 = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");


        match (qualified1, qualified2, qualified3) {
            (
                ScalarExpr::Literal(Literal::Int(v1)),
                ScalarExpr::Literal(Literal::String(v2)),
                ScalarExpr::Literal(Literal::Bool(v3)),
            ) => {
                assert_eq!(v1, 1);
                assert_eq!(v2, "value");
                assert!(v3);
            }
            other =>
                panic!("expected (Literal::Int(1), Literal::String('value'), Literal::Bool(true)), got {other:?}"),
        }
    }

    #[test]
    fn qualify_scalar_parameter_args() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);
        ctx.parameters = json!([1, [2, 3, 4]]);

        let expr = ScalarExpr::Parameter;

        let qualified1 = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");
        let qualified2 = ScalarResolver::qualify_scalar(&expr, &mut ctx, true).expect("qualify ?");


        match (qualified1, qualified2) {
            (
                ScalarExpr::Literal(Literal::Int(v1)),
                ScalarExpr::Args(args),
            ) => {
                assert_eq!(v1, 1);
                assert_eq!(args.len(), 3);
            }
            other =>
                panic!("expected (Literal::Int(1), Args(Vec<ScalarExpr>)), got {other:?}"),
        }
    }

    #[test]
    fn qualify_scalar_parameter_single() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);
        ctx.parameters = json!(1);

        let expr = ScalarExpr::Parameter;

        let qualified = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");

        match qualified {
            ScalarExpr::Literal(Literal::Int(value)) => {
                assert_eq!(value, 1);
            }
            other => panic!("expected Literal::Int(1), got {other:?}"),
        }
    }

    #[test]
    fn qualify_scalar_parameter_single_wrong_number_of_params() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);
        ctx.parameters = json!(1);

        let expr = ScalarExpr::Parameter;

        let _ = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");
        let qualified2 = ScalarResolver::qualify_scalar(&expr, &mut ctx, false);

        match qualified2 {
            Ok(_) => panic!("expected error when exceeded params"),
            Err(err) => assert_eq!(err, AnalyzerError::InvalidParameterValue ),
        }
    }

    #[test]
    fn qualify_scalar_parameter_one_wrong_number_of_params() {
        let sp = DummySchemas::new().with("t", vec![
            ("id", JsonPrimitive::Int, false),
        ]);
        let mut ctx = ctx_for_single_table(&sp, "t", None);
        ctx.parameters = json!([1]);

        let expr = ScalarExpr::Parameter;

        let _ = ScalarResolver::qualify_scalar(&expr, &mut ctx, false).expect("qualify ?");
        let qualified2 = ScalarResolver::qualify_scalar(&expr, &mut ctx, false);

        match qualified2 {
            Ok(_) => panic!("expected error when exceeded params"),
            Err(err) => assert_eq!(err, AnalyzerError::InvalidParameterValue ),
        }
    }
}