sqlite_graphrag/

errors.rs

//! Library-wide error type.
//!
//! `AppError` is the single error type returned by every public API in the
//! crate. Each variant maps to a deterministic exit code through
//! `AppError::exit_code`, which the binary propagates to the shell on
//! failure. See the README for the full exit code contract.

use crate::i18n::{current, Language};
use crate::spawn::preflight::PreFlightError;
use thiserror::Error;

/// Unified error type for all CLI and library operations.
///
/// Each variant corresponds to a distinct failure category. The
/// [`AppError::exit_code`] method converts a variant into a stable numeric
/// code so that shell callers and LLM agents can route on it.
///
/// # SemVer Policy
///
/// This enum is `#[non_exhaustive]`. New variants may be added in minor
/// releases without breaking downstream match arms (use a wildcard `_`).
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum AppError {
    /// Input failed schema, length or format validation. Maps to exit code `1`.
    ///
    /// This variant groups multiple validation failure causes. Callers that need
    /// programmatic retry decisions should use [`AppError::is_retryable`] instead
    /// of parsing the message string.
    #[error("validation error: {0}")]
    Validation(String),

    /// External binary required for operation was not found in PATH. Maps to exit code `1`.
    #[error("binary not found: {name} — ensure it is installed and in PATH")]
    BinaryNotFound { name: String },

    /// Remote service signaled rate limiting; caller should retry with backoff. Maps to exit code `1`.
    #[error("rate limited: {detail}")]
    RateLimited { detail: String },

    /// Operation exceeded its time budget. Maps to exit code `1`.
    #[error("timeout after {duration_secs}s: {operation}")]
    Timeout {
        operation: String,
        duration_secs: u64,
    },

    /// A memory or entity with the same `(namespace, name)` already exists. Maps to exit code `9`.
    #[error("duplicate detected: {0}")]
    Duplicate(String),

    /// Optimistic update lost the race because `updated_at` changed. Maps to exit code `3`.
    #[error("conflict: {0}")]
    Conflict(String),

    /// The requested record does not exist or was soft-deleted. Maps to exit code `4`.
    #[error("not found: {0}")]
    NotFound(String),

    /// Memory lookup by `(namespace, name)` returned no row. Maps to exit code `4`.
    ///
    /// G55 S2 (v1.0.80): structural variant that carries the requested identifier
    /// and namespace, eliminating the "not found: unknown in namespace 'X'" class
    /// of bugs that masked which lookup target failed. The display format matches
    /// the legacy string-based `NotFound` so the i18n replace-chain and external
    /// scripts that pattern-match on `memory not found: name='N' in namespace 'NS'`
    /// keep working.
    #[error("memory not found: name='{name}' in namespace '{namespace}'")]
    MemoryNotFound { name: String, namespace: String },

    /// Memory lookup by integer `id` returned no row. Maps to exit code `4`.
    #[error("memory not found: id={id}")]
    MemoryNotFoundById { id: i64 },

    /// GAP-SG-78: an entity referenced by a queued enrich item does not yet
    /// exist in `entities`. Maps to exit code `4`.
    ///
    /// # Cause
    ///
    /// Distinct from the terminal [`Self::NotFound`] / [`Self::MemoryNotFound`]
    /// cases (a memory that was deleted or renamed, permanently gone). An
    /// entity can be referenced by a queue row BEFORE it is materialized: a
    /// later enrich pass creates the entity, so its absence now is TRANSITORY,
    /// not terminal. Collapsing both into a single `NotFound` string sent every
    /// such item to the dead-letter on the first failure.
    ///
    /// # When it occurs
    ///
    /// Raised by the entity call-sites of `enrich` — `entity-descriptions`
    /// (`call_entity_description`) and `entity-type-validate`
    /// (`call_entity_type_validate`) — when the `(namespace, name)` lookup
    /// returns no row. Classified as [`Self::is_retryable`] so the item is
    /// rescheduled until `--max-attempts` is exhausted.
    #[error("entity '{name}' not yet materialized in namespace '{namespace}'")]
    EntityNotYetMaterialized { name: String, namespace: String },

    /// Namespace could not be resolved from flag, environment or markers. Maps to exit code `5`.
    #[error("namespace not resolved: {0}")]
    NamespaceError(String),

    /// Payload exceeded one of the configured body, name or batch limits. Maps to exit code `6`.
    ///
    /// v1.1.1 (P11): kept for caps other than the body-bytes and chunk-count
    /// ceilings, which now have the typed [`Self::BodyTooLarge`] and
    /// [`Self::TooManyChunks`] variants so the operator can tell WHICH cap
    /// fired without parsing the message.
    #[error("limit exceeded: {0}")]
    LimitExceeded(String),

    /// Body payload exceeded [`crate::constants::MAX_MEMORY_BODY_LEN`] bytes.
    /// Maps to exit code `6` (same contract as [`Self::LimitExceeded`]).
    ///
    /// v1.1.1 (P11): the two independent write ceilings — body bytes and chunk
    /// count — used to collapse into the generic `LimitExceeded` string, so an
    /// operator hitting exit 6 could not tell WHICH cap fired. This variant
    /// carries the measured size and the cap, and the message names the
    /// constant, so both the stderr line and the JSON envelope identify the
    /// ceiling deterministically (never by substring matching).
    #[error(
        "limit exceeded: body is {bytes} bytes, above the {limit}-byte cap \
         (MAX_MEMORY_BODY_LEN); split the content into multiple memories"
    )]
    BodyTooLarge { bytes: u64, limit: u64 },

    /// Chunking produced more chunks than
    /// [`crate::constants::REMEMBER_MAX_SAFE_MULTI_CHUNKS`]. Maps to exit
    /// code `6` (same contract as [`Self::LimitExceeded`]).
    ///
    /// v1.1.1 (P11): counterpart of [`Self::BodyTooLarge`] for the chunk-count
    /// ceiling. Carries the measured chunk count and the cap so the operator
    /// can distinguish a chunk overflow from a byte overflow on exit 6.
    #[error(
        "limit exceeded: document produces {chunks} chunks, above the \
         {limit}-chunk cap (REMEMBER_MAX_SAFE_MULTI_CHUNKS); split the \
         document before writing"
    )]
    TooManyChunks { chunks: usize, limit: usize },

    /// Low-level SQLite error propagated from `rusqlite`. Maps to exit code `10`.
    #[error("database error: {0}")]
    Database(#[from] rusqlite::Error),

    /// Embedding generation via `fastembed` failed or produced the wrong shape. Maps to exit code `11`.
    #[error("embedding error: {0}")]
    Embedding(String),

    /// The `sqlite-vec` extension could not load or register its virtual table. Maps to exit code `12`.
    #[error("sqlite-vec extension failed: {0}")]
    VecExtension(String),

    /// SQLite returned `SQLITE_BUSY` after exhausting retries. Maps to exit code `15` (was `13` before v2.0.0; relocated to free `13` for BatchPartialFailure per PRD).
    #[error("database busy: {0}")]
    DbBusy(String),

    /// Batch operation failed partially — N of M items failed. Maps to exit code `13` (PRD 1822).
    ///
    /// Reserved for use in `import`, `reindex` and batch stdin (BLOCK 3/4). Variant present
    /// since v2.0.0 even if call-sites do not yet exist — stable exit code mapping.
    #[error("batch partial failure: {failed} of {total} items failed")]
    BatchPartialFailure { total: usize, failed: usize },

    /// Filesystem I/O error while reading or writing the database or cache. Maps to exit code `14`.
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// Unexpected internal error surfaced through `anyhow`. Maps to exit code `20`.
    #[error(transparent)]
    Internal(#[from] anyhow::Error),

    /// JSON serialization or deserialization failure. Maps to exit code `20`.
    #[error("json error: {0}")]
    Json(#[from] serde_json::Error),

    /// Another instance is already running and holds the advisory lock. Maps to exit code `75`.
    ///
    /// Use `--allow-parallel` to skip the lock or `--wait-lock SECONDS` to retry.
    #[error("lock busy: {0}")]
    LockBusy(String),

    /// All concurrency slots are occupied after the wait timeout. Maps to exit code `75`.
    ///
    /// Occurs when [`crate::constants::MAX_CONCURRENT_CLI_INSTANCES`] instances are already
    /// active and the wait limit [`crate::constants::CLI_LOCK_DEFAULT_WAIT_SECS`] is exhausted.
    #[error(
        "all {max} concurrency slots occupied after waiting {waited_secs}s (exit 75); \
         use --max-concurrency or wait for other invocations to finish"
    )]
    AllSlotsFull { max: usize, waited_secs: u64 },

    /// A heavy long-running job is already running for this job_type/namespace
    /// pair. Maps to exit code `75` (the same `EX_TEMPFAIL` code used by the
    /// CLI semaphore).
    ///
    /// G28-B (v1.0.68): ensures at most one `enrich`, `ingest --mode
    /// claude-code`, or `ingest --mode codex` runs at a time per namespace.
    /// Use `--wait-job-singleton <SECONDS>` (per-command) to poll until the
    /// other invocation finishes.
    #[error(
        "job {job_type} for namespace '{namespace}' is already running (exit 75); \
         wait for it to finish or pass --wait-job-singleton <SECONDS>"
    )]
    JobSingletonLocked { job_type: String, namespace: String },

    /// G45: an LLM embedding operation is already running against the
    /// same `(namespace, db)` pair in another process. Exit code 75
    /// (retryable). The caller can pass `--wait-embed-singleton
    /// <SECONDS>` to poll until the lock drops.
    #[error(
        "embedding singleton for namespace '{namespace}' is already held (exit 75); \
         another CLI is calling the LLM on this database; pass --wait-embed-singleton <SECONDS> to wait"
    )]
    EmbeddingSingletonLocked { namespace: String },

    /// Available memory is below the minimum required to load the model. Maps to exit code `77`.
    ///
    /// Returned when `sysinfo` reports available memory below
    /// [`crate::constants::MIN_AVAILABLE_MEMORY_MB`] MiB before starting the ONNX model load.
    #[error(
        "available memory ({available_mb}MB) below required minimum ({required_mb}MB) \
         to load the model; abort other loads or use --skip-memory-guard (exit 77)"
    )]
    LowMemory { available_mb: u64, required_mb: u64 },

    /// v1.0.82 (GAP-002 final): shutdown was requested via SIGINT, SIGTERM or
    /// SIGHUP before the current command completed. Maps to exit code
    /// [`crate::constants::SHUTDOWN_EXIT_CODE`] (19).
    ///
    /// The signal name is preserved in the `signal` field so the JSON
    /// envelope emitted before exit can route the operator to a
    /// deterministic branch. Distinct from the legacy `128 + signal`
    /// Unix convention (130/143/129) so LLM agents can match on a
    /// single code for "cancelled by user".
    #[error("shutdown signal received: {signal}")]
    Shutdown { signal: String },

    /// v1.0.87 (GAP-META-005, ADR-0045): pre-flight validation gate
    /// rejected the spawn before fork. Maps to exit code `16`.
    ///
    /// The `source` field carries the structured [`PreFlightError`]
    /// variant so callers and operators can route on the specific
    /// failure class (BinaryNotFound, ArgvExceedsArgMax,
    /// McpConfigInlineJsonRejected, McpConfigPathMissing,
    /// McpConfigPathInvalidJson, WalkUpMcpJsonInvalid,
    /// OutputBufferTooSmall, ClaudeConfigDirNotEmpty) instead of
    /// parsing the legacy `detail: String` representation.
    ///
    /// This variant is **permanent** — retrying the same argv will fail
    /// identically. Operators must fix the underlying condition (install
    /// the binary, shorten the body, override `CLAUDE_CONFIG_DIR`,
    /// substitute the inline `--mcp-config '{}'` for a tempfile path,
    /// etc.) before retrying.
    #[error("preflight validation failed: {source}")]
    PreFlightFailed { source: Box<PreFlightError> },

    /// v1.0.97 (GAP-SG-01/03): the OpenRouter provider returned a structured
    /// error object (an `error` field carrying `code` and `message`), often
    /// inside an HTTP 200 body (e.g. token/context-length overflow). Maps to
    /// exit code `1`.
    ///
    /// Modelling the provider rejection as a typed variant — instead of the
    /// generic `Embedding`/`Validation` string — stops the optimistic success
    /// parse from masking the cause with a misleading missing-field error. The
    /// `code` and `message` carry the REAL provider diagnostics.
    ///
    /// This variant is **permanent**: a structured provider error in a success
    /// body is a content or configuration rejection that retrying the identical
    /// request will not fix. Genuine rate limiting surfaces as HTTP 429 and is
    /// retried inside the HTTP client (then exposed via `RateLimited` when
    /// attempts are exhausted), so it never reaches callers as `ProviderError`.
    #[error("provider error (code {code}): {message}")]
    ProviderError { code: String, message: String },
}

