nextdeck 0.1.0

A TUI wrapper for cargo-nextest, Clap-powered xtasks, and more.
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
use std::{
    collections::VecDeque,
    sync::atomic::{AtomicU64, Ordering},
    time::{SystemTime, UNIX_EPOCH},
};

use nextdeck_helper::{SCHEMA_VERSION, TestEvent};

use crate::{
    output::{OUTPUT_TEXT_LIMIT_BYTES, append_bounded_text, bounded_text_with_limit},
    output_pane::OutputPaneState,
};

const MAX_EVENT_RUNS: usize = 20;
const MAX_EVENTS_PER_RUN: usize = 2_000;
const EVENT_RUN_RETENTION_BYTES: usize = OUTPUT_TEXT_LIMIT_BYTES;
const EVENT_DETAIL_LIMIT_BYTES: usize = 64 * 1024;
const EVENT_SUMMARY_LIMIT_BYTES: usize = 4 * 1024;
const EVENTS_TRUNCATED_MARKER: &str = "[... earlier events discarded ...]\n";

static RUN_COUNTER: AtomicU64 = AtomicU64::new(1);

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct TestEventRun {
    pub id: String,
}

#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub enum TestEventsFocus {
    #[default]
    Runs,
    Events,
}

#[derive(Clone, Debug)]
pub struct TestEventsState {
    pub modal_open: bool,
    pub focus: TestEventsFocus,
    pub selected_run: usize,
    pub output: OutputPaneState,
    pub runs: Vec<TestEventRunLog>,
    active_run_id: Option<String>,
    unread: bool,
}

#[derive(Clone, Debug, PartialEq)]
pub struct TestEventRunLog {
    pub id: String,
    pub scope: String,
    pub status: String,
    events: VecDeque<RetainedTestEvent>,
    retained_bytes: usize,
    total_events: usize,
    events_truncated: bool,
}

#[derive(Clone, Debug, PartialEq)]
struct RetainedTestEvent {
    summary: String,
    detail: String,
}

impl Default for TestEventsState {
    fn default() -> Self {
        Self {
            modal_open: false,
            focus: TestEventsFocus::Runs,
            selected_run: 0,
            output: OutputPaneState::default(),
            runs: Vec::new(),
            active_run_id: None,
            unread: false,
        }
    }
}

impl TestEventsState {
    pub fn begin_run(&mut self, run: TestEventRun, scope: String) {
        self.make_room_for_run();
        self.active_run_id = Some(run.id.clone());
        self.runs.push(TestEventRunLog::new(run, scope, "running"));
        self.selected_run = self.runs.len().saturating_sub(1);
        self.output.reset_for_source_change();
    }

    pub fn finish_active_run(&mut self, status: impl Into<String>) {
        let Some(active_run_id) = self.active_run_id.take() else {
            return;
        };
        if let Some(run) = self.runs.iter_mut().find(|run| run.id == active_run_id) {
            run.status = status.into();
        }
    }

    pub fn append_event(&mut self, run_id: &str, event: TestEvent) {
        if let Some(run) = self.runs.iter_mut().find(|run| run.id == run_id) {
            run.append_event(&event);
        } else {
            self.make_room_for_run();
            let mut run = TestEventRunLog::new(
                TestEventRun {
                    id: run_id.to_owned(),
                },
                "external".to_owned(),
                "unknown",
            );
            run.append_event(&event);
            self.runs.push(run);
            self.selected_run = self.runs.len().saturating_sub(1);
        }
        if !self.modal_open {
            self.unread = true;
        }
    }

    pub fn append_active_event(&mut self, event: TestEvent) {
        let Some(run_id) = self.active_run_id.clone() else {
            return;
        };
        self.append_event(&run_id, event);
    }

    fn make_room_for_run(&mut self) {
        if self.runs.len() < MAX_EVENT_RUNS {
            return;
        }
        let overflow = self.runs.len() + 1 - MAX_EVENT_RUNS;
        self.runs.drain(0..overflow);
        self.selected_run = self.selected_run.saturating_sub(overflow);
    }

    pub fn open(&mut self) {
        self.modal_open = true;
        self.unread = false;
        self.focus = TestEventsFocus::Runs;
        self.selected_run = self.runs.len().saturating_sub(1);
        self.output.reset_for_source_change();
    }

    pub fn close(&mut self) {
        self.modal_open = false;
        self.output.search.close_interaction();
    }

    pub fn toggle_focus(&mut self) {
        self.focus = match self.focus {
            TestEventsFocus::Runs => TestEventsFocus::Events,
            TestEventsFocus::Events => TestEventsFocus::Runs,
        };
    }

