abstracttui 0.3.1

A reactive, compositor-grade terminal UI engine: fine-grained signals, layered rendering with damage tracking, images (kitty/iTerm2/sixel/mosaic), software-rasterized 3D (GLB), themes and animation.
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
//! `FeedState::sync` tests: the scripted-fold path pins (append-only
//! never rebuilds, mid-list changes rebuild, tail visibility appends)
//! and the pixel-parity bar — a sync-driven feed renders EXACTLY what
//! a hand-pushed feed renders for the same end state, across reorder,
//! mid-list update, burst append and full replace.

use std::cell::{Cell, RefCell};
use std::rc::Rc;

use crate::base::{Point, Size};
use crate::layout::{Dimension, Style as LayoutStyle};
use crate::reactive::{flush_effects, run_due_timers, Signal};
use crate::ui::{BufferCanvas, Element, UiTree};
use crate::widgets::itest_util::{mount_widget, render};
use crate::widgets::{Feed, FeedItem, FeedState, SyncSpec};

/// The scripted source row: id = identity, rev = fingerprint,
/// hidden = visibility, text = pixels.
#[derive(Clone)]
struct Msg {
    id: String,
    rev: u64,
    hidden: bool,
    text: String,
}

fn msg(id: &str, text: &str) -> Msg {
    Msg {
        id: id.to_string(),
        rev: 0,
        hidden: false,
        text: text.to_string(),
    }
}

/// One full settle (the feed_tests recipe): effects -> layout -> draw
/// (width discovery) -> due timers (geometry sync) -> effects -> draw.
fn settle(tree: &mut UiTree, size: Size) -> BufferCanvas {
    flush_effects();
    tree.layout();
    let _ = render(tree, size);
    run_due_timers(std::time::Instant::now());
    flush_effects();
    tree.layout();
    render(tree, size)
}

/// What `mount_synced` hands back for driving + inspection.
type SyncedMount = (
    crate::reactive::RootScope,
    UiTree,
    Signal<Vec<Msg>>,
    FeedState,
    Rc<Cell<usize>>,
);

/// The holder cell tests capture mount-created state through.
type StateHolder = Rc<RefCell<Option<(Signal<Vec<Msg>>, FeedState)>>>;

/// Mount a feed synced to a fresh `Signal<Vec<Msg>>`; returns the
/// source signal and a render-call counter (the cost pin instrument).
fn mount_synced(size: Size) -> SyncedMount {
    let renders = Rc::new(Cell::new(0usize));
    let holder: StateHolder = Rc::new(RefCell::new(None));
    let (h, r) = (holder.clone(), renders.clone());
    let (root, mut tree) = mount_widget(size, move |cx| {
        let items: Signal<Vec<Msg>> = cx.signal(Vec::new());
        let feed = FeedState::new(cx);
        feed.sync(
            cx,
            items,
            SyncSpec::new(
                |m: &Msg| m.id.to_string(),
                |m| m.rev,
                move |m| {
                    r.set(r.get() + 1);
                    FeedItem::text(m.text.clone())
                },
            )
            .visible(|m| !m.hidden),
        );
        *h.borrow_mut() = Some((items, feed.clone()));
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(Feed::new(&feed).view(cx))
            .build()
    });
    let (items, feed) = holder.borrow().clone().expect("state captured");
    let _ = settle(&mut tree, size);
    (root, tree, items, feed, renders)
}

/// Hand-pushed reference feed for the parity bar.
fn mount_reference(size: Size) -> (crate::reactive::RootScope, UiTree, FeedState) {
    let holder: Rc<RefCell<Option<FeedState>>> = Rc::new(RefCell::new(None));
    let h = holder.clone();
    let (root, tree) = mount_widget(size, move |cx| {
        let feed = FeedState::new(cx);
        *h.borrow_mut() = Some(feed.clone());
        Element::new()
            .style(
                LayoutStyle::default()
                    .width(Dimension::Percent(1.0))
                    .height(Dimension::Percent(1.0)),
            )
            .child(Feed::new(&feed).view(cx))
            .build()
    });
    let feed = holder.borrow().clone().expect("state captured");
    (root, tree, feed)
}

fn assert_same_pixels(a: &BufferCanvas, b: &BufferCanvas, size: Size, label: &str) {
    for y in 0..size.h {
        for x in 0..size.w {
            assert_eq!(
                a.cell(Point::new(x, y)),
                b.cell(Point::new(x, y)),
                "{label}: divergence at ({x},{y}):\nsynced: {:?}\nhand:   {:?}",
                a.row_text(y),
                b.row_text(y)
            );
        }
    }
}

