agntcy-slim-session 0.3.0

// Copyright AGNTCY Contributors (https://github.com/agntcy)
// SPDX-License-Identifier: Apache-2.0

use slim_datapath::api::ProtoName;
use slim_datapath::errors::{ErrorPayload, MessageContext};
// Third-party crates
use thiserror::Error;

// Local crate
use slim_auth::errors::AuthError;
use slim_datapath::api::{ProtoMessage, ProtoSessionMessageType, ProtoSessionType};
use slim_datapath::messages::utils::MessageError;
use slim_mls::errors::MlsError;
use tonic::Status;

use crate::SessionMessage;
use crate::subscription_manager::SubscriptionAckError;

#[derive(Error, Debug)]
pub enum SessionError {
    // Transport and channel errors
    #[error("SLIM channel closed")]
    SlimChannelClosed,
    #[error("error receiving message from SLIM")]
    SlimReception(#[from] Status),

    // Message processing and validation errors
    #[error("message error")]
    MessageError(#[from] MessageError),
    #[error("missing removed participant in GroupRemove message")]
    MissingRemovedParticipantInGroupRemove,
    #[error("missing group name in JoinRequest message")]
    MissingGroupNameInJoinRequest,
    #[error("ping state not initialized")]
    PingStateNotInitialized,
    #[error("missing channel name for group session")]
    MissingChannelName,
    #[error("session type unknown: {0:?}")]
    SessionTypeUnknown(ProtoSessionType),
    #[error("session message type unexpected: {0:?}")]
    SessionMessageInternalUnexpected(Box<SessionMessage>),
    #[error("session message type unknown: {0:?}")]
    SessionMessageTypeUnknown(ProtoSessionMessageType),
    #[error("message type unexpected: {0:?}")]
    MessageTypeUnexpected(Box<ProtoMessage>),
    #[error("session message type unexpected: {0:?}")]
    SessionMessageTypeUnexpected(ProtoSessionMessageType),
    #[error("error getting the participants list")]
    ParticipantsListQueryFailed,
    #[error("malformed participant settings")]
    MalformedParticipant,
    #[error("missing participant settings")]
    MissingParticipantSettings,
    #[error("unexpected error")]
    UnexpectedError { source: Box<SessionError> },

    // Lookup and missing entities
    #[error("session not found: {0}")]
    SessionNotFound(u32),
    #[error("subscription not found: {0}")]
    SubscriptionNotFound(ProtoName),

    // Session lifecycle and state
    #[error("session builder: not all required fields set")]
    SessionBuilderIncomplete,
    #[error("message lost for session id: {0}")]
    MessageLost(u32),
    #[error("session closed")]
    SessionClosed,
    #[error("receive timeout waiting for message")]
    ReceiveTimeout,
    #[error("session id already used: {0}")]
    SessionIdAlreadyUsed(u32),
    #[error("invalid session id: {0}")]
    InvalidSessionId(u32),

    // Cryptography (MLS)
    #[error("mls operation error")]
    MlsOp(#[from] MlsError),

    // Authorization and roles
    #[error("auth error")]
    Auth(#[from] AuthError),

    // Acknowledgements and routing
    #[error("error receiving ack for message: {0}")]
    AckReception(String),
    #[error("subscription ack failed: {0}")]
    SubscriptionAckFailed(#[source] SubscriptionAckError),
    #[error("unknown destination: {0}")]
    UnknownDestination(ProtoName),

    // Session membership and permissions
    #[error("participant not found in group: {0}")]
    ParticipantNotFound(ProtoName),
    #[error("participant already in group: {0}")]
    ParticipantAlreadyInGroup(ProtoName),
    #[error("cannot invite participant to point-to-point session")]
    CannotInviteToP2P,
    #[error("cannot remove participant from point-to-point session")]
    CannotRemoveFromP2P,
    #[error("only initiator can modify participants")]
    NotInitiator,

    // Routing and delivery failures
    #[error("error sending session internal message to session controller")]
    SessionControllerSendFailed,
    #[error("error sending new session notification to app")]
    NewSessionSendFailed,
    #[error("error sending session delete message to session layer")]
    SessionDeleteMessageSendFailed,
    #[error("error sending data message to application")]
    ApplicationMessageSendFailed,
    #[error("error sending data message to slim")]
    SlimMessageSendFailed,
    #[error("send failure reported from slim: {ctx}")]
    SlimSendFailure { ctx: Box<ErrorPayload> },

    // Session lifecycle and state (continued)
    #[error("session is draining - drop message")]
    SessionDrainingDrop,
    #[error("session already closed")]
    SessionAlreadyClosed,
    #[error("session cleanup failed: {details}")]
    SessionCleanupFailed { details: String },
    #[error("message send retries exhausted for id={id}")]
    MessageSendRetryFailed { id: u32 },
    #[error("message receive retries exhausted for id={id}")]
    MessageReceiveRetryFailed { id: u32 },
    #[error("session sender is shutdown, cannot send messages")]
    SessionSenderShutdown,
    #[error("session receiver is shutdown, cannot receive messages")]
    SessionReceiverShutdown,
    #[error("missing participant name on timer")]
    MissingParticipantNameOnTimer,

    // Message construction and extraction contexts
    #[error("missing payload: {context}")]
    MissingPayload { context: &'static str },
    #[error("message build failed: {0}")]
    MessageBuild(MessageError),
    #[error("message payload extract failed in {context}: {source}")]
    PayloadExtract {
        context: &'static str,
        source: MessageError,
    },

    // Participant connectivity
    #[error("missing mls payload in welcome message")]
    WelcomeMessageMissingMlsPayload,
    #[error("invalid join request payload")]
    InvalidJoinRequestPayload,
    #[error("participant disconnected: {0}")]
    ParticipantDisconnected(ProtoName),
    #[error("missing participant name on disconnection event")]
    MissingParticipantNameOnDisconnection,

    // Moderator task orchestration
    #[error("no pending requests for the given key: {0}")]
    TimerNotFound(u32),
    #[error("phase not supported for task")]
    ModeratorTaskUnsupportedPhase,
    #[error("unexpected timer id: {0}")]
    ModeratorTaskUnexpectedTimerId(u32),
    #[error("failed to add participant to session")]
    ModeratorTaskAddFailed { source: Box<SessionError> },
    #[error("failed to remove participant from session")]
    ModeratorTaskRemoveFailed { source: Box<SessionError> },
    #[error("failed to update session")]
    ModeratorTaskUpdateFailed { source: Box<SessionError> },
    #[error("failed to close session")]
    ModeratorTaskCloseFailed { source: Box<SessionError> },
}

impl SessionError {
    // Helper constructors for structured mapping without repeating strings.
    pub fn build_error(err: MessageError) -> Self {
        SessionError::MessageBuild(err)
    }
    pub fn extract_error(context: &'static str, err: MessageError) -> Self {
        SessionError::PayloadExtract {
            context,
            source: err,
        }
    }
    pub fn cleanup_failed<E: std::fmt::Display>(e: E) -> Self {
        SessionError::SessionCleanupFailed {
            details: e.to_string(),
        }
    }

    // Helpers to construct new structured retry failure variants
    pub fn send_retry_failed(id: u32) -> Self {
        SessionError::MessageSendRetryFailed { id }
    }

    pub fn receive_retry_failed(id: u32) -> Self {
        SessionError::MessageReceiveRetryFailed { id }
    }

    /// Extract session context from SlimSendFailure error
    /// Returns None if the error is not a SlimSendFailure or if it lacks session context
    pub fn session_context(&self) -> Option<&MessageContext> {
        match self {
            SessionError::SlimSendFailure { ctx } => ctx.session_context.as_ref(),
            _ => None,
        }
    }

    /// Check if this error is for a command message
    pub fn is_command_message_error(&self) -> bool {
        self.session_context()
            .map(|ctx| ctx.get_session_message_type().is_command_message())
            .unwrap_or(false)
    }
}