tuitbot_core/

error.rs

//! Error types for the Tuitbot core library.
//!
//! Each module has its own error enum to provide clear error boundaries.
//! The library uses `thiserror` for structured, typed errors.

/// Errors related to configuration loading, parsing, and validation.
#[derive(Debug, thiserror::Error)]
pub enum ConfigError {
    /// A required configuration field is absent.
    #[error("missing required config field: {field}")]
    MissingField {
        /// The name of the missing field.
        field: String,
    },

    /// A configuration field has an unacceptable value.
    #[error("invalid value for config field '{field}': {message}")]
    InvalidValue {
        /// The name of the invalid field.
        field: String,
        /// A description of why the value is invalid.
        message: String,
    },

    /// The configuration file does not exist at the specified path.
    #[error("config file not found: {path}")]
    FileNotFound {
        /// The path that was searched.
        path: String,
    },

    /// TOML deserialization failed.
    #[error("failed to parse config file: {source}")]
    ParseError {
        /// The underlying TOML parse error.
        #[source]
        source: toml::de::Error,
    },
}

/// Errors from interacting with the X (Twitter) API.
#[derive(Debug, thiserror::Error)]
pub enum XApiError {
    /// X API returned HTTP 429 (rate limited).
    #[error("X API rate limited{}", match .retry_after {
        Some(secs) => format!(", retry after {secs}s"),
        None => String::new(),
    })]
    RateLimited {
        /// Seconds to wait before retrying, if provided by the API.
        retry_after: Option<u64>,
    },

    /// OAuth token is expired and refresh failed.
    #[error("X API authentication expired, re-authentication required")]
    AuthExpired,

    /// Account is suspended or limited.
    #[error("X API account restricted: {message}")]
    AccountRestricted {
        /// Details about the restriction.
        message: String,
    },

    /// X API returned HTTP 403 (forbidden / tier restriction).
    #[error("X API forbidden: {message}")]
    Forbidden {
        /// Details about why access is forbidden.
        message: String,
    },

    /// OAuth scope insufficient for the requested operation.
    #[error("X API scope insufficient: {message}")]
    ScopeInsufficient {
        /// Details about missing or insufficient scopes.
        message: String,
    },

    /// Network-level failure communicating with X API.
    #[error("X API network error: {source}")]
    Network {
        /// The underlying HTTP client error.
        #[source]
        source: reqwest::Error,
    },

    /// Any other X API error response.
    #[error("X API error (HTTP {status}): {message}")]
    ApiError {
        /// The HTTP status code.
        status: u16,
        /// The error message from the API.
        message: String,
    },

    /// Media upload failed.
    #[error("media upload failed: {message}")]
    MediaUploadError {
        /// Details about the upload failure.
        message: String,
    },

    /// Media processing timed out after waiting for the specified duration.
    #[error("media processing timed out after {seconds}s")]
    MediaProcessingTimeout {
        /// Number of seconds waited before timing out.
        seconds: u64,
    },

    /// Mutation blocked because scraper backend has mutations disabled.
    #[error("scraper mutation blocked: {message}. Enable scraper_allow_mutations in config or switch to provider_backend = \"x_api\"")]
    ScraperMutationBlocked {
        /// The operation that was blocked.
        message: String,
    },

    /// Scraper transport is unavailable or not yet implemented.
    #[error("scraper transport unavailable: {message}")]
    ScraperTransportUnavailable {
        /// Details about the transport issue.
        message: String,
    },

    /// Feature requires authenticated X API access (not available in scraper mode).
    #[error("feature requires X API authentication: {message}. Switch to provider_backend = \"x_api\" to use this feature")]
    FeatureRequiresAuth {
        /// The feature or method that requires authentication.
        message: String,
    },
}

impl XApiError {
    /// Returns `true` for transient errors where a retry may succeed.
    ///
    /// Non-retryable: auth failures (401/403), scope issues, permanent
    /// client errors. Retryable: network errors, server errors (5xx),
    /// rate limits, and scraper transport issues.
    pub fn is_retryable(&self) -> bool {
        match self {
            // Transient: retry after a delay.
            XApiError::RateLimited { .. } => true,
            XApiError::Network { .. } => true,
            XApiError::ScraperTransportUnavailable { .. } => true,
            // Retryable server errors (5xx); non-retryable client errors (4xx).
            XApiError::ApiError { status, .. } => *status >= 500,
            // Non-retryable: credentials, permissions, or permanent client errors.
            XApiError::AuthExpired => false,
            XApiError::AccountRestricted { .. } => false,
            XApiError::Forbidden { .. } => false,
            XApiError::ScopeInsufficient { .. } => false,
            XApiError::FeatureRequiresAuth { .. } => false,
            XApiError::ScraperMutationBlocked { .. } => false,
            XApiError::MediaUploadError { .. } => false,
            XApiError::MediaProcessingTimeout { .. } => false,
        }
    }
}

