fret-ui 0.1.0

Mechanism-layer UI engine for Fret with tree, layout, focus, routing, and interaction contracts.
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
use super::*;

#[test]
fn retained_virtual_list_updates_visible_range_on_wheel_scroll_without_notifying_view_cache() {
    let mut app = TestHost::new();
    let mut ui: UiTree<TestHost> = UiTree::new();
    let window = AppWindowId::default();
    ui.set_window(window);
    ui.set_view_cache_enabled(true);
    ui.set_debug_enabled(true);

    let scroll_handle = crate::scroll::VirtualListScrollHandle::new();
    let bounds = Rect::new(
        fret_core::Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(200.0), Px(50.0)),
    );
    let mut text = FakeTextService::default();

    let render_calls: Arc<AtomicUsize> = Arc::new(AtomicUsize::new(0));

    fn build_tree(
        cx: &mut ElementContext<'_, TestHost>,
        scroll_handle: &crate::scroll::VirtualListScrollHandle,
        render_calls: Arc<AtomicUsize>,
    ) -> AnyElement {
        let mut cache = crate::element::ViewCacheProps::default();
        cache.layout.size.width = crate::element::Length::Fill;
        cache.layout.size.height = crate::element::Length::Fill;
        cache.cache_key = 1;

        cx.view_cache(cache, move |cx| {
            render_calls.fetch_add(1, Ordering::SeqCst);

            let list_layout = crate::element::LayoutStyle {
                size: crate::element::SizeStyle {
                    width: crate::element::Length::Fill,
                    height: crate::element::Length::Fill,
                    ..Default::default()
                },
                overflow: crate::element::Overflow::Clip,
                ..Default::default()
            };

            let key_at: crate::windowed_surface_host::RetainedVirtualListKeyAtFn =
                Arc::new(|i| i as crate::ItemKey);
            let row: crate::windowed_surface_host::RetainedVirtualListRowFn<TestHost> =
                Arc::new(|cx, _| cx.text("row"));

            vec![cx.virtual_list_keyed_retained_with_layout(
                list_layout,
                100,
                crate::element::VirtualListOptions::new(Px(10.0), 0),
                scroll_handle,
                key_at,
                row,
            )]
        })
    }

    // Frame 0: establish viewport size so the visible range can be computed.
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-refresh-on-wheel",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    app.advance_frame();

    // Frame 1: mount initial visible rows (0..=4).
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-refresh-on-wheel",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    let cache_node = ui.children(root)[0];
    let list_node = ui.children(cache_node)[0];
    assert_eq!(ui.children(list_node).len(), 5);
    app.advance_frame();

    // Frame 2: allow layout-driven bookkeeping (viewport/content size) to settle.
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-refresh-on-wheel",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    app.advance_frame();

    // Frame 3: prefer a cache hit; render closure should be skipped.
    let calls_before_wheel = render_calls.load(Ordering::SeqCst);
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-refresh-on-wheel",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    assert_eq!(
        render_calls.load(Ordering::SeqCst),
        calls_before_wheel,
        "expected view-cache root to be a cache hit before wheel scroll"
    );
    let cache_node = ui.children(root)[0];
    let _list_node = ui.children(cache_node)[0];

    // Wheel-scroll far enough that the desired visible range no longer overlaps the mounted rows.
    ui.dispatch_event(
        &mut app,
        &mut text,
        &fret_core::Event::Pointer(fret_core::PointerEvent::Wheel {
            position: fret_core::Point::new(Px(5.0), Px(5.0)),
            delta: fret_core::Point::new(Px(0.0), Px(-80.0)),
            modifiers: fret_core::Modifiers::default(),
            pointer_id: fret_core::PointerId(0),
            pointer_type: fret_core::PointerType::Mouse,
        }),
    );
    assert_eq!(
        scroll_handle.offset().y,
        Px(80.0),
        "expected wheel scroll to update the bound scroll handle"
    );

    assert_eq!(
        render_calls.load(Ordering::SeqCst),
        calls_before_wheel,
        "expected retained host to schedule a window update without rerendering the view-cache root"
    );
    assert!(
        ui.should_reuse_view_cache_node(cache_node),
        "expected retained host wheel scroll to avoid `notify()` on the view-cache root"
    );
    app.advance_frame();

    // Frame 4: cache hit again, but the retained host reconcile should attach/detach rows to match
    // the new window without re-running the parent render closure.
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-refresh-on-wheel",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    assert_eq!(
        render_calls.load(Ordering::SeqCst),
        calls_before_wheel,
        "expected retained host window refresh to avoid rerendering the view-cache root"
    );

    let cache_node = ui.children(root)[0];
    let list_node = ui.children(cache_node)[0];
    let props = app.with_global_mut(
        crate::declarative::frame::ElementFrame::default,
        |frame, _app| {
            frame
                .windows
                .get(&window)
                .and_then(|w| w.instances.get(list_node))
                .cloned()
        },
    );
    let crate::declarative::ElementInstance::VirtualList(props) =
        props.expect("list instance exists").instance
    else {
        panic!("expected VirtualList instance");
    };
    assert_eq!(
        props
            .visible_items
            .iter()
            .map(|item| item.index)
            .collect::<Vec<_>>(),
        vec![8, 9, 10, 11, 12],
        "expected retained host reconcile to update the visible-item set after wheel scroll"
    );
    assert_eq!(ui.children(list_node).len(), 5);
}

