nu-explore 0.113.0

Nushell table pager
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
use super::super::{
    config::ExploreConfig,
    nu_common::{NuText, run_command_with_value},
    pager::{
        Frame, Transition, ViewInfo,
        report::{Report, Severity},
    },
    views::{Layout, Orientation, Preview, RecordView, View, ViewConfig},
};
use super::ViewCommand;
use anyhow::Result;
use crossterm::event::{KeyCode, KeyEvent};
use nu_engine::get_columns;
use nu_protocol::{
    PipelineData, Value,
    engine::{EngineState, Stack},
};
use ratatui::layout::Rect;
use std::sync::mpsc::{self, Receiver, TryRecvError};
use std::thread::{self, JoinHandle};

#[derive(Debug, Default, Clone)]
pub struct NuCmd {
    command: String,
}

impl NuCmd {
    pub fn new() -> Self {
        Self {
            command: String::new(),
        }
    }

    pub const NAME: &'static str = "nu";
}

impl ViewCommand for NuCmd {
    type View = NuView;

    fn name(&self) -> &'static str {
        Self::NAME
    }

    fn description(&self) -> &'static str {
        ""
    }

    fn parse(&mut self, args: &str) -> Result<()> {
        args.trim().clone_into(&mut self.command);

        Ok(())
    }

    fn spawn(
        &mut self,
        engine_state: &EngineState,
        stack: &mut Stack,
        value: Option<Value>,
        config: &ViewConfig,
    ) -> Result<Self::View> {
        let value = value.unwrap_or_default();

        // Clone what we need for the background thread
        let engine_state = engine_state.clone();
        let mut stack = stack.clone();
        let command = self.command.clone();
        let explore_config = config.explore_config.clone();

        // Create channel for communicating results
        let (sender, receiver) = mpsc::channel();

        // Spawn background thread to run the command
        let handle = thread::spawn(move || {
            stream_command(
                &command,
                &value,
                &engine_state,
                &mut stack,
                &explore_config,
                sender,
            );
        });

        Ok(NuView {
            state: ViewState::Loading,
            receiver: Some(receiver),
            _handle: Some(handle),
            command_text: self.command.clone(),
            explore_config: config.explore_config.clone(),
            frame_count: 0,
            // Streaming state
            columns: Vec::new(),
            rows: Vec::new(),
            is_record: false,
            stream_done: false,
            last_error: None,
            last_row_count: 0,
        })
    }
}

/// Messages sent from the background thread to the UI
enum StreamMessage {
    /// Column names (sent once, when first determined)
    Columns(Vec<String>),
    /// A batch of rows
    Rows(Vec<Vec<Value>>),
    /// This is a record (single row with orientation left)
    IsRecord,
    /// Simple value result (not a table)
    SimpleValue(String),
    /// Streaming is complete
    Done,
    /// An error occurred
    Error(String),
}

/// Run the nu command and stream results back via the channel
fn stream_command(
    command: &str,
    value: &Value,
    engine_state: &EngineState,
    stack: &mut Stack,
    _explore_config: &ExploreConfig,
    sender: mpsc::Sender<StreamMessage>,
) {
    let pipeline = match run_command_with_value(command, value, engine_state, stack) {
        Ok(p) => p,
        Err(e) => {
            let _ = sender.send(StreamMessage::Error(format!("Command failed: {e}")));
            return;
        }
    };

    match pipeline {
        PipelineData::Empty => {
            let _ = sender.send(StreamMessage::Done);
        }
        PipelineData::Value(Value::Record { val, .. }, ..) => {
            // Record - show with left orientation
            let _ = sender.send(StreamMessage::IsRecord);
            let (cols, vals): (Vec<_>, Vec<_>) = val.into_owned().into_iter().unzip();
            let _ = sender.send(StreamMessage::Columns(cols));
            if !vals.is_empty() {
                let _ = sender.send(StreamMessage::Rows(vec![vals]));
            }
            let _ = sender.send(StreamMessage::Done);
        }
        PipelineData::Value(Value::List { vals, .. }, ..) => {
            // List value - stream it
            stream_values(vals.into_iter(), &sender);
        }
        PipelineData::Value(Value::String { val, .. }, ..) => {
            // String - show as preview
            let _ = sender.send(StreamMessage::SimpleValue(val));
        }
        PipelineData::Value(value, ..) => {
            // Other simple value - show as preview
            let text = value.to_abbreviated_string(&engine_state.config);
            let _ = sender.send(StreamMessage::SimpleValue(text));
        }
        PipelineData::ListStream(stream, ..) => {
            // Stream values as they arrive
            stream_values(stream.into_iter(), &sender);
        }
        PipelineData::ByteStream(stream, ..) => {
            // ByteStream - collect to string and show as preview
            let span = stream.span();
            match stream.into_string() {
                Ok(text) => {
                    let _ = sender.send(StreamMessage::SimpleValue(text));
                }
                Err(e) => {
                    let _ = sender.send(StreamMessage::Error(format!(
                        "Failed to read stream: {}",
                        Value::error(e, span).to_debug_string()
                    )));
                }
            }
        }
    }
}

