charmed-bubbletea 0.2.0

A powerful TUI framework based on The Elm Architecture
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
//! End-to-end tests for async Program lifecycle.
//!
//! These tests verify the complete async program lifecycle including:
//! - Async command execution within model context
//! - Graceful shutdown coordination
//! - Concurrent command handling
//! - Message ordering guarantees

#![cfg(feature = "async")]
// Test simulator doesn't need Send futures - it's single-threaded test infrastructure
#![allow(clippy::future_not_send)]
// Test helper methods don't need const
#![allow(clippy::missing_const_for_fn)]

use bubbletea::{AsyncCmd, Cmd, Message, Model, quit};
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::time::Duration;
use tokio::sync::mpsc;
use tokio::time::sleep;

// =============================================================================
// Test Models
// =============================================================================

/// A simple counter model that tracks async operations.
struct AsyncCounter {
    count: i32,
    async_ops_started: Arc<AtomicUsize>,
    async_ops_completed: Arc<AtomicUsize>,
}

impl AsyncCounter {
    fn new() -> Self {
        Self {
            count: 0,
            async_ops_started: Arc::new(AtomicUsize::new(0)),
            async_ops_completed: Arc::new(AtomicUsize::new(0)),
        }
    }
}

#[derive(Clone, Debug)]
enum CounterMsg {
    Increment,
    Decrement,
    AsyncIncrement,
    AsyncDone(i32),
    Quit,
}

impl Model for AsyncCounter {
    fn init(&self) -> Option<Cmd> {
        None
    }

    fn update(&mut self, msg: Message) -> Option<Cmd> {
        if let Some(counter_msg) = msg.downcast_ref::<CounterMsg>() {
            match counter_msg {
                CounterMsg::Increment => {
                    self.count += 1;
                    None
                }
                CounterMsg::Decrement => {
                    self.count -= 1;
                    None
                }
                CounterMsg::AsyncIncrement => {
                    self.async_ops_started.fetch_add(1, Ordering::SeqCst);
                    let completed = self.async_ops_completed.clone();
                    Some(Cmd::new(move || {
                        completed.fetch_add(1, Ordering::SeqCst);
                        Message::new(CounterMsg::AsyncDone(1))
                    }))
                }
                CounterMsg::AsyncDone(delta) => {
                    self.count += delta;
                    None
                }
                CounterMsg::Quit => Some(quit()),
            }
        } else {
            None
        }
    }

    fn view(&self) -> String {
        format!("Count: {}", self.count)
    }
}

/// Model that tracks message ordering.
struct OrderedMessageModel {
    received_order: Vec<usize>,
}

#[derive(Clone, Debug)]
struct OrderedMsg(usize);

impl Model for OrderedMessageModel {
    fn init(&self) -> Option<Cmd> {
        None
    }

    fn update(&mut self, msg: Message) -> Option<Cmd> {
        if let Some(ordered) = msg.downcast_ref::<OrderedMsg>() {
            self.received_order.push(ordered.0);
        }
        None
    }

    fn view(&self) -> String {
        format!("Received: {:?}", self.received_order)
    }
}

/// Model for testing graceful shutdown.
struct ShutdownModel {
    shutdown_started: Arc<AtomicBool>,
    cleanup_completed: Arc<AtomicBool>,
}

#[derive(Clone, Debug)]
#[allow(dead_code)] // Realistic enum - not all variants used in tests
enum ShutdownMsg {
    StartShutdown,
    CleanupDone,
}

impl Model for ShutdownModel {
    fn init(&self) -> Option<Cmd> {
        None
    }

    fn update(&mut self, msg: Message) -> Option<Cmd> {
        if let Some(shutdown_msg) = msg.downcast_ref::<ShutdownMsg>() {
            match shutdown_msg {
                ShutdownMsg::StartShutdown => {
                    self.shutdown_started.store(true, Ordering::SeqCst);
                    Some(quit())
                }
                ShutdownMsg::CleanupDone => {
                    self.cleanup_completed.store(true, Ordering::SeqCst);
                    None
                }
            }
        } else {
            None
        }
    }

