reratui 1.1.0

A modern, reactive TUI framework for Rust with React-inspired hooks and components, powered by ratatui
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
//! Integration tests for React parity in reratui.
//!
//! These tests verify that the hooks and runtime behave like React:
//! - Effects run after commit, not during render
//! - State updates are batched
//! - Context providers have proper lifecycle
//! - Hook state is isolated between fibers
//! - Cleanup functions run in correct order

use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};

use reratui::fiber_tree::{FiberTree, clear_fiber_tree, set_fiber_tree, with_fiber_tree_mut};
use reratui::hooks::{use_context, use_context_provider, use_effect, use_effect_once, use_state};
use reratui::scheduler::batch::{begin_batch, clear_state_batch, end_batch_with_tree};
use reratui::scheduler::effect_queue::{clear_effect_queue, flush_effects_with_tree};
use reratui::{FiberId, context_stack::clear_context_stack};

/// Helper to set up a test fiber tree with a single fiber
fn setup_single_fiber() -> FiberId {
    clear_effect_queue();
    clear_state_batch();
    clear_context_stack();
    let mut tree = FiberTree::new();
    let fiber_id = tree.mount(None, None);
    tree.begin_render(fiber_id);
    set_fiber_tree(tree);
    fiber_id
}

/// Helper to set up a test fiber tree with parent and child fibers
fn setup_parent_child_fibers() -> (FiberId, FiberId) {
    clear_effect_queue();
    clear_state_batch();
    clear_context_stack();
    let mut tree = FiberTree::new();
    let parent_id = tree.mount(None, None);
    let child_id = tree.mount(Some(parent_id), None);
    set_fiber_tree(tree);
    (parent_id, child_id)
}

/// Helper to clean up after tests
fn cleanup() {
    clear_fiber_tree();
    clear_effect_queue();
    clear_state_batch();
    clear_context_stack();
}

// =============================================================================
// Effect Timing Tests (React Parity: effects run after commit)
// =============================================================================

#[test]
fn test_effect_does_not_run_during_render() {
    let _fiber_id = setup_single_fiber();

    let effect_ran = Arc::new(AtomicUsize::new(0));
    let effect_ran_clone = effect_ran.clone();

    // Queue an effect during "render"
    use_effect_once(move || {
        effect_ran_clone.fetch_add(1, Ordering::SeqCst);
        Option::<fn()>::None
    });

    // Effect should NOT have run yet (still in render phase)
    assert_eq!(
        effect_ran.load(Ordering::SeqCst),
        0,
        "Effect should not run during render"
    );

    cleanup();
}

#[test]
fn test_effect_runs_after_commit_phase() {
    let _fiber_id = setup_single_fiber();

    let effect_ran = Arc::new(AtomicUsize::new(0));
    let effect_ran_clone = effect_ran.clone();

    use_effect_once(move || {
        effect_ran_clone.fetch_add(1, Ordering::SeqCst);
        Option::<fn()>::None
    });

    // Simulate commit phase by ending render and flushing effects
    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    // Effect should have run after commit
    assert_eq!(
        effect_ran.load(Ordering::SeqCst),
        1,
        "Effect should run after commit phase"
    );

    cleanup();
}

