formualizer-eval 0.6.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
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
//! Tests for the hybrid model of range dependency management.
use super::common::{abs_cell_ref, eval_config_with_range_limit};
use crate::engine::{DependencyGraph, Engine, EvalConfig, VertexId};
use crate::test_workbook::TestWorkbook;
use formualizer_common::{LiteralValue, parse_a1_1based};
use formualizer_parse::parse;
use formualizer_parse::parser::{ASTNode, ASTNodeType, ReferenceType};

/// Helper to create a range reference AST node
fn range_ast(start_row: u32, start_col: u32, end_row: u32, end_col: u32) -> ASTNode {
    ASTNode {
        node_type: ASTNodeType::Reference {
            original: format!("R{start_row}C{start_col}:R{end_row}C{end_col}"),
            reference: ReferenceType::range(
                None,
                Some(start_row),
                Some(start_col),
                Some(end_row),
                Some(end_col),
            ),
        },
        source_token: None,
        contains_volatile: false,
    }
}

/// Helper to create a SUM(range) AST node
fn sum_ast(start_row: u32, start_col: u32, end_row: u32, end_col: u32) -> ASTNode {
    ASTNode {
        node_type: ASTNodeType::Function {
            name: "SUM".to_string(),
            args: vec![range_ast(start_row, start_col, end_row, end_col)],
        },
        source_token: None,
        contains_volatile: false,
    }
}

fn graph_with_range_limit(limit: usize) -> DependencyGraph {
    DependencyGraph::new_with_config(eval_config_with_range_limit(limit))
}

#[test]
fn test_tiny_range_expands_to_cell_dependencies() {
    let mut graph = graph_with_range_limit(4);

    // C1 = SUM(A1:A4) - size is 4, which is <= limit
    graph
        .set_cell_formula("Sheet1", 1, 3, sum_ast(1, 1, 4, 1))
        .unwrap();

    let c1_id = *graph
        .get_vertex_id_for_address(&abs_cell_ref(0, 1, 3))
        .unwrap();
    let c1_vertex = graph
        .get_vertex_id_for_address(&abs_cell_ref(0, 1, 3))
        .unwrap();

    let dependencies = graph.get_dependencies(c1_id);

    // Should have 4 direct dependencies
    assert_eq!(
        dependencies.len(),
        4,
        "Should expand to 4 cell dependencies"
    );

    // Should have no compressed range dependencies
    assert!(
        graph.formula_to_range_deps().is_empty(),
        "Should not create a compressed range dependency"
    );

    // Verify the dependencies are correct
    let mut dep_addrs = Vec::new();
    for &dep_id in &dependencies {
        let cell_ref = graph.get_cell_ref(dep_id).unwrap();
        dep_addrs.push((cell_ref.coord.row(), cell_ref.coord.col()));
    }
    dep_addrs.sort();
    let expected_addrs = vec![(0, 0), (1, 0), (2, 0), (3, 0)];
    assert_eq!(dep_addrs, expected_addrs);
}

#[test]
fn test_range_dependency_dirtiness() {
    let mut graph = DependencyGraph::new();

    // C1 depends on the range A1:A10.
    graph
        .set_cell_formula("Sheet1", 1, 3, sum_ast(1, 1, 10, 1))
        .unwrap();
    let c1_id = *graph.cell_to_vertex().get(&abs_cell_ref(0, 1, 3)).unwrap();

    // Create a value in the middle of the range, e.g., A5.
    graph
        .set_cell_value("Sheet1", 5, 1, LiteralValue::Int(100))
        .unwrap();

    // Clear all dirty flags from the initial setup.
    let all_ids: Vec<VertexId> = graph.cell_to_vertex().values().copied().collect();
    graph.clear_dirty_flags(&all_ids);
    assert!(graph.get_evaluation_vertices().is_empty());

    // Now, change the value of A5. This should trigger dirty propagation
    // to C1 via the range dependency.
    graph
        .set_cell_value("Sheet1", 5, 1, LiteralValue::Int(200))
        .unwrap();

    // Check that C1 is now dirty.
    let eval_vertices = graph.get_evaluation_vertices();
    assert!(!eval_vertices.is_empty());
    assert!(eval_vertices.contains(&c1_id));
}