    fn view(&self) -> String {
        "Shutdown Model".to_string()
    }
}

// =============================================================================
// Async Simulator for E2E Testing
// =============================================================================

/// An async program simulator for testing lifecycle without a terminal.
struct AsyncProgramSimulator<M: Model> {
    model: M,
    tx: mpsc::Sender<Message>,
    rx: mpsc::Receiver<Message>,
    initialized: bool,
    quit_requested: bool,
}

impl<M: Model> AsyncProgramSimulator<M> {
    fn new(model: M) -> Self {
        let (tx, rx) = mpsc::channel(256);
        Self {
            model,
            tx,
            rx,
            initialized: false,
            quit_requested: false,
        }
    }

    /// Initialize the model.
    async fn init(&mut self) {
        if self.initialized {
            return;
        }
        self.initialized = true;

        if let Some(cmd) = self.model.init() {
            self.execute_command(cmd).await;
        }
    }

    /// Send a message to be processed.
    async fn send(&self, msg: Message) {
        let _ = self.tx.send(msg).await;
    }

    /// Process one pending message.
    async fn step(&mut self) -> bool {
        if !self.initialized {
            self.init().await;
        }

        if let Ok(msg) = self.rx.try_recv() {
            if msg.is::<bubbletea::QuitMsg>() {
                self.quit_requested = true;
                return false;
            }

            if let Some(cmd) = self.model.update(msg) {
                self.execute_command(cmd).await;
            }
            true
        } else {
            false
        }
    }

    /// Process all pending messages.
    async fn run_until_empty(&mut self) {
        if !self.initialized {
            self.init().await;
        }

        while !self.quit_requested {
            if !self.step().await {
                // No message processed and not quit - try to receive
                tokio::select! {
                    msg = self.rx.recv() => {
                        if let Some(msg) = msg {
                            if msg.is::<bubbletea::QuitMsg>() {
                                self.quit_requested = true;
                                break;
                            }
                            if let Some(cmd) = self.model.update(msg) {
                                self.execute_command(cmd).await;
                            }
                        } else {
                            break;
                        }
                    }
                    () = tokio::time::sleep(Duration::from_millis(10)) => {
                        break;
                    }
                }
            }
        }
    }

    /// Execute a command and queue resulting message.
    #[allow(clippy::unused_async)] // async kept for API consistency
    async fn execute_command(&self, cmd: Cmd) {
        let tx = self.tx.clone();
        tokio::spawn(async move {
            if let Some(msg) = cmd.execute() {
                let _ = tx.send(msg).await;
            }
        });
    }

    fn model(&self) -> &M {
        &self.model
    }

    fn is_quit(&self) -> bool {
        self.quit_requested
    }
}

// =============================================================================
// Lifecycle Tests
// =============================================================================

mod lifecycle_tests {
    use super::*;

    #[tokio::test]
    async fn test_program_initializes_correctly() {
        let model = AsyncCounter::new();
        let mut sim = AsyncProgramSimulator::new(model);

        assert!(!sim.initialized);
        sim.init().await;
        assert!(sim.initialized);
        assert_eq!(sim.model().count, 0);
    }

    #[tokio::test]
    async fn test_messages_processed_correctly() {
        let model = AsyncCounter::new();
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;
        sim.send(Message::new(CounterMsg::Increment)).await;
        sim.send(Message::new(CounterMsg::Increment)).await;
        sim.send(Message::new(CounterMsg::Decrement)).await;

        sim.run_until_empty().await;

        assert_eq!(sim.model().count, 1); // 0 + 1 + 1 - 1 = 1
    }

    #[tokio::test]
    async fn test_quit_triggers_shutdown() {
        let model = AsyncCounter::new();
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;
        sim.send(Message::new(CounterMsg::Increment)).await;
        sim.send(Message::new(CounterMsg::Quit)).await;

        sim.run_until_empty().await;

        assert!(sim.is_quit());
        // Increment processed before quit
        assert_eq!(sim.model().count, 1);
    }

