lazylog-framework 0.3.4

A framework for building terminal-based log viewers with vim-like navigation
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
use crate::{
    app_block::AppBlock,
    filter::FilterEngine,
    log_list::LogList,
    log_parser::{LogDetailLevel, LogItem},
    provider::{LogParser, LogProvider, spawn_provider_thread},
    status_bar::DisplayEvent,
    theme,
    ui_logger::UiLogger,
};
use anyhow::{Result, anyhow};
use crossterm::event::{self, Event, MouseEvent};
use ratatui::{Terminal, backend::CrosstermBackend, prelude::*, widgets::Widget};
use ringbuf::{
    HeapRb,
    traits::{Consumer, Split},
};
use std::{
    io,
    sync::{
        Arc, Mutex,
        atomic::{AtomicBool, Ordering},
    },
    thread,
    time::Duration,
};

mod events;
mod render;
mod scrolling;
mod selection;

// constants
const DEFAULT_POLL_INTERVAL_MS: u64 = 100;
const DEFAULT_RING_BUFFER_SIZE: usize = 16384;
const HELP_POPUP_WIDTH: u16 = 60;
const SCROLL_PAD: usize = 1;
const HORIZONTAL_SCROLL_STEP: usize = 5;
const DISPLAY_EVENT_DURATION_MS: u64 = 800;

#[derive(Clone)]
pub struct AppDesc {
    pub poll_interval: Duration,
    pub show_debug_logs: bool,
    pub ring_buffer_size: usize,
    pub parser: Arc<dyn LogParser>,
}

impl AppDesc {
    pub fn new(parser: Arc<dyn LogParser>) -> Self {
        Self {
            poll_interval: Duration::from_millis(DEFAULT_POLL_INTERVAL_MS),
            show_debug_logs: false,
            ring_buffer_size: DEFAULT_RING_BUFFER_SIZE,
            parser,
        }
    }
}

/// Start the application with default configuration
pub fn start_with_provider<P>(
    terminal: &mut Terminal<CrosstermBackend<io::Stdout>>,
    provider: P,
    parser: Arc<dyn LogParser>,
) -> Result<()>
where
    P: LogProvider + 'static,
{
    start_with_desc(terminal, provider, AppDesc::new(parser))
}

/// Start the application with custom configuration
pub fn start_with_desc<P>(
    terminal: &mut Terminal<CrosstermBackend<io::Stdout>>,
    provider: P,
    desc: AppDesc,
) -> Result<()>
where
    P: LogProvider + 'static,
{
    color_eyre::install().or(Err(anyhow!("Error installing color_eyre")))?;

    let app = App::new(provider, desc.clone());
    app.run(terminal, &desc)
}

struct App {
    is_exiting: bool,
    raw_logs: Vec<LogItem>,
    displaying_logs: LogList,
    log_consumer: ringbuf::HeapCons<LogItem>, // receives logs from provider thread
    provider_thread: Option<thread::JoinHandle<()>>,
    provider_stop_signal: Arc<AtomicBool>,
    autoscroll: bool,
    filter_input: String, // Current filter input text (includes leading '/')
    filter_focused: bool, // Whether the filter input is focused
    filter_engine: FilterEngine, // Filtering engine with incremental + parallel support
    detail_level: LogDetailLevel, // Detail level for log display
    parser: Arc<dyn LogParser>, // Parser for log items (handles both parsing and formatting)
    debug_logs: Arc<Mutex<Vec<String>>>, // Debug log messages for UI display
    hard_focused_block_id: uuid::Uuid, // Hard focus: set by clicking, persists until another click (defaults to logs_block)
    soft_focused_block_id: Option<uuid::Uuid>, // Soft focus: set by hovering, changes with mouse movement
    logs_block: AppBlock,
    details_block: AppBlock,
    debug_block: AppBlock,
    prev_selected_log_id: Option<uuid::Uuid>, // Track previous selected log item ID for details reset
    selected_log_uuid: Option<uuid::Uuid>,    // Track currently selected log item UUID
    last_logs_area: Option<Rect>, // Store the last rendered logs area for selection visibility
    last_details_area: Option<Rect>, // Store the last rendered details area
    last_debug_area: Option<Rect>, // Store the last rendered debug area
    last_logs_viewport_height: Option<usize>, // Track viewport height to preserve bottom item on resize
    text_wrapping_enabled: bool,              // Whether text wrapping is enabled (default false)
    show_debug_logs: bool,                    // Whether to show the debug logs block
    show_help_popup: bool,                    // Whether to show the help popup
    display_event: Option<DisplayEvent>,      // Temporary event to display in footer
    prev_hard_focused_block_id: uuid::Uuid,   // Track previous hard focus to detect changes