#[test]
fn test_cleanup_runs_before_new_effect() {
    let fiber_id = setup_single_fiber();

    let execution_order = Arc::new(std::sync::Mutex::new(Vec::new()));

    // First render with effect that has cleanup
    {
        let order = execution_order.clone();
        use_effect(
            move || {
                order.lock().unwrap().push("effect1");
                let order_cleanup = order.clone();
                Some(move || {
                    order_cleanup.lock().unwrap().push("cleanup1");
                })
            },
            None::<()>, // Run every render
        );
    }

    // Flush first effect
    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    // Second render - should trigger cleanup then new effect
    with_fiber_tree_mut(|tree| {
        tree.begin_render(fiber_id);
    });

    {
        let order = execution_order.clone();
        use_effect(
            move || {
                order.lock().unwrap().push("effect2");
                Option::<fn()>::None
            },
            None::<()>,
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    let order = execution_order.lock().unwrap();
    assert_eq!(
        *order,
        vec!["effect1", "cleanup1", "effect2"],
        "Cleanup should run before new effect"
    );

    cleanup();
}

// =============================================================================
// Hook State Isolation Tests
// =============================================================================

#[test]
fn test_hook_state_isolated_between_fibers() {
    let (parent_id, child_id) = setup_parent_child_fibers();

    // Parent fiber state
    with_fiber_tree_mut(|tree| {
        tree.begin_render(parent_id);
    });
    let (parent_count, _) = use_state(|| 100);
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // Child fiber state
    with_fiber_tree_mut(|tree| {
        tree.begin_render(child_id);
    });
    let (child_count, _) = use_state(|| 200);
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // States should be independent
    assert_eq!(parent_count, 100, "Parent should have its own state");
    assert_eq!(child_count, 200, "Child should have its own state");

    cleanup();
}

#[test]
fn test_multiple_hooks_in_same_fiber() {
    let _fiber_id = setup_single_fiber();

    let (count, _) = use_state(|| 1);
    let (name, _) = use_state(|| "Alice".to_string());
    let (active, _) = use_state(|| true);

    assert_eq!(count, 1);
    assert_eq!(name, "Alice");
    assert!(active);

    cleanup();
}

// =============================================================================
// State Batching Tests
// =============================================================================

#[test]
fn test_multiple_state_updates_are_batched() {
    let fiber_id = setup_single_fiber();

    let (_, set_count) = use_state(|| 0);

    // Begin batch (simulating event handler)
    begin_batch();

    // Multiple updates should be batched
    set_count.update(|n| n + 1);
    set_count.update(|n| n + 1);
    set_count.update(|n| n + 1);

    // End batch and apply updates
    with_fiber_tree_mut(|tree| {
        tree.end_render();
        let dirty = end_batch_with_tree(tree);

        // Only one fiber should be dirty (not three separate re-renders)
        assert_eq!(
            dirty.len(),
            1,
            "Updates should be batched into one dirty fiber"
        );
        assert!(dirty.contains(&fiber_id));

        // Final value should reflect all updates: 0 + 1 + 1 + 1 = 3
        let fiber = tree.get(fiber_id).unwrap();
        let final_value = fiber.get_hook::<i32>(0);
        assert_eq!(
            final_value,
            Some(3),
            "All batched updates should be applied"
        );
    });

    cleanup();
}

#[test]
fn test_functional_updates_receive_latest_state() {
    let fiber_id = setup_single_fiber();

    let (_, set_count) = use_state(|| 0);

    begin_batch();

    // Each functional update should receive the result of the previous
    set_count.update(|n| n + 10); // 0 -> 10
    set_count.update(|n| n * 2); // 10 -> 20
    set_count.update(|n| n + 5); // 20 -> 25

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        end_batch_with_tree(tree);

        let fiber = tree.get(fiber_id).unwrap();
        let final_value = fiber.get_hook::<i32>(0);
        assert_eq!(
            final_value,
            Some(25),
            "Functional updates should chain correctly"
        );
    });

    cleanup();
}

#[test]
fn test_set_if_changed_skips_equal_values() {
    let fiber_id = setup_single_fiber();

    let (_, set_count) = use_state(|| 42);

    // End initial render and mark clean
    with_fiber_tree_mut(|tree| {
        tree.end_render();
        tree.mark_clean(fiber_id);
        tree.begin_render(fiber_id);
    });
    clear_state_batch();

    // Set to same value - should NOT mark dirty
    set_count.set_if_changed(42);

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        let dirty = end_batch_with_tree(tree);

        assert!(
            !dirty.contains(&fiber_id),
            "Fiber should not be dirty when value unchanged"
        );
    });

    cleanup();
}

// =============================================================================
// Context Provider Scoping Tests
// =============================================================================

#[test]
fn test_context_provider_scoping() {
    let (parent_id, child_id) = setup_parent_child_fibers();

    // Parent provides context
    with_fiber_tree_mut(|tree| {
        tree.begin_render(parent_id);
    });
    use_context_provider(|| "parent-value".to_string());
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // Child can consume parent's context
    with_fiber_tree_mut(|tree| {
        tree.begin_render(child_id);
    });
    let value = use_context::<String>();
    assert_eq!(value, "parent-value", "Child should see parent's context");
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    cleanup();
}

#[test]
fn test_nested_context_providers_shadow() {
    let (parent_id, child_id) = setup_parent_child_fibers();

    // Parent provides context
    with_fiber_tree_mut(|tree| {
        tree.begin_render(parent_id);
    });
    use_context_provider(|| "outer".to_string());
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // Child provides same type - should shadow parent
    with_fiber_tree_mut(|tree| {
        tree.begin_render(child_id);
    });
    use_context_provider(|| "inner".to_string());
    let value = use_context::<String>();
    assert_eq!(value, "inner", "Inner provider should shadow outer");
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    cleanup();
}

#[test]
fn test_context_cleanup_on_unmount() {
    let (parent_id, child_id) = setup_parent_child_fibers();

    // Parent provides outer context
    with_fiber_tree_mut(|tree| {
        tree.begin_render(parent_id);
    });
    use_context_provider(|| "outer".to_string());
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // Child provides inner context
    with_fiber_tree_mut(|tree| {
        tree.begin_render(child_id);
    });
    use_context_provider(|| "inner".to_string());
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // Verify inner is visible
    assert_eq!(
        reratui::context_stack::get_context::<String>(),
        Some("inner".to_string())
    );

    // Unmount child
    with_fiber_tree_mut(|tree| {
        tree.schedule_unmount(child_id);
        tree.process_unmounts();
    });

    // After unmount, should see outer context again
    assert_eq!(
        reratui::context_stack::get_context::<String>(),
        Some("outer".to_string()),
        "After child unmount, parent context should be visible"
    );

    cleanup();
}