#[test]
fn retained_virtual_list_prefetches_window_before_escape_without_rerendering_cache_root() {
    let mut app = TestHost::new();
    let mut ui: UiTree<TestHost> = UiTree::new();
    let window = AppWindowId::default();
    ui.set_window(window);
    ui.set_view_cache_enabled(true);
    ui.set_debug_enabled(true);

    let scroll_handle = crate::scroll::VirtualListScrollHandle::new();
    let bounds = Rect::new(
        fret_core::Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(200.0), Px(50.0)),
    );
    let mut text = FakeTextService::default();

    let render_calls: Arc<AtomicUsize> = Arc::new(AtomicUsize::new(0));

    fn build_tree(
        cx: &mut ElementContext<'_, TestHost>,
        scroll_handle: &crate::scroll::VirtualListScrollHandle,
        render_calls: Arc<AtomicUsize>,
    ) -> AnyElement {
        let mut cache = crate::element::ViewCacheProps::default();
        cache.layout.size.width = crate::element::Length::Fill;
        cache.layout.size.height = crate::element::Length::Fill;
        cache.cache_key = 1;

        cx.view_cache(cache, move |cx| {
            render_calls.fetch_add(1, Ordering::SeqCst);

            let list_layout = crate::element::LayoutStyle {
                size: crate::element::SizeStyle {
                    width: crate::element::Length::Fill,
                    height: crate::element::Length::Fill,
                    ..Default::default()
                },
                overflow: crate::element::Overflow::Clip,
                ..Default::default()
            };

            let key_at: crate::windowed_surface_host::RetainedVirtualListKeyAtFn =
                Arc::new(|i| i as crate::ItemKey);
            let row: crate::windowed_surface_host::RetainedVirtualListRowFn<TestHost> =
                Arc::new(|cx, i| cx.text(format!("row {i}")));

            // Overscan > 0 is required to test staged prefetch (shift before escape).
            let options = crate::element::VirtualListOptions::new(Px(10.0), 4);
            vec![cx.virtual_list_keyed_retained_with_layout(
                list_layout,
                100,
                options,
                scroll_handle,
                key_at,
                row,
            )]
        })
    }

    // Establish viewport and mount initial children.
    for _frame in 0..3 {
        let root = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "mvp50-vlist-retained-prefetch",
            |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
        );
        ui.set_root(root);
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        app.advance_frame();
    }

    // Prefer a cache hit before changing the scroll offset.
    let calls_before_scroll = render_calls.load(Ordering::SeqCst);
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-prefetch",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    assert_eq!(
        render_calls.load(Ordering::SeqCst),
        calls_before_scroll,
        "expected a cache hit before prefetching"
    );
    let cache_node = ui.children(root)[0];
    let list_node = ui.children(cache_node)[0];
    let list_element = app
        .with_global_mut(
            crate::declarative::frame::ElementFrame::default,
            |frame, _app| {
                frame
                    .windows
                    .get(&window)
                    .and_then(|w| w.instances.get(list_node))
                    .map(|record| record.element)
            },
        )
        .expect("list instance exists");

    // Move near the overscan boundary but stay within it so this is a prefetch (not an escape).
    scroll_handle.set_offset(fret_core::Point::new(Px(0.0), Px(30.0)));
    app.advance_frame();

    // Frame: cache hit; prepaint should request a prefetch reconcile.
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-prefetch",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    // Ensure prepaint still observes a lagging "render window" (the previous window) while the
    // scroll offset and ideal window have advanced. This matches the steady-state cache-hit case
    // we care about: prepaint should request a staged prefetch reconcile without forcing the
    // cache-root subtree to rerender.
    crate::elements::with_element_state(
        &mut app,
        window,
        list_element,
        crate::element::VirtualListState::default,
        |state| {
            state.render_window_range = Some(crate::virtual_list::VirtualRange {
                start_index: 0,
                end_index: 4,
                overscan: 4,
                count: 100,
            });
        },
    );
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    assert_eq!(
        render_calls.load(Ordering::SeqCst),
        calls_before_scroll,
        "expected staged prefetch to avoid rerendering the view-cache root"
    );
    let last_window = ui
        .debug_virtual_list_windows()
        .iter()
        .rev()
        .find(|w| {
            matches!(
                w.source,
                crate::tree::UiDebugVirtualListWindowSource::Prepaint
            )
        })
        .expect("expected a prepaint virtual list window debug record");
    assert!(
        !last_window.window_mismatch,
        "expected prefetch to occur while still within the rendered prefetch window"
    );
    assert_eq!(
        last_window.window_shift_kind,
        crate::tree::UiDebugVirtualListWindowShiftKind::Prefetch,
        "expected prepaint to stage a prefetch window shift (record={last_window:?})"
    );

    // Next frame: reconcile executes (still cache-hit) and is attributed as a prefetch.
    app.advance_frame();
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "mvp50-vlist-retained-prefetch",
        |cx| vec![build_tree(cx, &scroll_handle, Arc::clone(&render_calls))],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    assert_eq!(
        render_calls.load(Ordering::SeqCst),
        calls_before_scroll,
        "expected staged prefetch reconcile to avoid rerendering the view-cache root"
    );
    assert!(
        ui.debug_retained_virtual_list_reconciles()
            .iter()
            .any(|r| r.reconcile_kind
                == crate::tree::UiDebugRetainedVirtualListReconcileKind::Prefetch),
        "expected at least one prefetch-attributed retained virtual-list reconcile"
    );
}

