mockforge-tui 0.3.187

Terminal UI dashboard for MockForge
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
//! App state machine and main event loop.

use std::time::Duration;

use anyhow::Result;
use crossterm::event::{KeyCode, KeyModifiers};
use ratatui::{
    layout::{Alignment, Constraint, Layout, Rect},
    style::Style,
    text::{Line, Span},
    widgets::Paragraph,
    Frame,
};

use crate::api::client::MockForgeClient;
use crate::config::TuiConfig;
use crate::event::{Event, EventHandler};
use crate::keybindings::{self, Action};
use crate::screens::{self, Screen, ScreenId};
use crate::theme::Theme;
use crate::tui;
use crate::widgets::command_palette::{CommandPalette, PaletteAction};
use crate::widgets::{help, status_bar};

/// Top-level application state.
pub struct App {
    config: TuiConfig,
    /// Round 37 — list of admin URLs the user can rotate through with
    /// `Ctrl-]` / `Ctrl-[`. Always has at least one entry; `admin_url`
    /// is its 0th element. When a user only passes one server (the
    /// default), `servers.len() == 1` and the rotation key is a no-op
    /// so the surface stays unchanged.
    servers: Vec<String>,
    /// Index into `servers` of the currently-active admin URL. The
    /// header tab bar renders an indicator (`[2/3]`) when
    /// `servers.len() > 1`; on a single server the indicator is hidden.
    active_server: usize,
    /// The active server's admin URL (mirrors `servers[active_server]`
    /// to keep existing render code untouched).
    admin_url: String,
    client: MockForgeClient,
    /// Optional auth token, threaded into each per-server client.
    /// `MockForgeClient::new` panics on a malformed base URL, but our
    /// inputs come from clap (already validated as `String`) so this is
    /// safe in practice. Stored so a server swap rebuilds the client
    /// with the same token.
    token: Option<String>,
    screens: Vec<Box<dyn Screen>>,
    active_tab: usize,
    show_help: bool,
    command_palette: CommandPalette,
    connected: bool,
    error_count: usize,
    should_quit: bool,
    /// Y-offset of the tab bar for mouse click detection.
    tab_bar_y: u16,
    /// Last time we checked connectivity.
    last_health_check: std::time::Instant,
}

impl App {
    /// Create the app from a config and optional auth token.
    pub fn new(config: TuiConfig, token: Option<String>) -> Self {
        Theme::init(config.is_light_theme());

        // Round 37 — resolve the server rotation list from config.
        // `all_admin_urls()` always returns at least one URL (the
        // primary `admin_url`), so subsequent indexing is safe.
        let servers = config.all_admin_urls();
        let active_server = 0;
        let admin_url = servers[active_server].clone();

        let client =
            MockForgeClient::new(admin_url.clone(), token.clone()).expect("failed to build client");

        let initial_tab = config.last_tab.unwrap_or(0);

        let screens: Vec<Box<dyn Screen>> = vec![
            Box::new(screens::dashboard::DashboardScreen::new()),
            Box::new(screens::logs::LogsScreen::new()),
            Box::new(screens::routes::RoutesScreen::new()),
            Box::new(screens::metrics::MetricsScreen::new()),
            Box::new(screens::config::ConfigScreen::new()),
            Box::new(screens::chaos::ChaosScreen::new()),
            Box::new(screens::workspaces::WorkspacesScreen::new()),
            Box::new(screens::plugins::PluginsScreen::new()),
            Box::new(screens::fixtures::FixturesScreen::new()),
            Box::new(screens::health::HealthScreen::new()),
            Box::new(screens::smoke_tests::SmokeTestsScreen::new()),
            Box::new(screens::time_travel::TimeTravelScreen::new()),
            Box::new(screens::chains::ChainsScreen::new()),
            // Conformance is intentionally placed before Verification —
            // Verification's `Tab` is consumed to cycle internal fields,
            // so plain Tab nav gets stuck on it. Order must match
            // `ScreenId::ALL`; the `app_screens_match_screen_id_all`
            // test asserts the lengths align.
            Box::new(screens::conformance::ConformanceScreen::new()),
            Box::new(screens::verification::VerificationScreen::new()),
            Box::new(screens::analytics::AnalyticsScreen::new()),
            Box::new(screens::recorder::RecorderScreen::new()),
            Box::new(screens::import::ImportScreen::new()),
            Box::new(screens::audit::AuditScreen::new()),
            Box::new(screens::world_state::WorldStateScreen::new()),
            Box::new(screens::contract_diff::ContractDiffScreen::new()),
            Box::new(screens::federation::FederationScreen::new()),
            Box::new(screens::behavioral_cloning::BehavioralCloningScreen::new()),
        ];

        // Invariant: every entry in `ScreenId::ALL` must have a matching
        // boxed Screen at the same index. The header renders tabs from
        // `self.screens` and routing looks up `self.screens[i]` keyed off
        // `ScreenId::ALL[i]` — if these go out of sync, a tab silently
        // disappears (regression first hit in v0.3.145: Conformance was
        // added to `ScreenId::ALL` but the Box was missed here).
        debug_assert_eq!(
            screens.len(),
            ScreenId::ALL.len(),
            "screens vec must match ScreenId::ALL length"
        );

        let active_tab = if initial_tab < screens.len() {
            initial_tab
        } else {
            0
        };

        Self {
            config,
            servers,
            active_server,
            admin_url,
            client,
            token,
            screens,
            active_tab,
            show_help: false,
            command_palette: CommandPalette::new(),
            connected: false,
            error_count: 0,
            should_quit: false,
            tab_bar_y: 1,
            last_health_check: std::time::Instant::now(),
        }
    }

