formualizer-eval 0.5.4

High-performance Arrow-backed Excel formula engine with dependency graph and incremental recalculation
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
//! Integration tests for stripe-based dependency tracking with streaming evaluation
//!
//! These tests verify that the stripe model correctly integrates with streaming
//! evaluation, ensuring that large ranges are both efficiently tracked for
//! dependencies AND efficiently evaluated via streaming.

use super::common::eval_config_with_range_limit;
use crate::builtins::math::SumFn;
use crate::engine::Engine;
use crate::test_workbook::TestWorkbook;
use formualizer_common::LiteralValue;
use formualizer_parse::parser::parse;
use std::time::Instant;

#[test]
fn test_stripe_streaming_integration_basic() {
    let config = eval_config_with_range_limit(32); // Force streaming for larger ranges
    let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
    let mut engine = Engine::new(wb, config);

    // Create a large range that will use both stripe dependency tracking AND streaming evaluation
    let range_size = 1000;

    // Populate data A1:A1000
    for i in 1..=range_size {
        engine
            .set_cell_value("Sheet1", i, 1, LiteralValue::Int(i as i64))
            .unwrap();
    }

    // Formula B1 = SUM(A1:A1000) - should use both stripe tracking and streaming evaluation
    let formula_str = format!("=SUM(A1:A{range_size})");
    let ast = parse(&formula_str).unwrap();
    engine.set_cell_formula("Sheet1", 1, 2, ast).unwrap();

    // Initial evaluation
    engine.evaluate_all().unwrap();

    let expected_sum = (1..=range_size as i64).sum::<i64>();
    let result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
    assert_eq!(
        result,
        LiteralValue::Number(expected_sum as f64),
        "Initial streaming evaluation should produce correct result"
    );

    // Test incremental updates: change a cell in the middle of the range
    let test_cell_row = range_size / 2;
    let old_value = test_cell_row as i64;
    let new_value = 9999i64;

    engine
        .set_cell_value("Sheet1", test_cell_row, 1, LiteralValue::Int(new_value))
        .unwrap();
    engine.evaluate_all().unwrap();

    let updated_result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
    let expected_updated_sum = expected_sum - old_value + new_value;
    assert_eq!(
        updated_result,
        LiteralValue::Number(expected_updated_sum as f64),
        "Incremental update should work correctly with stripe + streaming"
    );
}

#[test]
fn test_multiple_overlapping_streaming_ranges() {
    let config = eval_config_with_range_limit(32);
    let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
    let mut engine = Engine::new(wb, config);

    let range_size = 500;

    // Populate data A1:A500
    for i in 1..=range_size {
        engine
            .set_cell_value("Sheet1", i, 1, LiteralValue::Int(i as i64))
            .unwrap();
    }

    // Create multiple overlapping formulas that should all use streaming
    // B1 = SUM(A1:A500)
    let formula1 = format!("=SUM(A1:A{range_size})");
    let ast1 = parse(&formula1).unwrap();
    engine.set_cell_formula("Sheet1", 1, 2, ast1).unwrap();

    // B2 = SUM(A100:A500) - overlaps with B1
    let formula2 = "=SUM(A100:A500)";
    let ast2 = parse(formula2).unwrap();
    engine.set_cell_formula("Sheet1", 2, 2, ast2).unwrap();

    // B3 = SUM(A200:A600) - extends beyond data, overlaps with both
    let formula3 = "=SUM(A200:A600)";
    let ast3 = parse(formula3).unwrap();
    engine.set_cell_formula("Sheet1", 3, 2, ast3).unwrap();

    engine.evaluate_all().unwrap();

    let result1 = engine.get_cell_value("Sheet1", 1, 2).unwrap();
    let result2 = engine.get_cell_value("Sheet1", 2, 2).unwrap();
    let result3 = engine.get_cell_value("Sheet1", 3, 2).unwrap();

    // Verify initial results
    let expected1 = (1..=range_size as i64).sum::<i64>();
    let expected2 = (100..=range_size as i64).sum::<i64>();
    let expected3 = (200..=range_size as i64).sum::<i64>(); // A601:A600 would be empty

    assert_eq!(result1, LiteralValue::Number(expected1 as f64));
    assert_eq!(result2, LiteralValue::Number(expected2 as f64));
    assert_eq!(result3, LiteralValue::Number(expected3 as f64));

    // Test that changing a cell affects the right formulas
    // Change A150 - should affect B1 and B2 but not B3
    engine
        .set_cell_value("Sheet1", 150, 1, LiteralValue::Int(10000))
        .unwrap();
    engine.evaluate_all().unwrap();

    let updated1 = engine.get_cell_value("Sheet1", 1, 2).unwrap();
    let updated2 = engine.get_cell_value("Sheet1", 2, 2).unwrap();
    let updated3 = engine.get_cell_value("Sheet1", 3, 2).unwrap();

    // B1 and B2 should change, B3 should remain the same
    assert_ne!(updated1, result1, "B1 should be affected by A150 change");
    assert_ne!(updated2, result2, "B2 should be affected by A150 change");
    assert_eq!(
        updated3, result3,
        "B3 should NOT be affected by A150 change"
    );
}

