formualizer-eval 0.10.0

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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
use super::common::arrow_eval_config;
use crate::arrow_store::OverlayValue;
use crate::engine::template::region::Region;
use crate::engine::used_extent::{
    ExtentPolicy, OpenRangeBounds, ResolvedExtent, resolve_used_extent,
};
use crate::engine::virtual_deps::{DynamicRefCollector, RangeVirtualDepProvider};
use crate::engine::{Engine, FormulaPlaneMode};
use crate::interpreter::probe_range_dimensions;
use crate::test_workbook::TestWorkbook;
use crate::traits::EvaluationContext;
use formualizer_common::LiteralValue;
use formualizer_parse::parser::{ReferenceType, parse};
use proptest::prelude::*;

fn evaluation_extent(
    engine: &Engine<TestWorkbook>,
    sheet: &str,
    bounds: OpenRangeBounds,
) -> Option<ResolvedExtent> {
    let fallback = engine.sheet_bounds(sheet).map(|_| {
        (
            engine.config.max_open_ended_rows,
            engine.config.max_open_ended_cols,
        )
    });
    resolve_used_extent(
        bounds,
        ExtentPolicy::EvaluationCompat {
            fallback_row: fallback.map(|value| value.0),
            fallback_column: fallback.map(|value| value.1),
        },
        |first, last| engine.used_rows_for_columns(sheet, first, last),
        |first, last| engine.used_cols_for_rows(sheet, first, last),
    )
}

fn interpreter_probe_extent(
    engine: &Engine<TestWorkbook>,
    sheet: &str,
    bounds: OpenRangeBounds,
) -> Option<ResolvedExtent> {
    let fallback = engine.sheet_bounds(sheet);
    resolve_used_extent(
        bounds,
        ExtentPolicy::EvaluationCompat {
            fallback_row: fallback.map(|value| value.0),
            fallback_column: fallback.map(|value| value.1),
        },
        |first, last| engine.used_rows_for_columns(sheet, first, last),
        |first, last| engine.used_cols_for_rows(sheet, first, last),
    )
}

fn semantic_extent(
    engine: &Engine<TestWorkbook>,
    sheet: &str,
    bounds: OpenRangeBounds,
) -> Option<ResolvedExtent> {
    resolve_used_extent(
        bounds,
        ExtentPolicy::Semantic,
        |first, last| engine.semantic_used_rows_for_columns(sheet, first, last),
        |first, last| engine.semantic_used_cols_for_rows(sheet, first, last),
    )
}

fn virtual_dependency_extent(
    engine: &Engine<TestWorkbook>,
    sheet: &str,
    bounds: OpenRangeBounds,
) -> Option<ResolvedExtent> {
    let fallback = engine.sheet_bounds(sheet).map(|_| {
        (
            engine.config.max_open_ended_rows,
            engine.config.max_open_ended_cols,
        )
    });
    resolve_used_extent(
        bounds,
        ExtentPolicy::VirtualDependencyCompat {
            fallback_row: fallback.map(|value| value.0),
            fallback_column: fallback.map(|value| value.1),
        },
        |first, last| engine.used_rows_for_columns(sheet, first, last),
        |first, last| engine.used_cols_for_rows(sheet, first, last),
    )
}

