introduce client::RecvError

Author: dignifiedquire

iroh-relay/src/client.rs

@@ -20,7 +20,7 @@ use tracing::warn;
 use tracing::{debug, event, trace, Level};
 use url::Url;
 
-pub use self::conn::{ConnSendError, HandshakeError, ReceivedMessage, SendMessage};
+pub use self::conn::{ConnSendError, HandshakeError, ReceivedMessage, RecvError, SendMessage};
 #[cfg(not(wasm_browser))]
 use crate::dns::{DnsResolver, Error as DnsError};
 use crate::{
@@ -110,8 +110,6 @@ pub enum Error {
     Timeout(#[from] time::Elapsed),
     #[error(transparent)]
     Http(#[from] hyper::http::Error),
-    #[error("Unexpected frame received {0}")]
-    UnexpectedFrame(crate::protos::relay::FrameType),
     #[error(transparent)]
     Utf8(#[from] std::str::Utf8Error),
     #[cfg(wasm_browser)]
@@ -298,7 +296,7 @@ impl Client {
 }
 
 impl Stream for Client {
-    type Item = Result<ReceivedMessage, Error>;
+    type Item = Result<ReceivedMessage, RecvError>;
 
     fn poll_next(mut self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Option<Self::Item>> {
         Pin::new(&mut self.conn).poll_next(cx)
@@ -384,7 +382,7 @@ impl ClientStream {
 }
 
 impl Stream for ClientStream {
-    type Item = Result<ReceivedMessage, Error>;
+    type Item = Result<ReceivedMessage, RecvError>;
 
     fn poll_next(mut self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Option<Self::Item>> {
         Pin::new(&mut self.stream).poll_next(cx)

iroh-relay/src/client/conn.rs

@@ -16,7 +16,7 @@ use tokio_tungstenite_wasm::WebSocketStream;
 use tokio_util::codec::Framed;
 use tracing::debug;
 
-use super::{ConnectError, Error, KeyCache};
+use super::{ConnectError, KeyCache};
 use crate::protos::{
     self,
     relay::{ClientInfo, Frame, MAX_PACKET_SIZE, PROTOCOL_VERSION},
@@ -28,7 +28,7 @@ use crate::{client::streams::MaybeTlsStreamChained, protos::relay::RelayCodec};
 #[derive(Debug, thiserror::Error)]
 pub enum ConnSendError {
     /// An IO error.
-    #[error("IO error")]
+    #[error(transparent)]
     Io(#[from] io::Error),
     /// A protocol error.
     #[error("Protocol error")]
@@ -43,6 +43,23 @@ pub enum HandshakeError {
     Send(#[from] protos::relay::Error),
 }
 
+/// Errors when receiving messages from the relay server.
+#[derive(Debug, thiserror::Error)]
+#[allow(missing_docs)]
+pub enum RecvError {
+    /// An IO error.
+    #[error(transparent)]
+    Io(#[from] io::Error),
+    #[error(transparent)]
+    Protocol(#[from] crate::protos::relay::Error),
+    #[error(transparent)]
+    Websocket(#[from] tokio_tungstenite_wasm::Error),
+    #[error("invalid protocol message encoding")]
+    InvalidProtocolMessageEncoding,
+    #[error("Unexpected frame received {0}")]
+    UnexpectedFrame(crate::protos::relay::FrameType),
+}
+
 impl From<tokio_tungstenite_wasm::Error> for ConnSendError {
     fn from(source: tokio_tungstenite_wasm::Error) -> Self {
         let io_err = match source {
@@ -125,7 +142,7 @@ async fn server_handshake(writer: &mut Conn, secret_key: &SecretKey) -> Result<(
 }
 
 impl Stream for Conn {
-    type Item = Result<ReceivedMessage, Error>;
+    type Item = Result<ReceivedMessage, RecvError>;
 
     fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
         match *self {
@@ -303,7 +320,7 @@ pub enum ReceivedMessage {
 }
 
 impl TryFrom<Frame> for ReceivedMessage {
-    type Error = Error;
+    type Error = RecvError;
 
     fn try_from(frame: Frame) -> std::result::Result<Self, Self::Error> {
         match frame {
@@ -323,7 +340,9 @@ impl TryFrom<Frame> for ReceivedMessage {
             Frame::Ping { data } => Ok(ReceivedMessage::Ping(data)),
             Frame::Pong { data } => Ok(ReceivedMessage::Pong(data)),
             Frame::Health { problem } => {
-                let problem = std::str::from_utf8(&problem)?.to_owned();
+                let problem = std::str::from_utf8(&problem)
+                    .map_err(|_| RecvError::InvalidProtocolMessageEncoding)?
+                    .to_owned();
                 let problem = Some(problem);
                 Ok(ReceivedMessage::Health { problem })
             }
@@ -338,7 +357,7 @@ impl TryFrom<Frame> for ReceivedMessage {
                     try_for,
                 })
             }
-            _ => Err(Error::UnexpectedFrame(frame.typ())),
+            _ => Err(RecvError::UnexpectedFrame(frame.typ())),
         }
     }
 }

iroh-relay/src/server/http_server.rs

@@ -821,7 +821,7 @@ mod tests {
     }
 
     fn process_msg(
-        msg: Option<Result<ReceivedMessage, crate::client::Error>>,
+        msg: Option<Result<ReceivedMessage, crate::client::RecvError>>,
     ) -> Option<(PublicKey, Bytes)> {
         match msg {
             Some(Err(e)) => {