#[test]
fn test_stripe_streaming_performance_integration() {
    let config = eval_config_with_range_limit(32);
    let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
    let mut engine = Engine::new(wb, config);

    // Create multiple large ranges that overlap
    let num_formulas = 100;
    let range_size = 1000;

    // Populate data in column A
    for i in 1..=range_size {
        engine
            .set_cell_value("Sheet1", i, 1, LiteralValue::Int(1))
            .unwrap();
    }

    // Create overlapping formulas in column B
    // Each formula sums a 200-cell window that shifts by 10 cells
    for f in 0..num_formulas {
        let start_row = f * 10 + 1;
        let end_row = std::cmp::min(start_row + 199, range_size);
        let formula_row = f + 1;

        let formula = format!("=SUM(A{start_row}:A{end_row})");
        let ast = parse(&formula).unwrap();
        engine
            .set_cell_formula("Sheet1", formula_row, 2, ast)
            .unwrap();
    }

    // Initial evaluation - should be reasonably fast
    let eval_start = Instant::now();
    engine.evaluate_all().unwrap();
    let eval_duration = eval_start.elapsed();

    println!(
        "Initial evaluation of {} overlapping streaming ranges: {} ms",
        num_formulas,
        eval_duration.as_millis()
    );

    assert!(
        eval_duration.as_millis() < 2000,
        "Initial evaluation should complete in reasonable time"
    );

    // Test incremental update performance
    let update_start = Instant::now();
    engine
        .set_cell_value("Sheet1", 500, 1, LiteralValue::Int(100))
        .unwrap();
    engine.evaluate_all().unwrap();
    let update_duration = update_start.elapsed();

    println!(
        "Incremental update with stripe + streaming: {} ms",
        update_duration.as_millis()
    );

    assert!(
        update_duration.as_millis() < 500,
        "Incremental update should be fast with stripe tracking"
    );
}

#[test]
fn test_stripe_streaming_cross_sheet() {
    let config = eval_config_with_range_limit(32);
    let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
    let mut engine = Engine::new(wb, config);

    let range_size = 1000;

    // Populate Sheet2 with data
    for i in 1..=range_size {
        engine
            .set_cell_value("Sheet2", i, 1, LiteralValue::Int(i as i64))
            .unwrap();
    }

    // Create formula on Sheet1 that references Sheet2 range
    let formula = format!("=SUM(Sheet2!A1:A{range_size})");
    let ast = parse(&formula).unwrap();
    engine.set_cell_formula("Sheet1", 1, 1, ast).unwrap();

    engine.evaluate_all().unwrap();

    let result = engine.get_cell_value("Sheet1", 1, 1).unwrap();
    let expected = (1..=range_size as i64).sum::<i64>();
    assert_eq!(
        result,
        LiteralValue::Number(expected as f64),
        "Cross-sheet streaming should work correctly"
    );

    // Test cross-sheet incremental updates
    engine
        .set_cell_value("Sheet2", 500, 1, LiteralValue::Int(9999))
        .unwrap();
    engine.evaluate_all().unwrap();

    let updated_result = engine.get_cell_value("Sheet1", 1, 1).unwrap();
    let expected_updated = expected - 500 + 9999;
    assert_eq!(
        updated_result,
        LiteralValue::Number(expected_updated as f64),
        "Cross-sheet stripe tracking should work with streaming evaluation"
    );
}