#[test]
fn test_range_dependency_updates_on_formula_change() {
    let mut graph = DependencyGraph::new();

    // B1 = SUM(A1:A2)
    graph
        .set_cell_formula("Sheet1", 1, 2, sum_ast(1, 1, 2, 1))
        .unwrap();
    let b1_id = *graph.cell_to_vertex().get(&abs_cell_ref(0, 1, 2)).unwrap();

    // Change A1, B1 should be dirty
    graph
        .set_cell_value("Sheet1", 1, 1, LiteralValue::Int(10))
        .unwrap();
    assert!(graph.get_evaluation_vertices().contains(&b1_id));
    graph.clear_dirty_flags(&[b1_id]);
    assert!(!graph.get_evaluation_vertices().contains(&b1_id));

    // Change A3 (outside the range), B1 should NOT be dirty
    graph
        .set_cell_value("Sheet1", 3, 1, LiteralValue::Int(30))
        .unwrap();
    assert!(!graph.get_evaluation_vertices().contains(&b1_id));

    // Now, update B1 to depend on A1:A5
    graph
        .set_cell_formula("Sheet1", 1, 2, sum_ast(1, 1, 5, 1))
        .unwrap();
    graph.clear_dirty_flags(&[b1_id]);

    // Change A3 again (now inside the range), B1 should be dirty
    graph
        .set_cell_value("Sheet1", 3, 1, LiteralValue::Int(40))
        .unwrap();
    assert!(graph.get_evaluation_vertices().contains(&b1_id));
}

#[test]
fn test_large_range_creates_single_compressed_ref() {
    let mut graph = graph_with_range_limit(4);

    // C1 = SUM(A1:A100) - size is 100, which is > limit
    graph
        .set_cell_formula("Sheet1", 1, 3, sum_ast(1, 1, 100, 1))
        .unwrap();

    let c1_id = *graph
        .get_vertex_id_for_address(&abs_cell_ref(0, 1, 3))
        .unwrap();
    let c1_dependencies = graph.get_dependencies(c1_id);

    // Should have no direct dependencies
    assert!(
        c1_dependencies.is_empty(),
        "Should not have any direct cell dependencies"
    );

    // Should have one compressed range dependency
    let range_deps = graph.formula_to_range_deps();
    assert_eq!(
        range_deps.len(),
        1,
        "Should create one compressed range dependency"
    );
    assert!(range_deps.contains_key(&c1_id));
    assert_eq!(range_deps.get(&c1_id).unwrap().len(), 1);
}

#[test]
fn test_duplicate_range_refs_in_formula() {
    let mut graph = graph_with_range_limit(4);
    // B1 = SUM(A1:A100) + COUNT(A1:A100)
    let formula = ASTNode {
        node_type: ASTNodeType::BinaryOp {
            op: "+".to_string(),
            left: Box::new(sum_ast(1, 1, 100, 1)),
            right: Box::new(ASTNode {
                node_type: ASTNodeType::Function {
                    name: "COUNT".to_string(),
                    args: vec![range_ast(1, 1, 100, 1)],
                },
                source_token: None,
                contains_volatile: false,
            }),
        },
        source_token: None,
        contains_volatile: false,
    };
    graph.set_cell_formula("Sheet1", 1, 2, formula).unwrap();

    let b1_id = *graph
        .get_vertex_id_for_address(&abs_cell_ref(0, 1, 2))
        .unwrap();

    // Should only have one compressed range dependency, not two
    let range_deps = graph.formula_to_range_deps();
    assert_eq!(range_deps.get(&b1_id).unwrap().len(), 1);
}

#[test]
fn test_zero_sized_range_behavior() {
    let mut graph = DependencyGraph::new();
    // B1 = SUM(A1:A0)
    let result = graph.set_cell_formula("Sheet1", 1, 2, sum_ast(1, 1, 0, 1));
    assert!(result.is_err());
    assert_eq!(
        result.unwrap_err().kind,
        formualizer_common::ExcelErrorKind::Ref
    );
}

fn create_simple_engine() -> Engine<TestWorkbook> {
    let wb = TestWorkbook::new();
    let config = EvalConfig::default();
    Engine::new(wb, config)
}

/*
 * The Scenario: You have two different formulas that "look" at overlapping
 * parts of the same column. For example, Formula A calculates SUM(A1:A50)
 * and Formula B calculates SUM(A25:A75). The Test: It changes a value in
 * the "middle" (like cell A30) which belongs to both ranges.
 *
 * Why it matters: This ensures your Sheet Index and Range Compression logic
 * are robust enough to "wake up" every observer that cares about a specific
 * cell. It prevents a bug where the engine might only update the "first" or
 * "most recent" range it found in its index.
 */