// Frozen from Engine::resolve_range_view at ccfeaf83. Keep this test-only copy
// independent of the shared resolver so it remains a differential oracle.
fn frozen_evaluation_extent_ccfeaf83(
    engine: &Engine<TestWorkbook>,
    sheet_name: &str,
    bounds: OpenRangeBounds,
) -> Option<ResolvedExtent> {
    let mut sr = bounds.start_row;
    let mut sc = bounds.start_column;
    let mut er = bounds.end_row;
    let mut ec = bounds.end_column;

    if sr.is_none() && er.is_none() {
        let scv = sc.unwrap_or(1);
        let ecv = ec.unwrap_or(scv);
        sr = Some(1);
        if let Some((_, max_r)) = engine.used_rows_for_columns(sheet_name, scv, ecv) {
            er = Some(max_r);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            er = Some(engine.config.max_open_ended_rows);
        }
    }
    if sc.is_none() && ec.is_none() {
        let srv = sr.unwrap_or(1);
        let erv = er.unwrap_or(srv);
        sc = Some(1);
        if let Some((_, max_c)) = engine.used_cols_for_rows(sheet_name, srv, erv) {
            ec = Some(max_c);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            ec = Some(engine.config.max_open_ended_cols);
        }
    }
    if sr.is_some() && er.is_none() {
        let scv = sc.unwrap_or(1);
        let ecv = ec.unwrap_or(scv);
        if let Some((_, max_r)) = engine.used_rows_for_columns(sheet_name, scv, ecv) {
            er = Some(max_r);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            er = Some(engine.config.max_open_ended_rows);
        }
    }
    if er.is_some() && sr.is_none() {
        sr = Some(1);
    }
    if sc.is_some() && ec.is_none() {
        let srv = sr.unwrap_or(1);
        let erv = er.unwrap_or(srv);
        if let Some((_, max_c)) = engine.used_cols_for_rows(sheet_name, srv, erv) {
            ec = Some(max_c);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            ec = Some(engine.config.max_open_ended_cols);
        }
    }
    if ec.is_some() && sc.is_none() {
        sc = Some(1);
    }

    let sr = sr.unwrap_or(1);
    let sc = sc.unwrap_or(1);
    let er = er.unwrap_or(sr.saturating_sub(1));
    let ec = ec.unwrap_or(sc.saturating_sub(1));
    (er >= sr && ec >= sc).then_some(ResolvedExtent {
        start_row: sr,
        start_column: sc,
        end_row: er,
        end_column: ec,
    })
}

// Frozen from RangeVirtualDepProvider::get_virtual_deps at ccfeaf83. Its used
// minimum behavior is deliberately different from runtime evaluation.
fn frozen_virtual_dependency_extent_ccfeaf83(
    engine: &Engine<TestWorkbook>,
    sheet_name: &str,
    bounds: OpenRangeBounds,
) -> Option<ResolvedExtent> {
    let mut sr = bounds.start_row;
    let mut sc = bounds.start_column;
    let mut er = bounds.end_row;
    let mut ec = bounds.end_column;

    if sr.is_none() && er.is_none() {
        let scv = sc.unwrap_or(1u32);
        let ecv = ec.unwrap_or(scv);
        if let Some((min_r, max_r)) = engine.used_rows_for_columns(sheet_name, scv, ecv) {
            sr = Some(min_r);
            er = Some(max_r);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            sr = Some(1);
            er = Some(engine.config.max_open_ended_rows);
        }
    }
    if sc.is_none() && ec.is_none() {
        let srv = sr.unwrap_or(1u32);
        let erv = er.unwrap_or(srv);
        if let Some((min_c, max_c)) = engine.used_cols_for_rows(sheet_name, srv, erv) {
            sc = Some(min_c);
            ec = Some(max_c);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            sc = Some(1);
            ec = Some(engine.config.max_open_ended_cols);
        }
    }
    if sr.is_some() && er.is_none() {
        let scv = sc.unwrap_or(1u32);
        let ecv = ec.unwrap_or(scv);
        if let Some((_, max_r)) = engine.used_rows_for_columns(sheet_name, scv, ecv) {
            er = Some(max_r);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            er = Some(engine.config.max_open_ended_rows);
        }
    }
    if er.is_some() && sr.is_none() {
        let scv = sc.unwrap_or(1u32);
        let ecv = ec.unwrap_or(scv);
        if let Some((min_r, _)) = engine.used_rows_for_columns(sheet_name, scv, ecv) {
            sr = Some(min_r);
        } else {
            sr = Some(1);
        }
    }
    if sc.is_some() && ec.is_none() {
        let srv = sr.unwrap_or(1u32);
        let erv = er.unwrap_or(srv);
        if let Some((_, max_c)) = engine.used_cols_for_rows(sheet_name, srv, erv) {
            ec = Some(max_c);
        } else if engine.sheet_bounds(sheet_name).is_some() {
            ec = Some(engine.config.max_open_ended_cols);
        }
    }
    if ec.is_some() && sc.is_none() {
        let srv = sr.unwrap_or(1u32);
        let erv = er.unwrap_or(srv);
        if let Some((min_c, _)) = engine.used_cols_for_rows(sheet_name, srv, erv) {
            sc = Some(min_c);
        } else {
            sc = Some(1);
        }
    }

    let sr = sr.unwrap_or(1);
    let sc = sc.unwrap_or(1);
    let er = er.unwrap_or(sr.saturating_sub(1));
    let ec = ec.unwrap_or(sc.saturating_sub(1));
    (er >= sr && ec >= sc).then_some(ResolvedExtent {
        start_row: sr,
        start_column: sc,
        end_row: er,
        end_column: ec,
    })
}