    mouse_event: Option<MouseEvent>,
}

#[derive(Copy, Clone)]
pub(super) enum ScrollableBlockType {
    Details,
    Debug,
}

// ============================================================================
// Initialization
// ============================================================================
impl App {
    fn setup_logger() -> Arc<Mutex<Vec<String>>> {
        let debug_logs = Arc::new(Mutex::new(Vec::new()));
        let logger = Box::new(UiLogger::new(debug_logs.clone()));

        if log::set_logger(Box::leak(logger)).is_ok() {
            log::set_max_level(log::LevelFilter::Debug);
        }

        debug_logs
    }

    fn new<P>(provider: P, desc: AppDesc) -> Self
    where
        P: LogProvider + 'static,
    {
        let debug_logs = Self::setup_logger();

        // create ring buffer
        let ring_buffer = HeapRb::<LogItem>::new(desc.ring_buffer_size);
        let (producer, consumer) = ring_buffer.split();

        // spawn provider thread
        let poll_interval = desc.poll_interval;
        let (provider_thread, provider_stop_signal) =
            spawn_provider_thread(provider, desc.parser.clone(), producer, poll_interval);

        // create blocks first so we can reference their IDs
        let logs_block = AppBlock::new().set_title("[1]─Logs".to_string());
        let details_block = AppBlock::new()
            .set_title("[2]─Details")
            .set_padding(ratatui::widgets::Padding::horizontal(1));
        let debug_block = AppBlock::new()
            .set_title("[3]─Debug Logs")
            .set_padding(ratatui::widgets::Padding::horizontal(1));

        let logs_block_id = logs_block.id();

        // setup filter engine with parser
        let mut filter_engine = FilterEngine::new();
        filter_engine.set_formatter(desc.parser.clone());

        Self {
            is_exiting: false,
            raw_logs: Vec::new(),
            displaying_logs: LogList::new(Vec::new()),
            log_consumer: consumer,
            provider_thread: Some(provider_thread),
            provider_stop_signal,
            autoscroll: true,
            filter_input: String::new(),
            filter_focused: false,
            filter_engine,
            detail_level: 1, // default detail level (was Basic)
            parser: desc.parser,
            debug_logs,
            hard_focused_block_id: logs_block_id,
            soft_focused_block_id: None,
            logs_block,
            details_block,
            debug_block,
            prev_selected_log_id: None,
            selected_log_uuid: None,
            last_logs_area: None,
            last_details_area: None,
            last_debug_area: None,
            last_logs_viewport_height: None,
            text_wrapping_enabled: true,
            show_debug_logs: desc.show_debug_logs,
            show_help_popup: false,
            display_event: None,
            prev_hard_focused_block_id: logs_block_id,

            mouse_event: None,
        }
    }
}

// ============================================================================
// Lifecycle
// ============================================================================
impl App {
    fn run(
        mut self,
        terminal: &mut Terminal<CrosstermBackend<io::Stdout>>,
        desc: &AppDesc,
    ) -> Result<()> {
        let poll_interval = desc.poll_interval;

        let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| -> Result<()> {
            while !self.is_exiting {
                self.poll_event(poll_interval)?;
                self.update_logs()?;
                self.check_and_clear_expired_event();
                terminal.draw(|frame| frame.render_widget(&mut self, frame.area()))?;
            }
            Ok(())
        }));

        // cleanup provider thread before returning
        self.cleanup();

        match result {
            Ok(r) => r,
            Err(_) => {
                eprintln!("Application panicked, terminal restored");
                std::process::exit(1);
            }
        }
    }

    fn cleanup(&mut self) {
        // signal provider thread to stop
        self.provider_stop_signal.store(true, Ordering::Relaxed);

        // join the provider thread
        if let Some(handle) = self.provider_thread.take() {
            log::debug!("Waiting for provider thread to finish...");
            if let Err(e) = handle.join() {
                log::error!("Provider thread panicked: {:?}", e);
            }
        }
    }

    fn poll_event(&mut self, poll_interval: Duration) -> Result<()> {
        if event::poll(poll_interval)? {
            let event = event::read()?;
            match event {
                Event::Key(key) => self.handle_key(key)?,
                Event::Mouse(mouse) => {
                    self.handle_mouse_event(&mouse)?;
                    self.mouse_event = Some(mouse);
                }
                Event::Resize(width, height) => {
                    log::debug!("Terminal resized to {}x{}", width, height);
                }
                _ => {}
            }
        }

        Ok(())
    }
}

// ============================================================================
// Utility methods
// ============================================================================
impl App {
    fn to_underlying_index(_total: usize, visual_index: usize) -> usize {
        visual_index
    }

