ostool 0.14.0

A tool for operating system development
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

use anyhow::Context as _;
use futures::{SinkExt, StreamExt};
use serde::Deserialize;
use tokio::sync::mpsc;
use tokio_tungstenite::tungstenite::Message;

use crate::sterm::{AsyncTerminal, TerminalConfig};

#[derive(Debug, Deserialize)]
pub(crate) struct ServerControlMessage {
    #[serde(rename = "type")]
    pub(crate) kind: String,
    pub(crate) message: Option<String>,
}

pub async fn run_serial_terminal(ws_url: reqwest::Url) -> anyhow::Result<()> {
    let (stream, _) = tokio_tungstenite::connect_async(ws_url.as_str())
        .await
        .with_context(|| format!("failed to connect serial websocket {}", ws_url))?;
    let (mut sink, mut stream) = stream.split();

    let (inbound_tx, inbound_rx) = mpsc::unbounded_channel::<Vec<u8>>();
    let (outbound_tx, mut outbound_rx) = mpsc::unbounded_channel::<Vec<u8>>();

    let read_task = tokio::spawn(async move {
        while let Some(message) = stream.next().await {
            match message.context("serial websocket read failed")? {
                Message::Binary(bytes) => {
                    if inbound_tx.send(bytes.to_vec()).is_err() {
                        break;
                    }
                }
                Message::Text(text) => {
                    if let Ok(control) = serde_json::from_str::<ServerControlMessage>(&text) {
                        match control.kind.as_str() {
                            "opened" | "closed" => continue,
                            "error" => {
                                let message = control
                                    .message
                                    .unwrap_or_else(|| "serial websocket error".to_string());
                                let formatted = format!("\n[ostool-server] {message}\n");
                                if inbound_tx.send(formatted.into_bytes()).is_err() {
                                    break;
                                }
                                break;
                            }
                            _ => {}
                        }
                    }
                    if inbound_tx.send(text.bytes().collect()).is_err() {
                        break;
                    }
                }
                Message::Close(_) => break,
                Message::Ping(_) | Message::Pong(_) | Message::Frame(_) => {}
            }
        }

        Ok::<(), anyhow::Error>(())
    });

    let write_task = tokio::spawn(async move {
        while let Some(bytes) = outbound_rx.recv().await {
            sink.send(Message::Binary(bytes.into()))
                .await
                .context("serial websocket write failed")?;
        }

        let _ = sink
            .send(Message::Text(r#"{"type":"close"}"#.to_string().into()))
            .await;
        let _ = sink.send(Message::Close(None)).await;
        Ok::<(), anyhow::Error>(())
    });

    let terminal = AsyncTerminal::new(TerminalConfig {
        intercept_exit_sequence: true,
        timeout: None,
        timeout_label: "remote serial terminal".to_string(),
    });
    let run_result = terminal
        .run(inbound_rx, outbound_tx, |_handle, _byte| {})
        .await;

    read_task.abort();
    if let Err(err) = write_task.await
        && !err.is_cancelled()
    {
        log::debug!("serial websocket writer join error: {err}");
    }
    if let Err(err) = read_task.await
        && !err.is_cancelled()
    {
        log::debug!("serial websocket reader join error: {err}");
    }

    run_result
}

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

    #[test]
    fn parse_server_control_message() {
        let opened: ServerControlMessage = serde_json::from_str(r#"{"type":"opened"}"#).unwrap();
        assert_eq!(opened.kind, "opened");
    }

    #[test]
    fn parse_server_error_control_message() {
        let error: ServerControlMessage =
            serde_json::from_str(r#"{"type":"error","message":"power failed"}"#).unwrap();
        assert_eq!(error.kind, "error");
        assert_eq!(error.message.as_deref(), Some("power failed"));
    }
}