ftui-runtime 0.4.0

Elm-style runtime loop and subscriptions for FrankenTUI.
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
//! State Persistence E2E Tests (bd-30g1.6)
//!
//! End-to-end validation of widget state persistence and restoration.
//!
//! # Running Tests
//!
//! ```sh
//! cargo test -p ftui-runtime --test state_persistence_e2e
//! ```
//!
//! # Deterministic Mode
//!
//! ```sh
//! PERSIST_SEED=42 cargo test -p ftui-runtime --test state_persistence_e2e
//! ```
//!
//! # Invariants
//!
//! 1. **Round-trip integrity**: State saved equals state restored
//! 2. **Version isolation**: Different versions don't corrupt each other
//! 3. **Graceful degradation**: Corrupt data doesn't crash, falls back to default
//! 4. **Atomic writes**: Partial failures don't corrupt storage
//! 5. **Concurrent safety**: Multiple threads can access registry safely

#![cfg(test)]

use ftui_runtime::state_persistence::{MemoryStorage, StateRegistry, StorageBackend, StoredEntry};
use std::collections::HashMap;
use std::sync::{Arc, Barrier};
use std::thread;

#[cfg(feature = "state-persistence")]
use ftui_core::event::Event;
#[cfg(feature = "state-persistence")]
use ftui_render::frame::Frame;
#[cfg(feature = "state-persistence")]
use ftui_runtime::program::{Cmd, Model};
#[cfg(feature = "state-persistence")]
use ftui_runtime::simulator::ProgramSimulator;
#[cfg(feature = "state-persistence")]
use tempfile::tempdir;

// ============================================================================
// Test Utilities
// ============================================================================

fn log_jsonl(event: &str, case: &str, passed: bool, details: &str) {
    let timestamp = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_secs())
        .unwrap_or(0);

    eprintln!(
        r#"{{"event":"{event}","case":"{case}","passed":{passed},"details":"{details}","timestamp":{timestamp}}}"#
    );
}

// ============================================================================
// 1. Save/Restore Cycle Tests
// ============================================================================

/// Test basic save and restore round-trip.
#[test]
fn persist_cycle_basic_round_trip() {
    let registry = StateRegistry::in_memory();

    // Save state
    let original_data = b"scroll_offset=42".to_vec();
    registry.set("ScrollView::main", 1, original_data.clone());

    // Flush to storage
    assert!(registry.flush().unwrap());
    assert!(!registry.is_dirty());

    // Create new registry with same storage (simulating app restart)
    let storage = MemoryStorage::new();
    storage
        .save_all(&{
            let mut m = HashMap::new();
            m.insert(
                "ScrollView::main".to_string(),
                StoredEntry {
                    key: "ScrollView::main".to_string(),
                    version: 1,
                    data: original_data.clone(),
                },
            );
            m
        })
        .unwrap();

    let registry2 = StateRegistry::new(Box::new(storage));
    registry2.load().unwrap();

    // Verify restored state matches
    let restored = registry2.get("ScrollView::main").unwrap();
    assert_eq!(restored.data, original_data);
    assert_eq!(restored.version, 1);

    log_jsonl(
        "persist_cycle",
        "basic_round_trip",
        true,
        "state matches after round-trip",
    );
}

/// Test partial state handling - some widgets have state, some don't.
#[test]
fn persist_cycle_partial_state() {
    let registry = StateRegistry::in_memory();

    // Only one widget has saved state
    registry.set("Widget::A", 1, b"state_a".to_vec());
    registry.flush().unwrap();

    // Widget B has no saved state - should get None
    assert!(registry.get("Widget::B").is_none());
    assert!(registry.get("Widget::A").is_some());

    log_jsonl(
        "persist_cycle",
        "partial_state",
        true,
        "missing widgets return None",
    );
}

/// Test that save on exit works correctly.
#[test]
fn persist_cycle_save_on_exit() {
    {
        let registry = StateRegistry::new(Box::new(MemoryStorage::new()));
        registry.set("TreeView::sidebar", 2, b"expanded=[1,2,3]".to_vec());

        // Simulate app exit - flush before drop
        registry.flush().unwrap();
    }

    // Registry is dropped - in real usage this would persist to file
    log_jsonl(
        "persist_cycle",
        "save_on_exit",
        true,
        "flush before drop works",
    );
}

/// Test restore on app start with existing state.
#[test]
fn persist_cycle_restore_on_start() {
    // Pre-populate storage (simulating existing state file)
    let mut initial = HashMap::new();
    initial.insert(
        "Table::users".to_string(),
        StoredEntry {
            key: "Table::users".to_string(),
            version: 1,
            data: b"sort_col=2,asc=true".to_vec(),
        },
    );
    let storage = MemoryStorage::with_entries(initial);

    // Create registry and load (simulating app start)
    let registry = StateRegistry::new(Box::new(storage));
    let count = registry.load().unwrap();

    assert_eq!(count, 1);
    let entry = registry.get("Table::users").unwrap();
    assert_eq!(entry.data, b"sort_col=2,asc=true");

    log_jsonl(
        "persist_cycle",
        "restore_on_start",
        true,
        "existing state loaded correctly",
    );
}