    fn to_visual_index(_total: usize, underlying_index: usize) -> usize {
        underlying_index
    }

    fn is_log_block_focused(&self) -> Result<bool> {
        Ok(self.get_display_focused_block() == self.logs_block.id())
    }
}

// ============================================================================
// Log and filter management
// ============================================================================
impl App {
    fn update_logs(&mut self) -> Result<()> {
        // consume all available logs from ring buffer
        let mut new_logs = Vec::new();
        while let Some(log) = self.log_consumer.try_pop() {
            new_logs.push(log);
        }

        if new_logs.is_empty() {
            return Ok(());
        }

        let previous_uuid = self.selected_log_uuid;
        let previous_scroll_pos = Some(self.logs_block.get_scroll_position());

        log::debug!("Received {} new log items from provider", new_logs.len());
        let old_raw_count = self.raw_logs.len();
        self.raw_logs.extend(new_logs);

        // use incremental filtering for efficiency (only filters new logs)
        let filter_query = self.get_filter_query().to_string();
        let filtered_indices = self.filter_engine.filter_new_logs(
            &self.raw_logs,
            old_raw_count,
            &filter_query,
            self.detail_level,
        );
        self.displaying_logs = LogList::new(filtered_indices);

        if previous_uuid.is_some() {
            self.update_selection_by_uuid();
        }

        {
            let new_items_count = self.displaying_logs.len();

            if self.autoscroll {
                // scroll to bottom (stop when last item is fully displayed)
                let viewport_height = if let Some(area) = self.last_logs_area {
                    let is_focused = self.is_log_block_focused().unwrap_or(false);
                    let [main_content_area, _] =
                        Layout::horizontal([Constraint::Fill(1), Constraint::Length(1)])
                            .margin(0)
                            .areas(area);

                    let [content_area, _] =
                        Layout::vertical([Constraint::Fill(1), Constraint::Length(1)])
                            .margin(0)
                            .areas(main_content_area);

                    let inner_area = self.logs_block.get_content_rect(content_area, is_focused);
                    inner_area.height as usize
                } else {
                    1 // fallback if area not yet rendered
                };

                let max_scroll = new_items_count.saturating_sub(viewport_height);
                self.logs_block.set_scroll_position(max_scroll);
            } else if previous_scroll_pos.is_some() {
                // oldest is at visual index 0, newest at end;
                // adding items doesn't change visual position of existing items,
                // so scroll position stays the same
                // (scroll position is already set correctly, no adjustment needed)
            }

            self.logs_block.set_lines_count(new_items_count);
            self.logs_block.update_scrollbar_state(
                new_items_count,
                Some(self.logs_block.get_scroll_position()),
            );
        }

        Ok(())
    }

    fn get_filter_query(&self) -> &str {
        // filter_input includes the leading '/', so skip it
        if self.filter_input.starts_with('/') && self.filter_input.len() > 1 {
            &self.filter_input[1..]
        } else {
            ""
        }
    }

    fn apply_filter(&mut self) {
        let previous_uuid = self.selected_log_uuid;
        let prev_scroll_pos = self.logs_block.get_scroll_position();

        // calculate the relative position of the selected item in the viewport
        let prev_relative_offset = if let Some(selected_idx) = self.displaying_logs.state.selected()
        {
            selected_idx.saturating_sub(prev_scroll_pos)
        } else {
            0
        };

        self.rebuild_filtered_list();

        if previous_uuid.is_some() {
            self.update_selection_by_uuid();

            // if the previously selected item is no longer in the filtered list,
            // clear selection
            if self.selected_log_uuid.is_none() {
                self.displaying_logs.state.select(None);
            }
        }

        {
            let new_total = self.displaying_logs.len();
            let mut pos = prev_scroll_pos;
            if new_total == 0 {
                pos = 0;
            } else {
                // try to preserve the relative screen position of the selected item
                if let Some(selected_idx) = self.displaying_logs.state.selected() {
                    // calculate desired scroll position to maintain relative offset
                    let desired_scroll = selected_idx.saturating_sub(prev_relative_offset);
                    // clamp to valid range
                    pos = desired_scroll.min(new_total.saturating_sub(1));
                } else {
                    // fallback to previous scroll position
                    pos = pos.min(new_total.saturating_sub(1));
                }
            }
            self.logs_block.set_scroll_position(pos);
            self.logs_block.set_lines_count(new_total);
            self.logs_block.update_scrollbar_state(new_total, Some(pos));
        }

        // ensure the selected item is scrolled into view after filter changes
        let _ = self.ensure_selection_visible();
    }

    fn rebuild_filtered_list(&mut self) {
        let filter_query = self.get_filter_query().to_string();

        // use FilterEngine for filtering (incremental + parallel)
        let filtered_indices =
            self.filter_engine
                .filter(&self.raw_logs, &filter_query, self.detail_level);

        self.displaying_logs = LogList::new(filtered_indices);
    }