fn range_matrix() -> [OpenRangeBounds; 16] {
    let mut ranges = [OpenRangeBounds {
        start_row: None,
        start_column: None,
        end_row: None,
        end_column: None,
    }; 16];
    for (index, bounds) in ranges.iter_mut().enumerate() {
        bounds.start_row = ((index & 0b1000) != 0).then_some(2);
        bounds.start_column = ((index & 0b0100) != 0).then_some(2);
        bounds.end_row = ((index & 0b0010) != 0).then_some(8);
        bounds.end_column = ((index & 0b0001) != 0).then_some(6);
    }
    ranges
}

fn populated_engine(
    base_cells: &[(u32, u32)],
    overlay_cells: &[(u32, u32)],
    formula_cells: &[(u32, u32)],
) -> Engine<TestWorkbook> {
    let mut config = arrow_eval_config();
    config.formula_plane_mode = FormulaPlaneMode::Off;
    config.enable_parallel = false;
    config.max_open_ended_rows = 64;
    config.max_open_ended_cols = 16;
    let mut engine = Engine::new(TestWorkbook::new(), config);
    let sheet = "Sheet1";

    {
        let mut ingest = engine.begin_bulk_ingest_arrow();
        ingest.add_sheet(sheet, 8, 4);
        for row in 1..=12 {
            let values = (1..=8)
                .map(|column| {
                    if base_cells.contains(&(row, column)) {
                        LiteralValue::Int(i64::from(row * 10 + column))
                    } else {
                        LiteralValue::Empty
                    }
                })
                .collect::<Vec<_>>();
            ingest.append_row(sheet, &values).unwrap();
        }
        ingest.finish().unwrap();
    }

    for &(row, column) in overlay_cells {
        let row0 = usize::try_from(row - 1).unwrap();
        let column0 = usize::try_from(column - 1).unwrap();
        let arrow_sheet = engine.sheet_store_mut().sheet_mut(sheet).unwrap();
        let (chunk, offset) = arrow_sheet.chunk_of_row(row0).unwrap();
        arrow_sheet.columns[column0].chunks[chunk]
            .overlay
            .set_scalar(offset, OverlayValue::Number(f64::from(row * 10 + column)));
    }

    for &(row, column) in formula_cells {
        engine
            .set_cell_formula(sheet, row, column, parse("=1+2").unwrap())
            .unwrap();
    }
    engine
}

proptest! {
    #![proptest_config(ProptestConfig::with_cases(48))]

    #[test]
    fn randomized_sheet_extents_match_frozen_ccfeaf83_helpers(
        base_cells in prop::collection::vec((1u32..=12, 1u32..=8), 0..30),
        overlay_cells in prop::collection::vec((1u32..=12, 1u32..=8), 0..20),
        formula_cells in prop::collection::vec((1u32..=32, 1u32..=8), 0..20),
    ) {
        let engine = populated_engine(&base_cells, &overlay_cells, &formula_cells);
        for bounds in range_matrix() {
            prop_assert_eq!(
                evaluation_extent(&engine, "Sheet1", bounds),
                frozen_evaluation_extent_ccfeaf83(&engine, "Sheet1", bounds),
            );
            prop_assert_eq!(
                virtual_dependency_extent(&engine, "Sheet1", bounds),
                frozen_virtual_dependency_extent_ccfeaf83(&engine, "Sheet1", bounds),
            );
        }
    }
}