#[test]
fn test_partial_range_overlap_dependency_propagation() {
    let mut engine = create_simple_engine(); // From evaluation.rs context

    // 1. Setup initial values in the overlap area
    engine
        .set_cell_value("Sheet1", 30, 1, LiteralValue::Number(10.0))
        .unwrap(); // A30 = 10

    // 2. Define two overlapping range formulas
    // B1 = SUM(A1:A50)
    let sum_a1_a50 = sum_ast(1, 1, 50, 1);
    engine.set_cell_formula("Sheet1", 1, 2, sum_a1_a50).unwrap();

    // B2 = SUM(A25:A75)
    let sum_a25_a75 = sum_ast(25, 1, 75, 1);
    engine
        .set_cell_formula("Sheet1", 2, 2, sum_a25_a75)
        .unwrap();

    // Initial Evaluation
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(10.0))
    );
    assert_eq!(
        engine.get_cell_value("Sheet1", 2, 2),
        Some(LiteralValue::Number(10.0))
    );

    // 3. Update the overlapping cell A30
    // This is the critical moment for the DependencyGraph and Scheduler
    engine
        .set_cell_value("Sheet1", 30, 1, LiteralValue::Number(20.0))
        .unwrap();

    // 4. Verify propagation
    // We check if both B1 and B2 are flagged as dirty or produce new values
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(20.0)),
        "B1 (A1:A50) failed to update when overlapping cell A30 changed"
    );
    assert_eq!(
        engine.get_cell_value("Sheet1", 2, 2),
        Some(LiteralValue::Number(20.0)),
        "B2 (A25:A75) failed to update when overlapping cell A30 changed"
    );
}

/*
 * The Scenario: You are standing on Sheet1 and write a formula that sums
 * data physically located on Sheet2 (e.g., =SUM(Sheet2!A1:A10))
 *
 * The Test: It updates a value on Sheet2 and checks if the formula on
 * Sheet1 correctly reflects that change.
 *
 * Why it matters: This verifies that your Dependency Graph can track
 * "edges" (connections) across different sheet boundaries. It confirms
 * that when Sheet2 is marked "dirty," the engine knows to look across
 * the workbook to find formulas on other sheets that might be affected.
 */

#[test]
fn test_cross_sheet_range_dependency() {
    let mut engine = create_simple_engine();

    // 1. Setup Sheet2 with a value
    engine.graph.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap(); // Sheet2!A1 = 10

    // 2. Create formula on Sheet1: =SUM(Sheet2!A1:A10)
    let range_cross = ASTNode {
        node_type: ASTNodeType::Reference {
            original: "Sheet2!A1:A10".to_string(),
            reference: ReferenceType::Range {
                sheet: Some("Sheet2".to_string()),
                start_row: Some(1),
                start_col: Some(1),
                end_row: Some(10),
                end_col: Some(1),
                start_row_abs: true,
                start_col_abs: true,
                end_row_abs: true,
                end_col_abs: true,
            },
        },
        source_token: None,
        contains_volatile: false,
    };

    let sum_formula = ASTNode {
        node_type: ASTNodeType::Function {
            name: "SUM".to_string(),
            args: vec![range_cross],
        },
        source_token: None,
        contains_volatile: false,
    };

    engine
        .set_cell_formula("Sheet1", 1, 2, sum_formula)
        .unwrap(); // Sheet1!B1
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(10.0))
    );

    // 3. Update Sheet2!A1 and verify Sheet1!B1 follows
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(50.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(50.0)),
        "Cross-sheet range dependency failed to propagate"
    );
}

/*
 * The Scenario: You have a chain of dependencies. Cell C1 feeds into cell A5.
 * Then, a range formula SUM(A1:A10) includes cell A5.
 * The Test: You change the "grandparent" cell (C1). This should trigger A5,
 * which in turn should trigger the SUM formula.
 *
 * Why it matters: This is a "stress test" for your Scheduler and
 * Tarjan's SCC algorithm. It ensures that the engine doesn't just look for
 * direct manual edits to a range, but also understands when a range's value
 * changes because one of the cells inside that range is itself a formula that
 * just recalculated.
 */
#[test]
fn test_nested_formula_within_range_propagation() {
    let mut engine = create_simple_engine();

    // 1. Setup C1 as the source
    engine
        .set_cell_value("Sheet1", 1, 3, LiteralValue::Number(10.0))
        .unwrap(); // C1 = 10

    // 2. A5 is a formula depending on C1
    // A5 = C1
    let a5_formula = ASTNode {
        node_type: ASTNodeType::Reference {
            original: "C1".to_string(),
            reference: ReferenceType::cell(None, 1, 3),
        },
        source_token: None,
        contains_volatile: false,
    };
    engine.set_cell_formula("Sheet1", 5, 1, a5_formula).unwrap();

    // 3. B1 depends on the range A1:A10
    // B1 = SUM(A1:A10) -> Should include the value of A5 (which is C1)
    engine
        .set_cell_formula("Sheet1", 1, 2, sum_ast(1, 1, 10, 1))
        .unwrap();

    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(10.0))
    );

    // 4. TRIGGER: Change C1.
    // This MUST trigger A5, which MUST trigger the Range A1:A10, which MUST trigger B1.
    engine
        .set_cell_value("Sheet1", 1, 3, LiteralValue::Number(50.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(50.0)),
        "Range dependency failed to trigger via a nested formula change"
    );
}

