fleche 6.22.0

Remote job runner for Slurm clusters
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

//! Job log viewing operations.

use crate::error::Result;
use crate::local;
use crate::registry::Registry;
use crate::runtime::RuntimeCtx;
use console::style;
use std::path::PathBuf;

use super::{job_path_from_workspace, status::resolve_job};

/// Options for displaying job logs.
#[derive(Debug, Default)]
pub struct ShowLogsOptions {
    /// Stream logs in real-time.
    pub follow: bool,
    /// Show only stdout.
    pub only_stdout: bool,
    /// Show only stderr.
    pub only_stderr: bool,
    /// Show only the last N lines.
    pub tail: Option<usize>,
    /// Strip ANSI escape codes from output.
    pub raw: bool,
    /// Shared runtime settings.
    pub ctx: RuntimeCtx,
}

/// Displays logs from a job's stdout or stderr.
pub async fn show_logs(
    job_id: Option<&str>,
    tags: &[(String, String)],
    note_filter: Option<&str>,
    opts: ShowLogsOptions,
) -> Result<()> {
    let registry = Registry::open()?;
    let job = resolve_job(&registry, job_id, tags, note_filter)?;

    // Determine which streams to show
    let show_stdout = !opts.only_stderr || opts.only_stdout;
    let show_stderr = !opts.only_stdout || opts.only_stderr;
    let show_both = show_stdout && show_stderr;

    // Strip ANSI codes if --raw is set or if stdout is not a terminal (piped)
    let strip_ansi = opts.raw || !std::io::IsTerminal::is_terminal(&std::io::stdout());

    // Handle local jobs
    if job.remote_host == "local" {
        let project_path = PathBuf::from(&job.project_path);

        if opts.follow {
            println!(
                "{}",
                style("Following output (Ctrl+C to disconnect)...").yellow()
            );
            local::follow_local_logs(&project_path, &job.id)?;
        } else if show_both {
            println!("{}", style("=== STDOUT ===").bold());
            match local::read_local_logs(
                &project_path,
                &job.id,
                local::LogStream::Stdout,
                opts.tail,
            ) {
                Ok(content) => print!("{}", maybe_strip_ansi(&content, strip_ansi)),
                Err(e) => eprintln!("Error reading stdout: {e}"),
            }

            println!();
            println!("{}", style("=== STDERR ===").bold());
            match local::read_local_logs(
                &project_path,
                &job.id,
                local::LogStream::Stderr,
                opts.tail,
            ) {
                Ok(content) => print!("{}", maybe_strip_ansi(&content, strip_ansi)),
                Err(e) => eprintln!("Error reading stderr: {e}"),
            }
        } else {
            let stream = if show_stderr {
                local::LogStream::Stderr
            } else {
                local::LogStream::Stdout
            };
            let content = local::read_local_logs(&project_path, &job.id, stream, opts.tail)?;
            print!("{}", maybe_strip_ansi(&content, strip_ansi));
        }

        return Ok(());
    }

    // Remote job handling
    let ssh = opts.ctx.ssh(&job.remote_host);

    let log_base = job_path_from_workspace(&job.remote_path, &job.id);

    if opts.follow {
        let paths = if opts.only_stderr {
            vec![format!("{log_base}/job.err")]
        } else if opts.only_stdout {
            vec![format!("{log_base}/job.out")]
        } else {
            vec![format!("{log_base}/job.out"), format!("{log_base}/job.err")]
        };
        let path_refs: Vec<&str> = paths.iter().map(String::as_str).collect();

        if job.slurm_id.is_some() {
            println!(
                "{}",
                style("Following output (Ctrl+C to disconnect)...").yellow()
            );
        }
        let mut child = ssh.tail_follow(&path_refs)?;
        let _ = child.wait().await;
    } else if show_both {
        println!("{}", style("=== STDOUT ===").bold());
        let stdout_path = format!("{log_base}/job.out");
        match ssh.cat_tail(&stdout_path, opts.tail).await {
            Ok(content) => print!("{}", maybe_strip_ansi(&content, strip_ansi)),
            Err(e) => eprintln!("Error reading stdout: {e}"),
        }

        println!();
        println!("{}", style("=== STDERR ===").bold());
        let stderr_path = format!("{log_base}/job.err");
        match ssh.cat_tail(&stderr_path, opts.tail).await {
            Ok(content) => print!("{}", maybe_strip_ansi(&content, strip_ansi)),
            Err(e) => eprintln!("Error reading stderr: {e}"),
        }
    } else {
        let log_file = if show_stderr { "job.err" } else { "job.out" };
        let log_path = format!("{log_base}/{log_file}");

        let content = ssh.cat_tail(&log_path, opts.tail).await?;
        print!("{}", maybe_strip_ansi(&content, strip_ansi));
    }

    Ok(())
}