#[test]
fn retained_virtual_list_keep_alive_reuses_detached_items_when_scrolling_back() {
    let mut app = TestHost::new();
    let mut ui: UiTree<TestHost> = UiTree::new();
    let window = AppWindowId::default();
    ui.set_window(window);
    ui.set_view_cache_enabled(true);
    ui.set_debug_enabled(true);

    let scroll_handle = crate::scroll::VirtualListScrollHandle::new();
    let bounds = Rect::new(
        fret_core::Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(200.0), Px(50.0)),
    );
    let mut text = FakeTextService::default();

    fn build_tree(
        cx: &mut ElementContext<'_, TestHost>,
        scroll_handle: &crate::scroll::VirtualListScrollHandle,
    ) -> AnyElement {
        let mut cache = crate::element::ViewCacheProps::default();
        cache.layout.size.width = crate::element::Length::Fill;
        cache.layout.size.height = crate::element::Length::Fill;
        cache.cache_key = 1;

        cx.view_cache(cache, move |cx| {
            let list_layout = crate::element::LayoutStyle {
                size: crate::element::SizeStyle {
                    width: crate::element::Length::Fill,
                    height: crate::element::Length::Fill,
                    ..Default::default()
                },
                overflow: crate::element::Overflow::Clip,
                ..Default::default()
            };

            let key_at: crate::windowed_surface_host::RetainedVirtualListKeyAtFn =
                Arc::new(|i| i as crate::ItemKey);
            let row: crate::windowed_surface_host::RetainedVirtualListRowFn<TestHost> =
                Arc::new(|cx, i| cx.text(format!("row {i}")));

            let options = crate::element::VirtualListOptions::new(Px(10.0), 0).keep_alive(32);
            vec![cx.virtual_list_keyed_retained_with_layout(
                list_layout,
                100,
                options,
                scroll_handle,
                key_at,
                row,
            )]
        })
    }

    // Establish viewport and mount initial children.
    for _frame in 0..3 {
        let root = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "retained-virt-keep-alive",
            |cx| vec![build_tree(cx, &scroll_handle)],
        );
        ui.set_root(root);
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        app.advance_frame();
    }

    // Scroll down across the window boundary (forces reconcile + detach).
    scroll_handle.set_offset(fret_core::Point::new(Px(0.0), Px(60.0)));
    let mut kept_alive_any = false;
    for _frame in 0..2 {
        let root = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "retained-virt-keep-alive",
            |cx| vec![build_tree(cx, &scroll_handle)],
        );
        ui.set_root(root);
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        kept_alive_any |= ui
            .debug_retained_virtual_list_reconciles()
            .iter()
            .any(|r| r.kept_alive_items > 0);
        app.advance_frame();
    }
    assert!(
        kept_alive_any,
        "expected reconcile to retain some keep-alive items"
    );

    // Scroll back to the top; the host should reuse some kept-alive items instead of mounting them
    // again from scratch.
    scroll_handle.set_offset(fret_core::Point::new(Px(0.0), Px(0.0)));
    let mut reused_any = false;
    for _frame in 0..2 {
        let root = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "retained-virt-keep-alive",
            |cx| vec![build_tree(cx, &scroll_handle)],
        );
        ui.set_root(root);
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        reused_any |= ui
            .debug_retained_virtual_list_reconciles()
            .iter()
            .any(|r| r.reused_from_keep_alive_items > 0);
        app.advance_frame();
    }
    assert!(
        reused_any,
        "expected reconcile to reuse items from the keep-alive bucket when scrolling back"
    );
}