/*
 * Scenario: Dependency Recovery (The Ghost Reference)
 * 1. Create a formula on Sheet1 that references a cell on Sheet2.
 * 2. Delete Sheet2 entirely.
 * 3. Verify the formula on Sheet1 evaluates to an error (#REF!).
 * 4. Re-create Sheet2 with the same name and provide a new value.
 *
 * Why it matters:
 * This verifies that the Dependency Graph isn't "brittle." When a sheet is
 * deleted, the connection should break gracefully, but when the sheet
 * returns, the engine should automatically "heal" the link and resume
 * tracking updates without requiring the user to re-enter the formula.
 */
#[test]
fn test_sheet_recreation_dependency_recovery() {
    use formualizer_parse::parse; // Import the parser
    let mut engine = create_simple_engine();

    // 1. Setup cross-sheet dependency
    engine.graph.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();

    // Sheet1!A1 = Sheet2!A1
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!A1").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();

    // 2. Remove Sheet2
    let s2_id = engine
        .graph
        .sheet_id("Sheet2")
        .expect("Sheet2 should exist");
    engine.graph.remove_sheet(s2_id).unwrap();

    // Formula should now be an error (likely #REF!)
    engine.evaluate_all().unwrap();
    let val = engine.get_cell_value("Sheet1", 1, 1).unwrap();
    match val {
        LiteralValue::Error(_) => { /* Success: it recognized the missing sheet */ }
        _ => panic!(
            "Expected an error value after sheet removal, found {:?}",
            val
        ),
    }

    // 3. Re-add Sheet2 and provide value
    engine.graph.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(50.0))
        .unwrap();

    // 4. Check for "Healing"
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(50.0)),
        "Dependency failed to 'heal' after sheet was removed and re-added"
    );
}

#[test]
fn test_ast_surgical_rename() {
    let mut ast = parse("=Sheet2!A1 + Sheet3!A1").unwrap();
    ast.update_sheet_references(Some("Sheet2"), "NewSheet");

    let normalized = format!("{:?}", ast); // Use Debug output since that's what we saw in logs

    // Check for the updated sheet name in the Debug output
    assert!(normalized.contains("\"NewSheet\""));
    // Ensure Sheet3 was NOT touched
    assert!(normalized.contains("\"Sheet3\""));
}
#[test]
fn test_rename_fixes_ref_errors() {
    let mut engine = create_simple_engine();

    let _ = engine.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!A1").unwrap())
        .unwrap();

    // CRITICAL: We must evaluate or "touch" the graph so the dependency is registered
    engine.evaluate_all().unwrap();

    let s2_id = engine.graph.sheet_id("Sheet2").unwrap();

    // This call MUST populate the tombstone registry
    engine.remove_sheet(s2_id).unwrap();

    // Verify it's broken
    engine.evaluate_all().unwrap();

    let s3_id = engine.add_sheet("Sheet3").unwrap();
    engine
        .set_cell_value("Sheet3", 1, 1, LiteralValue::Number(100.0))
        .unwrap();

    // This should now find the orphan
    engine.rename_sheet(s3_id, "Sheet2").unwrap();
    let id_check = engine.graph.sheet_id("Sheet2");

    // Assumption 2: Does the storage have data?
    let val_check = engine.get_cell_value("Sheet2", 1, 1);
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(100.0))
    );
}