    /// Round 37 — cycle to the next configured admin server. No-op
    /// when only one server is in the rotation. The screens are NOT
    /// reset on switch: each screen's next `tick()` will re-fetch
    /// from the new admin URL, so the user sees the prior server's
    /// cached data for up to one refresh-interval, then fresh data.
    /// `step` is `+1` for next, `-1` for previous; any non-zero step
    /// works (rotation is modular).
    fn rotate_server(&mut self, step: isize) {
        let n = self.servers.len();
        if n <= 1 {
            return;
        }
        let next = (self.active_server as isize + step).rem_euclid(n as isize) as usize;
        self.active_server = next;
        self.admin_url = self.servers[next].clone();
        // Rebuild the client; MockForgeClient is cheap to construct
        // (just stores the URL + token + reqwest::Client) and we want
        // the rest of the app to keep treating `self.client` as the
        // single active client without holding a Vec.
        if let Ok(new_client) = MockForgeClient::new(self.admin_url.clone(), self.token.clone()) {
            self.client = new_client;
        }
        // Force a re-ping on the new server so the header indicator
        // updates without waiting for the next health-check tick.
        self.connected = false;
        // Backdate the last health check so the next tick re-pings the
        // new server immediately instead of waiting for the next
        // scheduled interval.
        let one_hour = Duration::from_secs(3600);
        self.last_health_check = std::time::Instant::now()
            .checked_sub(one_hour)
            .unwrap_or_else(std::time::Instant::now);
    }
}

#[cfg(test)]
mod server_rotation_tests {
    use super::*;

    fn cfg_with(extras: &[&str]) -> TuiConfig {
        TuiConfig {
            admin_url: "http://primary:9080".into(),
            extra_servers: extras.iter().map(|s| s.to_string()).collect(),
            ..TuiConfig::default()
        }
    }

    #[test]
    fn all_admin_urls_keeps_primary_first_and_dedupes() {
        let cfg = cfg_with(&["http://b:9080", "http://primary:9080", "http://c:9080"]);
        let urls = cfg.all_admin_urls();
        assert_eq!(urls, vec!["http://primary:9080", "http://b:9080", "http://c:9080"]);
    }

    #[test]
    fn all_admin_urls_drops_empty_entries() {
        let cfg = cfg_with(&["", "http://b:9080", ""]);
        let urls = cfg.all_admin_urls();
        assert_eq!(urls, vec!["http://primary:9080", "http://b:9080"]);
    }