/// Parity harness: drive the synced feed to `list`, hand-push the same
/// visible end state, compare every cell.
fn assert_parity(label: &str, list: Vec<Msg>) {
    let size = Size::new(26, 14);
    let (root_a, mut tree_a, items, _feed, _r) = mount_synced(size);
    items.set(list.clone());
    let canvas_a = settle(&mut tree_a, size);

    let (root_b, mut tree_b, reference) = mount_reference(size);
    for m in list.iter().filter(|m| !m.hidden) {
        reference.push(m.id.clone(), FeedItem::text(m.text.clone()));
    }
    let canvas_b = settle(&mut tree_b, size);

    assert_same_pixels(&canvas_a, &canvas_b, size, label);
    root_a.dispose();
    root_b.dispose();
}

#[test]
fn append_only_folds_take_the_push_path_and_never_rebuild() {
    let size = Size::new(24, 12);
    let (root, mut tree, items, feed, renders) = mount_synced(size);

    items.set(vec![msg("a", "alpha"), msg("b", "beta")]);
    flush_effects();
    assert_eq!(renders.get(), 2, "initial fill renders each item once");
    assert_eq!(feed.len(), 2);

    // Ten appends, one at a time: each run renders ONLY the new item.
    for i in 0..10 {
        items.update(|v| v.push(msg(&format!("k{i}"), &format!("line {i}"))));
        flush_effects();
    }
    assert_eq!(
        renders.get(),
        12,
        "append-only fold must never re-render shown items (no rebuild)"
    );
    assert_eq!(feed.len(), 12);
    let canvas = settle(&mut tree, size);
    assert!(canvas.row_text(0).contains("alpha"));
    root.dispose();
}

#[test]
fn fingerprint_change_updates_in_place_without_rebuild() {
    let size = Size::new(24, 12);
    let (root, mut tree, items, feed, renders) = mount_synced(size);
    items.set(vec![msg("a", "alpha"), msg("b", "beta"), msg("c", "gamma")]);
    flush_effects();
    assert_eq!(renders.get(), 3);

    // Mid-list content change: bump the fingerprint, keep order.
    items.update(|v| {
        v[1].rev = 1;
        v[1].text = "BETA2".into();
    });
    flush_effects();
    assert_eq!(renders.get(), 4, "one changed fingerprint = one render");
    assert_eq!(feed.len(), 3, "update in place, not append");
    let canvas = settle(&mut tree, size);
    let dump: Vec<String> = (0..size.h).map(|y| canvas.row_text(y)).collect();
    assert!(dump.iter().any(|r| r.contains("BETA2")), "{dump:#?}");
    assert!(!dump.iter().any(|r| r.contains("beta")), "old text gone");
    root.dispose();
}

#[test]
fn mid_list_insert_rebuilds_exactly_once() {
    let size = Size::new(24, 12);
    let (root, _tree, items, feed, renders) = mount_synced(size);
    items.set(vec![msg("a", "alpha"), msg("c", "gamma")]);
    flush_effects();
    assert_eq!(renders.get(), 2);

    items.update(|v| v.insert(1, msg("b", "beta")));
    flush_effects();
    // Rebuild: every visible item re-renders exactly once (2 + 3).
    assert_eq!(renders.get(), 5, "mid-list insert = one whole rebuild");
    assert_eq!(feed.len(), 3);
    root.dispose();
}

#[test]
fn visibility_flips_mid_list_rebuild_and_tail_flips_append() {
    let size = Size::new(24, 12);
    let (root, _tree, items, feed, renders) = mount_synced(size);
    items.set(vec![msg("a", "alpha"), msg("b", "beta"), msg("c", "gamma")]);
    flush_effects();
    assert_eq!(renders.get(), 3);

    // Hide a mid-list item: push order breaks -> rebuild (2 renders).
    items.update(|v| v[1].hidden = true);
    flush_effects();
    assert_eq!(renders.get(), 5, "mid-list hide rebuilds the window");
    assert_eq!(feed.len(), 2);

    // A hidden TAIL item becoming visible is an append, not a rebuild.
    items.update(|v| {
        let mut d = msg("d", "delta");
        d.hidden = true;
        v.push(d);
    });
    flush_effects();
    assert_eq!(renders.get(), 5, "hidden tail item renders nothing");
    items.update(|v| v[3].hidden = false);
    flush_effects();
    assert_eq!(renders.get(), 6, "tail-only visibility flip appends");
    assert_eq!(feed.len(), 3);
    root.dispose();
}