/// Errors from interacting with LLM providers (OpenAI, Anthropic, Ollama).
#[derive(Debug, thiserror::Error)]
pub enum LlmError {
    /// HTTP request to the LLM endpoint failed.
    #[error("LLM HTTP request failed: {0}")]
    Request(#[from] reqwest::Error),

    /// LLM API returned an error response.
    #[error("LLM API error (status {status}): {message}")]
    Api {
        /// The HTTP status code.
        status: u16,
        /// The error message from the API.
        message: String,
    },

    /// LLM provider rate limit hit.
    #[error("LLM rate limited, retry after {retry_after_secs} seconds")]
    RateLimited {
        /// Seconds to wait before retrying.
        retry_after_secs: u64,
    },

    /// LLM response could not be parsed.
    #[error("failed to parse LLM response: {0}")]
    Parse(String),

    /// No LLM provider configured.
    #[error("no LLM provider configured")]
    NotConfigured,

    /// Content generation failed after retries.
    #[error("content generation failed: {0}")]
    GenerationFailed(String),
}

/// Errors from SQLite storage operations.
#[derive(Debug, thiserror::Error)]
pub enum StorageError {
    /// Failed to connect to SQLite database.
    #[error("database connection error: {source}")]
    Connection {
        /// The underlying SQLx error.
        #[source]
        source: sqlx::Error,
    },

    /// Database migration failed.
    #[error("database migration error: {source}")]
    Migration {
        /// The underlying migration error.
        #[source]
        source: sqlx::migrate::MigrateError,
    },

    /// A database query failed.
    #[error("database query error: {source}")]
    Query {
        /// The underlying SQLx error.
        #[source]
        source: sqlx::Error,
    },

    /// An approval item has already been reviewed and cannot be re-reviewed.
    #[error("item {id} has already been reviewed (current status: {current_status})")]
    AlreadyReviewed {
        /// The approval queue item ID.
        id: i64,
        /// The current status of the item.
        current_status: String,
    },
}

/// Errors from the tweet scoring engine.
#[derive(Debug, thiserror::Error)]
pub enum ScoringError {
    /// Tweet data is missing or malformed for scoring.
    #[error("invalid tweet data for scoring: {message}")]
    InvalidTweetData {
        /// Details about what is missing or malformed.
        message: String,
    },
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn config_error_missing_field_message() {
        let err = ConfigError::MissingField {
            field: "business.product_name".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "missing required config field: business.product_name"
        );
    }

    #[test]
    fn config_error_invalid_value_message() {
        let err = ConfigError::InvalidValue {
            field: "llm.provider".to_string(),
            message: "must be openai, anthropic, or ollama".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "invalid value for config field 'llm.provider': must be openai, anthropic, or ollama"
        );
    }

    #[test]
    fn config_error_file_not_found_message() {
        let err = ConfigError::FileNotFound {
            path: "/home/user/.tuitbot/config.toml".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "config file not found: /home/user/.tuitbot/config.toml"
        );
    }

    #[test]
    fn x_api_error_rate_limited_with_retry() {
        let err = XApiError::RateLimited {
            retry_after: Some(30),
        };
        assert_eq!(err.to_string(), "X API rate limited, retry after 30s");
    }

    #[test]
    fn x_api_error_rate_limited_without_retry() {
        let err = XApiError::RateLimited { retry_after: None };
        assert_eq!(err.to_string(), "X API rate limited");
    }

    #[test]
    fn x_api_error_auth_expired_message() {
        let err = XApiError::AuthExpired;
        assert_eq!(
            err.to_string(),
            "X API authentication expired, re-authentication required"
        );
    }

    #[test]
    fn x_api_error_api_error_message() {
        let err = XApiError::ApiError {
            status: 403,
            message: "Forbidden".to_string(),
        };
        assert_eq!(err.to_string(), "X API error (HTTP 403): Forbidden");
    }

    #[test]
    fn x_api_error_scope_insufficient_message() {
        let err = XApiError::ScopeInsufficient {
            message: "missing tweet.write".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "X API scope insufficient: missing tweet.write"
        );
    }

    #[test]
    fn llm_error_not_configured_message() {
        let err = LlmError::NotConfigured;
        assert_eq!(err.to_string(), "no LLM provider configured");
    }

    #[test]
    fn llm_error_rate_limited_message() {
        let err = LlmError::RateLimited {
            retry_after_secs: 30,
        };
        assert_eq!(err.to_string(), "LLM rate limited, retry after 30 seconds");
    }

    #[test]
    fn llm_error_parse_failure_message() {
        let err = LlmError::Parse("unexpected JSON structure".to_string());
        assert_eq!(
            err.to_string(),
            "failed to parse LLM response: unexpected JSON structure"
        );
    }

