Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

7.7 KB
Raw Blame
use axum::http::StatusCode;
use axum::response::{IntoResponse, Response};
use axum::Json;
use dbx_core::backend_error::BackendError;
use std::fmt;

#[derive(Debug)]
pub struct AppError {
    pub message: String,
    pub status: StatusCode,
    pub error: Box<BackendError>,
}

impl fmt::Display for AppError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl AppError {
    pub fn internal(msg: impl Into<String>) -> Self {
        Self::with_status(msg.into(), StatusCode::INTERNAL_SERVER_ERROR)
    }

    pub fn bad_request(msg: impl Into<String>) -> Self {
        Self::with_status(msg.into(), StatusCode::BAD_REQUEST)
    }

    pub fn conflict(msg: impl Into<String>) -> Self {
        Self::with_status(msg.into(), StatusCode::CONFLICT)
    }

    pub fn forbidden(msg: impl Into<String>) -> Self {
        Self::with_status(msg.into(), StatusCode::FORBIDDEN)
    }

    pub fn not_found(msg: impl Into<String>) -> Self {
        Self::with_status(msg.into(), StatusCode::NOT_FOUND)
    }

    fn with_status(message: String, status: StatusCode) -> Self {
        let error = BackendError::from_legacy_string(&message);
        Self { message, status, error: Box::new(error) }
    }

    pub fn from_backend_error(error: BackendError) -> Self {
        Self { message: error.code().to_string(), status: StatusCode::INTERNAL_SERVER_ERROR, error: Box::new(error) }
    }
}

impl IntoResponse for AppError {
    fn into_response(self) -> Response {
        (self.status, Json(*self.error)).into_response()
    }
}

impl From<String> for AppError {
    fn from(s: String) -> Self {
        Self::internal(s)
    }
}

impl From<&str> for AppError {
    fn from(s: &str) -> Self {
        Self::internal(s)
    }
}