#[test]
fn shrink_and_reorder_take_the_rebuild_path() {
    let size = Size::new(24, 12);
    let (root, _tree, items, feed, renders) = mount_synced(size);
    items.set(vec![msg("a", "alpha"), msg("b", "beta"), msg("c", "gamma")]);
    flush_effects();
    assert_eq!(renders.get(), 3);

    // Tail removal: same key prefix but shorter -> must rebuild
    // (the feed cannot remove).
    items.update(|v| {
        v.pop();
    });
    flush_effects();
    assert_eq!(renders.get(), 5, "shrink rebuilds (2 items re-render)");
    assert_eq!(feed.len(), 2);

    // Reorder: prefix keys mismatch -> rebuild.
    items.update(|v| v.swap(0, 1));
    flush_effects();
    assert_eq!(renders.get(), 7, "reorder rebuilds");
    assert_eq!(feed.len(), 2);
    root.dispose();
}

/// The visibility-mirror bar: for every mutation class the synced feed
/// must render the EXACT cells a hand-pushed feed renders for the same
/// visible end state.
#[test]
fn parity_reorder_midlist_update_burst_append_full_replace() {
    // Reorder.
    assert_parity(
        "reorder",
        vec![msg("b", "second first"), msg("a", "first second")],
    );
    // Mid-list update end state.
    let mut updated = vec![msg("a", "alpha"), msg("b", "changed body"), msg("c", "g")];
    updated[1].rev = 3;
    assert_parity("mid-list update", updated);
    // Burst append end state (drive through the signal in two steps to
    // exercise the append path, then compare).
    let size = Size::new(26, 14);
    let (root_a, mut tree_a, items, _f, _r) = mount_synced(size);
    items.set(vec![msg("a", "alpha")]);
    flush_effects();
    items.update(|v| {
        for i in 0..6 {
            v.push(msg(&format!("b{i}"), &format!("burst {i}")));
        }
    });
    let canvas_a = settle(&mut tree_a, size);
    let (root_b, mut tree_b, reference) = mount_reference(size);
    reference.push("a", FeedItem::text("alpha"));
    for i in 0..6 {
        reference.push(format!("b{i}"), FeedItem::text(format!("burst {i}")));
    }
    let canvas_b = settle(&mut tree_b, size);
    assert_same_pixels(&canvas_a, &canvas_b, size, "burst append");
    root_a.dispose();
    root_b.dispose();
    // Full replace (every key different).
    let size = Size::new(26, 14);
    let (root_a, mut tree_a, items, _f, _r) = mount_synced(size);
    items.set(vec![msg("a", "alpha"), msg("b", "beta")]);
    flush_effects();
    items.set(vec![msg("x", "new one"), msg("y", "new two")]);
    let canvas_a = settle(&mut tree_a, size);
    let (root_b, mut tree_b, reference) = mount_reference(size);
    reference.push("x", FeedItem::text("new one"));
    reference.push("y", FeedItem::text("new two"));
    let canvas_b = settle(&mut tree_b, size);
    assert_same_pixels(&canvas_a, &canvas_b, size, "full replace");
    root_a.dispose();
    root_b.dispose();
}

#[test]
fn hidden_items_never_reach_the_feed_and_parity_holds_with_filter() {
    let mut list = vec![msg("a", "alpha"), msg("b", "beta"), msg("c", "gamma")];
    list[1].hidden = true;
    assert_parity("hidden mid-list", list);
}