/// Bridges the structured [`PreFlightError`] produced by the
/// pre-flight validation gate (v1.0.87, ADR-0045) into the unified
/// [`AppError`] envelope. Lets spawners use the `?` operator instead
/// of hand-rolling `AppError::PreFlightFailed { source: ... }` at every
/// call site, and keeps the variant alive as the canonical exit code 16
/// path rather than the dead code it was at v1.0.87.
impl From<PreFlightError> for AppError {
    fn from(source: PreFlightError) -> Self {
        AppError::PreFlightFailed {
            source: Box::new(source),
        }
    }
}

impl AppError {
    /// Returns the deterministic process exit code for this error variant.
    ///
    /// The codes follow the contract documented in the README: `1` for
    /// validation, `9` for duplicates (moved from `2` in v1.0.52), `3` for conflicts, `4` for missing
    /// records, `5` for namespace errors, `6` for limit violations, `10`–`14`
    /// for infrastructure failures, `13` for BatchPartialFailure (PRD 1822),
    /// `15` for DbBusy (migrated from `13` in v2.0.0), `20` for internal errors,
    /// `75` (EX_TEMPFAIL) when the advisory CLI lock is held or all concurrency
    /// slots are exhausted, and `77` when available memory is insufficient to
    /// load the embedding model.
    ///
    /// # Examples
    ///
    /// ```
    /// use sqlite_graphrag::errors::AppError;
    ///
    /// assert_eq!(AppError::Validation("invalid field".into()).exit_code(), 1);
    /// assert_eq!(AppError::Duplicate("ns/mem".into()).exit_code(), 9);
    /// assert_eq!(AppError::Conflict("ts changed".into()).exit_code(), 3);
    /// assert_eq!(AppError::NotFound("id 42".into()).exit_code(), 4);
    /// assert_eq!(AppError::NamespaceError("no marker".into()).exit_code(), 5);
    /// assert_eq!(AppError::LimitExceeded("body too large".into()).exit_code(), 6);
    /// assert_eq!(AppError::Embedding("wrong dim".into()).exit_code(), 11);
    /// assert_eq!(AppError::DbBusy("retries exhausted".into()).exit_code(), 15);
    /// assert_eq!(AppError::LockBusy("another instance".into()).exit_code(), 75);
    /// ```
    #[inline]
    #[must_use]
    pub fn exit_code(&self) -> i32 {
        match self {
            Self::Validation(_) => 1,
            Self::BinaryNotFound { .. } => 1,
            Self::RateLimited { .. } => 1,
            Self::Timeout { .. } => 1,
            Self::Duplicate(_) => crate::constants::DUPLICATE_EXIT_CODE,
            Self::Conflict(_) => 3,
            Self::NotFound(_) => 4,
            Self::MemoryNotFound { .. } => 4,
            Self::MemoryNotFoundById { .. } => 4,
            Self::EntityNotYetMaterialized { .. } => 4,
            Self::NamespaceError(_) => 5,
            Self::LimitExceeded(_) => 6,
            Self::BodyTooLarge { .. } => 6,
            Self::TooManyChunks { .. } => 6,
            Self::Database(_) => 10,
            Self::Embedding(_) => 11,
            Self::VecExtension(_) => 12,
            Self::BatchPartialFailure { .. } => crate::constants::BATCH_PARTIAL_FAILURE_EXIT_CODE,
            Self::DbBusy(_) => crate::constants::DB_BUSY_EXIT_CODE,
            Self::Io(_) => 14,
            Self::Internal(_) => 20,
            Self::Json(_) => 20,
            Self::LockBusy(_) => crate::constants::CLI_LOCK_EXIT_CODE,
            Self::AllSlotsFull { .. } => crate::constants::CLI_LOCK_EXIT_CODE,
            Self::JobSingletonLocked { .. } => crate::constants::CLI_LOCK_EXIT_CODE,
            Self::EmbeddingSingletonLocked { .. } => crate::constants::CLI_LOCK_EXIT_CODE,
            Self::LowMemory { .. } => crate::constants::LOW_MEMORY_EXIT_CODE,
            Self::Shutdown { .. } => crate::constants::SHUTDOWN_EXIT_CODE,
            Self::PreFlightFailed { .. } => 16,
            Self::ProviderError { .. } => 1,
        }
    }

