h3x 0.6.0-beta.1

//! Shared IPC error types.
//!
//! These types are used by both the connection-level ([`super::quic`]) and
//! session-level ([`super::webtransport`]) IPC modules.

use serde::{Deserialize, Serialize};
use snafu::Snafu;

use crate::quic::ConnectionError;

// ---------------------------------------------------------------------------
// Error types
// ---------------------------------------------------------------------------

/// Infrastructure-level error for IPC plumbing failures.
///
/// This type captures failures in the RPC transport or OS-level I/O
/// (socketpair creation, FD conversion, queue operations).  It deliberately
/// excludes stream-level errors ([`StreamError`](crate::quic::StreamError)),
/// which are application-layer concerns carried in [`Resolved`](crate::util::deferred::Resolved).
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, Snafu)]
#[snafu(module(ipc_plumbing_error), visibility(pub))]
pub enum IpcPlumbingError {
    /// RPC call failed.
    #[snafu(transparent)]
    Rpc { source: remoc::rtc::CallError },

    /// OS-level or infrastructure I/O failure.
    #[snafu(display("{message}"))]
    Io { message: String },
}

/// Errors from IPC `open_bi` / `open_uni` operations at the connection level.
///
/// Distinguishes between connection-level failures (the connection itself is
/// broken) and plumbing failures (the IPC infrastructure failed).
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, Snafu)]
#[snafu(module(ipc_open_error), visibility(pub))]
pub enum IpcOpenError {
    /// The underlying connection failed.
    #[snafu(transparent)]
    Connection { source: ConnectionError },

    /// IPC plumbing failure (RPC or I/O).
    #[snafu(transparent)]
    Plumbing { source: IpcPlumbingError },
}

/// Errors from IPC `accept_bi` / `accept_uni` operations at the connection level.
///
/// Structurally identical to [`IpcOpenError`] but kept separate for
/// type-level distinction between open and accept paths.
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, Snafu)]
#[snafu(module(ipc_accept_error), visibility(pub))]
pub enum IpcAcceptError {
    /// The underlying connection failed.
    #[snafu(transparent)]
    Connection { source: ConnectionError },

    /// IPC plumbing failure (RPC or I/O).
    #[snafu(transparent)]
    Plumbing { source: IpcPlumbingError },
}

// ---------------------------------------------------------------------------
// Conversions
// ---------------------------------------------------------------------------

impl From<remoc::rtc::CallError> for IpcOpenError {
    fn from(error: remoc::rtc::CallError) -> Self {
        IpcPlumbingError::Rpc { source: error }.into()
    }
}

impl From<remoc::rtc::CallError> for IpcAcceptError {
    fn from(error: remoc::rtc::CallError) -> Self {
        IpcPlumbingError::Rpc { source: error }.into()
    }
}

#[cfg(test)]
mod tests {
    use std::error::Error as _;

    use super::*;
    use crate::{error::Code, quic::ApplicationError, varint::VarInt};

    #[test]
    fn plumbing_io_error_displays_message() {
        let error = IpcPlumbingError::Io {
            message: "socketpair failed".to_owned(),
        };

        assert_eq!(error.to_string(), "socketpair failed");
    }

    #[test]
    fn plumbing_io_error_preserves_message_and_has_no_source() {
        let error = IpcPlumbingError::Io {
            message: "socketpair failed".to_owned(),
        };

        let IpcPlumbingError::Io { message } = &error else {
            panic!("expected io plumbing error");
        };
        assert_eq!(message, "socketpair failed");
        assert!(error.source().is_none());
    }

    #[test]
    fn plumbing_rpc_error_displays_like_call_error() {
        let source = remoc::rtc::CallError::Dropped;
        let expected = source.to_string();
        let error = IpcPlumbingError::Rpc { source };

        assert_eq!(error.to_string(), expected);
    }

    #[test]
    fn plumbing_error_converts_to_open_and_accept_errors() {
        let open_error = IpcOpenError::from(IpcPlumbingError::Io {
            message: "open socketpair failed".to_owned(),
        });
        let IpcOpenError::Plumbing { source } = open_error else {
            panic!("plumbing error should stay plumbing-scoped on open");
        };
        assert_eq!(source.to_string(), "open socketpair failed");

        let accept_error = IpcAcceptError::from(IpcPlumbingError::Io {
            message: "accept socketpair failed".to_owned(),
        });
        let IpcAcceptError::Plumbing { source } = accept_error else {
            panic!("plumbing error should stay plumbing-scoped on accept");
        };
        assert_eq!(source.to_string(), "accept socketpair failed");
    }

    #[test]
    fn open_and_accept_io_plumbing_errors_display_inner_message() {
        let open_error = IpcOpenError::from(IpcPlumbingError::Io {
            message: "open socketpair failed".to_owned(),
        });
        assert_eq!(open_error.to_string(), "open socketpair failed");

        let accept_error = IpcAcceptError::from(IpcPlumbingError::Io {
            message: "accept socketpair failed".to_owned(),
        });
        assert_eq!(accept_error.to_string(), "accept socketpair failed");
    }

    #[test]
    fn call_error_converts_to_open_plumbing_error() {
        let error = IpcOpenError::from(remoc::rtc::CallError::Dropped);
        let IpcOpenError::Plumbing {
            source: IpcPlumbingError::Rpc { source },
        } = error
        else {
            panic!("call error should map to open plumbing error");
        };

        assert!(matches!(source, remoc::rtc::CallError::Dropped));
    }

    #[test]
    fn call_error_converts_to_accept_plumbing_error() {
        let error = IpcAcceptError::from(remoc::rtc::CallError::Dropped);
        let IpcAcceptError::Plumbing {
            source: IpcPlumbingError::Rpc { source },
        } = error
        else {
            panic!("call error should map to accept plumbing error");
        };

        assert!(matches!(source, remoc::rtc::CallError::Dropped));
    }

    #[test]
    fn connection_error_stays_connection_scoped_on_open_and_accept() {
        let source = ConnectionError::Application {
            source: ApplicationError {
                code: Code::new(VarInt::from_u32(7)),
                reason: "application closed".into(),
            },
        };

        let open_error = IpcOpenError::from(source.clone());
        let IpcOpenError::Connection {
            source: open_source,
        } = open_error
        else {
            panic!("connection error should stay connection-scoped on open");
        };
        assert!(open_source.is_application());

        let accept_error = IpcAcceptError::from(source);
        let IpcAcceptError::Connection {
            source: accept_source,
        } = accept_error
        else {
            panic!("connection error should stay connection-scoped on accept");
        };
        assert!(accept_source.is_application());
    }
}