#[test]
fn test_graph_orphan_healing_isolation() {
    let mut engine = create_simple_engine();
    let _ = engine.add_sheet("Sheet2").unwrap();

    // 1. Formula points to B2 (row 2, col 2)
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!B2").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();

    let s2_id = engine.graph.sheet_id("Sheet2").unwrap();
    engine.remove_sheet(s2_id).unwrap();

    // 2. Add Sheet3 and put data in B2 (row 2, col 2) to MATCH the formula
    let s3_id = engine.add_sheet("Sheet3").unwrap();
    engine
        .set_cell_value("Sheet3", 2, 2, LiteralValue::Number(100.0)) // Match the B2 (2,2)
        .unwrap();

    // 3. Rename Sheet3 -> Sheet2 (This triggers the healing)
    engine.rename_sheet(s3_id, "Sheet2").unwrap();
    engine.evaluate_all().unwrap();

    // 4. Verification
    let val = engine.get_cell_value("Sheet1", 1, 1);

    assert!(val.is_some(), "Value should be Some(100.0)");
    match val.as_ref().unwrap() {
        // .as_ref() avoids the move/clone issue
        LiteralValue::Number(n) => assert_eq!(*n, 100.0),
        LiteralValue::Error(e) => panic!("Still got an error: {:?}", e),
        _ => panic!("Unexpected value type: {:?}", val),
    }
}
/*
 * Scenario: Cross-Sheet Row Insertion Shifting
 * 1. Sheet1 has a SUM formula looking at a specific range on Sheet2 (A1:A10).
 * 2. A new row is inserted at the very top of Sheet2 (before Row 1).
 * 3. The data that was in A1 is now physically in A2.
 * * Why it matters:
 * This is a major test of coordinate stability. In a robust engine, the
 * formula on Sheet1 should automatically "stretch" or "shift" its
 * reference to (A2:A11) to follow the data. If it stays stuck on A1:A10,
 * the user's calculation becomes wrong. It verifies that structural
 * changes on one sheet correctly trigger coordinate updates on all
 * dependent sheets.
 */
#[test]
fn test_cross_sheet_row_insertion_dependency() {
    use formualizer_parse::parse;
    let mut engine = create_simple_engine();

    // 1. Setup Sheet2 with data and Sheet1 with a formula pointing to it
    engine.graph.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap(); // Sheet2!A1 = 10

    // Sheet1!A1 = SUM(Sheet2!A1:A10)
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=SUM(Sheet2!A1:A10)").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(10.0))
    );

    // 2. Insert 1 row at index 1 (the very top) on Sheet2
    // We call this on 'engine' directly, not 'engine.graph'
    engine.insert_rows("Sheet2", 1, 1).unwrap();

    // 3. The value 10.0 is now at Sheet2!A2.
    // The formula on Sheet1 should have been rewritten to SUM(Sheet2!A2:A11)
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(10.0)),
        "Inserting a row on Sheet2 failed to shift the reference on Sheet1"
    );
}
/*
 * Scenario: Range Dependency Fan-Out (Memory Stress)
 * 1. Create 5,000 unique formulas that all overlap on the same source cell (A1).
 * 2. Each formula is slightly different: SUM(A1:A2), SUM(A1:A3), SUM(A1:A4)...
 * 3. Update the source cell (A1).
 *
 * Why it matters:
 * In a "Hybrid" model, the engine must manage a massive amount of "Range Observers."
 * If the memory complexity is O(N^2) or if it fails to share metadata, memory
 * usage will spike. This test ensures the engine can handle a "worst-case"
 * spreadsheet layout where thousands of cells depend on one central data point.
 */