    /// Returns `true` when the error is transient and the operation may
    /// succeed on retry with backoff.
    ///
    /// # Examples
    ///
    /// ```
    /// use sqlite_graphrag::errors::AppError;
    ///
    /// assert!(AppError::DbBusy("busy".into()).is_retryable());
    /// assert!(AppError::LockBusy("held".into()).is_retryable());
    /// assert!(!AppError::NotFound("x".into()).is_retryable());
    /// assert!(!AppError::Validation("bad".into()).is_retryable());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_retryable(&self) -> bool {
        matches!(
            self,
            Self::DbBusy(_)
                | Self::LockBusy(_)
                | Self::AllSlotsFull { .. }
                | Self::JobSingletonLocked { .. }
                | Self::EmbeddingSingletonLocked { .. }
                | Self::LowMemory { .. }
                | Self::RateLimited { .. }
                | Self::Timeout { .. }
                | Self::EntityNotYetMaterialized { .. }
        )
    }

    /// Returns `true` when shutdown was requested by the user via signal.
    ///
    /// Distinct from `is_permanent` because shutdown is a USER intent, not
    /// a state to retry against. The operation should be retried with
    /// `--resume` (GAP-001) when the persisted staging row still exists.
    ///
    /// # Examples
    ///
    /// ```
    /// use sqlite_graphrag::errors::AppError;
    ///
    /// assert!(AppError::Shutdown { signal: "SIGINT".into() }.is_shutdown());
    /// assert!(!AppError::Validation("x".into()).is_shutdown());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_shutdown(&self) -> bool {
        matches!(self, Self::Shutdown { .. })
    }

    /// Returns `true` when the error is permanent and must NOT be retried.
    ///
    /// Complement to [`Self::is_retryable`]. Errors not classified by either
    /// method (e.g. `Database`, `Io`, `Internal`) are ambiguous — the caller
    /// decides based on context.
    ///
    /// # Examples
    ///
    /// ```
    /// use sqlite_graphrag::errors::AppError;
    ///
    /// assert!(AppError::Validation("bad".into()).is_permanent());
    /// assert!(!AppError::DbBusy("busy".into()).is_permanent());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_permanent(&self) -> bool {
        matches!(
            self,
            Self::Validation(_)
                | Self::BinaryNotFound { .. }
                | Self::Duplicate(_)
                | Self::NotFound(_)
                | Self::MemoryNotFound { .. }
                | Self::MemoryNotFoundById { .. }
                | Self::NamespaceError(_)
                | Self::LimitExceeded(_)
                | Self::BodyTooLarge { .. }
                | Self::TooManyChunks { .. }
                | Self::VecExtension(_)
                | Self::PreFlightFailed { .. }
                | Self::ProviderError { .. }
        )
    }

    /// GAP-SG-39: returns an actionable remediation hint for the error, surfaced
    /// in the stdout error envelope as the `suggestion` field. The hint tells the
    /// operator HOW to recover instead of leaving an exit code without guidance —
    /// this is what makes a write rejection (e.g. a malformed name) observable and
    /// fixable. Returns `None` for variants whose own message is already
    /// self-remediating.
    #[must_use]
    pub fn suggestion(&self) -> Option<&'static str> {
        match self {
            Self::Validation(_) => Some(
                "review the input against the command's --help; names must be kebab-case (lowercase letters, digits, hyphens) and bodies non-empty",
            ),
            Self::Duplicate(_) => {
                Some("pass --force-merge to update the existing memory instead of failing")
            }
            Self::Conflict(_) => Some(
                "another writer changed the row; re-read with `read --name <n> --json` and retry with a fresh --expected-updated-at",
            ),
            Self::NotFound(_) | Self::MemoryNotFound { .. } | Self::MemoryNotFoundById { .. } => {
                Some("verify the name/id and namespace with `list --json` or `read --name <n> --json`")
            }
            Self::NamespaceError(_) => {
                Some("set --namespace or SQLITE_GRAPHRAG_NAMESPACE; inspect with `namespace-detect --json`")
            }
            Self::LimitExceeded(_) => {
                Some("split the input into smaller memories or raise the documented cap before retrying")
            }
            Self::BodyTooLarge { .. } => {
                Some("the body-bytes cap (MAX_MEMORY_BODY_LEN) fired; split the content into multiple memories or use --body-file")
            }
            Self::TooManyChunks { .. } => {
                Some("the chunk-count cap (REMEMBER_MAX_SAFE_MULTI_CHUNKS) fired; split the document into smaller memories before writing")
            }
            Self::Embedding(_) => Some(
                "verify the embedding backend and OPENROUTER_API_KEY; re-run `enrich --operation re-embed` once resolved",
            ),
            Self::Database(_) | Self::DbBusy(_) => {
                Some("run `health --json` then `vacuum --json`; widen --wait-lock if the database is busy")
            }
            Self::Io(_) => Some("check the path exists and is writable, then retry"),
            Self::RateLimited { .. } => {
                Some("wait for the reported retry-after window, then retry")
            }
            Self::LockBusy(_) | Self::AllSlotsFull { .. } | Self::JobSingletonLocked { .. } => {
                Some("wait for the other invocation to finish or pass --wait-lock / --wait-job-singleton")
            }
            _ => None,
        }
    }

    /// Returns the localized error message in the active language (`--lang` / `SQLITE_GRAPHRAG_LANG`).
    ///
    /// In English the text is identical to the `Display` generated by thiserror.
    /// In Portuguese the prefixes and messages are translated to PT-BR.
    pub fn localized_message(&self) -> String {
        self.localized_message_for(current())
    }

    /// Returns the localized message for the explicitly provided language.
    /// Useful in tests that cannot depend on the global `OnceLock`.
    ///
    /// # Examples
    ///
    /// ```
    /// use sqlite_graphrag::errors::AppError;
    /// use sqlite_graphrag::i18n::Language;
    ///
    /// let err = AppError::NotFound("mem-xyz".into());
    ///
    /// let en = err.localized_message_for(Language::English);
    /// assert!(en.contains("not found"));
    ///
    /// let pt = err.localized_message_for(Language::Portuguese);
    /// assert!(pt.contains("n\u{e3}o encontrado"));
    /// ```
    pub fn localized_message_for(&self, lang: Language) -> String {
        match lang {
            Language::English => self.to_string(),
            Language::Portuguese => self.to_string_pt(),
        }
    }

    fn to_string_pt(&self) -> String {
        use crate::i18n::validation::app_error_pt as pt;
        match self {
            Self::Validation(msg) => pt::validation(msg),
            Self::BinaryNotFound { name } => pt::binary_not_found(name),
            Self::RateLimited { detail } => pt::rate_limited(detail),
            Self::Timeout {
                operation,
                duration_secs,
            } => pt::timeout(operation, *duration_secs),
            Self::Duplicate(msg) => pt::duplicate(msg),
            Self::Conflict(msg) => pt::conflict(msg),
            Self::NotFound(msg) => pt::not_found(msg),
            Self::MemoryNotFound { name, namespace } => pt::memory_not_found(name, namespace),
            Self::MemoryNotFoundById { id } => pt::memory_not_found_by_id(*id),
            Self::EntityNotYetMaterialized { name, namespace } => {
                pt::entity_not_yet_materialized(name, namespace)
            }
            Self::NamespaceError(msg) => pt::namespace_error(msg),
            Self::LimitExceeded(msg) => pt::limit_exceeded(msg),
            Self::BodyTooLarge { bytes, limit } => pt::body_too_large(*bytes, *limit),
            Self::TooManyChunks { chunks, limit } => pt::too_many_chunks(*chunks, *limit),
            Self::Database(e) => pt::database(&e.to_string()),
            Self::Embedding(msg) => pt::embedding(msg),
            Self::VecExtension(msg) => pt::vec_extension(msg),
            Self::DbBusy(msg) => pt::db_busy(msg),
            Self::BatchPartialFailure { total, failed } => {
                pt::batch_partial_failure(*total, *failed)
            }
            Self::Io(e) => pt::io(&e.to_string()),
            Self::Internal(e) => pt::internal(&e.to_string()),
            Self::Json(e) => pt::json(&e.to_string()),
            Self::LockBusy(msg) => pt::lock_busy(msg),
            Self::AllSlotsFull { max, waited_secs } => pt::all_slots_full(*max, *waited_secs),
            Self::JobSingletonLocked {
                job_type,
                namespace,
            } => pt::job_singleton_locked(job_type, namespace),
            Self::EmbeddingSingletonLocked { namespace } => {
                pt::embedding_singleton_locked(namespace)
            }
            Self::LowMemory {
                available_mb,
                required_mb,
            } => pt::low_memory(*available_mb, *required_mb),
            Self::Shutdown { signal } => pt::shutdown(signal),
            Self::PreFlightFailed { source } => pt::preflight_failed(&source.to_string()),
            Self::ProviderError { code, message } => pt::provider_error(code, message),
        }
    }
}

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

    #[test]
    fn exit_code_validation_returns_1() {
        assert_eq!(AppError::Validation("invalid field".into()).exit_code(), 1);
    }

    // GAP-SG-39: actionable errors carry a remediation suggestion.
    #[test]
    fn suggestion_present_for_actionable_variants() {
        assert!(AppError::Validation("bad name".into())
            .suggestion()
            .is_some());
        let dup = AppError::Duplicate("global/x".into());
        assert!(dup.suggestion().unwrap().contains("--force-merge"));
        let nf = AppError::MemoryNotFound {
            name: "x".into(),
            namespace: "global".into(),
        };
        assert!(nf.suggestion().is_some());
    }

    #[test]
    fn exit_code_duplicate_returns_9() {
        assert_eq!(AppError::Duplicate("namespace/name".into()).exit_code(), 9);
    }

    #[test]
    fn exit_code_conflict_returns_3() {
        assert_eq!(
            AppError::Conflict("updated_at changed".into()).exit_code(),
            3
        );
    }

    #[test]
    fn exit_code_not_found_returns_4() {
        assert_eq!(AppError::NotFound("memory missing".into()).exit_code(), 4);
    }

    #[test]
    fn exit_code_namespace_error_returns_5() {
        assert_eq!(
            AppError::NamespaceError("not resolved".into()).exit_code(),
            5
        );
    }

    #[test]
    fn exit_code_limit_exceeded_returns_6() {
        assert_eq!(
            AppError::LimitExceeded("body too large".into()).exit_code(),
            6
        );
    }

    // v1.1.1 (P11): both typed ceiling variants keep the exit 6 contract.
    #[test]
    fn exit_code_body_too_large_and_too_many_chunks_return_6() {
        assert_eq!(
            AppError::BodyTooLarge {
                bytes: 600_000,
                limit: 512_000
            }
            .exit_code(),
            6
        );
        assert_eq!(
            AppError::TooManyChunks {
                chunks: 700,
                limit: 512
            }
            .exit_code(),
            6
        );
    }

    // v1.1.1 (P11): the message identifies WHICH cap fired, with the measured
    // value and the limit — bytes vs chunks are distinguishable without
    // substring classification of a generic string.
    #[test]
    fn body_too_large_message_identifies_bytes_cap() {
        let err = AppError::BodyTooLarge {
            bytes: 600_000,
            limit: 512_000,
        };
        let msg = err.to_string();
        assert!(msg.contains("limit exceeded"), "obtido: {msg}");
        assert!(msg.contains("600000 bytes"), "obtido: {msg}");
        assert!(msg.contains("512000-byte cap"), "obtido: {msg}");
        assert!(msg.contains("MAX_MEMORY_BODY_LEN"), "obtido: {msg}");
        assert!(!msg.contains("chunk"), "obtido: {msg}");
    }

    #[test]
    fn too_many_chunks_message_identifies_chunk_cap() {
        let err = AppError::TooManyChunks {
            chunks: 700,
            limit: 512,
        };
        let msg = err.to_string();
        assert!(msg.contains("limit exceeded"), "obtido: {msg}");
        assert!(msg.contains("700 chunks"), "obtido: {msg}");
        assert!(msg.contains("512-chunk cap"), "obtido: {msg}");
        assert!(
            msg.contains("REMEMBER_MAX_SAFE_MULTI_CHUNKS"),
            "obtido: {msg}"
        );
        assert!(!msg.contains("byte cap"), "obtido: {msg}");
    }

    #[test]
    fn typed_limit_variants_are_permanent_with_suggestion() {
        let body = AppError::BodyTooLarge { bytes: 1, limit: 1 };
        let chunks = AppError::TooManyChunks {
            chunks: 1,
            limit: 1,
        };
        assert!(body.is_permanent());
        assert!(chunks.is_permanent());
        assert!(!body.is_retryable());
        assert!(!chunks.is_retryable());
        assert!(body.suggestion().unwrap().contains("MAX_MEMORY_BODY_LEN"));
        assert!(chunks
            .suggestion()
            .unwrap()
            .contains("REMEMBER_MAX_SAFE_MULTI_CHUNKS"));
    }

    #[test]
    fn typed_limit_variants_localize_to_pt() {
        let body = AppError::BodyTooLarge {
            bytes: 600_000,
            limit: 512_000,
        };
        let pt = body.localized_message_for(crate::i18n::Language::Portuguese);
        assert!(pt.contains("limite excedido"), "obtido: {pt}");
        assert!(pt.contains("600000"), "obtido: {pt}");
        let chunks = AppError::TooManyChunks {
            chunks: 700,
            limit: 512,
        };
        let pt = chunks.localized_message_for(crate::i18n::Language::Portuguese);
        assert!(pt.contains("limite excedido"), "obtido: {pt}");
        assert!(pt.contains("700"), "obtido: {pt}");
    }

    #[test]
    fn exit_code_embedding_returns_11() {
        assert_eq!(AppError::Embedding("model failure".into()).exit_code(), 11);
    }

    #[test]
    fn exit_code_vec_extension_returns_12() {
        assert_eq!(
            AppError::VecExtension("extension did not load".into()).exit_code(),
            12
        );
    }

    #[test]
    fn exit_code_db_busy_returns_15() {
        assert_eq!(AppError::DbBusy("retries exhausted".into()).exit_code(), 15);
    }

    #[test]
    fn exit_code_batch_partial_failure_returns_13() {
        assert_eq!(
            AppError::BatchPartialFailure {
                total: 10,
                failed: 3
            }
            .exit_code(),
            13
        );
    }

    #[test]
    fn display_batch_partial_failure_includes_counts() {
        let err = AppError::BatchPartialFailure {
            total: 50,
            failed: 7,
        };
        let msg = err.to_string();
        assert!(msg.contains("7"));
        assert!(msg.contains("50"));
        // to_string() uses the English #[error] attr; PT is in localized_message_for
        assert!(msg.contains("batch partial failure"));
    }

    #[test]
    fn exit_code_io_returns_14() {
        let io_err = io::Error::new(io::ErrorKind::NotFound, "file missing");
        assert_eq!(AppError::Io(io_err).exit_code(), 14);
    }

    #[test]
    fn exit_code_internal_returns_20() {
        let anyhow_err = anyhow::anyhow!("unexpected internal error");
        assert_eq!(AppError::Internal(anyhow_err).exit_code(), 20);
    }

    #[test]
    fn exit_code_json_returns_20() {
        let json_err = serde_json::from_str::<serde_json::Value>("invalid json {{").unwrap_err();
        assert_eq!(AppError::Json(json_err).exit_code(), 20);
    }

    #[test]
    fn exit_code_lock_busy_returns_75() {
        assert_eq!(
            AppError::LockBusy("another active instance".into()).exit_code(),
            75
        );
    }

    #[test]
    fn display_validation_includes_message() {
        let err = AppError::Validation("invalid id".into());
        assert!(err.to_string().contains("invalid id"));
        assert!(err.to_string().contains("validation error"));
    }

    #[test]
    fn display_duplicate_includes_message() {
        let err = AppError::Duplicate("proj/mem".into());
        assert!(err.to_string().contains("proj/mem"));
        assert!(err.to_string().contains("duplicate detected"));
    }

    #[test]
    fn display_not_found_includes_message() {
        let err = AppError::NotFound("id 42".into());
        assert!(err.to_string().contains("id 42"));
        assert!(err.to_string().contains("not found"));
    }

    #[test]
    fn display_embedding_includes_message() {
        let err = AppError::Embedding("wrong dimension".into());
        assert!(err.to_string().contains("wrong dimension"));
        assert!(err.to_string().contains("embedding error"));
    }

    #[test]
    fn display_lock_busy_includes_message() {
        let err = AppError::LockBusy("pid 1234".into());
        assert!(err.to_string().contains("pid 1234"));
        assert!(err.to_string().contains("lock busy"));
    }

    #[test]
    fn from_io_error_converts_correctly() {
        let io_err = io::Error::new(io::ErrorKind::PermissionDenied, "permission denied");
        let app_err: AppError = io_err.into();
        assert_eq!(app_err.exit_code(), 14);
        assert!(app_err.to_string().contains("IO error"));
    }

    #[test]
    fn from_anyhow_error_converts_correctly() {
        let anyhow_err = anyhow::anyhow!("internal detail");
        let app_err: AppError = anyhow_err.into();
        assert_eq!(app_err.exit_code(), 20);
        assert!(app_err.to_string().contains("internal detail"));
    }

    #[test]
    fn from_serde_json_error_converts_correctly() {
        let json_err = serde_json::from_str::<serde_json::Value>("{bad_field}").unwrap_err();
        let app_err: AppError = json_err.into();
        assert_eq!(app_err.exit_code(), 20);
        assert!(app_err.to_string().contains("json error"));
    }

    #[test]
    fn exit_code_lock_busy_matches_constant() {
        assert_eq!(
            AppError::LockBusy("test".into()).exit_code(),
            crate::constants::CLI_LOCK_EXIT_CODE
        );
    }

    #[test]
    fn localized_message_en_equals_to_string() {
        let err = AppError::NotFound("mem-x".into());
        assert_eq!(
            err.localized_message_for(crate::i18n::Language::English),
            err.to_string()
        );
    }

    // Detailed Portuguese-specific assertions live in `src/i18n.rs`
    // (the bilingual module). Here we only verify that delegation is wired
    // correctly, without embedding PT strings in this English-only file.

    #[test]
    fn localized_message_pt_differs_from_en() {
        let err = AppError::NotFound("mem-x".into());
        let en = err.localized_message_for(crate::i18n::Language::English);
        let pt = err.localized_message_for(crate::i18n::Language::Portuguese);
        assert_ne!(en, pt, "PT and EN must produce distinct messages");
        assert!(pt.contains("mem-x"), "PT must include the variant payload");
    }

    #[test]
    fn localized_message_pt_delegates_to_app_error_pt_helper() {
        use crate::i18n::validation::app_error_pt as pt;

        let cases: Vec<(AppError, String)> = vec![
            (AppError::Validation("x".into()), pt::validation("x")),
            (AppError::Duplicate("x".into()), pt::duplicate("x")),
            (AppError::Conflict("x".into()), pt::conflict("x")),
            (AppError::NotFound("x".into()), pt::not_found("x")),
            (
                AppError::NamespaceError("x".into()),
                pt::namespace_error("x"),
            ),
            (AppError::LimitExceeded("x".into()), pt::limit_exceeded("x")),
            (AppError::Embedding("x".into()), pt::embedding("x")),
            (AppError::VecExtension("x".into()), pt::vec_extension("x")),
            (AppError::DbBusy("x".into()), pt::db_busy("x")),
            (
                AppError::BatchPartialFailure {
                    total: 10,
                    failed: 3,
                },
                pt::batch_partial_failure(10, 3),
            ),
            (AppError::LockBusy("x".into()), pt::lock_busy("x")),
            (
                AppError::AllSlotsFull {
                    max: 4,
                    waited_secs: 60,
                },
                pt::all_slots_full(4, 60),
            ),
            (
                AppError::LowMemory {
                    available_mb: 100,
                    required_mb: 500,
                },
                pt::low_memory(100, 500),
            ),
            (
                AppError::BinaryNotFound {
                    name: "claude".into(),
                },
                pt::binary_not_found("claude"),
            ),
            (
                AppError::RateLimited {
                    detail: "429".into(),
                },
                pt::rate_limited("429"),
            ),
            (
                AppError::Timeout {
                    operation: "op".into(),
                    duration_secs: 30,
                },
                pt::timeout("op", 30),
            ),
        ];

        for (err, expected) in cases {
            let actual = err.localized_message_for(crate::i18n::Language::Portuguese);
            assert_eq!(actual, expected, "delegation mismatch");
        }
    }

    #[test]
    fn is_retryable_transient_errors() {
        assert!(AppError::DbBusy("x".into()).is_retryable());
        assert!(AppError::LockBusy("x".into()).is_retryable());
        assert!(AppError::AllSlotsFull {
            max: 4,
            waited_secs: 60
        }
        .is_retryable());
        assert!(AppError::LowMemory {
            available_mb: 100,
            required_mb: 500
        }
        .is_retryable());
        assert!(AppError::RateLimited {
            detail: "429".into()
        }
        .is_retryable());
        assert!(AppError::Timeout {
            operation: "op".into(),
            duration_secs: 30
        }
        .is_retryable());
    }

    #[test]
    fn is_retryable_permanent_errors() {
        assert!(!AppError::Validation("x".into()).is_retryable());
        assert!(!AppError::NotFound("x".into()).is_retryable());
        assert!(!AppError::Duplicate("x".into()).is_retryable());
        assert!(!AppError::Conflict("x".into()).is_retryable());
        assert!(!AppError::BinaryNotFound { name: "x".into() }.is_retryable());
    }

    #[test]
    fn exit_code_new_variants() {
        assert_eq!(AppError::BinaryNotFound { name: "x".into() }.exit_code(), 1);
        assert_eq!(AppError::RateLimited { detail: "x".into() }.exit_code(), 1);
        assert_eq!(
            AppError::Timeout {
                operation: "x".into(),
                duration_secs: 5
            }
            .exit_code(),
            1
        );
    }

    // GAP-SG-78: EntityNotYetMaterialized is a transitory absence (the entity is
    // materialized on a later enrich pass), NOT a terminal not-found.
    #[test]
    fn entity_not_yet_materialized_exit_code_is_4() {
        let e = AppError::EntityNotYetMaterialized {
            name: "acme".into(),
            namespace: "global".into(),
        };
        assert_eq!(e.exit_code(), 4);
    }

    #[test]
    fn entity_not_yet_materialized_is_retryable_not_permanent() {
        let e = AppError::EntityNotYetMaterialized {
            name: "acme".into(),
            namespace: "global".into(),
        };
        assert!(e.is_retryable());
        assert!(!e.is_permanent());
    }

    #[test]
    fn entity_not_yet_materialized_user_message_non_empty() {
        let e = AppError::EntityNotYetMaterialized {
            name: "acme".into(),
            namespace: "global".into(),
        };
        assert!(!e
            .localized_message_for(crate::i18n::Language::English)
            .is_empty());
        assert!(!e
            .localized_message_for(crate::i18n::Language::Portuguese)
            .is_empty());
    }

    #[test]
    fn app_error_size_does_not_exceed_budget() {
        let size = std::mem::size_of::<AppError>();
        assert!(
            size <= 128,
            "AppError is {size} bytes — exceeds 128-byte budget; \
             consider boxing large variants to reduce memcpy cost in Result propagation"
        );
    }
}