    #[test]
    fn rotate_server_cycles_in_both_directions() {
        let cfg = cfg_with(&["http://b:9080", "http://c:9080"]);
        let mut app = App::new(cfg, None);
        assert_eq!(app.active_server, 0);
        assert_eq!(app.admin_url, "http://primary:9080");

        app.rotate_server(1);
        assert_eq!(app.active_server, 1);
        assert_eq!(app.admin_url, "http://b:9080");

        app.rotate_server(1);
        assert_eq!(app.active_server, 2);
        assert_eq!(app.admin_url, "http://c:9080");

        // Wrap forward.
        app.rotate_server(1);
        assert_eq!(app.active_server, 0);

        // Wrap backward.
        app.rotate_server(-1);
        assert_eq!(app.active_server, 2);
        assert_eq!(app.admin_url, "http://c:9080");
    }

    #[test]
    fn rotate_server_is_noop_on_single_server() {
        let cfg = cfg_with(&[]);
        let mut app = App::new(cfg, None);
        let before = app.admin_url.clone();
        app.rotate_server(1);
        assert_eq!(app.admin_url, before);
        assert_eq!(app.active_server, 0);
    }
}

impl App {
    /// Run the terminal UI event loop.
    pub async fn run(mut self) -> Result<()> {
        let mut terminal = tui::init()?;
        let tick_rate = Duration::from_millis(250);
        let mut events = EventHandler::new(tick_rate);
        let tx = events.sender();

        // Initial connectivity check.
        self.connected = self.client.ping().await;

        loop {
            // Render.
            terminal.draw(|frame| self.render(frame))?;

            // Wait for next event.
            let event = events.next().await?;

            match event {
                Event::Key(key) => {
                    // Ctrl+C always quits.
                    if key.modifiers.contains(KeyModifiers::CONTROL)
                        && matches!(key.code, KeyCode::Char('c'))
                    {
                        self.should_quit = true;
                    } else if self.command_palette.visible {
                        if let Some(action) = self.command_palette.handle_key(key) {
                            self.execute_palette_action(action);
                        }
                    } else if self.show_help {
                        if matches!(key.code, KeyCode::Char('?') | KeyCode::Esc) {
                            self.show_help = false;
                        }
                    } else {
                        // Try screen-specific handling first.
                        let consumed = self.screens[self.active_tab].handle_key(key);
                        if !consumed {
                            self.handle_global_key(key);
                        }
                    }
                }
                Event::Tick => {
                    self.screens[self.active_tab].tick(&self.client, &tx);

                    // Periodic connectivity check every 10 seconds.
                    if self.last_health_check.elapsed() >= Duration::from_secs(10) {
                        self.last_health_check = std::time::Instant::now();
                        let client = self.client.clone();
                        let health_tx = tx.clone();
                        tokio::spawn(async move {
                            let ok = client.ping().await;
                            // Use a special screen key for health check routing.
                            if ok {
                                let _ = health_tx.send(Event::Data {
                                    screen: "_health_check",
                                    payload: String::new(),
                                });
                            } else {
                                let _ = health_tx.send(Event::ApiError {
                                    screen: "_health_check",
                                    message: "Server unreachable".into(),
                                });
                            }
                        });
                    }
                }
                Event::Data { screen, payload } => {
                    self.route_data(screen, &payload);
                }
                Event::ApiError { screen, message } => {
                    self.error_count = (self.error_count + 1).min(999);
                    self.route_error(screen, &message);
                }
                Event::LogLine(line) => {
                    self.connected = true;
                    if let Some(logs) = self.screens.get_mut(1) {
                        logs.push_log_line(line);
                    }
                }
                Event::Resize(_, _) => {}
                Event::Mouse(mouse) => {
                    self.handle_mouse(mouse);
                }
            }

            if self.should_quit {
                break;
            }
        }

        // Save last-used tab to config file (best-effort).
        self.config.last_tab = Some(self.active_tab);
        let _ = self.config.save();

        tui::restore()?;
        Ok(())
    }