    #[test]
    fn llm_error_api_error_message() {
        let err = LlmError::Api {
            status: 401,
            message: "Invalid API key".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "LLM API error (status 401): Invalid API key"
        );
    }

    #[test]
    fn storage_error_already_reviewed_message() {
        let err = StorageError::AlreadyReviewed {
            id: 42,
            current_status: "approved".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "item 42 has already been reviewed (current status: approved)"
        );
    }

    #[test]
    fn scoring_error_invalid_tweet_data_message() {
        let err = ScoringError::InvalidTweetData {
            message: "missing author_id".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "invalid tweet data for scoring: missing author_id"
        );
    }

    #[test]
    fn x_api_error_media_upload_message() {
        let err = XApiError::MediaUploadError {
            message: "file too large".to_string(),
        };
        assert_eq!(err.to_string(), "media upload failed: file too large");
    }

    #[test]
    fn x_api_error_media_processing_timeout_message() {
        let err = XApiError::MediaProcessingTimeout { seconds: 300 };
        assert_eq!(err.to_string(), "media processing timed out after 300s");
    }

    #[test]
    fn x_api_error_scraper_mutation_blocked_message() {
        let err = XApiError::ScraperMutationBlocked {
            message: "post_tweet".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "scraper mutation blocked: post_tweet. Enable scraper_allow_mutations in config or switch to provider_backend = \"x_api\""
        );
    }

    #[test]
    fn x_api_error_scraper_transport_unavailable_message() {
        let err = XApiError::ScraperTransportUnavailable {
            message: "search_tweets: scraper transport not yet implemented".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "scraper transport unavailable: search_tweets: scraper transport not yet implemented"
        );
    }

    #[test]
    fn x_api_error_feature_requires_auth_message() {
        let err = XApiError::FeatureRequiresAuth {
            message: "get_me requires authenticated API access".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "feature requires X API authentication: get_me requires authenticated API access. Switch to provider_backend = \"x_api\" to use this feature"
        );
    }

    #[test]
    fn llm_error_generation_failed_message() {
        let err = LlmError::GenerationFailed("max retries exceeded".to_string());
        assert_eq!(
            err.to_string(),
            "content generation failed: max retries exceeded"
        );
    }

    #[test]
    fn x_api_error_account_restricted_message() {
        let err = XApiError::AccountRestricted {
            message: "Account suspended".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "X API account restricted: Account suspended"
        );
    }

    #[test]
    fn x_api_error_forbidden_message() {
        let err = XApiError::Forbidden {
            message: "Basic tier cannot access this endpoint".to_string(),
        };
        assert_eq!(
            err.to_string(),
            "X API forbidden: Basic tier cannot access this endpoint"
        );
    }

    #[test]
    fn storage_error_connection_message() {
        let err = StorageError::Connection {
            source: sqlx::Error::Configuration("test config error".into()),
        };
        let msg = err.to_string();
        assert!(msg.contains("database connection error"));
    }

    #[test]
    fn storage_error_query_message() {
        let err = StorageError::Query {
            source: sqlx::Error::ColumnNotFound("missing_col".to_string()),
        };
        let msg = err.to_string();
        assert!(msg.contains("database query error"));
    }

    #[test]
    fn config_error_is_debug() {
        let err = ConfigError::MissingField {
            field: "test".to_string(),
        };
        let debug = format!("{err:?}");
        assert!(debug.contains("MissingField"));
    }

    #[test]
    fn x_api_error_is_debug() {
        let err = XApiError::AuthExpired;
        let debug = format!("{err:?}");
        assert!(debug.contains("AuthExpired"));
    }

    #[test]
    fn llm_error_is_debug() {
        let err = LlmError::NotConfigured;
        let debug = format!("{err:?}");
        assert!(debug.contains("NotConfigured"));
    }

    #[test]
    fn storage_error_is_debug() {
        let err = StorageError::AlreadyReviewed {
            id: 1,
            current_status: "approved".to_string(),
        };
        let debug = format!("{err:?}");
        assert!(debug.contains("AlreadyReviewed"));
    }

    #[test]
    fn scoring_error_is_debug() {
        let err = ScoringError::InvalidTweetData {
            message: "test".to_string(),
        };
        let debug = format!("{err:?}");
        assert!(debug.contains("InvalidTweetData"));
    }

    #[test]
    fn x_api_error_rate_limited_with_retry_formats_seconds() {
        let err = XApiError::RateLimited {
            retry_after: Some(120),
        };
        assert!(err.to_string().contains("120s"));
    }

    #[test]
    fn llm_error_api_error_includes_status_code() {
        let err = LlmError::Api {
            status: 500,
            message: "Internal server error".to_string(),
        };
        let msg = err.to_string();
        assert!(msg.contains("500"));
        assert!(msg.contains("Internal server error"));
    }
}