    pub fn focus_events(&mut self) {
        self.focus = TestEventsFocus::Events;
    }

    pub fn select_next_run(&mut self) {
        if self.runs.is_empty() {
            return;
        }
        self.selected_run = (self.selected_run + 1).min(self.runs.len() - 1);
        self.output.reset_for_source_change();
    }

    pub fn select_previous_run(&mut self) {
        self.selected_run = self.selected_run.saturating_sub(1);
        self.output.reset_for_source_change();
    }

    pub fn selected_run(&self) -> Option<&TestEventRunLog> {
        self.runs.get(self.selected_run)
    }

    pub fn latest_event_label(&self) -> String {
        let Some(event) = self
            .runs
            .iter()
            .rev()
            .find_map(TestEventRunLog::latest_event)
        else {
            return "-".to_owned();
        };
        let suffix = if self.unread { "" } else { "" };
        format!("{}{}", event.summary, suffix)
    }

    pub fn output_text(&self) -> String {
        let Some(run) = self.selected_run() else {
            return "No test event runs yet.\nRun tests from Nextdeck to create an event stream."
                .to_owned();
        };
        if run.events.is_empty() {
            return format!("No events captured for run {}", run.id);
        }
        render_events(run)
    }
}

impl TestEventRunLog {
    fn new(run: TestEventRun, scope: String, status: &str) -> Self {
        Self {
            id: run.id,
            scope,
            status: status.to_owned(),
            events: VecDeque::new(),
            retained_bytes: 0,
            total_events: 0,
            events_truncated: false,
        }
    }

    fn append_event(&mut self, event: &TestEvent) {
        let event = RetainedTestEvent::new(event);
        self.retained_bytes += event.retained_bytes();
        self.total_events += 1;
        self.events.push_back(event);
        while self.events.len() > MAX_EVENTS_PER_RUN
            || self.retained_bytes > EVENT_RUN_RETENTION_BYTES
        {
            let Some(event) = self.events.pop_front() else {
                break;
            };
            self.retained_bytes -= event.retained_bytes();
            self.events_truncated = true;
        }
    }

    fn latest_event(&self) -> Option<&RetainedTestEvent> {
        self.events.back()
    }

    pub fn event_count(&self) -> usize {
        self.total_events
    }
}

impl RetainedTestEvent {
    fn new(event: &TestEvent) -> Self {
        Self {
            summary: bounded_text_with_limit(event_summary(event), EVENT_SUMMARY_LIMIT_BYTES),
            detail: bounded_text_with_limit(render_event_detail(event), EVENT_DETAIL_LIMIT_BYTES),
        }
    }

    fn retained_bytes(&self) -> usize {
        self.summary.len() + self.detail.len()
    }
}

pub fn create_run() -> TestEventRun {
    TestEventRun { id: run_id() }
}

pub fn parse_event_line(line: &str) -> Result<TestEvent, String> {
    let event = serde_json::from_str::<TestEvent>(line).map_err(|error| error.to_string())?;
    if event.schema_version != SCHEMA_VERSION {
        return Err(format!(
            "unsupported test event schema version {}, expected {}",
            event.schema_version, SCHEMA_VERSION
        ));
    }
    Ok(event)
}

fn render_events(run: &TestEventRunLog) -> String {
    let mut text = String::new();
    if run.events_truncated {
        append_bounded_text(&mut text, EVENTS_TRUNCATED_MARKER);
    }
    let first_index = run.total_events.saturating_sub(run.events.len()) + 1;
    for (offset, event) in run.events.iter().enumerate() {
        let index = first_index + offset;
        if offset > 0 {
            append_bounded_text(&mut text, "\n");
        }
        append_bounded_text(&mut text, &format!("#{index:<4} {}", event.detail));
    }
    text
}

fn render_event_detail(event: &TestEvent) -> String {
    let mut text = format!(
        "{:>13} {:<5} {:<24} {}\n",
        event.time,
        level_label(event.level),
        event.target.as_deref().unwrap_or("-"),
        event.message
    );
    if !event.fields.is_empty() {
        let fields = serde_json::to_string_pretty(&event.fields)
            .unwrap_or_else(|_| format!("{:?}", event.fields));
        for line in fields.lines() {
            text.push_str("      ");
            text.push_str(line);
            text.push('\n');
        }
    }
    if let Some(source) = &event.source {
        text.push_str(&format!(
            "      at {} {}:{}\n",
            source.module, source.file, source.line
        ));
    }
    text
}

pub fn inline_event_line(event: &TestEvent) -> String {
    event_summary_with_prefix(event, "@ event")
}