#[test]
fn differential_matrix_covers_empty_formula_only_overlay_only_and_logical_tail() {
    let empty = populated_engine(&[], &[], &[]);
    let formula_only = populated_engine(&[], &[], &[(31, 2)]);
    let overlay_only = populated_engine(&[], &[(11, 4)], &[]);
    let mixed = populated_engine(&[(2, 1), (9, 7)], &[(12, 3)], &[(30, 6)]);

    for engine in [&empty, &formula_only, &overlay_only, &mixed] {
        for bounds in range_matrix() {
            assert_eq!(
                evaluation_extent(engine, "Sheet1", bounds),
                frozen_evaluation_extent_ccfeaf83(engine, "Sheet1", bounds)
            );
            assert_eq!(
                virtual_dependency_extent(engine, "Sheet1", bounds),
                frozen_virtual_dependency_extent_ccfeaf83(engine, "Sheet1", bounds)
            );
        }
    }

    for bounds in range_matrix() {
        assert_eq!(
            evaluation_extent(&empty, "Missing", bounds),
            frozen_evaluation_extent_ccfeaf83(&empty, "Missing", bounds)
        );
        assert_eq!(
            virtual_dependency_extent(&empty, "Missing", bounds),
            frozen_virtual_dependency_extent_ccfeaf83(&empty, "Missing", bounds)
        );
    }

    let whole_column =
        ReferenceType::range(Some("Sheet1".to_string()), None, Some(2), None, Some(2));
    let empty_view = empty.resolve_range_view(&whole_column, "Sheet1").unwrap();
    assert_eq!((empty_view.start_row(), empty_view.end_row()), (0, 63));

    let view = formula_only
        .resolve_range_view(&whole_column, "Sheet1")
        .unwrap();
    assert_eq!((view.start_row(), view.end_row()), (0, 30));
    assert_eq!(
        formula_only.sheet_store().sheet("Sheet1").unwrap().nrows,
        12
    );
}

#[test]
fn interpreter_probe_sheet_bounds_fallback_divergence_is_pinned_not_changed() {
    let engine = populated_engine(&[], &[], &[]);
    let whole_column = OpenRangeBounds {
        start_row: None,
        start_column: Some(1),
        end_row: None,
        end_column: Some(1),
    };

    let evaluation = evaluation_extent(&engine, "Sheet1", whole_column).unwrap();
    let interpreter_probe = interpreter_probe_extent(&engine, "Sheet1", whole_column).unwrap();
    assert_eq!(evaluation.end_row, 64);
    assert_eq!(interpreter_probe.end_row, 1_048_576);

    let production_reference =
        ReferenceType::range(Some("Sheet1".to_string()), None, Some(1), None, Some(1));
    assert_eq!(
        probe_range_dimensions(&engine, "Sheet1", &production_reference),
        Some((1_048_576, 1))
    );
}

#[test]
fn interpreter_production_probe_loads_sheet_bounds_only_for_fallback() {
    use std::sync::Arc;
    use std::sync::atomic::{AtomicUsize, Ordering};

    let calls = Arc::new(AtomicUsize::new(0));
    let context = TestWorkbook::new().with_sheet_bounds_counter(Arc::clone(&calls));
    let bounded = ReferenceType::range(None, Some(1), Some(1), Some(2), Some(2));
    assert_eq!(
        probe_range_dimensions(&context, "Sheet1", &bounded),
        Some((2, 2))
    );
    assert_eq!(calls.load(Ordering::Relaxed), 0);

    let whole_column = ReferenceType::range(None, None, Some(1), None, Some(1));
    assert_eq!(
        probe_range_dimensions(&context, "Sheet1", &whole_column),
        Some((1_048_576, 1))
    );
    assert_eq!(calls.load(Ordering::Relaxed), 1);
}

#[test]
fn interpreter_production_probe_rejects_column_inversion_without_underflow() {
    let engine = populated_engine(&[], &[], &[]);
    let inverted = ReferenceType::range(
        Some("Sheet1".to_string()),
        Some(2),
        Some(9),
        Some(3),
        Some(4),
    );
    assert_eq!(
        probe_range_dimensions(&engine, "Sheet1", &inverted),
        Some((0, 0))
    );
}

#[test]
fn virtual_dependency_used_minimum_divergence_is_pinned_not_changed() {
    let engine = populated_engine(&[(8, 2)], &[], &[(20, 2)]);
    let whole_column = OpenRangeBounds {
        start_row: None,
        start_column: Some(2),
        end_row: None,
        end_column: Some(2),
    };
    let evaluation = evaluation_extent(&engine, "Sheet1", whole_column).unwrap();
    let virtual_dependency = virtual_dependency_extent(&engine, "Sheet1", whole_column).unwrap();
    assert_eq!((evaluation.start_row, evaluation.end_row), (1, 20));
    assert_eq!(
        (virtual_dependency.start_row, virtual_dependency.end_row),
        (8, 20)
    );
}