#[test]
fn test_massive_range_fan_out_performance() {
    let mut engine = create_simple_engine();
    let sheet = "Sheet1";

    // 1. Initial value
    engine
        .set_cell_value(sheet, 1, 1, LiteralValue::Number(1.0))
        .unwrap();

    // 2. Create 5,000 overlapping ranges
    for i in 2..5002 {
        // Create SUM(A1:A{i}) in column B
        engine
            .set_cell_formula(sheet, i, 2, sum_ast(1, 1, i, 1))
            .unwrap();
    }

    // 3. Measure update time (Performance/Complexity check)
    let start = std::time::Instant::now();
    engine
        .set_cell_value(sheet, 1, 1, LiteralValue::Number(2.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    let duration = start.elapsed();

    // Verify a sample (the last formula)
    // Result should be 2.0 (A1) + 0.0 (others) = 2.0
    assert_eq!(
        engine.get_cell_value(sheet, 5001, 2),
        Some(LiteralValue::Number(2.0))
    );

    // Ideally, this should be sub-second even in debug mode
    assert!(duration.as_secs() < 2, "Fan-out propagation is too slow!");
}

/*
 * Scenario: Stripe Boundary Intersection
 * 1. Identify the engine's "Stripe Size" (usually a power of 2, like 64 or 128).
 * 2. Create a formula that looks at a range straddling that boundary.
 * 3. Update cells on BOTH sides of the boundary line.
 *
 * Why it matters:
 * Engines that use "Striping" to speed up lookups often have bugs at the
 * "seams." A range might be correctly indexed in Stripe A, but not Stripe B.
 * This verifies that the range is registered in every stripe it physically
 * occupies so that no updates are missed.
 */
#[test]
fn test_stripe_boundary_range_trigger() {
    let mut engine = create_simple_engine();

    // Assuming a stripe size of 64 (common in these engines)
    // Range A60:A70 crosses the 64-row boundary
    engine
        .set_cell_formula("Sheet1", 1, 2, sum_ast(60, 1, 70, 1))
        .unwrap();

    // Test Case 1: Update cell BEFORE boundary (A63)
    engine
        .set_cell_value("Sheet1", 63, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(10.0))
    );

    // Test Case 2: Update cell AFTER boundary (A65)
    engine
        .set_cell_value("Sheet1", 65, 1, LiteralValue::Number(5.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    // Total should be 15.0
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(15.0)),
        "Range failed to catch update from the second stripe"
    );
}

#[test]
fn test_rename_layer_registry() {
    let mut engine = create_simple_engine(); // Your engine setup
    let sheet_id = engine.graph.sheet_reg().get_id("Sheet1").unwrap();

    engine.graph.rename_sheet(sheet_id, "NewSheet").unwrap();

    assert_eq!(engine.graph.sheet_name(sheet_id), "NewSheet");
    assert!(engine.graph.sheet_reg().get_id("Sheet1").is_none());
}

#[test]
fn test_rename_layer_storage() {
    let mut engine = create_simple_engine();
    // 1. Put data in
    let _ = engine.set_cell_value("Sheet1", 1, 1, LiteralValue::Number(100.0));

    // 2. Rename
    let sheet_id = engine.graph.sheet_reg().get_id("Sheet1").unwrap();
    engine.rename_sheet(sheet_id, "Sheet2").unwrap();

    // 3. Try to read from the NEW name
    let val = engine.read_cell_value("Sheet2", 1, 1);
    assert_eq!(
        val,
        Some(LiteralValue::Number(100.0)),
        "Storage failed to follow the rename!"
    );
}
#[test]
fn test_rename_layer_identity() {
    let mut engine = create_simple_engine();
    let _ = engine.set_cell_value("Sheet1", 1, 1, LiteralValue::Number(100.0));

    let (row, col, _, _) = parse_a1_1based("A1").unwrap();
    let addr = engine.graph.make_cell_ref("Sheet1", row, col);

    // Fix: Dereference here to copy the ID and release the borrow on engine
    let v_id = *engine.graph.get_vertex_id_for_address(&addr).unwrap();

    let sheet_id = engine
        .graph
        .sheet_reg()
        .get_id("Sheet1")
        .expect("Sheet1 missing");

    // This now works because v_id is just a value, not a borrow
    engine.rename_sheet(sheet_id, "SheetX").unwrap();

    let cell_ref = engine
        .graph
        .get_cell_ref(v_id) // No * needed here now as v_id is already the value
        .expect("Vertex lost its cell ref!");

    let current_name = engine.graph.sheet_name(cell_ref.sheet_id);
    assert_eq!(
        current_name, "SheetX",
        "Vertex still thinks it is on the old sheet name!"
    );
}
#[test]
fn test_rename_layer_vertex_read() {
    let mut engine = create_simple_engine();
    let _ = engine.set_cell_value("Sheet1", 1, 1, LiteralValue::Number(100.0));

    let (row, col, _, _) = parse_a1_1based("A1").unwrap();
    let addr = engine.graph.make_cell_ref("Sheet1", row, col);
    let v_id = *engine.graph.get_vertex_id_for_address(&addr).unwrap();

    let sheet_id = engine.graph.sheet_reg().get_id("Sheet1").unwrap();
    engine.rename_sheet(sheet_id, "SheetX").unwrap();

    // Use evaluate_vertex to force a fresh look at the data
    let val = engine.evaluate_vertex(v_id).expect("Evaluation failed");
    assert_eq!(
        val,
        LiteralValue::Number(100.0),
        "Data not found after rename!"
    );
}
#[test]
fn test_rename_check_formula_healing() {
    let mut engine = create_simple_engine();
    // 1. Data on Sheet2
    let _ = engine.set_cell_value("Sheet2", 1, 1, LiteralValue::Number(100.0));

    // 2. Create a VALID formula first (pointing to Sheet2)
    let ast = parse("=Sheet2!A1").expect("Parse failed");
    engine.set_cell_formula("Sheet1", 1, 2, ast).unwrap();
    engine.evaluate_all().unwrap();

    // 3. NOW break it: Rename Sheet2 to "Other"
    // Sheet1!B1 should now be #REF! because "Sheet2" is gone
    let sheet2_id = engine.graph.sheet_reg().get_id("Sheet2").unwrap();
    engine.rename_sheet(sheet2_id, "Other").unwrap();
    engine.evaluate_all().unwrap();

    // 4. HEAL it: Rename "Other" to "Missing"
    // (The test previously used "Missing" in the formula string)
    // Actually, let's just rename "Other" back to "Sheet2" to match the formula.
    engine.rename_sheet(sheet2_id, "Sheet2").unwrap();
    engine.evaluate_all().unwrap();

    // 5. Verify the value is back to 100.0
    let v_id = *engine
        .graph
        .get_vertex_id_for_address(&engine.graph.make_cell_ref("Sheet1", 1, 2))
        .unwrap();

    // Using evaluate_vertex to ensure we bypass any stale cache
    let val = engine.evaluate_vertex(v_id).expect("Evaluation failed");
    assert_eq!(
        val,
        LiteralValue::Number(100.0),
        "Formula did not heal correctly!"
    );
}
#[test]
fn test_rename_cross_sheet_link() {
    let mut engine = create_simple_engine();
    // Assuming Sheet1 and Sheet2 exist.
    let _ = engine.set_cell_value("Sheet1", 1, 1, LiteralValue::Number(100.0));

    // 1. Rename Sheet1 to DataSheet
    let sheet_id = engine.graph.sheet_reg().get_id("Sheet1").unwrap();
    engine.rename_sheet(sheet_id, "DataSheet").unwrap();

    // 2. Create link on Sheet2!A1 pointing to the renamed sheet
    let ast = parse("=DataSheet!A1").expect("Parse failed");
    engine.set_cell_formula("Sheet2", 1, 1, ast).unwrap();

    // 3. Force Evaluation
    let _ = engine.evaluate_all().unwrap();

    // 4. Verification: Look up the vertex by the EXACT address used
    let addr = engine.graph.make_cell_ref("Sheet2", 1, 1);
    let v_id = *engine
        .graph
        .get_vertex_id_for_address(&addr)
        .expect("Vertex not found at Sheet2!A1");

    // Fetch the value from the engine
    let val = engine.evaluate_vertex(v_id).expect("Evaluation failed");
    assert_eq!(
        val,
        LiteralValue::Number(100.0),
        "Cross-sheet link failed to retrieve value"
    );
}

#[test]
fn test_update_in_revived_sheeet() {
    // setup
    let mut engine = create_simple_engine();
    let s2 = engine.add_sheet("Sheet2");
    let _ = engine.set_cell_value("Sheet2", 1, 1, LiteralValue::Number(12.34));
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!A1").unwrap())
        .unwrap();

    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(12.34)),
        "Cross-sheet link failed to retrieve value"
    );

    // delete the sheet a formula is pointing to
    let _ = engine.remove_sheet(s2.expect("Sheet2 must exist"));
    engine.evaluate_all().unwrap();
    let val = engine.get_cell_value("Sheet1", 1, 1).unwrap();
    match val {
        LiteralValue::Error(_) => { /* Success: it recognized the missing sheet */ }
        _ => panic!(
            "Expected an error value after sheet removal, found {:?}",
            val
        ),
    }

    // add a new sheet with the same name
    let _ = engine.add_sheet("Sheet2");
    let _ = engine.set_cell_value("Sheet2", 1, 1, LiteralValue::Number(774422.987));
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(774422.987)),
        "ref should work after sheet was re-added"
    );

    // If dependency edges were rebuilt incorrectly, this change will not propagate.
    let _ = engine.set_cell_value("Sheet2", 1, 1, LiteralValue::Number(999.0));
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(999.0)),
        "Dependency tracking failed after heal! The second update did not propagate."
    );
}

