bssh 2.4.3

Parallel SSH command execution tool for cluster management
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

// Copyright 2025 Lablup Inc. and Jeongkyu Shin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Ordered filtering, terminal delivery, and observation of remote output.

use std::io::{self, Write};

use super::escape_filter::EscapeSequenceFilter;

/// Filter remote bytes, write the surviving bytes, then commit only bytes the
/// terminal actually accepted to the protocol observer.
pub(super) fn deliver_filtered_output(
    filter: &mut EscapeSequenceFilter,
    writer: &mut impl Write,
    input: &[u8],
    commit: impl FnOnce(&[u8]),
) -> io::Result<()> {
    let output = filter.filter(input);
    if output.is_empty() {
        return Ok(());
    }

    writer.write_all(&output)?;
    commit(&output);
    let _ = writer.flush();
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::pty::terminal_screen::ScreenModeTracker;

    struct FailedWriter;

    impl Write for FailedWriter {
        fn write(&mut self, _buffer: &[u8]) -> io::Result<usize> {
            Err(io::Error::other("injected delivery failure"))
        }

        fn flush(&mut self) -> io::Result<()> {
            Ok(())
        }
    }

    #[test]
    fn failed_delivery_does_not_commit_screen_transition() {
        let mut filter = EscapeSequenceFilter::new();
        let mut tracker = ScreenModeTracker::new();
        let mut committed = false;

        let result =
            deliver_filtered_output(&mut filter, &mut FailedWriter, b"\x1b[?1049h", |output| {
                committed = true;
                tracker.observe(output);
            });

        assert!(result.is_err());
        assert!(!committed);
    }

    #[test]
    fn filtered_payload_does_not_commit_screen_transition() {
        let mut filter = EscapeSequenceFilter::new();
        let mut tracker = ScreenModeTracker::new();
        let mut output = Vec::new();
        let mut committed = false;

        deliver_filtered_output(
            &mut filter,
            &mut output,
            b"\x1b]10;payload\x1b[?1049h\x07",
            |delivered| {
                committed = true;
                tracker.observe(delivered);
            },
        )
        .unwrap();

        assert!(output.is_empty());
        assert!(!committed);
    }

    #[test]
    fn successful_delivery_commits_screen_transition() {
        let mut filter = EscapeSequenceFilter::new();
        let mut tracker = ScreenModeTracker::new();
        let mut output = Vec::new();
        let mut observed = None;

        deliver_filtered_output(&mut filter, &mut output, b"\x1b[?1049h", |delivered| {
            observed = tracker.observe(delivered);
        })
        .unwrap();

        assert_eq!(output, b"\x1b[?1049h");
        assert_eq!(observed, Some(true));
    }
}