    fn update_logs_scrollbar_state(&mut self) {
        let total = self.displaying_logs.len();

        {
            let max_top = total.saturating_sub(1);
            let pos = self.logs_block.get_scroll_position().min(max_top);
            self.logs_block.set_scroll_position(pos);

            self.logs_block.set_lines_count(total);
            self.logs_block.update_scrollbar_state(total, Some(pos));
        }
    }
}

// ============================================================================
// Focus management
// ============================================================================
impl App {
    fn set_hard_focused_block(&mut self, block_id: uuid::Uuid) {
        self.hard_focused_block_id = block_id;
    }

    fn set_soft_focused_block(&mut self, block_id: uuid::Uuid) {
        if self.soft_focused_block_id != Some(block_id) {
            self.soft_focused_block_id = Some(block_id);
        }
    }

    fn get_display_focused_block(&self) -> uuid::Uuid {
        self.hard_focused_block_id
    }

    fn is_mouse_in_area(&self, mouse: &MouseEvent, area: Rect) -> bool {
        mouse.column >= area.x
            && mouse.column < area.x + area.width
            && mouse.row >= area.y
            && mouse.row < area.y + area.height
    }

    fn get_block_under_mouse(&self, mouse: &MouseEvent) -> Option<uuid::Uuid> {
        if let Some(area) = self.last_logs_area
            && self.is_mouse_in_area(mouse, area)
        {
            return Some(self.logs_block.id());
        }

        if let Some(area) = self.last_details_area
            && self.is_mouse_in_area(mouse, area)
        {
            return Some(self.details_block.id());
        }

        if let Some(area) = self.last_debug_area
            && self.is_mouse_in_area(mouse, area)
        {
            return Some(self.debug_block.id());
        }

        None
    }
}

// ============================================================================
// Display events
// ============================================================================
impl App {
    /// Set a display event to show in the footer for a given duration
    pub fn set_display_event(&mut self, text: String, duration: Duration, style: Option<Style>) {
        self.display_event = Some(DisplayEvent::create(
            text,
            duration,
            style,
            theme::DISPLAY_EVENT_STYLE,
        ));
    }

    /// Check if the current display event has expired and clear it if so
    fn check_and_clear_expired_event(&mut self) {
        self.display_event = DisplayEvent::check_and_clear(self.display_event.take());
    }

    fn clear_event(&mut self) {
        self.mouse_event = None;
    }
}

// ============================================================================
// Widget implementation
// ============================================================================
impl Widget for &mut App {
    fn render(self, area: Rect, buf: &mut Buffer) {
        // detect if hard focus changed since last render
        let focus_changed = self.hard_focused_block_id != self.prev_hard_focused_block_id;

        // determine dynamic layout based on hard focus
        let (logs_percentage, details_percentage) =
            if self.hard_focused_block_id == self.logs_block.id() {
                (60, 40)
            } else if self.hard_focused_block_id == self.details_block.id() {
                (40, 60)
            } else {
                (60, 40) // default for debug block or any other case
            };

        if self.show_debug_logs {
            let [main, debug_area, footer_area] = Layout::vertical([
                Constraint::Fill(1),
                Constraint::Length(6),
                Constraint::Length(1),
            ])
            .areas(area);

            let [logs_area, details_area] = Layout::vertical([
                Constraint::Percentage(logs_percentage),
                Constraint::Percentage(details_percentage),
            ])
            .areas(main);

            self.render_logs(logs_area, buf).unwrap();
            self.render_details(details_area, buf).unwrap();
            self.render_debug_logs(debug_area, buf).unwrap();
            self.render_footer(footer_area, buf).unwrap();
        } else {
            let [main, footer_area] =
                Layout::vertical([Constraint::Fill(1), Constraint::Length(1)]).areas(area);

            let [logs_area, details_area] = Layout::vertical([
                Constraint::Percentage(logs_percentage),
                Constraint::Percentage(details_percentage),
            ])
            .areas(main);

            self.render_logs(logs_area, buf).unwrap();
            self.render_details(details_area, buf).unwrap();
            self.render_footer(footer_area, buf).unwrap();
        }

        // render help popup on top if visible
        if self.show_help_popup {
            self.render_help_popup(area, buf).unwrap();
        }

        // adjust viewport if hard focus changed (panels resized)
        if focus_changed {
            log::debug!("Hard focus changed, adjusting viewport");
            let _ = self.ensure_selection_visible();
            self.prev_hard_focused_block_id = self.hard_focused_block_id;
        }

        self.clear_event();
    }
}