/// Stream values from an iterator, sending rows in batches
fn stream_values<I>(iter: I, sender: &mpsc::Sender<StreamMessage>)
where
    I: Iterator<Item = Value>,
{
    const BATCH_SIZE: usize = 1;
    const INITIAL_ROWS_FOR_COLUMNS: usize = 1;

    let mut columns: Option<Vec<String>> = None;
    let mut batch: Vec<Vec<Value>> = Vec::with_capacity(BATCH_SIZE);
    let mut initial_values: Vec<Value> = Vec::new();

    for value in iter {
        if columns.is_none() {
            // Buffer initial values to determine columns
            initial_values.push(value);

            if initial_values.len() >= INITIAL_ROWS_FOR_COLUMNS {
                // Determine columns from buffered values
                let cols = get_columns(&initial_values);
                if !cols.is_empty() {
                    let _ = sender.send(StreamMessage::Columns(cols.clone()));
                }

                // Convert buffered values to rows and send
                let rows: Vec<Vec<Value>> = initial_values
                    .drain(..)
                    .map(|v| value_to_row(&cols, &v))
                    .collect();

                if sender.send(StreamMessage::Rows(rows)).is_err() {
                    return; // Receiver dropped
                }

                columns = Some(cols);
            }
        } else if let Some(ref cols) = columns {
            // We have columns, add to batch
            batch.push(value_to_row(cols, &value));

            if batch.len() >= BATCH_SIZE {
                if sender
                    .send(StreamMessage::Rows(std::mem::take(&mut batch)))
                    .is_err()
                {
                    return; // Receiver dropped
                }
                batch = Vec::with_capacity(BATCH_SIZE);
            }
        }
    }

    // Handle case where we never got enough values to determine columns
    if columns.is_none() && !initial_values.is_empty() {
        let cols = get_columns(&initial_values);
        if !cols.is_empty() {
            let _ = sender.send(StreamMessage::Columns(cols.clone()));
        }

        let rows: Vec<Vec<Value>> = initial_values
            .drain(..)
            .map(|v| value_to_row(&cols, &v))
            .collect();

        let _ = sender.send(StreamMessage::Rows(rows));
    }

    // Send any remaining batch
    if !batch.is_empty() {
        let _ = sender.send(StreamMessage::Rows(batch));
    }

    let _ = sender.send(StreamMessage::Done);
}

/// Convert a Value to a row based on expected columns
fn value_to_row(cols: &[String], value: &Value) -> Vec<Value> {
    if cols.is_empty() {
        vec![value.clone()]
    } else if let Value::Record { val, .. } = value {
        cols.iter()
            .map(|col| val.get(col).cloned().unwrap_or_default())
            .collect()
    } else {
        // Non-record value in a list - put it in the first column
        let mut row = vec![Value::default(); cols.len()];
        if !row.is_empty() {
            row[0] = value.clone();
        }
        row
    }
}

/// The current state of the view
enum ViewState {
    /// Waiting for first data
    Loading,
    /// Streaming/showing a RecordView
    Records(Box<RecordView>),
    /// Showing a simple preview
    Preview(Preview),
    /// Command completed with no output
    Empty,
}

/// A view that runs a command in the background and streams results
pub struct NuView {
    state: ViewState,
    receiver: Option<Receiver<StreamMessage>>,
    _handle: Option<JoinHandle<()>>,
    command_text: String,
    explore_config: ExploreConfig,
    frame_count: usize,
    // Streaming state - used to accumulate data before/while view exists
    columns: Vec<String>,
    rows: Vec<Vec<Value>>,
    is_record: bool,
    stream_done: bool,
    last_error: Option<String>,
    last_row_count: usize,
}