#[test]
fn test_readded_sheet_keeps_mixed_sheet_formula_intact() {
    let mut engine = create_simple_engine();
    engine.add_sheet("Sheet2").unwrap();
    engine.add_sheet("Sheet3").unwrap();

    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine
        .set_cell_value("Sheet3", 1, 1, LiteralValue::Number(5.0))
        .unwrap();
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!A1+Sheet3!A1").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();

    let s2 = engine.sheet_id("Sheet2").unwrap();
    engine.remove_sheet(s2).unwrap();
    engine.evaluate_all().unwrap();

    engine.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(15.0)),
        "Healing must not rewrite unrelated Sheet3 references"
    );
}

#[test]
fn test_readd_sheet_does_not_overwrite_user_formula_edit_while_missing() {
    let mut engine = create_simple_engine();
    engine.add_sheet("Sheet2").unwrap();
    engine.add_sheet("Sheet3").unwrap();

    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine
        .set_cell_value("Sheet3", 1, 1, LiteralValue::Number(5.0))
        .unwrap();

    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!A1").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();

    let s2 = engine.sheet_id("Sheet2").unwrap();
    engine.remove_sheet(s2).unwrap();
    engine.evaluate_all().unwrap();

    // User changes formula while Sheet2 is missing.
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet3!A1").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(5.0))
    );

    // Re-adding Sheet2 should not resurrect stale orphan intent.
    engine.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(99.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(5.0)),
        "Stale orphan metadata must not override updated formulas"
    );
}