    fn handle_global_key(&mut self, key: crossterm::event::KeyEvent) {
        // `:` opens the command palette (not in keybindings since it's a modal trigger).
        if matches!(key.code, KeyCode::Char(':')) {
            self.command_palette.open();
            return;
        }

        if let Some(action) = keybindings::resolve(key) {
            match action {
                Action::Quit => self.should_quit = true,
                Action::ToggleHelp => self.show_help = !self.show_help,
                Action::NextTab => {
                    self.active_tab = (self.active_tab + 1) % self.screens.len();
                }
                Action::PrevTab => {
                    self.active_tab = if self.active_tab == 0 {
                        self.screens.len() - 1
                    } else {
                        self.active_tab - 1
                    };
                }
                Action::JumpTab(idx) => {
                    if idx < self.screens.len() {
                        self.active_tab = idx;
                    }
                }
                Action::Refresh => {
                    self.screens[self.active_tab].force_refresh();
                }
                Action::NextServer => self.rotate_server(1),
                Action::PrevServer => self.rotate_server(-1),
                _ => {}
            }
        }
    }

    fn execute_palette_action(&mut self, action: PaletteAction) {
        match action {
            PaletteAction::GoToScreen(idx) => {
                if idx < self.screens.len() {
                    self.active_tab = idx;
                }
            }
            PaletteAction::Refresh => {
                self.screens[self.active_tab].force_refresh();
            }
            PaletteAction::ToggleHelp => {
                self.show_help = !self.show_help;
            }
            PaletteAction::Quit => {
                self.should_quit = true;
            }
        }
    }

    fn handle_mouse(&mut self, mouse: crossterm::event::MouseEvent) {
        use crossterm::event::{MouseButton, MouseEventKind};

        match mouse.kind {
            MouseEventKind::Down(MouseButton::Left) => {
                // Check if click is on the tab bar row.
                if mouse.row == self.tab_bar_y {
                    self.handle_tab_click(mouse.column);
                }
            }
            MouseEventKind::ScrollUp => {
                // Forward as Up key to the active screen.
                let key = crossterm::event::KeyEvent::new(KeyCode::Up, KeyModifiers::NONE);
                self.screens[self.active_tab].handle_key(key);
            }
            MouseEventKind::ScrollDown => {
                let key = crossterm::event::KeyEvent::new(KeyCode::Down, KeyModifiers::NONE);
                self.screens[self.active_tab].handle_key(key);
            }
            _ => {}
        }
    }

    fn handle_tab_click(&mut self, column: u16) {
        // Calculate tab boundaries based on rendered tab labels.
        let mut x: u16 = 0;
        for (i, screen) in self.screens.iter().enumerate() {
            let title_len = u16::try_from(screen.title().len()).unwrap_or(u16::MAX);
            let label_len: u16 = if i <= 9 {
                // " N:Title " + " " separator
                title_len.saturating_add(4)
            } else {
                // " Title " + " "
                title_len.saturating_add(3)
            };
            if column >= x && column < x.saturating_add(label_len) {
                self.active_tab = i;
                return;
            }
            x = x.saturating_add(label_len);
        }
    }

    fn route_data(&mut self, screen_key: &str, payload: &str) {
        self.connected = true;

        // Internal health check — not routed to any screen.
        if screen_key == "_health_check" {
            return;
        }

        for (i, sid) in ScreenId::ALL.iter().enumerate() {
            if sid.data_key() == screen_key {
                if let Some(screen) = self.screens.get_mut(i) {
                    screen.on_data(payload);
                }
                return;
            }
        }
    }

    fn route_error(&mut self, screen_key: &str, message: &str) {
        // Internal health check failure — mark disconnected but don't
        // propagate to any screen.
        if screen_key == "_health_check" {
            self.connected = false;
            return;
        }

        for (i, sid) in ScreenId::ALL.iter().enumerate() {
            if sid.data_key() == screen_key {
                if let Some(screen) = self.screens.get_mut(i) {
                    screen.on_error(message);
                }
                return;
            }
        }
    }

