canic-testkit 0.27.1

use std::{any::Any, panic::catch_unwind};

use pocket_ic::PocketIcBuilder;

use super::Pic;

///
/// PicStartError
///

#[derive(Debug, Eq, PartialEq)]
pub enum PicStartError {
    BinaryUnavailable { message: String },
    BinaryInvalid { message: String },
    DownloadFailed { message: String },
    ServerStartFailed { message: String },
    StartupTimedOut { message: String },
    Panic { message: String },
}

#[derive(Debug, Eq, PartialEq)]
pub(super) enum PicPanicKind {
    DeadInstanceTransport { message: String },
    Other { message: String },
}

pub(super) fn try_build_pic(builder: PocketIcBuilder) -> Result<Pic, PicStartError> {
    let build = catch_unwind(|| builder.build());

    match build {
        Ok(inner) => Ok(Pic { inner }),
        Err(payload) => Err(classify_pic_start_panic(payload)),
    }
}

impl std::fmt::Display for PicStartError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::BinaryUnavailable { message }
            | Self::BinaryInvalid { message }
            | Self::DownloadFailed { message }
            | Self::ServerStartFailed { message }
            | Self::StartupTimedOut { message }
            | Self::Panic { message } => f.write_str(message),
        }
    }
}

impl std::error::Error for PicStartError {}

// Extract a stable string message from one panic payload.
pub(super) fn panic_payload_to_string(payload: &(dyn Any + Send)) -> String {
    if let Some(message) = payload.downcast_ref::<String>() {
        return message.clone();
    }
    if let Some(message) = payload.downcast_ref::<&'static str>() {
        return (*message).to_string();
    }

    "non-string panic payload".to_string()
}

// Classify one panic payload so callers can recover dead-instance restores
// without repeating transport-string matching at each call site.
pub(super) fn classify_pic_panic(payload: Box<dyn Any + Send>) -> PicPanicKind {
    let message = panic_payload_to_string(payload.as_ref());

    if is_dead_instance_transport_error(&message) {
        return PicPanicKind::DeadInstanceTransport { message };
    }

    PicPanicKind::Other { message }
}

// Check whether one panic payload belongs to the dead-instance transport class
// without consuming it, so callers can still resume the original panic.
pub(super) fn panic_is_dead_instance_transport(payload: &(dyn Any + Send)) -> bool {
    matches!(
        classify_pic_panic(Box::new(panic_payload_to_string(payload))),
        PicPanicKind::DeadInstanceTransport { .. }
    )
}

// Detect the PocketIC transport failure class that means the owned instance
// has already died and cached snapshot restore should rebuild from scratch.
pub(super) fn is_dead_instance_transport_error(message: &str) -> bool {
    message.contains("ConnectionRefused")
        || message.contains("tcp connect error")
        || message.contains("IncompleteMessage")
        || message.contains("connection closed before message completed")
        || message.contains("channel closed")
}

// Classify one PocketIC startup panic into a typed public error.
fn classify_pic_start_panic(payload: Box<dyn Any + Send>) -> PicStartError {
    let message = match classify_pic_panic(payload) {
        PicPanicKind::DeadInstanceTransport { message } | PicPanicKind::Other { message } => {
            message
        }
    };

    if message.starts_with("Failed to validate PocketIC server binary") {
        if message.contains("No such file or directory") || message.contains("os error 2") {
            return PicStartError::BinaryUnavailable { message };
        }

        return PicStartError::BinaryInvalid { message };
    }

    if message.starts_with("Failed to download PocketIC server")
        || message.starts_with("Failed to write PocketIC server binary")
    {
        return PicStartError::DownloadFailed { message };
    }

    if message.starts_with("Failed to start PocketIC binary")
        || message.starts_with("Failed to create PocketIC server directory")
    {
        return PicStartError::ServerStartFailed { message };
    }

    if message.starts_with("Timed out waiting for PocketIC server being available") {
        return PicStartError::StartupTimedOut { message };
    }

    PicStartError::Panic { message }
}

#[cfg(test)]
mod tests {
    use super::{
        PicPanicKind, PicStartError, classify_pic_panic, classify_pic_start_panic,
        is_dead_instance_transport_error,
    };

    #[test]
    fn pic_start_error_classifies_missing_binary() {
        let error = classify_pic_start_panic(Box::new(
            "Failed to validate PocketIC server binary `/tmp/pocket-ic`: `No such file or directory (os error 2)`.".to_string(),
        ));

        assert!(matches!(error, PicStartError::BinaryUnavailable { .. }));
    }

    #[test]
    fn pic_start_error_classifies_failed_spawn() {
        let error = classify_pic_start_panic(Box::new(
            "Failed to start PocketIC binary (/tmp/pocket-ic)".to_string(),
        ));

        assert!(matches!(error, PicStartError::ServerStartFailed { .. }));
    }

    #[test]
    fn dead_instance_transport_error_detects_connection_refused() {
        assert!(is_dead_instance_transport_error(
            "reqwest::Error { source: ConnectError(\"tcp connect error\", 127.0.0.1:1234, Os { code: 111, kind: ConnectionRefused, message: \"Connection refused\" }) }"
        ));
    }

    #[test]
    fn dead_instance_transport_error_detects_incomplete_message() {
        assert!(is_dead_instance_transport_error(
            "reqwest::Error { source: hyper::Error(IncompleteMessage) }"
        ));
    }

    #[test]
    fn classify_pic_panic_marks_dead_instance_transport() {
        let classified = classify_pic_panic(Box::new(
            "reqwest::Error { source: hyper::Error(IncompleteMessage) }".to_string(),
        ));

        assert!(matches!(
            classified,
            PicPanicKind::DeadInstanceTransport { .. }
        ));
    }
}