#[test]
fn test_healed_formula_recomputes_downstream_dependents() {
    let mut engine = create_simple_engine();
    engine.add_sheet("Sheet2").unwrap();

    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=Sheet2!A1").unwrap())
        .unwrap();
    engine
        .set_cell_formula("Sheet1", 1, 2, parse("=A1+1").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();

    let s2 = engine.sheet_id("Sheet2").unwrap();
    engine.remove_sheet(s2).unwrap();
    engine.evaluate_all().unwrap();

    engine.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(50.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(50.0))
    );
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(51.0)),
        "Downstream dependents should recover after healing"
    );

    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(60.0))
        .unwrap();
    engine.evaluate_all().unwrap();

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(60.0))
    );
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 2),
        Some(LiteralValue::Number(61.0)),
        "Downstream dependents should continue tracking subsequent edits"
    );
}

#[test]
fn test_invalid_rename_rolls_back_arrow_storage() {
    let mut engine = create_simple_engine();
    engine
        .set_cell_value("Sheet1", 1, 1, LiteralValue::Number(7.0))
        .unwrap();

    let sheet_id = engine.sheet_id("Sheet1").unwrap();
    let result = engine.rename_sheet(sheet_id, "");
    assert!(result.is_err(), "Invalid rename should fail");

    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(7.0)),
        "Failed rename must not mutate Arrow storage sheet mapping"
    );
}

#[test]
fn test_whole_column_cross_sheet_recovers_after_readd() {
    let mut engine = create_simple_engine();
    engine.add_sheet("Sheet2").unwrap();

    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=SUM(Sheet2!A:A)").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(10.0))
    );

    let s2 = engine.sheet_id("Sheet2").unwrap();
    engine.remove_sheet(s2).unwrap();
    engine.evaluate_all().unwrap();
    match engine.get_cell_value("Sheet1", 1, 1) {
        Some(LiteralValue::Error(_)) => {}
        other => panic!("expected #REF after removing Sheet2, got {other:?}"),
    }

    engine.add_sheet("Sheet2").unwrap();
    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(50.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(50.0))
    );

    engine
        .set_cell_value("Sheet2", 1, 1, LiteralValue::Number(70.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(70.0)),
        "Whole-column dependency should continue tracking after heal"
    );
}

#[test]
fn test_heal_one_of_multiple_missing_sheets_does_not_double_bind() {
    let mut engine = create_simple_engine();
    engine.add_sheet("S2").unwrap();
    engine.add_sheet("S3").unwrap();

    engine
        .set_cell_value("S2", 1, 1, LiteralValue::Number(10.0))
        .unwrap();
    engine
        .set_cell_value("S3", 1, 1, LiteralValue::Number(20.0))
        .unwrap();
    engine
        .set_cell_formula("Sheet1", 1, 1, parse("=S2!A1+S3!A1").unwrap())
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(30.0))
    );

    let s2 = engine.sheet_id("S2").unwrap();
    let s3 = engine.sheet_id("S3").unwrap();
    engine.remove_sheet(s2).unwrap();
    engine.remove_sheet(s3).unwrap();
    engine.evaluate_all().unwrap();

    engine.add_sheet("S2").unwrap();
    engine
        .set_cell_value("S2", 1, 1, LiteralValue::Number(100.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    match engine.get_cell_value("Sheet1", 1, 1) {
        Some(LiteralValue::Error(_)) => {}
        other => panic!("expected unresolved error until S3 returns, got {other:?}"),
    }

    engine.add_sheet("S3").unwrap();
    engine
        .set_cell_value("S3", 1, 1, LiteralValue::Number(20.0))
        .unwrap();
    engine.evaluate_all().unwrap();
    assert_eq!(
        engine.get_cell_value("Sheet1", 1, 1),
        Some(LiteralValue::Number(120.0)),
        "Healing S2 first must not rewrite S3 references"
    );
}