    fn render(&self, frame: &mut Frame) {
        let area = frame.area();

        // Minimum terminal size check (80x24).
        if area.width < 80 || area.height < 24 {
            let msg = Paragraph::new(format!(
                "Terminal too small ({}x{}). Minimum: 80x24. Please resize.",
                area.width, area.height
            ))
            .style(Style::default().fg(Theme::RED))
            .alignment(Alignment::Center);
            let centered = Rect {
                y: area.height / 2,
                height: 1,
                ..area
            };
            frame.render_widget(msg, centered);
            return;
        }

        let chunks = Layout::vertical([
            Constraint::Length(2), // title bar + tabs
            Constraint::Min(0),    // main content
            Constraint::Length(1), // status bar
        ])
        .split(area);

        self.render_header(frame, chunks[0]);

        // Error banner: show a persistent 1-line banner when the active screen
        // has an error, while still rendering data underneath.
        let content_area = if let Some(err) = self.screens[self.active_tab].error() {
            let parts =
                Layout::vertical([Constraint::Length(1), Constraint::Min(0)]).split(chunks[1]);
            let banner = Paragraph::new(format!(" Error: {err}"))
                .style(Style::default().fg(Theme::RED).bg(Theme::OVERLAY));
            frame.render_widget(banner, parts[0]);
            parts[1]
        } else {
            chunks[1]
        };

        self.screens[self.active_tab].render(frame, content_area);

        status_bar::render(
            frame,
            chunks[2],
            self.connected,
            self.screens[self.active_tab].status_hint(),
            self.error_count,
            &self.admin_url,
        );

        if self.show_help {
            help::render(frame);
        }

        if self.command_palette.visible {
            self.command_palette.render(frame);
        }
    }

    fn render_header(&self, frame: &mut Frame, area: Rect) {
        let chunks = Layout::vertical([Constraint::Length(1), Constraint::Length(1)]).split(area);

        // Title bar
        let conn_status = if self.connected {
            "Connected"
        } else {
            "Disconnected"
        };
        let conn_style = if self.connected {
            Theme::success()
        } else {
            Theme::error()
        };
        // Round 37 — when more than one server is in the rotation,
        // surface the active index (`[2/3]`) before the URL so the
        // user always sees which server's data they are looking at.
        // Single-server runs keep the original layout.
        let server_indicator = if self.servers.len() > 1 {
            format!("  [{}/{}] {}", self.active_server + 1, self.servers.len(), self.admin_url)
        } else {
            format!("  {}", self.admin_url)
        };
        let title = Line::from(vec![
            Span::styled(" MockForge TUI ", Theme::title()),
            Span::styled(format!("v{}", env!("CARGO_PKG_VERSION")), Theme::dim()),
            Span::raw("  "),
            Span::styled(conn_status, conn_style),
            Span::styled(server_indicator, Theme::dim()),
        ]);
        frame.render_widget(Paragraph::new(title).style(Theme::surface()), chunks[0]);

        // Tab bar
        let mut tab_spans = Vec::new();
        for (i, screen) in self.screens.iter().enumerate() {
            let style = if i == self.active_tab {
                Theme::tab_active()
            } else {
                Theme::tab_inactive()
            };
            let label = if i < 9 {
                format!(" {}:{} ", i + 1, screen.title())
            } else if i == 9 {
                format!(" 0:{} ", screen.title())
            } else {
                format!(" {} ", screen.title())
            };
            tab_spans.push(Span::styled(label, style));
            tab_spans.push(Span::raw(" "));
        }
        let tabs = Line::from(tab_spans);
        frame.render_widget(Paragraph::new(tabs).style(Theme::base()), chunks[1]);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::TuiConfig;

    /// Regression test for v0.3.145 → v0.3.146 hotfix: every entry in
    /// `ScreenId::ALL` must have a corresponding `Box<dyn Screen>` in
    /// `App::new`. When they go out of sync, the missing tab silently
    /// disappears from the header (`render_header` iterates `self.screens`
    /// while routing iterates `ScreenId::ALL`).
    #[test]
    fn app_screens_match_screen_id_all() {
        let app = App::new(TuiConfig::default(), None);
        assert_eq!(
            app.screens.len(),
            ScreenId::ALL.len(),
            "App::new must instantiate a Screen for every ScreenId::ALL entry"
        );
    }
}