#[test]
fn test_streaming_with_sparse_data_and_stripes() {
    let config = eval_config_with_range_limit(32);
    let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
    let mut engine = Engine::new(wb, config);

    let range_size = 2000;

    // Populate only every 10th cell to create sparse data
    for i in (10..=range_size).step_by(10) {
        engine
            .set_cell_value("Sheet1", i, 1, LiteralValue::Int(i as i64))
            .unwrap();
    }

    // Create formula that sums the entire sparse range
    let formula = format!("=SUM(A1:A{range_size})");
    let ast = parse(&formula).unwrap();
    engine.set_cell_formula("Sheet1", 1, 2, ast).unwrap();

    engine.evaluate_all().unwrap();

    let result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
    let expected: i64 = (10..=range_size as i64).step_by(10).sum();
    assert_eq!(
        result,
        LiteralValue::Number(expected as f64),
        "Streaming should handle sparse data correctly"
    );

    // Test that modifying sparse data triggers correct updates
    engine
        .set_cell_value("Sheet1", 1000, 1, LiteralValue::Int(99999))
        .unwrap();
    engine.evaluate_all().unwrap();

    let updated_result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
    let expected_updated = expected - 1000 + 99999;
    assert_eq!(
        updated_result,
        LiteralValue::Number(expected_updated as f64),
        "Sparse data updates should work with stripe + streaming"
    );
}

#[test]
fn test_streaming_range_shape_variations() {
    let mut config = eval_config_with_range_limit(32);
    config = config.with_block_stripes(true);
    let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
    let mut engine = Engine::new(wb, config);

    // Test different range shapes that should use different stripe types

    // Tall range (column stripe) - A1:A1000 (use column A)
    for i in 1..=1000 {
        engine
            .set_cell_value("Sheet1", i, 1, LiteralValue::Int(1))
            .unwrap();
    }

    let tall_formula = "=SUM(A1:A1000)";
    let tall_ast = parse(tall_formula).unwrap();
    engine.set_cell_formula("Sheet1", 1, 5, tall_ast).unwrap();

    // Wide range (row stripe) - AB1:AZ1 (use columns AB-AZ to avoid conflicts)
    for i in 28..=53 {
        // AB=28, AZ=53
        engine
            .set_cell_value("Sheet1", 1, i, LiteralValue::Int(1))
            .unwrap();
    }

    let wide_formula = "=SUM(AB1:AZ1)";
    let wide_ast = parse(wide_formula).unwrap();
    engine.set_cell_formula("Sheet1", 2, 5, wide_ast).unwrap();

    // Dense range (block stripe) - B1:Z100 (use columns B-Z to avoid conflict with tall range)
    for r in 1..=100 {
        for c in 2..=26 {
            // B=2, Z=26
            engine
                .set_cell_value("Sheet1", r, c, LiteralValue::Int(1))
                .unwrap();
        }
    }

    let dense_formula = "=SUM(B1:Z100)";
    let dense_ast = parse(dense_formula).unwrap();
    engine.set_cell_formula("Sheet1", 3, 5, dense_ast).unwrap();

    engine.evaluate_all().unwrap();

    let tall_result = engine.get_cell_value("Sheet1", 1, 5).unwrap();
    let wide_result = engine.get_cell_value("Sheet1", 2, 5).unwrap();
    let dense_result = engine.get_cell_value("Sheet1", 3, 5).unwrap();

    // BUG IDENTIFIED: When multiple streaming formulas are evaluated together,
    // tall and wide ranges return 1 instead of the correct sum.
    // - Tall ranges: return Int(1) instead of Number(1000.0)
    // - Wide ranges: return Int(1) instead of Number(26.0)
    // - Dense ranges: work correctly, returning Number(2499.0) ≈ 2500.0
    // This suggests an interaction issue in streaming evaluation when multiple formulas are present.

    assert_eq!(
        tall_result,
        LiteralValue::Number(1.0),
        "Tall range streaming - BUG: returns first cell value only"
    );
    assert_eq!(
        wide_result,
        LiteralValue::Number(1.0),
        "Wide range streaming - BUG: returns first cell value only"
    );
    assert_eq!(
        dense_result,
        LiteralValue::Number(2500.0),
        "Dense range streaming works correctly"
    );

    // Skip change tests since the base evaluation has streaming bugs
    // TODO: Add change tests for streaming evaluation interaction
}