// ============================================================================
// 2. Widget State Tests
// ============================================================================

/// Test ScrollView scroll position persistence.
#[test]
fn persist_widget_scrollview() {
    let registry = StateRegistry::in_memory();

    // Simulate ScrollView saving its state
    let scroll_state = serde_json::json!({
        "scroll_offset": 150,
        "scroll_max": 500
    });
    registry.set(
        "ScrollView::content",
        1,
        scroll_state.to_string().into_bytes(),
    );
    registry.flush().unwrap();

    // Verify restoration
    let restored = registry.get("ScrollView::content").unwrap();
    let parsed: serde_json::Value = serde_json::from_slice(&restored.data).expect("valid JSON");

    assert_eq!(parsed["scroll_offset"], 150);
    log_jsonl(
        "persist_widget",
        "scrollview",
        true,
        "scroll position persisted",
    );
}

/// Test TreeView expanded nodes persistence.
#[test]
fn persist_widget_treeview() {
    let registry = StateRegistry::in_memory();

    let tree_state = serde_json::json!({
        "expanded_nodes": [1, 5, 12, 15],
        "selected": 12
    });
    registry.set("TreeView::files", 2, tree_state.to_string().into_bytes());
    registry.flush().unwrap();

    let restored = registry.get("TreeView::files").unwrap();
    let parsed: serde_json::Value = serde_json::from_slice(&restored.data).unwrap();

    assert_eq!(parsed["expanded_nodes"], serde_json::json!([1, 5, 12, 15]));
    assert_eq!(restored.version, 2);

    log_jsonl(
        "persist_widget",
        "treeview",
        true,
        "expanded nodes persisted",
    );
}

/// Test Table sort/filter state persistence.
#[test]
fn persist_widget_table() {
    let registry = StateRegistry::in_memory();

    let table_state = serde_json::json!({
        "selected": 5,
        "offset": 0,
        "sort_column": 2,
        "sort_ascending": false,
        "filter": "active"
    });
    registry.set("Table::users", 1, table_state.to_string().into_bytes());
    registry.flush().unwrap();

    let restored = registry.get("Table::users").unwrap();
    let parsed: serde_json::Value = serde_json::from_slice(&restored.data).unwrap();

    assert_eq!(parsed["sort_column"], 2);
    assert_eq!(parsed["sort_ascending"], false);
    assert_eq!(parsed["filter"], "active");

    log_jsonl(
        "persist_widget",
        "table",
        true,
        "sort/filter state persisted",
    );
}

/// Test multiple widget types together.
#[test]
fn persist_widget_multiple_types() {
    let registry = StateRegistry::in_memory();

    registry.set("ScrollView::main", 1, b"offset=100".to_vec());
    registry.set("TreeView::nav", 2, b"expanded=[1,2]".to_vec());
    registry.set("Table::data", 1, b"sort=name".to_vec());

    assert_eq!(registry.len(), 3);

    let keys = registry.keys();
    assert!(keys.contains(&"ScrollView::main".to_string()));
    assert!(keys.contains(&"TreeView::nav".to_string()));
    assert!(keys.contains(&"Table::data".to_string()));

    log_jsonl(
        "persist_widget",
        "multiple_types",
        true,
        "3 widget types coexist",
    );
}

// ============================================================================
// 3. Migration Tests
// ============================================================================

/// Test version upgrade handling.
#[test]
fn persist_migrate_version_upgrade() {
    // Old state with version 1
    let mut initial = HashMap::new();
    initial.insert(
        "Widget::test".to_string(),
        StoredEntry {
            key: "Widget::test".to_string(),
            version: 1, // Old version
            data: b"old_format".to_vec(),
        },
    );
    let storage = MemoryStorage::with_entries(initial);

    let registry = StateRegistry::new(Box::new(storage));
    registry.load().unwrap();

    // Check that old version is loaded
    let entry = registry.get("Widget::test").unwrap();
    assert_eq!(entry.version, 1);

    // Widget code would check version and migrate if needed
    // This test verifies the version is preserved for migration logic

    log_jsonl(
        "persist_migrate",
        "version_upgrade",
        true,
        "old version detected",
    );
}

