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

use std::fmt::{Display, Formatter};

use tokio_tungstenite::tungstenite::Error as TungsteniteError;

use ockam_core::Error;
use ockam_transport_core::TransportError;

/// A WebSocket connection worker specific error type
#[derive(Clone, Copy, Debug)]
#[non_exhaustive]
pub enum WebSocketError {
    /// A wrapped transport error
    Transport(TransportError),
    /// HTTP error
    Http,
    /// TLS error
    Tls,
}

impl WebSocketError {
    /// Integer code associated with the error domain.
    pub const DOMAIN_CODE: u32 = 21_000;
    /// Error domain
    pub const DOMAIN_NAME: &'static str = "OCKAM_TRANSPORT_WEBSOCKET";

    pub fn code(&self) -> u32 {
        match self {
            WebSocketError::Transport(_) => 0,
            WebSocketError::Http => 0,
            WebSocketError::Tls => 1,
        }
    }
}

impl Display for WebSocketError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let err: Error = (*self).into();
        err.fmt(f)
    }
}

impl From<WebSocketError> for Error {
    fn from(e: WebSocketError) -> Error {
        match e {
            WebSocketError::Transport(e) => e.into(),
            _ => Error::new(
                WebSocketError::DOMAIN_CODE + e.code(),
                WebSocketError::DOMAIN_NAME,
            ),
        }
    }
}

impl From<TungsteniteError> for WebSocketError {
    fn from(e: TungsteniteError) -> Self {
        match e {
            TungsteniteError::ConnectionClosed => Self::Transport(TransportError::ConnectionDrop),
            TungsteniteError::AlreadyClosed => Self::Transport(TransportError::ConnectionDrop),
            TungsteniteError::Io(_) => Self::Transport(TransportError::GenericIo),
            TungsteniteError::Url(_) => Self::Transport(TransportError::InvalidAddress),
            TungsteniteError::HttpFormat(_) => Self::Transport(TransportError::InvalidAddress),
            TungsteniteError::Capacity(_) => Self::Transport(TransportError::Capacity),
            TungsteniteError::Utf8 => Self::Transport(TransportError::Encoding),
            TungsteniteError::Protocol(_) => Self::Transport(TransportError::Protocol),
            TungsteniteError::SendQueueFull(_) => Self::Transport(TransportError::SendBadMessage),
            TungsteniteError::Http(_) => Self::Http,
            TungsteniteError::Tls(_) => Self::Tls,
        }
    }
}

impl<T> From<futures_channel::mpsc::TrySendError<T>> for WebSocketError {
    fn from(_e: futures_channel::mpsc::TrySendError<T>) -> Self {
        Self::Transport(TransportError::GenericIo)
    }
}

impl From<futures_channel::mpsc::SendError> for WebSocketError {
    fn from(_e: futures_channel::mpsc::SendError) -> Self {
        Self::Transport(TransportError::GenericIo)
    }
}

#[cfg(test)]
mod test {
    use tokio_tungstenite::tungstenite::http::Response;

    use ockam_core::hashbrown::HashMap;

    use super::*;

    #[test]
    fn code_and_domain() {
        let ws_errors_map = [
            (13, WebSocketError::Transport(TransportError::GenericIo)),
            (0, WebSocketError::Http),
            (1, WebSocketError::Tls),
        ]
        .into_iter()
        .collect::<HashMap<_, _>>();
        for (expected_code, ws_err) in ws_errors_map {
            let err: Error = ws_err.into();
            match ws_err {
                WebSocketError::Transport(_) => {
                    assert_eq!(err.domain(), TransportError::DOMAIN_NAME);
                    assert_eq!(err.code(), TransportError::DOMAIN_CODE + expected_code);
                }
                _ => {
                    assert_eq!(err.domain(), WebSocketError::DOMAIN_NAME);
                    assert_eq!(err.code(), WebSocketError::DOMAIN_CODE + expected_code);
                }
            }
        }
    }

    #[test]
    fn from_tungstenite_error_to_transport_error() {
        let ts_err = TungsteniteError::ConnectionClosed;
        let ws_err: WebSocketError = ts_err.into();
        let err: Error = ws_err.into();
        let expected_err_code = TransportError::ConnectionDrop as u32;
        assert_eq!(err.domain(), TransportError::DOMAIN_NAME);
        assert_eq!(err.code(), TransportError::DOMAIN_CODE + expected_err_code);
    }

    #[test]
    fn from_tungstenite_error_to_websocket_error() {
        let ts_err = TungsteniteError::Http(Response::new(None));
        let ws_err: WebSocketError = ts_err.into();
        let err: Error = ws_err.into();
        let expected_err_code = (WebSocketError::Http).code();
        assert_eq!(err.domain(), WebSocketError::DOMAIN_NAME);
        assert_eq!(err.code(), WebSocketError::DOMAIN_CODE + expected_err_code);
    }
}