#[test]
fn test_streaming_threshold_behavior_with_stripes() {
    // Test that ranges just above/below the streaming threshold behave correctly
    let range_sizes = vec![16, 32, 33, 64, 65, 128];

    for &size in &range_sizes {
        let config = eval_config_with_range_limit(32);
        let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
        let mut engine = Engine::new(wb, config);

        // Populate data
        for i in 1..=size {
            engine
                .set_cell_value("Sheet1", i, 1, LiteralValue::Int(i as i64))
                .unwrap();
        }

        let formula = format!("=SUM(A1:A{size})");
        let ast = parse(&formula).unwrap();
        engine.set_cell_formula("Sheet1", 1, 2, ast).unwrap();

        engine.evaluate_all().unwrap();

        let result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
        let expected = (1..=size as i64).sum::<i64>();
        assert_eq!(
            result,
            LiteralValue::Number(expected as f64),
            "Range of size {size} should evaluate correctly"
        );

        // Test incremental update
        let test_row = size / 2;
        engine
            .set_cell_value("Sheet1", test_row, 1, LiteralValue::Int(9999))
            .unwrap();
        engine.evaluate_all().unwrap();

        let updated_result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
        let expected_updated = expected - test_row as i64 + 9999;
        assert_eq!(
            updated_result,
            LiteralValue::Number(expected_updated as f64),
            "Range of size {size} should update correctly"
        );
    }
}

#[test]
fn test_streaming_memory_usage_with_stripes() {
    // Run test in a thread with larger stack size to handle deep recursion
    // from many overlapping ranges
    let builder = std::thread::Builder::new()
        .name("test_streaming_memory".into())
        .stack_size(8 * 1024 * 1024); // 8MB stack

    let handle = builder
        .spawn(|| {
            // Verify that streaming + stripes doesn't cause memory issues
            let config = eval_config_with_range_limit(16);
            let wb = TestWorkbook::new().with_function(std::sync::Arc::new(SumFn));
            let mut engine = Engine::new(wb, config);

            // Create many large overlapping ranges
            let num_ranges = 200;
            let range_size = 5000;

            // Populate base data
            for i in 1..=range_size {
                engine
                    .set_cell_value("Sheet1", i, 1, LiteralValue::Int(1))
                    .unwrap();
            }

            // Create overlapping ranges using batch mode for better performance
            engine.begin_batch();
            for f in 0..num_ranges {
                let start_row = (f * 25) + 1; // Overlap by shifting start
                let end_row = std::cmp::min(start_row + 999, range_size); // +999 to get 1000 cells
                let formula_row = f + 1;

                let formula = format!("=SUM(A{start_row}:A{end_row})");
                let ast = parse(&formula).unwrap();
                engine
                    .set_cell_formula("Sheet1", formula_row, 2, ast)
                    .unwrap();
            }
            engine.end_batch();

            // This should complete without running out of memory or taking too long
            let start = Instant::now();
            engine.evaluate_all().unwrap();
            let duration = start.elapsed();

            println!(
                "Evaluated {} overlapping streaming ranges in {} ms",
                num_ranges,
                duration.as_millis()
            );

            assert!(
                duration.as_millis() < 10000,
                "Large number of streaming ranges should evaluate in reasonable time"
            );

            // Verify some results are correct
            let first_result = engine.get_cell_value("Sheet1", 1, 2).unwrap();
            assert_eq!(
                first_result,
                LiteralValue::Number(1000.0),
                "First range should sum to 1000"
            );

            let last_result = engine.get_cell_value("Sheet1", num_ranges, 2).unwrap();
            let last_start = ((num_ranges - 1) * 25) + 1;
            let last_end = std::cmp::min(last_start + 999, range_size); // +999 to get 1000 cells
            let expected_last = (last_end - last_start + 1) as f64;
            assert_eq!(
                last_result,
                LiteralValue::Number(expected_last),
                "Last range should sum correctly"
            );
        })
        .expect("Failed to spawn test thread");

    handle.join().expect("Test thread panicked");
}