impl NuView {
    /// Process any pending messages from the background thread
    fn process_messages(&mut self) {
        // Take receiver temporarily to avoid borrow issues
        let receiver = match self.receiver.take() {
            Some(r) => r,
            None => return,
        };

        // Process all available messages
        let mut should_update_view = false;
        loop {
            match receiver.try_recv() {
                Ok(StreamMessage::Columns(cols)) => {
                    self.columns = cols;
                }
                Ok(StreamMessage::Rows(new_rows)) => {
                    self.rows.extend(new_rows);
                    should_update_view = true;
                }
                Ok(StreamMessage::IsRecord) => {
                    self.is_record = true;
                }
                Ok(StreamMessage::SimpleValue(text)) => {
                    self.state = ViewState::Preview(Preview::new(&text));
                    self.stream_done = true;
                    // Don't put receiver back - we're done
                    return;
                }
                Ok(StreamMessage::Done) => {
                    self.stream_done = true;
                    // If we have no data yet, mark as empty
                    if self.rows.is_empty()
                        && !matches!(self.state, ViewState::Records(_) | ViewState::Preview(_))
                    {
                        self.state = ViewState::Empty;
                    }
                    // Don't put receiver back - we're done
                    if should_update_view {
                        self.update_record_view();
                    }
                    return;
                }
                Ok(StreamMessage::Error(e)) => {
                    self.last_error = Some(e);
                    if !matches!(self.state, ViewState::Records(_) | ViewState::Preview(_)) {
                        self.state = ViewState::Empty;
                    }
                    self.stream_done = true;
                    // Don't put receiver back - we're done
                    return;
                }
                Err(TryRecvError::Empty) => {
                    // No more messages available right now
                    // Put receiver back for next time
                    self.receiver = Some(receiver);
                    if should_update_view {
                        self.update_record_view();
                    }
                    return;
                }
                Err(TryRecvError::Disconnected) => {
                    // Thread finished
                    self.stream_done = true;
                    if self.rows.is_empty()
                        && !matches!(self.state, ViewState::Records(_) | ViewState::Preview(_))
                    {
                        self.state = ViewState::Empty;
                    }
                    // Don't put receiver back - we're done
                    if should_update_view {
                        self.update_record_view();
                    }
                    return;
                }
            }
        }
    }

    /// Create or update the RecordView with current data
    fn update_record_view(&mut self) {
        if self.rows.is_empty() {
            return;
        }

        let cols = if self.columns.is_empty() {
            vec![String::new()]
        } else {
            self.columns.clone()
        };

        match &mut self.state {
            ViewState::Records(existing_view) => {
                // Append new rows to existing view
                let layer = existing_view.get_top_layer_mut();
                layer.record_values = self.rows.clone();
                // Update cursor limits
                let _ = layer.cursor.y.view.set_size(layer.record_values.len());
                let _ = layer.cursor.x.view.set_size(layer.column_names.len());
                // Invalidate text to force redraw
                layer.record_text = None;
            }
            _ => {
                // Create new view with all accumulated data
                let mut view =
                    RecordView::new(cols, self.rows.clone(), self.explore_config.clone());

                if self.is_record {
                    view.set_top_layer_orientation(Orientation::Left);
                }

                self.state = ViewState::Records(Box::new(view));
            }
        }
    }

    fn spinner_char(&self) -> char {
        const SPINNER: &[char] = &['', '', '', '', '', '', '', '', '', ''];
        SPINNER[self.frame_count % SPINNER.len()]
    }

    fn row_count(&self) -> usize {
        self.rows.len()
    }

    fn is_streaming(&self) -> bool {
        !self.stream_done
    }

    fn non_interactive_transition(key: KeyEvent) -> Transition {
        match key.code {
            KeyCode::Char('q') | KeyCode::Esc => Transition::Exit,
            _ => Transition::None,
        }
    }
}

impl View for NuView {
    fn draw(&mut self, f: &mut Frame, area: Rect, cfg: ViewConfig<'_>, layout: &mut Layout) {
        self.frame_count = self.frame_count.wrapping_add(1);

        // Tail the view if new rows have been added during streaming
        if self.rows.len() > self.last_row_count {
            self.last_row_count = self.rows.len();
            if let ViewState::Records(view) = &mut self.state {
                view.tail(area.width, area.height);
            }
        }

        match &mut self.state {
            ViewState::Loading => {
                // Don't draw anything in the content area while loading
                // The status bar will show the spinner
            }
            ViewState::Records(view) => {
                view.draw(f, area, cfg, layout);
            }
            ViewState::Preview(view) => {
                view.draw(f, area, cfg, layout);
            }
            ViewState::Empty => {
                // Nothing to display
            }
        }
    }