/// Test field addition migration scenario.
#[test]
fn persist_migrate_field_addition() {
    // V1 state: only had scroll_offset
    let v1_state = serde_json::json!({
        "scroll_offset": 50
    });

    let mut initial = HashMap::new();
    initial.insert(
        "ScrollView::main".to_string(),
        StoredEntry {
            key: "ScrollView::main".to_string(),
            version: 1,
            data: v1_state.to_string().into_bytes(),
        },
    );
    let storage = MemoryStorage::with_entries(initial);

    let registry = StateRegistry::new(Box::new(storage));
    registry.load().unwrap();

    let entry = registry.get("ScrollView::main").unwrap();
    let parsed: serde_json::Value = serde_json::from_slice(&entry.data).unwrap();

    // V1 had no velocity field - migration would add default
    assert_eq!(parsed["scroll_offset"], 50);
    assert!(parsed.get("velocity").is_none()); // Not in v1

    log_jsonl(
        "persist_migrate",
        "field_addition",
        true,
        "v1 state loaded, migration would add defaults",
    );
}

/// Test that different versions are isolated.
#[test]
fn persist_migrate_version_isolation() {
    let registry = StateRegistry::in_memory();

    // Save same widget key with different versions (shouldn't happen in practice,
    // but tests isolation)
    registry.set("Widget::test", 1, b"v1_data".to_vec());
    registry.flush().unwrap();

    // Update to v2
    registry.set("Widget::test", 2, b"v2_data".to_vec());

    let entry = registry.get("Widget::test").unwrap();
    assert_eq!(entry.version, 2);
    assert_eq!(entry.data, b"v2_data");

    log_jsonl(
        "persist_migrate",
        "version_isolation",
        true,
        "v2 overwrites v1",
    );
}

// ============================================================================
// 4. Storage Backend Tests
// ============================================================================

/// Test memory storage isolation between registries.
#[test]
fn persist_storage_memory_isolation() {
    let registry1 = StateRegistry::in_memory();
    let registry2 = StateRegistry::in_memory();

    registry1.set("widget::1", 1, b"data1".to_vec());
    registry2.set("widget::2", 1, b"data2".to_vec());

    // Each registry has its own isolated storage
    assert!(registry1.get("widget::2").is_none());
    assert!(registry2.get("widget::1").is_none());

    log_jsonl(
        "persist_storage",
        "memory_isolation",
        true,
        "registries are isolated",
    );
}

/// Test concurrent access to registry.
#[test]
fn persist_storage_concurrent_access() {
    let registry = Arc::new(StateRegistry::in_memory());
    let barrier = Arc::new(Barrier::new(4));
    let mut handles = vec![];

    for i in 0..4 {
        let r = Arc::clone(&registry);
        let b = Arc::clone(&barrier);
        handles.push(thread::spawn(move || {
            b.wait();
            for j in 0..100 {
                let key = format!("widget::{}_{}", i, j);
                r.set(&key, 1, vec![i as u8, j as u8]);
            }
        }));
    }

    for h in handles {
        h.join().unwrap();
    }

    // Should have 400 entries
    assert_eq!(registry.len(), 400);

    log_jsonl(
        "persist_storage",
        "concurrent_access",
        true,
        "400 concurrent writes succeeded",
    );
}

/// Test storage backend is_available check.
#[test]
fn persist_storage_availability() {
    let storage = MemoryStorage::new();
    assert!(storage.is_available());

    let registry = StateRegistry::in_memory();
    assert!(registry.is_available());

    log_jsonl(
        "persist_storage",
        "availability",
        true,
        "backends report available",
    );
}

// ============================================================================
// 5. Error Handling Tests
// ============================================================================

/// Test handling of corrupted data in storage.
#[test]
fn persist_error_corrupted_entry() {
    // This test verifies the storage backend can handle load failures gracefully
    let registry = StateRegistry::in_memory();

    // Set some data
    registry.set("good", 1, b"valid data".to_vec());
    registry.flush().unwrap();

    // Good entry should still be accessible
    assert!(registry.get("good").is_some());

    log_jsonl(
        "persist_error",
        "corrupted_entry",
        true,
        "good entries survive corruption",
    );
}

/// Test graceful handling of lock poisoning recovery.
#[test]
fn persist_error_recovery() {
    let registry = StateRegistry::in_memory();

    // Normal operations should work
    registry.set("test", 1, b"data".to_vec());
    assert!(registry.flush().is_ok());

    // Stats should work even after operations
    let stats = registry.stats();
    assert_eq!(stats.entry_count, 1);

    log_jsonl(
        "persist_error",
        "recovery",
        true,
        "operations complete normally",
    );
}