/// Strips ANSI escape codes from a string if `strip` is true.
fn maybe_strip_ansi(s: &str, strip: bool) -> std::borrow::Cow<'_, str> {
    if strip {
        strip_ansi_codes(s).into()
    } else {
        s.into()
    }
}

/// Strips ANSI escape codes from a string.
///
/// Handles common ANSI sequences: CSI (ESC [), OSC (ESC ]), and basic escape codes.
fn strip_ansi_codes(s: &str) -> String {
    let mut result = String::with_capacity(s.len());
    let mut chars = s.chars().peekable();

    while let Some(c) = chars.next() {
        if c == '\x1b' {
            // ESC character - start of escape sequence
            match chars.peek() {
                Some('[') => {
                    // CSI sequence: ESC [ ... (ends with letter or @-~)
                    chars.next(); // consume '['
                    while let Some(&nc) = chars.peek() {
                        chars.next();
                        if nc.is_ascii_alphabetic() || ('@'..='~').contains(&nc) {
                            break;
                        }
                    }
                }
                Some(']') => {
                    // OSC sequence: ESC ] ... (ends with BEL or ST)
                    chars.next(); // consume ']'
                    while let Some(&nc) = chars.peek() {
                        chars.next();
                        if nc == '\x07' {
                            // BEL
                            break;
                        }
                        if nc == '\x1b' {
                            // ST (ESC \)
                            if chars.peek() == Some(&'\\') {
                                chars.next();
                            }
                            break;
                        }
                    }
                }
                Some('(' | ')') => {
                    // Character set selection: ESC ( or ESC )
                    chars.next();
                    chars.next(); // skip the designator
                }
                _ => {
                    // Single-character escape or unknown - skip next char
                    chars.next();
                }
            }
        } else {
            result.push(c);
        }
    }

    result
}

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

    #[test]
    fn test_strip_ansi_codes_csi_colors() {
        // Basic color codes
        assert_eq!(strip_ansi_codes("\x1b[31mred\x1b[0m"), "red");
        assert_eq!(
            strip_ansi_codes("\x1b[1;32mbold green\x1b[0m"),
            "bold green"
        );
        assert_eq!(
            strip_ansi_codes("\x1b[38;5;196mextended\x1b[0m"),
            "extended"
        );
    }

    #[test]
    fn test_strip_ansi_codes_csi_cursor() {
        // Cursor movement
        assert_eq!(strip_ansi_codes("\x1b[2Jclear"), "clear");
        assert_eq!(strip_ansi_codes("\x1b[10;20Hposition"), "position");
    }

    #[test]
    fn test_strip_ansi_codes_osc() {
        // OSC sequences (terminal title, notifications)
        assert_eq!(strip_ansi_codes("\x1b]0;title\x07text"), "text");
        assert_eq!(strip_ansi_codes("\x1b]9;notification\x07text"), "text");
    }

    #[test]
    fn test_strip_ansi_codes_preserves_text() {
        assert_eq!(strip_ansi_codes("plain text"), "plain text");
        assert_eq!(strip_ansi_codes("line1\nline2"), "line1\nline2");
        assert_eq!(strip_ansi_codes(""), "");
    }

    #[test]
    fn test_strip_ansi_codes_complex() {
        let input = "\x1b[1mBold\x1b[0m and \x1b[31mred\x1b[0m text";
        assert_eq!(strip_ansi_codes(input), "Bold and red text");
    }

    #[test]
    fn test_strip_ansi_codes_progress_bar() {
        // Common progress bar output with cursor control
        let input = "Progress: \x1b[32m50%\x1b[0m \x1b[K";
        assert_eq!(strip_ansi_codes(input), "Progress: 50% ");
    }
}