// =============================================================================
// Component Unmount Cleanup Order Tests
// =============================================================================

#[test]
fn test_unmount_cleanup_order() {
    let (parent_id, child_id) = setup_parent_child_fibers();

    // Both fibers provide context
    with_fiber_tree_mut(|tree| {
        tree.begin_render(parent_id);
    });
    use_context_provider(|| 1i32);
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    with_fiber_tree_mut(|tree| {
        tree.begin_render(child_id);
    });
    use_context_provider(|| 2i32);
    with_fiber_tree_mut(|tree| {
        tree.end_render();
    });

    // Schedule both for unmount
    with_fiber_tree_mut(|tree| {
        tree.schedule_unmount(child_id);
        tree.schedule_unmount(parent_id);

        let unmounted = tree.process_unmounts();

        // Both should be unmounted
        assert_eq!(unmounted.len(), 2);
        // Use public API to check if fibers exist
        assert!(tree.get(child_id).is_none());
        assert!(tree.get(parent_id).is_none());
    });

    // Context should be fully cleaned up
    assert_eq!(
        reratui::context_stack::get_context::<i32>(),
        None,
        "All context should be cleaned up after unmount"
    );

    cleanup();
}

// =============================================================================
// Effect Dependency Tests
// =============================================================================

#[test]
fn test_effect_with_empty_deps_runs_once() {
    let fiber_id = setup_single_fiber();

    let run_count = Arc::new(AtomicUsize::new(0));

    // First render
    {
        let count = run_count.clone();
        use_effect(
            move || {
                count.fetch_add(1, Ordering::SeqCst);
                Option::<fn()>::None
            },
            Some(()), // Empty deps = run once
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    assert_eq!(run_count.load(Ordering::SeqCst), 1);

    // Second render - should NOT run again
    with_fiber_tree_mut(|tree| {
        tree.begin_render(fiber_id);
    });

    {
        let count = run_count.clone();
        use_effect(
            move || {
                count.fetch_add(1, Ordering::SeqCst);
                Option::<fn()>::None
            },
            Some(()),
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    assert_eq!(
        run_count.load(Ordering::SeqCst),
        1,
        "Effect with empty deps should only run once"
    );

    cleanup();
}

#[test]
fn test_effect_with_changing_deps_reruns() {
    let fiber_id = setup_single_fiber();

    let run_count = Arc::new(AtomicUsize::new(0));

    // First render with deps = (1,)
    {
        let count = run_count.clone();
        use_effect(
            move || {
                count.fetch_add(1, Ordering::SeqCst);
                Option::<fn()>::None
            },
            Some((1i32,)),
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    assert_eq!(run_count.load(Ordering::SeqCst), 1);

    // Second render with different deps = (2,) - should run
    with_fiber_tree_mut(|tree| {
        tree.begin_render(fiber_id);
    });

    {
        let count = run_count.clone();
        use_effect(
            move || {
                count.fetch_add(1, Ordering::SeqCst);
                Option::<fn()>::None
            },
            Some((2i32,)), // Different deps
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    assert_eq!(
        run_count.load(Ordering::SeqCst),
        2,
        "Effect should rerun when deps change"
    );

    cleanup();
}

#[test]
fn test_effect_with_same_deps_does_not_rerun() {
    let fiber_id = setup_single_fiber();

    let run_count = Arc::new(AtomicUsize::new(0));

    // First render with deps = (42,)
    {
        let count = run_count.clone();
        use_effect(
            move || {
                count.fetch_add(1, Ordering::SeqCst);
                Option::<fn()>::None
            },
            Some((42i32,)),
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    assert_eq!(run_count.load(Ordering::SeqCst), 1);

    // Second render with same deps = (42,) - should NOT run
    with_fiber_tree_mut(|tree| {
        tree.begin_render(fiber_id);
    });

    {
        let count = run_count.clone();
        use_effect(
            move || {
                count.fetch_add(1, Ordering::SeqCst);
                Option::<fn()>::None
            },
            Some((42i32,)), // Same deps
        );
    }

    with_fiber_tree_mut(|tree| {
        tree.end_render();
        flush_effects_with_tree(tree);
    });

    assert_eq!(
        run_count.load(Ordering::SeqCst),
        1,
        "Effect should not rerun when deps are unchanged"
    );

    cleanup();
}