/// The one-writer self-heal (cycle-2 review C-1): a manual `push` onto
/// a synced feed is DETECTED at the next drain (mutation counter) and
/// healed with a rebuild — the stray item is evicted, the feed equals
/// the source again, and fast paths resume afterwards (the heal is a
/// one-shot repair, not a permanent rebuild storm).
#[test]
fn foreign_push_between_drains_self_heals_with_a_rebuild() {
    let size = Size::new(24, 12);
    let (root, mut tree, items, feed, renders) = mount_synced(size);
    items.set(vec![msg("a", "alpha"), msg("b", "beta")]);
    flush_effects();
    assert_eq!(renders.get(), 2);

    // The violation: the app writes past the bridge.
    feed.push("stray", FeedItem::text("stray row"));
    assert_eq!(feed.len(), 3, "precondition: the stray landed");

    // Next drain is an APPEND-ONLY source change — before the guard
    // this stayed on the fast path forever and the stray survived.
    items.update(|v| v.push(msg("c", "gamma")));
    flush_effects();
    assert_eq!(feed.len(), 3, "self-heal rebuilt: 3 mirrored, 0 stray");
    assert_eq!(
        renders.get(),
        5,
        "the heal is one full rebuild (2 + 3 renders)"
    );
    let canvas = settle(&mut tree, size);
    let dump: Vec<String> = (0..size.h).map(|y| canvas.row_text(y)).collect();
    assert!(
        !dump.iter().any(|r| r.contains("stray row")),
        "stray write evicted at the next drain: {dump:#?}"
    );

    // A clean append after the heal takes the fast path again.
    items.update(|v| v.push(msg("d", "delta")));
    flush_effects();
    assert_eq!(renders.get(), 6, "fast paths resume after the heal");
    assert_eq!(feed.len(), 4);
    root.dispose();
}

/// The worst shape from the review (C-1): the app manually pushes a
/// key the source appends LATER. Un-healed, the bridge's `push` for
/// that key lands as a replace-in-place at the old index, so feed
/// order diverges from source order permanently while `shown` claims
/// they agree. The self-heal rebuild restores source order.
#[test]
fn foreign_push_of_a_future_source_key_heals_to_source_order() {
    let size = Size::new(24, 12);
    let (root, mut tree, items, feed, _renders) = mount_synced(size);
    items.set(vec![msg("a", "alpha")]);
    flush_effects();

    // Foreign write of key "c" — a key the source will append later.
    feed.push("c", FeedItem::text("premature gamma"));

    // The source then appends b and c: without the heal, "c" would be
    // replaced in place at index 1 and the feed would read a, c, b.
    items.update(|v| {
        v.push(msg("b", "beta"));
        v.push(msg("c", "gamma"));
    });
    let canvas = settle(&mut tree, size);
    assert_eq!(feed.len(), 3);
    let rows: Vec<i32> = ["a", "b", "c"]
        .iter()
        .map(|k| feed.row_of(k).expect("mirrored key"))
        .collect();
    assert!(
        rows[0] < rows[1] && rows[1] < rows[2],
        "feed order equals source order after the heal: {rows:?}"
    );
    let dump: Vec<String> = (0..size.h).map(|y| canvas.row_text(y)).collect();
    assert!(
        dump.iter().any(|r| r.contains("gamma")),
        "the source's render won, not the foreign content: {dump:#?}"
    );
    assert!(
        !dump.iter().any(|r| r.contains("premature")),
        "foreign content evicted: {dump:#?}"
    );
    root.dispose();
}

/// Measured (report evidence, perf-suite convention): one sync run
/// folding a 1k burst append into a feed already mirroring 10k items —
/// the diff walks 11k fingerprints and renders exactly 1k new items.
///
/// ```sh
/// cargo test --release --lib perf_sync_burst -- --ignored --nocapture
/// ```
// The borrow-based source door (first-app/0282) — a child module in a
// sibling file (<600-line budget) so it shares this rig through
// `super::*` with zero visibility churn.
#[path = "feed_sync_with_tests.rs"]
mod sync_with;

#[test]
#[ignore = "perf: measured evidence, run explicitly in release (--ignored)"]
fn perf_sync_burst_1k_into_10k() {
    let size = Size::new(40, 12);
    let m = crate::testing::time_median("sync burst 1k into 10k", 1, 5, 1, |_| {
        let (root, mut tree, items, feed, renders) = mount_synced(size);
        items.set(
            (0..10_000)
                .map(|i| msg(&format!("k{i}"), "seed row"))
                .collect(),
        );
        flush_effects();
        let _ = settle(&mut tree, size);
        assert_eq!(renders.get(), 10_000);
        let start = std::time::Instant::now();
        items.update(|v| {
            for i in 0..1_000 {
                v.push(msg(&format!("b{i}"), "burst row"));
            }
        });
        flush_effects();
        eprintln!("  burst fold alone: {:?}", start.elapsed());
        assert_eq!(renders.get(), 11_000, "burst renders only the 1k new items");
        assert_eq!(feed.len(), 11_000);
        root.dispose();
    });
    eprintln!("{}", m.report());
    if !cfg!(debug_assertions) {
        m.assert_under(std::time::Duration::from_secs(3));
    }
}