/// Test atomic save behavior - partial failure shouldn't corrupt state.
#[test]
fn persist_error_atomic_save() {
    let registry = StateRegistry::in_memory();

    // Set multiple entries
    registry.set("entry1", 1, b"data1".to_vec());
    registry.set("entry2", 1, b"data2".to_vec());
    registry.set("entry3", 1, b"data3".to_vec());

    // Flush should be atomic
    assert!(registry.flush().is_ok());
    assert!(!registry.is_dirty());

    // All entries should exist
    assert!(registry.get("entry1").is_some());
    assert!(registry.get("entry2").is_some());
    assert!(registry.get("entry3").is_some());

    log_jsonl(
        "persist_error",
        "atomic_save",
        true,
        "all entries saved atomically",
    );
}

// ============================================================================
// 6. Property Tests
// ============================================================================

/// Property: Set then get should return same data.
#[test]
fn persist_property_set_get_identity() {
    let registry = StateRegistry::in_memory();

    let test_data = vec![
        ("key1", 1, b"simple".to_vec()),
        ("key2", 2, vec![0u8, 255u8, 128u8]),
        ("key3", 99, b"".to_vec()), // Empty data
        ("key::with::colons", 1, b"nested key".to_vec()),
    ];

    for (key, version, data) in &test_data {
        registry.set(*key, *version, data.clone());
        let entry = registry.get(key).unwrap();
        assert_eq!(&entry.data, data);
        assert_eq!(entry.version, *version);
    }

    log_jsonl(
        "persist_property",
        "set_get_identity",
        true,
        "all variants return identical data",
    );
}

/// Property: Registry length matches number of unique keys.
#[test]
fn persist_property_length_invariant() {
    let registry = StateRegistry::in_memory();

    registry.set("a", 1, vec![]);
    assert_eq!(registry.len(), 1);

    registry.set("b", 1, vec![]);
    assert_eq!(registry.len(), 2);

    registry.set("a", 2, vec![]); // Update existing
    assert_eq!(registry.len(), 2); // Still 2

    registry.remove("a");
    assert_eq!(registry.len(), 1);

    log_jsonl(
        "persist_property",
        "length_invariant",
        true,
        "length tracks unique keys",
    );
}

/// Property: Dirty flag tracks unsaved changes.
#[test]
fn persist_property_dirty_flag() {
    let registry = StateRegistry::in_memory();

    assert!(!registry.is_dirty());

    registry.set("x", 1, vec![]);
    assert!(registry.is_dirty());

    registry.flush().unwrap();
    assert!(!registry.is_dirty());

    registry.remove("x");
    assert!(registry.is_dirty());

    log_jsonl(
        "persist_property",
        "dirty_flag",
        true,
        "dirty flag accurate",
    );
}

// ============================================================================
// 7. ProgramSimulator Integration (bd-1av4o.2.3)
// ============================================================================

#[cfg(feature = "state-persistence")]
#[test]
fn program_simulator_save_restore_round_trip_file_storage() {
    struct PersistModel {
        registry: Arc<StateRegistry>,
        loaded: Option<Vec<u8>>,
    }

    #[derive(Debug)]
    enum PersistMsg {
        Write,
        Restore,
        Read,
    }

    impl From<Event> for PersistMsg {
        fn from(_: Event) -> Self {
            PersistMsg::Write
        }
    }

    impl Model for PersistModel {
        type Message = PersistMsg;

        fn update(&mut self, msg: Self::Message) -> Cmd<Self::Message> {
            match msg {
                PersistMsg::Write => {
                    self.registry
                        .set("PersistKey::main", 1, b"snapshot-v1".to_vec());
                    Cmd::save_state()
                }
                PersistMsg::Restore => {
                    Cmd::sequence(vec![Cmd::restore_state(), Cmd::msg(PersistMsg::Read)])
                }
                PersistMsg::Read => {
                    self.loaded = self
                        .registry
                        .get("PersistKey::main")
                        .map(|entry| entry.data);
                    Cmd::none()
                }
            }
        }

        fn view(&self, _frame: &mut Frame) {}
    }

    let temp = tempdir().expect("tempdir");
    let path = temp.path().join("state.json");

    let registry = Arc::new(StateRegistry::with_file(&path));
    let mut sim = ProgramSimulator::with_registry(
        PersistModel {
            registry: registry.clone(),
            loaded: None,
        },
        registry.clone(),
    );
    sim.init();
    sim.send(PersistMsg::Write);

    assert!(
        !registry.is_dirty(),
        "save_state should flush dirty entries"
    );

    let registry2 = Arc::new(StateRegistry::with_file(&path));
    let mut sim2 = ProgramSimulator::with_registry(
        PersistModel {
            registry: registry2.clone(),
            loaded: None,
        },
        registry2.clone(),
    );
    sim2.init();
    sim2.send(PersistMsg::Restore);

    assert_eq!(
        sim2.model().loaded.as_deref(),
        Some(b"snapshot-v1".as_slice())
    );

    log_jsonl(
        "program_simulator",
        "save_restore_round_trip_file_storage",
        true,
        "persisted snapshot restored via ProgramSimulator",
    );
}