#[test]
fn graph_compressed_self_use_path_keeps_row_and_column_fallback_caps() {
    let mut engine = populated_engine(&[], &[], &[]);
    engine
        .set_cell_value("Sheet1", 20, 30, LiteralValue::Int(1))
        .unwrap();
    let sheet_id = engine.graph.sheet_id("Sheet1").unwrap();
    assert_eq!(
        engine
            .graph
            .compressed_range_resolved_bounds(sheet_id, (None, None, None, None)),
        Some((0, 63, 0, 29))
    );
}

#[test]
fn virtual_dependency_production_provider_keeps_used_minimum_policy() {
    let mut engine = populated_engine(&[(8, 2)], &[], &[]);
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=SUM(B:B)").unwrap())
        .unwrap();
    let address = engine.graph.make_cell_ref("Sheet1", 1, 1);
    let vertex = engine.graph.get_vertex_id_for_address(&address).unwrap();
    let range = engine.graph.get_range_dependencies(vertex).unwrap()[0].clone();

    assert!(RangeVirtualDepProvider::get_virtual_deps(&engine, vertex).is_empty());
    let extent = RangeVirtualDepProvider::resolve_range(&engine, "Sheet1", &range).unwrap();
    assert_eq!((extent.start_row, extent.end_row), (8, 8));
}

#[test]
fn dynamic_collector_production_path_keeps_evaluation_policy() {
    let engine = populated_engine(&[(8, 2)], &[], &[(20, 2)]);
    let collector = DynamicRefCollector::new(&engine, "Sheet1");
    let whole_column =
        ReferenceType::range(Some("Sheet1".to_string()), None, Some(2), None, Some(2));
    collector
        .resolve_range_view(&whole_column, "Sheet1")
        .unwrap();

    let sheet_id = engine.graph.sheet_id("Sheet1").unwrap();
    let regions = collector.collected_regions.lock().unwrap();
    assert!(regions.contains(&Region::rect(sheet_id, 0, 19, 1, 1).normalized()));
    assert!(!regions.contains(&Region::rect(sheet_id, 7, 19, 1, 1).normalized()));
}

#[test]
fn semantic_engine_source_excludes_dangling_reference_placeholders() {
    let mut engine = populated_engine(&[], &[], &[]);
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Z1000").unwrap())
        .unwrap();
    let whole_z = OpenRangeBounds {
        start_row: None,
        start_column: Some(26),
        end_row: None,
        end_column: Some(26),
    };

    assert_eq!(
        engine.used_rows_for_columns("Sheet1", 26, 26),
        Some((1000, 1000))
    );
    let semantic = semantic_extent(&engine, "Sheet1", whole_z);
    assert_eq!(semantic, None);
    assert_eq!(semantic.map(ResolvedExtent::cell_count).unwrap_or(0), 0);

    let evaluation = evaluation_extent(&engine, "Sheet1", whole_z).unwrap();
    assert_eq!((evaluation.start_row, evaluation.end_row), (1, 1000));
}

#[test]
fn semantic_engine_source_includes_formula_only_and_overlay_only_cells() {
    let formula_only = populated_engine(&[], &[], &[(31, 2)]);
    let formula_extent = semantic_extent(
        &formula_only,
        "Sheet1",
        OpenRangeBounds {
            start_row: None,
            start_column: Some(2),
            end_row: None,
            end_column: Some(2),
        },
    )
    .unwrap();
    assert_eq!((formula_extent.start_row, formula_extent.end_row), (1, 31));

    let overlay_only = populated_engine(&[], &[(11, 4)], &[]);
    let overlay_extent = semantic_extent(
        &overlay_only,
        "Sheet1",
        OpenRangeBounds {
            start_row: None,
            start_column: Some(4),
            end_row: None,
            end_column: Some(4),
        },
    )
    .unwrap();
    assert_eq!((overlay_extent.start_row, overlay_extent.end_row), (1, 11));
}