#[test]
fn retained_virtual_list_reconcile_waits_for_authoritative_viewport_before_consuming_pending() {
    let mut app = TestHost::new();
    let mut ui: UiTree<TestHost> = UiTree::new();
    let window = AppWindowId::default();
    ui.set_window(window);
    ui.set_view_cache_enabled(true);
    ui.set_debug_enabled(true);

    let scroll_handle = crate::scroll::VirtualListScrollHandle::new();
    let bounds = Rect::new(
        fret_core::Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(200.0), Px(50.0)),
    );
    let mut text = FakeTextService::default();

    fn build_tree(
        cx: &mut ElementContext<'_, TestHost>,
        scroll_handle: &crate::scroll::VirtualListScrollHandle,
    ) -> AnyElement {
        let mut cache = crate::element::ViewCacheProps::default();
        cache.layout.size.width = crate::element::Length::Fill;
        cache.layout.size.height = crate::element::Length::Fill;
        cache.cache_key = 1;

        cx.view_cache(cache, move |cx| {
            let list_layout = crate::element::LayoutStyle {
                size: crate::element::SizeStyle {
                    width: crate::element::Length::Fill,
                    height: crate::element::Length::Fill,
                    ..Default::default()
                },
                overflow: crate::element::Overflow::Clip,
                ..Default::default()
            };

            let key_at: crate::windowed_surface_host::RetainedVirtualListKeyAtFn =
                Arc::new(|i| i as crate::ItemKey);
            let row: crate::windowed_surface_host::RetainedVirtualListRowFn<TestHost> =
                Arc::new(|cx, i| cx.text(format!("row {i}")));

            vec![cx.virtual_list_keyed_retained_with_layout(
                list_layout,
                100,
                crate::element::VirtualListOptions::new(Px(10.0), 0),
                scroll_handle,
                key_at,
                row,
            )]
        })
    }

    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "retained-virt-pending-reconcile-awaits-viewport",
        |cx| vec![build_tree(cx, &scroll_handle)],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);

    let cache_node = ui.children(root)[0];
    let list_node = ui.children(cache_node)[0];
    let list_element = app
        .with_global_mut(
            crate::declarative::frame::ElementFrame::default,
            |frame, _app| {
                frame
                    .windows
                    .get(&window)
                    .and_then(|w| w.instances.get(list_node))
                    .map(|record| record.element)
            },
        )
        .expect("expected retained virtual list element");

    crate::elements::with_element_state(
        &mut app,
        window,
        list_element,
        crate::element::VirtualListState::default,
        |state| {
            state.viewport_h = Px(0.0);
            state.window_range = None;
            state.render_window_range = None;
            state.has_final_viewport = false;
        },
    );
    crate::elements::with_window_state(&mut app, window, |window_state| {
        window_state.mark_retained_virtual_list_needs_reconcile(
            list_element,
            crate::tree::UiDebugRetainedVirtualListReconcileKind::Escape,
        );
    });

    app.advance_frame();
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "retained-virt-pending-reconcile-awaits-viewport",
        |cx| vec![build_tree(cx, &scroll_handle)],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);
    assert!(
        ui.debug_retained_virtual_list_reconciles().is_empty(),
        "expected pending reconcile to defer while viewport/window range are still unavailable"
    );

    app.advance_frame();
    let root = render_root(
        &mut ui,
        &mut app,
        &mut text,
        window,
        bounds,
        "retained-virt-pending-reconcile-awaits-viewport",
        |cx| vec![build_tree(cx, &scroll_handle)],
    );
    ui.set_root(root);
    ui.layout_all(&mut app, &mut text, bounds, 1.0);

    assert!(
        ui.debug_retained_virtual_list_reconciles()
            .iter()
            .any(|r| r.element == list_element
                && r.reconcile_kind
                    == crate::tree::UiDebugRetainedVirtualListReconcileKind::Escape),
        "expected deferred retained-host reconcile to survive the viewport-unknown frame and complete once layout produced an authoritative viewport"
    );
}

