crates/forge_domain/src/error.rs

use std::pin::Pin;

use derive_more::From;
use forge_json_repair::JsonRepairError;
use thiserror::Error;

use crate::{AgentId, ConversationId, ProviderId, WorkspaceId};

// NOTE: Deriving From for error is a really bad idea. This is because you end
// up converting errors incorrectly without much context. For eg: You don't want
// all serde error to be treated as the same. Instead we want to know exactly
// where that serde failure happened and for what kind of value.
#[derive(Debug, Error, From)]
pub enum Error {
    #[error("Missing tool name")]
    ToolCallMissingName,

    #[error("Missing tool id")]
    ToolCallMissingId,

    #[error("Unsupported role: {0}")]
    #[from(skip)]
    UnsupportedRole(String),

    #[error("{0}")]
    EToolCallArgument(ToolCallArgumentError),

    #[error("JSON deserialization error: {error}")]
    #[from(skip)]
    ToolCallArgument {
        error: JsonRepairError,
        args: String,
    },

    #[error("JSON deserialization error: {error}")]
    #[from(skip)]
    AgentCallArgument { error: serde_json::error::Error },

    #[error("Invalid tool call XML: {0}")]
    #[from(skip)]
    ToolCallParse(String),

    #[error("Invalid conversation id: {0}")]
    ConversationId(uuid::Error),

    #[error("Agent not found in the arena: {0}")]
    AgentUndefined(AgentId),

    #[error("Variable not found in output: {0}")]
    #[from(skip)]
    UndefinedVariable(String),

    #[error("Head agent not found")]
    HeadAgentUndefined,

    #[error("Agent '{0}' has reached max turns of {1}")]
    MaxTurnsReached(AgentId, u64),

    #[error("Conversation with ID '{0}' not found")]
    ConversationNotFound(ConversationId),

    #[error("Missing description for agent: {0}")]
    #[from(skip)]
    MissingAgentDescription(AgentId),

    #[error("Missing model for agent: {0}")]
    #[from(skip)]
    MissingModel(AgentId),

    #[error("No model defined for agent: {0}")]
    #[from(skip)]
    NoModelDefined(AgentId),

    #[error("Empty completion received - no content, tool calls, or valid finish reason")]
    EmptyCompletion,

    #[error(
        "The model refused to generate a response (safety/content filter). \
         Retrying the same request will produce the same refusal - rephrase \
         the request or switch to a different model."
    )]
    Refusal,

    #[error(transparent)]
    Retryable(anyhow::Error),

    #[error("Environment variable {env_var} not found for provider {provider}")]
    EnvironmentVariableNotFound {
        provider: ProviderId,
        env_var: String,
    },

    #[error("Provider {provider} is not available. Login again to configure it.")]
    ProviderNotAvailable { provider: ProviderId },

    #[error("Failed to create VertexAI provider: {message}")]
    VertexAiConfiguration { message: String },

    // Indexing errors
    #[error("No indexing authentication found")]
    AuthTokenNotFound,

    #[error("Workspace not found")]
    WorkspaceNotFound,

    #[error("Workspace already initialized with id: {0}")]
    WorkspaceAlreadyInitialized(WorkspaceId),

    #[error("Failed to sync {count} file(s)")]
    SyncFailed { count: usize },

    #[error("No default provider and model configured.")]
    NoDefaultSession,
}

pub type Result<A> = std::result::Result<A, Error>;
pub type BoxStream<A, E> =
    Pin<Box<dyn tokio_stream::Stream<Item = std::result::Result<A, E>> + Send>>;

pub type ResultStream<A, E> = std::result::Result<BoxStream<A, E>, E>;

#[derive(Debug, derive_more::From)]
pub struct ToolCallArgumentError(eserde::DeserializationErrors);

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

impl std::fmt::Display for ToolCallArgumentError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "Invalid tool call arguments:")?;
        for error in self.0.iter() {
            writeln!(f, "- {error}")?;
        }
        Ok(())
    }
}

impl Error {
    pub fn into_retryable(self) -> Self {
        use anyhow::anyhow;
        Self::Retryable(anyhow!(self))
    }

    pub fn env_var_not_found(provider: ProviderId, env_var: &str) -> Self {
        Self::EnvironmentVariableNotFound { provider, env_var: env_var.to_string() }
    }

    pub fn provider_not_available(provider: ProviderId) -> Self {
        Self::ProviderNotAvailable { provider }
    }

    pub fn vertex_ai_config(message: impl Into<String>) -> Self {
        Self::VertexAiConfiguration { message: message.into() }
    }

    pub fn sync_failed(count: usize) -> Self {
        Self::SyncFailed { count }
    }
}

#[cfg(test)]
mod test {
    use forge_json_repair::JsonRepairError;
    use serde_json::Value;

    use crate::Error;

    #[test]
    fn test_debug_serde_error() {
        let args = "{a: 1}";
        let serde_error = serde_json::from_str::<Value>(args).unwrap_err();
        let a = Error::ToolCallArgument {
            error: JsonRepairError::from(serde_error),
            args: args.to_string(),
        };
        let a = anyhow::anyhow!(a);
        eprintln!("{:?}", a.root_cause());
    }
}