fn event_summary(event: &TestEvent) -> String {
    let target = event.target.as_deref().unwrap_or("-");
    if target == "-" {
        format!("{} {}", level_label(event.level), event.message)
    } else {
        format!("{} {}: {}", level_label(event.level), target, event.message)
    }
}

fn event_summary_with_prefix(event: &TestEvent, prefix: &str) -> String {
    let target = event.target.as_deref().unwrap_or("-");
    if target == "-" {
        format!("{prefix} {} {}", level_label(event.level), event.message)
    } else {
        format!(
            "{prefix} {} {}: {}",
            level_label(event.level),
            target,
            event.message
        )
    }
}

fn run_id() -> String {
    let millis = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_millis();
    let counter = RUN_COUNTER.fetch_add(1, Ordering::Relaxed);
    format!("{}-{}-{}", millis, std::process::id(), counter)
}

pub fn level_label(level: nextdeck_helper::Level) -> &'static str {
    match level {
        nextdeck_helper::Level::Trace => "trace",
        nextdeck_helper::Level::Debug => "debug",
        nextdeck_helper::Level::Info => "info",
        nextdeck_helper::Level::Warn => "warn",
        nextdeck_helper::Level::Error => "error",
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use nextdeck_helper::Level;
    use serde_json::json;

    #[test]
    fn parse_event_line_rejects_wrong_schema() {
        let error = parse_event_line(
            r#"{"schema_version":2,"sequence":1,"time":1,"level":"info","message":"x"}"#,
        )
        .unwrap_err();

        assert!(error.contains("unsupported test event schema version"));
    }

    #[test]
    fn state_tracks_unread_events_until_modal_opens() {
        let mut state = TestEventsState::default();
        state.begin_run(
            TestEventRun {
                id: "run-1".to_owned(),
            },
            "workspace".to_owned(),
        );

        state.append_event("run-1", TestEvent::new(Level::Info, "cache hit"));

        assert_eq!(state.latest_event_label(), "info cache hit •");

        state.open();

        assert_eq!(state.latest_event_label(), "info cache hit");
        assert!(state.output_text().contains("cache hit"));
    }

    #[test]
    fn render_events_includes_fields_and_source() {
        let event = TestEvent::new(Level::Info, "cache hit")
            .with_target("artifact-cache")
            .with_fields(std::collections::BTreeMap::from([(
                "key".to_owned(),
                json!("abc"),
            )]))
            .with_source("demo::tests", "src/lib.rs", 42);
        let mut run = TestEventRunLog::new(
            TestEventRun {
                id: "run-1".to_owned(),
            },
            "workspace".to_owned(),
            "passed",
        );
        run.append_event(&event);

        let text = render_events(&run);

        assert!(text.contains("artifact-cache"));
        assert!(text.contains("cache hit"));
        assert!(text.contains("\"key\": \"abc\""));
        assert!(text.contains("demo::tests src/lib.rs:42"));
    }

    #[test]
    fn state_bounds_events_by_count_and_preserves_total() {
        let mut state = TestEventsState::default();
        state.begin_run(
            TestEventRun {
                id: "run-1".to_owned(),
            },
            "workspace".to_owned(),
        );
        for index in 0..MAX_EVENTS_PER_RUN + 5 {
            state.append_event(
                "run-1",
                TestEvent::new(Level::Info, format!("event-{index}")),
            );
        }

        let run = state.selected_run().expect("run exists");
        assert_eq!(run.event_count(), MAX_EVENTS_PER_RUN + 5);
        assert_eq!(run.events.len(), MAX_EVENTS_PER_RUN);
        assert!(run.events_truncated);
        assert!(state.output_text().contains("earlier events discarded"));
        assert!(state.output_text().contains("event-2004"));
    }

    #[test]
    fn state_bounds_event_details_by_bytes() {
        let mut state = TestEventsState::default();
        state.begin_run(
            TestEventRun {
                id: "run-1".to_owned(),
            },
            "workspace".to_owned(),
        );
        for index in 0..20 {
            state.append_event(
                "run-1",
                TestEvent::new(
                    Level::Info,
                    format!("event-{index} {}", "x".repeat(100_000)),
                ),
            );
        }

        let run = state.selected_run().expect("run exists");
        assert!(run.retained_bytes <= EVENT_RUN_RETENTION_BYTES);
        assert!(run.events_truncated);
        assert!(state.output_text().len() <= OUTPUT_TEXT_LIMIT_BYTES);
    }

    #[test]
    fn creates_unique_in_memory_runs() {
        assert_ne!(create_run().id, create_run().id);
    }
}