#[test]
fn retained_virtual_list_host_updates_window_without_rerendering_view_cache_root() {
    #[derive(Default)]
    struct CapturedIds {
        cache_root: Option<crate::elements::GlobalElementId>,
        rows: std::collections::HashMap<usize, crate::elements::GlobalElementId>,
    }

    let mut app = TestHost::new();
    let mut ui: UiTree<TestHost> = UiTree::new();
    let window = AppWindowId::default();
    ui.set_window(window);
    ui.set_view_cache_enabled(true);

    let scroll_handle = crate::scroll::VirtualListScrollHandle::new();
    let bounds = Rect::new(
        fret_core::Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(200.0), Px(30.0)),
    );
    let mut text = FakeTextService::default();
    let captured_ids = Arc::new(std::sync::Mutex::new(CapturedIds::default()));

    fn build_list(
        cx: &mut ElementContext<'_, TestHost>,
        scroll_handle: &crate::scroll::VirtualListScrollHandle,
        captured_ids: &Arc<std::sync::Mutex<CapturedIds>>,
    ) -> AnyElement {
        let mut options = crate::element::VirtualListOptions::new(Px(10.0), 0);
        options.measure_mode = crate::element::VirtualListMeasureMode::Fixed;
        let mut layout = crate::element::LayoutStyle::default();
        layout.size.height = crate::element::Length::Fill;

        {
            let mut captured = captured_ids.lock().expect("capture cache root");
            captured.cache_root = Some(cx.root_id());
        }

        let key_at: crate::windowed_surface_host::RetainedVirtualListKeyAtFn =
            Arc::new(|i| i as crate::ItemKey);

        let row_ids = Arc::clone(captured_ids);
        let row: crate::windowed_surface_host::RetainedVirtualListRowFn<TestHost> =
            Arc::new(move |cx, index| {
                let mut style = crate::element::LayoutStyle::default();
                style.size.height = crate::element::Length::Px(Px(10.0));
                let row_ids = Arc::clone(&row_ids);
                cx.semantics_with_id(
                    crate::element::SemanticsProps {
                        role: fret_core::SemanticsRole::ListItem,
                        label: Some(Arc::<str>::from(format!("Row {index}"))),
                        ..Default::default()
                    },
                    move |cx, id| {
                        row_ids
                            .lock()
                            .expect("capture row id")
                            .rows
                            .insert(index, id);
                        vec![cx.container(
                            crate::element::ContainerProps {
                                layout: style,
                                ..Default::default()
                            },
                            |cx| vec![cx.text(format!("Row {index}"))],
                        )]
                    },
                )
            });

        cx.virtual_list_keyed_retained_with_layout(
            layout,
            200,
            options,
            scroll_handle,
            Arc::clone(&key_at),
            Arc::clone(&row),
        )
    }

    // Virtual lists need a "viewport-known" render to mount their first visible window. Do an
    // initial two-frame warmup with view caching disabled so `VirtualListState.viewport_*` gets
    // populated during layout, then allow the next render to build the initial children.
    for _frame in 0..2 {
        let scroll_handle = scroll_handle.clone();
        let captured_ids = Arc::clone(&captured_ids);
        let root_node = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "retained-virt-003",
            move |cx| {
                vec![
                    cx.view_cache(crate::element::ViewCacheProps::default(), |cx| {
                        vec![build_list(cx, &scroll_handle, &captured_ids)]
                    }),
                ]
            },
        );

        ui.set_root(root_node);
        ui.request_semantics_snapshot();
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        let mut scene = Scene::default();
        ui.paint_all(&mut app, &mut text, bounds, &mut scene, 1.0);
        app.advance_frame();
    }

    ui.set_view_cache_enabled(true);
    let renders = Arc::new(AtomicUsize::new(0));

    // Establish cache-hit steady state: the view-cache closure should only run once.
    for _frame in 0..6 {
        let renders = Arc::clone(&renders);
        let scroll_handle = scroll_handle.clone();
        let captured_ids = Arc::clone(&captured_ids);
        let root_node = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "retained-virt-003",
            move |cx| {
                vec![
                    cx.view_cache(crate::element::ViewCacheProps::default(), |cx| {
                        renders.fetch_add(1, Ordering::SeqCst);
                        vec![build_list(cx, &scroll_handle, &captured_ids)]
                    }),
                ]
            },
        );

        ui.set_root(root_node);
        ui.request_semantics_snapshot();
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        let mut scene = Scene::default();
        ui.paint_all(&mut app, &mut text, bounds, &mut scene, 1.0);
        app.advance_frame();
    }

    let baseline_renders = renders.load(Ordering::SeqCst);
    assert!(
        baseline_renders <= 2,
        "expected view-cache warmup to stabilize quickly (renders={baseline_renders})"
    );

    let (vlist_element, vlist_instances) =
        crate::declarative::with_window_frame(&mut app, window, |window_frame| {
            let window_frame = window_frame?;
            let vlists = window_frame
                .instances
                .iter()
                .filter_map(|(_, record)| {
                    matches!(
                        record.instance,
                        crate::declarative::frame::ElementInstance::VirtualList(_)
                    )
                    .then_some(record.element)
                })
                .collect::<Vec<_>>();
            Some(vlists)
        })
        .map(|vlists| {
            let first = *vlists.first().expect("virtual list instance");
            (first, vlists.len())
        })
        .expect("window frame");
    assert_eq!(
        vlist_instances, 1,
        "expected a single virtual list instance"
    );

    assert!(
        crate::elements::with_window_state(&mut app, window, |window_state| {
            window_state.has_state::<crate::windowed_surface_host::RetainedVirtualListHostMarker>(
                vlist_element,
            )
        }),
        "expected retained virtual list host marker state to exist"
    );

    let bound = crate::declarative::frame::bound_elements_for_scroll_handle(
        &mut app,
        window,
        scroll_handle.base_handle().binding_key(),
    );
    assert!(
        bound.contains(&vlist_element),
        "expected the virtual list element to be bound to the scroll handle (bound={bound:?})"
    );

    let (registry_frame_id, registry_handles, registry_by_handle) = app.with_global_mut_untracked(
        crate::declarative::frame::ScrollHandleRegistry::default,
        |registry, _| {
            let window_registry = registry
                .windows
                .get(&window)
                .expect("scroll handle registry window");
            (
                window_registry.frame_id,
                window_registry.handles.len(),
                window_registry.by_handle.len(),
            )
        },
    );
    assert!(
        registry_handles > 0,
        "expected scroll handle registry to have handles after warmup (frame_id={registry_frame_id:?}, handles={registry_handles}, by_handle={registry_by_handle})"
    );

    // Jump outside the previously rendered overscan window (e.g. 0..=2 -> 3..=5).
    //
    // Use a relative delta so we guarantee an actual offset change even if a previous frame
    // adjusted the handle internally (e.g. clamping).
    let prev_offset = scroll_handle.offset();
    let prev_revision = scroll_handle.revision();
    let next_offset = Px(prev_offset.y.0 + 30.0);
    scroll_handle.set_offset(fret_core::Point::new(prev_offset.x, next_offset));
    assert_ne!(
        scroll_handle.revision(),
        prev_revision,
        "expected set_offset to bump the scroll handle revision (prev_offset={prev_offset:?}, next_offset={:?})",
        scroll_handle.offset(),
    );

    let expected_start = (next_offset.0 / 10.0) as usize;

    let mut renders_after_scroll_frames: Vec<usize> = Vec::new();
    for _frame in 0..2 {
        let renders_for_closure = Arc::clone(&renders);
        let scroll_handle = scroll_handle.clone();
        let captured_ids = Arc::clone(&captured_ids);
        let root_node = render_root(
            &mut ui,
            &mut app,
            &mut text,
            window,
            bounds,
            "retained-virt-003",
            move |cx| {
                vec![
                    cx.view_cache(crate::element::ViewCacheProps::default(), |cx| {
                        renders_for_closure.fetch_add(1, Ordering::SeqCst);
                        vec![build_list(cx, &scroll_handle, &captured_ids)]
                    }),
                ]
            },
        );
        ui.set_root(root_node);
        ui.request_semantics_snapshot();
        ui.layout_all(&mut app, &mut text, bounds, 1.0);
        let mut scene = Scene::default();
        ui.paint_all(&mut app, &mut text, bounds, &mut scene, 1.0);
        renders_after_scroll_frames.push(renders.load(Ordering::SeqCst));
        app.advance_frame();
    }

    assert_eq!(
        renders_after_scroll_frames.len(),
        2,
        "expected two scroll frames"
    );
    assert_eq!(
        renders_after_scroll_frames[0], renders_after_scroll_frames[1],
        "expected scroll frames to stabilize after the first frame (renders_after_scroll_frames={renders_after_scroll_frames:?})"
    );
    assert!(
        renders_after_scroll_frames[1] <= baseline_renders.saturating_add(1),
        "expected retained host reconciliation to avoid repeated rerendering the cache root (baseline_renders={baseline_renders}, renders_after_scroll_frames={renders_after_scroll_frames:?})"
    );

    let vlist_node =
        crate::declarative::node_for_element_in_window_frame(&mut app, window, vlist_element)
            .expect("virtual list node exists");
    let (visible_indices, frame_children_len, ui_children_len): (Vec<usize>, usize, usize) =
        crate::declarative::with_window_frame(&mut app, window, |window_frame| {
            let window_frame = window_frame?;
            let record = window_frame.instances.get(vlist_node)?;
            let crate::declarative::frame::ElementInstance::VirtualList(props) = &record.instance
            else {
                return None;
            };
            let visible_indices = props
                .visible_items
                .iter()
                .map(|item| item.index)
                .collect::<Vec<_>>();
            let frame_children_len = window_frame
                .children
                .get(vlist_node)
                .map(|c| c.len())
                .unwrap_or(0);
            Some((
                visible_indices,
                frame_children_len,
                ui.children(vlist_node).len(),
            ))
        })
        .expect("window frame");

    assert!(
        !visible_indices.is_empty(),
        "expected virtual list to have visible items after scroll (expected_start={expected_start}, ui_children_len={ui_children_len}, frame_children_len={frame_children_len})"
    );
    assert!(
        visible_indices.contains(&expected_start),
        "expected the reconciled window to include index {expected_start} (visible_indices={visible_indices:?})"
    );
    assert!(
        visible_indices.contains(&(expected_start + 1)),
        "expected the reconciled window to include index {} (visible_indices={visible_indices:?})",
        expected_start + 1
    );
    assert!(
        visible_indices.contains(&(expected_start + 2)),
        "expected the reconciled window to include index {} (visible_indices={visible_indices:?})",
        expected_start + 2
    );

    let (cache_root, expected_row_membership) = {
        let captured = captured_ids.lock().expect("captured row ids");
        (
            captured.cache_root.expect("cache root id"),
            vec![
                (
                    expected_start,
                    *captured
                        .rows
                        .get(&expected_start)
                        .expect("captured id for first expected row"),
                ),
                (
                    expected_start + 1,
                    *captured
                        .rows
                        .get(&(expected_start + 1))
                        .expect("captured id for second expected row"),
                ),
                (
                    expected_start + 2,
                    *captured
                        .rows
                        .get(&(expected_start + 2))
                        .expect("captured id for third expected row"),
                ),
            ],
        )
    };

    app.with_global_mut(crate::elements::ElementRuntime::new, |runtime, _app| {
        let window_state = runtime.for_window_mut(window);
        let elements = window_state
            .view_cache_elements_for_root(cache_root)
            .expect("expected cache-root membership after retained-host reconcile");

        for (index, row_id) in &expected_row_membership {
            assert!(
                elements.contains(row_id),
                "expected cache-root membership to refresh after retained-host reconcile; missing row index {index} id {row_id:?} from {elements:?}"
            );
        }
    });
}