#[test]
fn semantic_engine_source_treats_placeholder_only_sheet_as_empty() {
    let mut engine = populated_engine(&[], &[], &[]);
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Z1000").unwrap())
        .unwrap();
    engine
        .set_cell_value("Sheet1", 1, 1, LiteralValue::Empty)
        .unwrap();

    let extent = semantic_extent(
        &engine,
        "Sheet1",
        OpenRangeBounds {
            start_row: None,
            start_column: None,
            end_row: None,
            end_column: None,
        },
    );
    assert_eq!(extent, None);
}

#[test]
fn referenced_cells_extent_follows_structural_edits_and_their_undo() {
    use crate::engine::ChangeLog;
    use crate::engine::graph::editor::undo_engine::UndoEngine;
    let mut engine = Engine::new(TestWorkbook::new(), arrow_eval_config());
    engine.add_sheet("Refs").unwrap();
    engine
        .set_cell_formula("Refs", 1, 1, parse("=SUM(Sheet1!AB4999:AB5000)").unwrap())
        .unwrap();
    let sheet = engine.graph.sheet_id("Sheet1").unwrap();
    let bounds = |e: &Engine<TestWorkbook>| {
        (
            e.graph.used_row_bounds_for_columns(sheet, 27, 27),
            e.graph.used_col_bounds_for_rows(sheet, 4999, 4999),
        )
    };
    let start = (Some((4998, 4999)), Some((27, 27)));
    let shifted = (Some((5000, 5001)), None);
    assert_eq!(bounds(&engine), start);
    let mut log = ChangeLog::new();
    let mut undo = UndoEngine::new();
    engine
        .action_with_logger(&mut log, "insert", |a| {
            a.insert_rows("Sheet1", 3000, 2).map(|_| ())
        })
        .unwrap();
    assert_eq!(bounds(&engine), shifted);
    // The undo shifts the record back at the edit's end marker, then
    // replays the formula's old text (noting its cells in that frame): the
    // record returns to its state before.
    engine.undo_logged(&mut undo, &mut log).unwrap();
    assert_eq!(bounds(&engine), start);
    engine.redo_logged(&mut undo, &mut log).unwrap();
    assert_eq!(bounds(&engine), shifted);
    engine.undo_logged(&mut undo, &mut log).unwrap();
    engine
        .action_with_logger(&mut log, "insert", |a| {
            a.insert_rows("Sheet1", 3000, 2).map(|_| ())
        })
        .unwrap();
    assert_eq!(bounds(&engine), shifted);
    // A delete drops the band's cells.
    engine.delete_rows("Sheet1", 5001, 1).unwrap();
    assert_eq!(
        engine.graph.used_row_bounds_for_columns(sheet, 27, 27),
        Some((5000, 5000))
    );
    engine.delete_columns("Sheet1", 28, 1).unwrap();
    assert_eq!(
        engine.graph.used_row_bounds_for_columns(sheet, 27, 27),
        None
    );
}