    #[tokio::test]
    async fn test_view_renders_correctly() {
        let model = AsyncCounter::new();
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;
        assert_eq!(sim.model().view(), "Count: 0");

        sim.send(Message::new(CounterMsg::Increment)).await;
        sim.run_until_empty().await;
        assert_eq!(sim.model().view(), "Count: 1");
    }
}

// =============================================================================
// Async Command Integration Tests
// =============================================================================

mod async_integration_tests {
    use super::*;

    #[tokio::test]
    async fn test_async_command_executes() {
        let model = AsyncCounter::new();
        let ops_started = model.async_ops_started.clone();
        let ops_completed = model.async_ops_completed.clone();

        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;
        sim.send(Message::new(CounterMsg::AsyncIncrement)).await;

        // Process the message that triggers async command
        sim.step().await;

        // Wait for async command to complete
        sleep(Duration::from_millis(50)).await;

        // Process the AsyncDone message
        sim.run_until_empty().await;

        assert_eq!(ops_started.load(Ordering::SeqCst), 1);
        assert_eq!(ops_completed.load(Ordering::SeqCst), 1);
        assert_eq!(sim.model().count, 1);
    }

    #[tokio::test]
    async fn test_multiple_async_commands() {
        let model = AsyncCounter::new();
        let ops_started = model.async_ops_started.clone();
        let ops_completed = model.async_ops_completed.clone();

        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;

        // Send multiple async increment commands
        for _ in 0..5 {
            sim.send(Message::new(CounterMsg::AsyncIncrement)).await;
        }

        // Process all messages
        for _ in 0..5 {
            sim.step().await;
        }

        // Wait for all async commands to complete
        sleep(Duration::from_millis(100)).await;

        // Process all AsyncDone messages
        sim.run_until_empty().await;

        assert_eq!(ops_started.load(Ordering::SeqCst), 5);
        assert_eq!(ops_completed.load(Ordering::SeqCst), 5);
        assert_eq!(sim.model().count, 5);
    }

    #[tokio::test]
    async fn test_mixed_sync_async_commands() {
        let model = AsyncCounter::new();
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;

        // Mix sync and async
        sim.send(Message::new(CounterMsg::Increment)).await;
        sim.send(Message::new(CounterMsg::AsyncIncrement)).await;
        sim.send(Message::new(CounterMsg::Increment)).await;

        // Process all
        for _ in 0..3 {
            sim.step().await;
        }

        // Wait for async
        sleep(Duration::from_millis(50)).await;

        sim.run_until_empty().await;

        // 2 sync + 1 async = 3
        assert_eq!(sim.model().count, 3);
    }
}

// =============================================================================
// Message Ordering Tests
// =============================================================================

mod ordering_tests {
    use super::*;

    #[tokio::test]
    async fn test_messages_maintain_order() {
        let model = OrderedMessageModel {
            received_order: vec![],
        };
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;

        // Send messages in order
        for i in 1..=5 {
            sim.send(Message::new(OrderedMsg(i))).await;
        }

        sim.run_until_empty().await;

        // Verify order preserved
        assert_eq!(sim.model().received_order, vec![1, 2, 3, 4, 5]);
    }

    #[tokio::test]
    async fn test_many_messages_maintain_order() {
        let model = OrderedMessageModel {
            received_order: vec![],
        };
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;

        // Send many messages
        for i in 1..=100 {
            sim.send(Message::new(OrderedMsg(i))).await;
        }

        sim.run_until_empty().await;

        // Verify all received in order
        let expected: Vec<usize> = (1..=100).collect();
        assert_eq!(sim.model().received_order, expected);
    }
}

// =============================================================================
// Shutdown Tests
// =============================================================================

mod shutdown_tests {
    use super::*;

    #[tokio::test]
    async fn test_clean_shutdown() {
        let shutdown_started = Arc::new(AtomicBool::new(false));
        let cleanup_completed = Arc::new(AtomicBool::new(false));

        let model = ShutdownModel {
            shutdown_started: shutdown_started.clone(),
            cleanup_completed: cleanup_completed.clone(),
        };
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;
        sim.send(Message::new(ShutdownMsg::StartShutdown)).await;

        sim.run_until_empty().await;

        assert!(shutdown_started.load(Ordering::SeqCst));
        assert!(sim.is_quit());
    }

