query-flow 0.17.0

A high-level query framework built on whale for incremental computation.
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
//! Tests for list_queries and list_asset_keys functionality.

use std::sync::atomic::{AtomicU32, Ordering};
use std::sync::Arc;

use query_flow::{AssetKey, Db, DurabilityLevel, Query, QueryError, QueryRuntime};

// Simple query that doubles a value
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
struct DoubleQuery {
    value: i32,
}

impl Query for DoubleQuery {
    type Output = i32;

    fn query(self, _db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
        Ok(Arc::new(self.value * 2))
    }

    fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
        old == new
    }
}

// Asset key for testing list_asset_keys
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
struct ConfigFile(String);

impl AssetKey for ConfigFile {
    type Asset = String;

    fn asset_eq(old: &Self::Asset, new: &Self::Asset) -> bool {
        old == new
    }
}

// Query that lists all config files
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
struct ListConfigsQuery;

impl Query for ListConfigsQuery {
    type Output = Vec<String>;

    fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
        let keys = db.list_asset_keys::<ConfigFile>();
        let mut names: Vec<String> = keys.iter().map(|k| k.0.clone()).collect();
        names.sort();
        Ok(Arc::new(names))
    }

    fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
        old == new
    }
}

#[test]
fn test_list_queries_basic() {
    // Query that aggregates all DoubleQuery results using list_queries
    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct AggregateQuery;

    impl Query for AggregateQuery {
        type Output = Vec<i32>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            let queries = db.list_queries::<DoubleQuery>();
            let mut results = Vec::new();
            for q in queries {
                results.push(*db.query(q)?);
            }
            results.sort();
            Ok(Arc::new(results))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();

    // Execute some queries
    runtime.query(DoubleQuery { value: 1 }).unwrap();
    runtime.query(DoubleQuery { value: 2 }).unwrap();
    runtime.query(DoubleQuery { value: 3 }).unwrap();

    // Aggregate should see all three
    let result = runtime.query(AggregateQuery).unwrap();
    assert_eq!(*result, vec![2, 4, 6]);
}

#[test]
fn test_list_queries_invalidation_on_add() {
    static AGGREGATE_COUNT: AtomicU32 = AtomicU32::new(0);

    // Query that aggregates all DoubleQuery results using list_queries
    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct TrackedAggregateQuery;

    impl Query for TrackedAggregateQuery {
        type Output = Vec<i32>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            AGGREGATE_COUNT.fetch_add(1, Ordering::SeqCst);
            let queries = db.list_queries::<DoubleQuery>();
            let mut results = Vec::new();
            for q in queries {
                results.push(*db.query(q)?);
            }
            results.sort();
            Ok(Arc::new(results))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();
    AGGREGATE_COUNT.store(0, Ordering::SeqCst);

    // Execute initial queries
    runtime.query(DoubleQuery { value: 1 }).unwrap();
    runtime.query(DoubleQuery { value: 2 }).unwrap();

    // First aggregate
    let result = runtime.query(TrackedAggregateQuery).unwrap();
    assert_eq!(*result, vec![2, 4]);
    assert_eq!(AGGREGATE_COUNT.load(Ordering::SeqCst), 1);

    // Cache hit - should not recompute
    let result = runtime.query(TrackedAggregateQuery).unwrap();
    assert_eq!(*result, vec![2, 4]);
    assert_eq!(AGGREGATE_COUNT.load(Ordering::SeqCst), 1);

    // Add a new query - this should invalidate the aggregate
    runtime.query(DoubleQuery { value: 3 }).unwrap();

    // Should recompute with the new query
    let result = runtime.query(TrackedAggregateQuery).unwrap();
    assert_eq!(*result, vec![2, 4, 6]);
    assert_eq!(AGGREGATE_COUNT.load(Ordering::SeqCst), 2);
}

#[test]
fn test_list_queries_no_invalidation_on_value_change() {
    static AGGREGATE_COUNT: AtomicU32 = AtomicU32::new(0);

    // Query that only uses list_queries, not individual queries
    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct ListOnlyQuery;

    impl Query for ListOnlyQuery {
        type Output = usize;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            AGGREGATE_COUNT.fetch_add(1, Ordering::SeqCst);
            let queries = db.list_queries::<DoubleQuery>();
            // Just count, don't query individual ones
            Ok(Arc::new(queries.len()))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();
    AGGREGATE_COUNT.store(0, Ordering::SeqCst);

    // Execute initial query
    runtime.query(DoubleQuery { value: 1 }).unwrap();

    // First list-only query
    let result = runtime.query(ListOnlyQuery).unwrap();
    assert_eq!(*result, 1);
    assert_eq!(AGGREGATE_COUNT.load(Ordering::SeqCst), 1);

    // Invalidate the individual query (not the set)
    runtime.invalidate(&DoubleQuery { value: 1 });

    // The list-only query should still be cached because:
    // 1. It doesn't depend on individual query values
    // 2. The SET didn't change (no add/remove)
    let result = runtime.query(ListOnlyQuery).unwrap();
    assert_eq!(*result, 1);
    assert_eq!(AGGREGATE_COUNT.load(Ordering::SeqCst), 1);
}

#[test]
fn test_list_queries_individual_dependency() {
    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct AggregateQuery2;

    impl Query for AggregateQuery2 {
        type Output = Vec<i32>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            let queries = db.list_queries::<DoubleQuery>();
            let mut results = Vec::new();
            for q in queries {
                results.push(*db.query(q)?);
            }
            results.sort();
            Ok(Arc::new(results))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();

    // Execute queries
    runtime.query(DoubleQuery { value: 1 }).unwrap();
    runtime.query(DoubleQuery { value: 2 }).unwrap();

    // Aggregate depends on both the set and individual queries
    let result = runtime.query(AggregateQuery2).unwrap();
    assert_eq!(*result, vec![2, 4]);

    // Invalidate an individual query
    runtime.invalidate(&DoubleQuery { value: 1 });

    // Re-execute individual query with same key
    runtime.query(DoubleQuery { value: 1 }).unwrap();

    // Aggregate should still work correctly
    let result = runtime.query(AggregateQuery2).unwrap();
    assert_eq!(*result, vec![2, 4]);
}

#[test]
fn test_list_asset_keys_basic() {
    let runtime = QueryRuntime::new();

    // Resolve some assets
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "{}".to_string(),
        DurabilityLevel::Volatile,
    );
    runtime.resolve_asset(
        ConfigFile("db.json".to_string()),
        "{}".to_string(),
        DurabilityLevel::Volatile,
    );

    // List should see both
    let result = runtime.query(ListConfigsQuery).unwrap();
    assert_eq!(*result, vec!["app.json", "db.json"]);
}

#[test]
fn test_list_asset_keys_invalidation_on_remove() {
    static LIST_COUNT: AtomicU32 = AtomicU32::new(0);

    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct TrackedListConfigs;

    impl Query for TrackedListConfigs {
        type Output = Vec<String>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            LIST_COUNT.fetch_add(1, Ordering::SeqCst);
            let keys = db.list_asset_keys::<ConfigFile>();
            let mut names: Vec<String> = keys.iter().map(|k| k.0.clone()).collect();
            names.sort();
            Ok(Arc::new(names))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();
    LIST_COUNT.store(0, Ordering::SeqCst);

    // Resolve assets
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "{}".to_string(),
        DurabilityLevel::Volatile,
    );
    runtime.resolve_asset(
        ConfigFile("db.json".to_string()),
        "{}".to_string(),
        DurabilityLevel::Volatile,
    );

    // First list
    let result = runtime.query(TrackedListConfigs).unwrap();
    assert_eq!(*result, vec!["app.json", "db.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 1);

    // Cache hit
    let result = runtime.query(TrackedListConfigs).unwrap();
    assert_eq!(*result, vec!["app.json", "db.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 1);

    // Remove an asset - should invalidate list
    runtime.remove_asset(&ConfigFile("db.json".to_string()));

    // Should recompute
    let result = runtime.query(TrackedListConfigs).unwrap();
    assert_eq!(*result, vec!["app.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 2);
}

#[test]
fn test_list_asset_keys_no_invalidation_on_value_change() {
    static LIST_COUNT: AtomicU32 = AtomicU32::new(0);

    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct TrackedListConfigs2;

    impl Query for TrackedListConfigs2 {
        type Output = Vec<String>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            LIST_COUNT.fetch_add(1, Ordering::SeqCst);
            let keys = db.list_asset_keys::<ConfigFile>();
            let mut names: Vec<String> = keys.iter().map(|k| k.0.clone()).collect();
            names.sort();
            Ok(Arc::new(names))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();
    LIST_COUNT.store(0, Ordering::SeqCst);

    // Resolve asset
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "v1".to_string(),
        DurabilityLevel::Volatile,
    );

    // First list
    let result = runtime.query(TrackedListConfigs2).unwrap();
    assert_eq!(*result, vec!["app.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 1);

    // Update asset value (same key, different value)
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "v2".to_string(),
        DurabilityLevel::Volatile,
    );

    // List should still be cached because the SET didn't change
    let result = runtime.query(TrackedListConfigs2).unwrap();
    assert_eq!(*result, vec!["app.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 1);
}

#[test]
fn test_list_asset_keys_with_individual_asset_dependency() {
    static CONTENT_COUNT: AtomicU32 = AtomicU32::new(0);

    // Query that lists all config files and reads their contents
    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct AllConfigContents;

    impl Query for AllConfigContents {
        type Output = Vec<(String, String)>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            CONTENT_COUNT.fetch_add(1, Ordering::SeqCst);
            let keys = db.list_asset_keys::<ConfigFile>();
            let mut results = Vec::new();
            for key in keys {
                let key_name = key.0.clone();
                if let Some(content) = db.asset_state(key)?.get() {
                    results.push((key_name, (**content).clone()));
                }
            }
            results.sort();
            Ok(Arc::new(results))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();
    CONTENT_COUNT.store(0, Ordering::SeqCst);

    // Resolve assets
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "v1".to_string(),
        DurabilityLevel::Volatile,
    );

    // First query
    let result = runtime.query(AllConfigContents).unwrap();
    assert_eq!(*result, vec![("app.json".to_string(), "v1".to_string())]);
    assert_eq!(CONTENT_COUNT.load(Ordering::SeqCst), 1);

    // Update asset value - should invalidate because we depend on individual assets too
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "v2".to_string(),
        DurabilityLevel::Volatile,
    );

    // Should recompute because of individual asset dependency
    let result = runtime.query(AllConfigContents).unwrap();
    assert_eq!(*result, vec![("app.json".to_string(), "v2".to_string())]);
    assert_eq!(CONTENT_COUNT.load(Ordering::SeqCst), 2);
}

#[test]
fn test_list_queries_empty() {
    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct AggregateQuery3;

    impl Query for AggregateQuery3 {
        type Output = Vec<i32>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            let queries = db.list_queries::<DoubleQuery>();
            let mut results = Vec::new();
            for q in queries {
                results.push(*db.query(q)?);
            }
            results.sort();
            Ok(Arc::new(results))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();

    // Query aggregate before any DoubleQuery has been executed
    let result = runtime.query(AggregateQuery3).unwrap();
    assert_eq!(*result, Vec::<i32>::new());
}

#[test]
fn test_list_asset_keys_empty() {
    let runtime = QueryRuntime::new();

    // Query list before any assets have been resolved
    let result = runtime.query(ListConfigsQuery).unwrap();
    assert_eq!(*result, Vec::<String>::new());
}

#[test]
fn test_list_asset_keys_invalidation_on_add() {
    static LIST_COUNT: AtomicU32 = AtomicU32::new(0);

    #[derive(Clone, Debug, Hash, PartialEq, Eq)]
    struct TrackedListConfigs3;

    impl Query for TrackedListConfigs3 {
        type Output = Vec<String>;

        fn query(self, db: &impl Db) -> Result<Arc<Self::Output>, QueryError> {
            LIST_COUNT.fetch_add(1, Ordering::SeqCst);
            let keys = db.list_asset_keys::<ConfigFile>();
            let mut names: Vec<String> = keys.iter().map(|k| k.0.clone()).collect();
            names.sort();
            Ok(Arc::new(names))
        }

        fn output_eq(old: &Self::Output, new: &Self::Output) -> bool {
            old == new
        }
    }

    let runtime = QueryRuntime::new();
    LIST_COUNT.store(0, Ordering::SeqCst);

    // Resolve first asset
    runtime.resolve_asset(
        ConfigFile("app.json".to_string()),
        "{}".to_string(),
        DurabilityLevel::Volatile,
    );

    // First list
    let result = runtime.query(TrackedListConfigs3).unwrap();
    assert_eq!(*result, vec!["app.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 1);

    // Add another asset - should invalidate list
    runtime.resolve_asset(
        ConfigFile("db.json".to_string()),
        "{}".to_string(),
        DurabilityLevel::Volatile,
    );

    // Should recompute
    let result = runtime.query(TrackedListConfigs3).unwrap();
    assert_eq!(*result, vec!["app.json", "db.json"]);
    assert_eq!(LIST_COUNT.load(Ordering::SeqCst), 2);
}