    fn handle_input(
        &mut self,
        engine_state: &EngineState,
        stack: &mut Stack,
        layout: &Layout,
        info: &mut ViewInfo,
        key: KeyEvent,
    ) -> Transition {
        match &mut self.state {
            ViewState::Records(view) => view.handle_input(engine_state, stack, layout, info, key),
            ViewState::Preview(view) => view.handle_input(engine_state, stack, layout, info, key),
            _ => Self::non_interactive_transition(key),
        }
    }

    fn update(&mut self, info: &mut ViewInfo) -> bool {
        // Process any pending messages from the stream
        self.process_messages();

        if let Some(message) = &self.last_error {
            info.status = Some(Report::error(message.clone()));
            return false;
        }

        // Update the status bar based on current state
        match &self.state {
            ViewState::Loading => {
                let spinner = self.spinner_char();
                let msg = format!("{} Running: {}", spinner, self.command_text);
                info.status = Some(Report::message(msg, Severity::Info));
                true // Keep polling
            }
            ViewState::Records(_) => {
                let row_count = self.row_count();
                if self.is_streaming() {
                    let spinner = self.spinner_char();
                    let msg = format!("{} Streaming: {} rows", spinner, row_count);
                    info.status = Some(Report::message(msg, Severity::Info));
                    true // Keep polling
                } else {
                    info.status = Some(Report::new(
                        format!("{} rows", row_count),
                        Severity::Info,
                        String::new(),
                        String::new(),
                        String::new(),
                    ));
                    false // Done polling
                }
            }
            ViewState::Preview(_) => {
                info.status = Some(Report::message("Preview", Severity::Info));
                false // Done polling
            }
            ViewState::Empty => {
                info.status = Some(Report::message("No output", Severity::Info));
                false // Done polling
            }
        }
    }

    fn show_data(&mut self, i: usize) -> bool {
        match &mut self.state {
            ViewState::Records(view) => view.show_data(i),
            ViewState::Preview(view) => view.show_data(i),
            _ => false,
        }
    }

    fn collect_data(&self) -> Vec<NuText> {
        match &self.state {
            ViewState::Records(view) => view.collect_data(),
            ViewState::Preview(view) => view.collect_data(),
            _ => Vec::new(),
        }
    }

    fn exit(&mut self) -> Option<Value> {
        match &mut self.state {
            ViewState::Records(view) => view.exit(),
            ViewState::Preview(view) => view.exit(),
            _ => None,
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crossterm::event::KeyModifiers;

    #[test]
    fn non_interactive_states_exit_on_q_or_esc() {
        let key_q = KeyEvent::new(KeyCode::Char('q'), KeyModifiers::NONE);
        let key_esc = KeyEvent::new(KeyCode::Esc, KeyModifiers::NONE);

        assert!(matches!(
            NuView::non_interactive_transition(key_q),
            Transition::Exit
        ));
        assert!(matches!(
            NuView::non_interactive_transition(key_esc),
            Transition::Exit
        ));
    }

    #[test]
    fn non_interactive_states_ignore_other_keys() {
        let key = KeyEvent::new(KeyCode::Enter, KeyModifiers::NONE);

        assert!(matches!(
            NuView::non_interactive_transition(key),
            Transition::None
        ));
    }

    #[test]
    fn stream_error_is_reported_without_error_view() {
        let (sender, receiver) = mpsc::channel();

        sender
            .send(StreamMessage::Error(String::from("Command failed")))
            .expect("send error message");

        let mut view = NuView {
            state: ViewState::Loading,
            receiver: Some(receiver),
            _handle: None,
            command_text: String::new(),
            explore_config: ExploreConfig::default(),
            frame_count: 0,
            columns: Vec::new(),
            rows: Vec::new(),
            is_record: false,
            stream_done: false,
            last_error: None,
            last_row_count: 0,
        };

        view.process_messages();

        assert!(matches!(view.state, ViewState::Empty));
        assert!(view.stream_done);
        assert_eq!(view.last_error.as_deref(), Some("Command failed"));
    }

    #[test]
    fn update_prioritizes_error_status() {
        let mut view = NuView {
            state: ViewState::Empty,
            receiver: None,
            _handle: None,
            command_text: String::new(),
            explore_config: ExploreConfig::default(),
            frame_count: 0,
            columns: Vec::new(),
            rows: Vec::new(),
            is_record: false,
            stream_done: true,
            last_error: Some(String::from("stream failed")),
            last_row_count: 0,
        };

        let mut info = ViewInfo::default();
        let keep_polling = view.update(&mut info);

        assert!(!keep_polling);

        let status = info.status.expect("status to be set");
        assert!(matches!(status.level, Severity::Err));
        assert_eq!(status.message, "stream failed");
    }
}