/// Program 3 audit B2: undo of a structural edit restores the extent record
/// from what the edit dropped (a delete's band), not from a copy of the
/// sheet's record per edit. Undo/redo of a logged delete of a band holding
/// value and referenced cells, and of an insert with an adjusted reader,
/// give the record back; history retained for undo grows with the cells
/// the edits dropped (linear in edits, none for inserts), also when the
/// caller discards its logs.
#[test]
fn structural_undo_extent_history_is_delta_sized() {
    use crate::engine::ChangeLog;
    use crate::engine::graph::editor::undo_engine::UndoEngine;
    let mut engine = Engine::new(TestWorkbook::new(), arrow_eval_config());
    engine.add_sheet("Refs").unwrap();
    for row in 1..=5u32 {
        engine
            .set_cell_value("Sheet1", row * 10, 2, LiteralValue::Number(1.0))
            .unwrap();
    }
    engine
        .set_cell_formula("Refs", 1, 1, parse("=SUM(Sheet1!AB25:AB26)").unwrap())
        .unwrap();
    let sheet = engine.graph.sheet_id("Sheet1").unwrap();
    let bounds = |e: &Engine<TestWorkbook>| {
        (
            e.graph.used_row_bounds_for_columns(sheet, 1, 1),
            e.graph.used_row_bounds_for_columns(sheet, 27, 27),
            e.graph.used_col_bounds_for_rows(sheet, 19, 29),
        )
    };
    let start = bounds(&engine);
    assert_eq!(start, (Some((9, 49)), Some((24, 25)), Some((1, 27))));
    let mut log = ChangeLog::new();
    let mut undo = UndoEngine::new();
    // Delete rows 20..=30 (1-based): B20, B30 and AB25:AB26 go.
    engine
        .edit_with_logger(&mut log, |ed| ed.delete_rows(sheet, 19, 11).map(|_| ()))
        .unwrap()
        .unwrap();
    let deleted = (Some((9, 38)), None, Some((1, 1)));
    assert_eq!(bounds(&engine), deleted);
    assert_eq!(engine.graph.extent_history_counts().0, 1);
    engine.undo_logged(&mut undo, &mut log).unwrap();
    assert_eq!(bounds(&engine), start);
    assert_eq!(engine.graph.extent_history_counts(), (0, 0));
    engine.redo_logged(&mut undo, &mut log).unwrap();
    assert_eq!(bounds(&engine), deleted);
    engine.undo_logged(&mut undo, &mut log).unwrap();
    assert_eq!(bounds(&engine), start);
    // An insert above everything, then its undo (the reader's old text is
    // replayed in the pre-insert frame).
    engine
        .action_with_logger(&mut log, "insert", |a| {
            a.insert_rows("Sheet1", 1, 3).map(|_| ())
        })
        .unwrap();
    assert_eq!(
        bounds(&engine).0.zip(bounds(&engine).1),
        Some(((12, 52), (27, 28)))
    );
    assert_eq!(engine.graph.extent_history_counts(), (0, 0));
    engine.undo_logged(&mut undo, &mut log).unwrap();
    assert_eq!(bounds(&engine), start);

    // Growth: n rounds of (value, logged insert below it, logged delete of
    // the value's row), each round's log discarded.
    let retained = |n: u32| {
        let mut e = Engine::new(TestWorkbook::new(), arrow_eval_config());
        for i in 1..=n {
            e.set_cell_value("S", 2 * i, 1, LiteralValue::Number(1.0))
                .unwrap();
            let mut log = ChangeLog::new();
            e.action_with_logger(&mut log, "insert", |a| {
                a.insert_rows("S", 10_000, 1).map(|_| ())
            })
            .unwrap();
            e.set_cell_value("S", 2 * i + 1, 1, LiteralValue::Number(1.0))
                .unwrap();
            let s = e.graph.sheet_id("S").unwrap();
            e.edit_with_logger(&mut log, |ed| ed.delete_rows(s, 2 * i, 1).map(|_| ()))
                .unwrap()
                .unwrap();
        }
        e.graph.extent_history_counts()
    };
    let mut last = None;
    for n in [64u32, 128, 256, 512] {
        let (entries, runs) = retained(n);
        // One entry per logged delete, holding the one cell it dropped.
        assert_eq!((entries, runs), (n as usize, n as usize), "n={n}");
        if let Some(prev) = last {
            let ratio = runs as f64 / prev as f64;
            assert!(ratio <= 2.2, "retained runs doubled by {ratio:.2} at n={n}");
        }
        last = Some(runs);
    }
}

/// Decision 31 (matthew_lenhart__26135): the extent notes a load leaves
/// pending (value and referenced cells) are folded when the load ends, not
/// by the edit that next crosses the fold threshold (that edit's set took
/// ~60 µs instead of ~3).
#[test]
fn load_folds_its_pending_extent_notes() {
    let mut engine = Engine::new(TestWorkbook::new(), arrow_eval_config());
    engine.set_first_load_assume_new(true);
    for row in 1..=3000u32 {
        engine
            .set_cell_value("Sheet1", row * 2, 2, LiteralValue::Number(1.0))
            .unwrap();
    }
    assert!(engine.graph.extent_record_pending() > 0);
    engine.set_first_load_assume_new(false);
    assert_eq!(engine.graph.extent_record_pending(), 0);
    let sheet = engine.graph.sheet_id("Sheet1").unwrap();
    assert_eq!(
        engine.graph.used_row_bounds_for_columns(sheet, 1, 1),
        Some((1, 5999))
    );
}