impl From<BackendError> for AppError {
    fn from(error: BackendError) -> Self {
        Self::from_backend_error(error)
    }
}

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

    #[test]
    fn legacy_errors_are_exposed_as_the_shared_backend_envelope() {
        let error = AppError::internal("database failed");
        assert_eq!(error.status, StatusCode::INTERNAL_SERVER_ERROR);
        assert_eq!(error.error.version(), 1);
        assert_eq!(error.error.code(), "DBX-LEGACY-0001");
        assert_eq!(error.message, "database failed");
    }

    #[test]
    fn app_error_stays_small_for_route_result_types() {
        assert!(std::mem::size_of::<AppError>() <= 64);
    }

    #[test]
    fn structured_agent_text_keeps_catalog_identity_at_http_boundary() {
        let error = AppError::from(
            "Agent RPC error (-1): timed out\nDBX_AGENT_ERROR_DATA:{\"category\":\"timeout\",\"stage\":\"execute\"}",
        );
        assert_eq!(error.error.code(), "DBX-JDBC-9001");
        assert_eq!(error.error.source(), dbx_core::backend_error::BackendErrorSource::JdbcAgentLegacy);
    }

    #[tokio::test]
    async fn http_response_preserves_original_legacy_detail() {
        let response = AppError::internal("database failed").into_response();
        assert_eq!(response.status(), StatusCode::INTERNAL_SERVER_ERROR);
        assert_eq!(response.headers()[axum::http::header::CONTENT_TYPE], "application/json");
        let body = axum::body::to_bytes(response.into_body(), usize::MAX).await.unwrap();
        let payload: serde_json::Value = serde_json::from_slice(&body).unwrap();
        assert_eq!(payload["version"], 1);
        assert_eq!(payload["code"], "DBX-LEGACY-0001");
        assert_eq!(payload["messageKey"], "backendErrors.legacy");
        assert_eq!(payload["detail"], "database failed");
    }

    #[tokio::test]
    async fn http_response_preserves_sql_keyword_diagnostic_detail() {
        let response = AppError::internal("Incorrect syntax near SELECT").into_response();
        let body = axum::body::to_bytes(response.into_body(), usize::MAX).await.unwrap();
        let payload: serde_json::Value = serde_json::from_slice(&body).unwrap();
        assert_eq!(payload["code"], "DBX-LEGACY-0001");
        assert_eq!(payload["detail"], "Incorrect syntax near SELECT");
    }

    #[tokio::test]
    async fn http_response_preserves_original_structured_agent_detail() {
        use dbx_core::db::agent_driver::{
            AgentCallError, AgentErrorCategory, AgentErrorContext, AgentErrorStage, AgentOperationOutcome,
            AgentSessionDisposition,
        };

        let error = BackendError::from_agent_call_error(&AgentCallError::Structured {
            rpc_code: -1,
            message: "relation customer_orders does not exist".to_string(),
            context: AgentErrorContext {
                contract_version: 1,
                category: AgentErrorCategory::Sql,
                retryable: false,
                session_disposition: AgentSessionDisposition::Keep,
                stage: AgentErrorStage::Execute,
                operation_outcome: AgentOperationOutcome::Unknown,
                agent_session_id: Some("session-1".to_string()),
                sql_state: Some("42P01".to_string()),
                vendor_code: None,
                exception_class: Some("java.sql.SQLException".to_string()),
            },
        });

        let response = AppError::from(error).into_response();
        let body = axum::body::to_bytes(response.into_body(), usize::MAX).await.unwrap();
        let payload: serde_json::Value = serde_json::from_slice(&body).unwrap();

        assert_eq!(payload["code"], "DBX-JDBC-4001");
        assert_eq!(payload["source"], "jdbcAgent");
        assert_eq!(payload["detail"], "relation customer_orders does not exist");
        assert!(payload["diagnostics"].get("agentSessionId").is_none());
    }

    #[tokio::test]
    async fn http_response_preserves_duckdb_native_detail_and_worker_code() {
        let error = BackendError::from_duckdb_worker_error(
            "duckdb_execute_failed",
            "Catalog Error: Table missing_table does not exist",
        );

        let response = AppError::from(error).into_response();
        let body = axum::body::to_bytes(response.into_body(), usize::MAX).await.unwrap();
        let payload: serde_json::Value = serde_json::from_slice(&body).unwrap();

        assert_eq!(payload["detail"], "Catalog Error: Table missing_table does not exist");
        assert_eq!(payload["origin"]["driver"], "duckdb");
        assert_eq!(payload["diagnostics"]["adapterCode"], "duckdb_execute_failed");
    }

    #[tokio::test]
    async fn http_response_preserves_native_sql_detail() {
        let error = BackendError::from_sql_detail(
            "ERROR: statement [UPDATE users SET password='user-input' WHERE email='[email protected]']",
        );

        let response = AppError::from(error).into_response();
        let body = axum::body::to_bytes(response.into_body(), usize::MAX).await.unwrap();
        let payload: serde_json::Value = serde_json::from_slice(&body).unwrap();
        let detail = payload["detail"].as_str().unwrap();

        assert_eq!(
            detail,
            "ERROR: statement [UPDATE users SET password='user-input' WHERE email='[email protected]']"
        );
    }

    #[tokio::test]
    async fn http_response_redacts_common_sensitive_key_variants() {
        let error = AppError::internal(
            "driver failed: PASSWORD:secret-a refresh_token = \"secret-b\" api-key:secret-c authorization: Bearer secret-d sessionid=secret-e",
        );

        let response = error.into_response();
        let body = axum::body::to_bytes(response.into_body(), usize::MAX).await.unwrap();
        let payload: serde_json::Value = serde_json::from_slice(&body).unwrap();
        let detail = payload["detail"].as_str().unwrap();

        for secret in ["secret-a", "secret-b", "secret-c", "secret-d", "secret-e"] {
            assert!(!detail.contains(secret), "sensitive value leaked: {secret}; detail={detail}");
        }
    }
}