    #[tokio::test]
    async fn test_shutdown_with_pending_messages() {
        let model = AsyncCounter::new();
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;

        // Process some messages first
        for _ in 0..5 {
            sim.send(Message::new(CounterMsg::Increment)).await;
        }
        sim.run_until_empty().await;
        assert_eq!(sim.model().count, 5);

        // Now send quit - verify it triggers shutdown
        sim.send(Message::new(CounterMsg::Quit)).await;
        sim.run_until_empty().await;

        assert!(sim.is_quit());
        // Count should still be 5 (quit processed, no more increments)
        assert_eq!(sim.model().count, 5);
    }
}

// =============================================================================
// Concurrent Command Tests
// =============================================================================

mod concurrent_tests {
    use super::*;

    #[tokio::test]
    async fn test_concurrent_async_commands_complete() {
        struct ConcurrentModel {
            completed: Arc<AtomicUsize>,
        }

        #[derive(Clone)]
        struct StartAsync;
        #[derive(Clone)]
        struct AsyncCompleted;

        impl Model for ConcurrentModel {
            fn init(&self) -> Option<Cmd> {
                None
            }

            fn update(&mut self, msg: Message) -> Option<Cmd> {
                if msg.is::<StartAsync>() {
                    let completed = self.completed.clone();
                    Some(Cmd::new(move || {
                        std::thread::sleep(Duration::from_millis(10));
                        completed.fetch_add(1, Ordering::SeqCst);
                        Message::new(AsyncCompleted)
                    }))
                } else {
                    None
                }
            }

            fn view(&self) -> String {
                String::new()
            }
        }

        let completed = Arc::new(AtomicUsize::new(0));
        let model = ConcurrentModel {
            completed: completed.clone(),
        };
        let mut sim = AsyncProgramSimulator::new(model);

        sim.init().await;

        // Start multiple concurrent operations
        for _ in 0..5 {
            sim.send(Message::new(StartAsync)).await;
        }

        // Process the StartAsync messages
        for _ in 0..5 {
            sim.step().await;
        }

        // Wait for all concurrent operations
        sleep(Duration::from_millis(100)).await;

        // All should complete
        assert_eq!(completed.load(Ordering::SeqCst), 5);
    }
}

// =============================================================================
// AsyncCmd Specific Tests
// =============================================================================

#[cfg(feature = "async")]
mod async_cmd_tests {
    use super::*;

    #[tokio::test]
    async fn test_async_cmd_executes() {
        struct Result(i32);

        let cmd = AsyncCmd::new(|| async { Message::new(Result(42)) });
        let msg = cmd.execute().await.unwrap();
        let result = msg.downcast::<Result>().unwrap();
        assert_eq!(result.0, 42);
    }

    #[tokio::test]
    async fn test_async_cmd_with_delay() {
        struct DelayedResult;

        let start = std::time::Instant::now();
        let cmd = AsyncCmd::new(|| async {
            sleep(Duration::from_millis(50)).await;
            Message::new(DelayedResult)
        });

        let msg = cmd.execute().await.unwrap();
        let elapsed = start.elapsed();

        assert!(msg.is::<DelayedResult>());
        assert!(elapsed >= Duration::from_millis(50));
    }

    #[tokio::test]
    async fn test_multiple_async_cmds_run_concurrently() {
        #[allow(dead_code)] // Used as message marker
        struct TaskResult(usize);

        let counter = Arc::new(AtomicUsize::new(0));
        let mut handles = vec![];

        // Spawn 5 concurrent async commands
        for i in 0..5 {
            let counter = counter.clone();
            let cmd = AsyncCmd::new(move || {
                let counter = counter.clone();
                async move {
                    sleep(Duration::from_millis(10)).await;
                    counter.fetch_add(1, Ordering::SeqCst);
                    Message::new(TaskResult(i))
                }
            });
            handles.push(tokio::spawn(async move { cmd.execute().await }));
        }

        // Wait for all
        for handle in handles {
            let _ = handle.await;
        }

        // All should have completed
        assert_eq!(counter.load(Ordering::SeqCst), 5);
    }
}