cabinpkg 0.17.0

//! Registry mapping known typed domain errors to the
//! diagnostic-rendering shape they should use.
//!
//! The `cabin` dispatcher returns `anyhow::Error`; the leaves
//! of that chain are typed domain errors (`ManifestError`,
//! `WorkspaceError`, `ConfigError`, …).  Some implement
//! [`miette::Diagnostic`] and carry rich source-spanned reports;
//! others only need a stable area code so the renderer can wrap
//! them in `error[<code>]: <message>`.
//!
//! [`downcast_diagnostic`] is the lookup: it walks the known
//! typed-error roots and yields a [`DiagnosticCandidate`] when
//! one matches.  Adding a new diagnostic-bearing error type is
//! a one-line edit here, isolated from the top-level
//! orchestration in `lib.rs::run`.
//!
//! The candidate type lives in this module too - it is the
//! vocabulary the registry uses to describe a renderable
//! error.  The top-level error renderer
//! ([`crate::error_rendering`]) then asks each candidate to
//! render itself through [`cabin_diagnostics`].

use cabin_core::ColorChoice;
use termcolor::StandardStream;

/// A diagnostic recovered from one item in the anyhow source
/// chain.
pub(crate) enum DiagnosticCandidate<'a> {
    /// The domain error itself implements `miette::Diagnostic`
    /// and may carry source snippets or variant-specific help.
    Rich(&'a dyn cabin_diagnostics::miette::Diagnostic),
    /// The domain error is typed and user-facing, but only needs
    /// an area-level stable code.  Wrap it so rendering still goes
    /// through `cabin-diagnostics`.
    Coded { code: &'static str },
}

impl DiagnosticCandidate<'_> {
    pub(crate) fn render(
        &self,
        root: &anyhow::Error,
        stderr: &mut StandardStream,
        color: ColorChoice,
    ) -> std::io::Result<()> {
        match self {
            Self::Rich(diag) => cabin_diagnostics::render(*diag, stderr, color),
            Self::Coded { code } => {
                let message = format!("{root:#}");
                let diagnostic = cabin_diagnostics::CodedMessage::new(&message, code);
                cabin_diagnostics::render(&diagnostic, stderr, color)
            }
        }
    }
}

/// Walk the known typed-error roots and yield a diagnostic
/// candidate when one matches.
///
/// Adding a new diagnostic-bearing error type is a one-line
/// change here.  The cost of explicit listing is small relative
/// to the boundary clarity it gives - we never accidentally
/// route a typed error away from the diagnostic renderer
/// because of an unsafe blanket impl.
pub(crate) fn downcast_diagnostic<'a>(
    err: &'a (dyn std::error::Error + 'static),
) -> Option<DiagnosticCandidate<'a>> {
    use cabin_diagnostics::code;

    // The order matters: try the most specific typed error
    // first, then fall through to looser wrappers that share
    // the same source chain.  ManifestError can hide either
    // standalone (e.g. `cabin package`) or behind
    // WorkspaceError::Manifest, so we look at the leaf first.
    if let Some(e) = err.downcast_ref::<cabin_manifest::ManifestError>() {
        return Some(DiagnosticCandidate::Rich(e));
    }
    // Workspace / artifact / package errors box their inner
    // `ManifestError` (the boxed variant keeps the outer error
    // small enough to pass `clippy::result_large_err`); the
    // chain walker would otherwise skip the manifest layer.
    if let Some(e) = err.downcast_ref::<Box<cabin_manifest::ManifestError>>() {
        return Some(DiagnosticCandidate::Rich(e.as_ref()));
    }
    if let Some(e) = err.downcast_ref::<cabin_workspace::WorkspaceError>() {
        return Some(DiagnosticCandidate::Rich(e));
    }
    if let Some(e) = err.downcast_ref::<cabin_system_deps::PkgConfigError>() {
        return Some(DiagnosticCandidate::Rich(e));
    }
    if let Some(e) = err.downcast_ref::<cabin_config::ConfigError>() {
        return Some(DiagnosticCandidate::Coded {
            code: config_error_code(e),
        });
    }
    if err
        .downcast_ref::<cabin_lockfile::LockfileError>()
        .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::LOCKFILE_ERROR,
        });
    }
    if let Some(e) = err.downcast_ref::<cabin_resolver::ResolveError>() {
        return Some(DiagnosticCandidate::Rich(e));
    }
    if err
        .downcast_ref::<cabin_artifact::ArtifactError>()
        .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::ARTIFACT_ERROR,
        });
    }
    if err.downcast_ref::<cabin_build::BuildError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::BUILD_ERROR,
        });
    }
    // `BuildError::StandardFlagConflict` boxes the typed conflict
    // (keeping the enum small), so the chain element is the `Box` -
    // match both shapes, like the boxed `ManifestError` above.
    if err
        .downcast_ref::<cabin_core::StandardFlagConflict>()
        .is_some()
        || err
            .downcast_ref::<Box<cabin_core::StandardFlagConflict>>()
            .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::LANGUAGE_STANDARD_FLAG_CONFLICT,
        });
    }
    if err.downcast_ref::<cabin_package::PackageError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::PACKAGE_ERROR,
        });
    }
    if err
        .downcast_ref::<cabin_toolchain::ToolchainError>()
        .is_some()
        || err
            .downcast_ref::<cabin_toolchain::ToolchainDetectionFailure>()
            .is_some()
        || err.downcast_ref::<cabin_toolchain::RunError>().is_some()
        || err
            .downcast_ref::<cabin_toolchain::CompilerWrapperResolutionError>()
            .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::TOOLCHAIN_ERROR,
        });
    }
    if err.downcast_ref::<cabin_vendor::VendorError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::VENDOR_ERROR,
        });
    }
    if err.downcast_ref::<cabin_index::IndexError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::INDEX_ERROR,
        });
    }
    if err
        .downcast_ref::<cabin_index_http::IndexHttpError>()
        .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::INDEX_HTTP_ERROR,
        });
    }
    if err.downcast_ref::<cabin_publish::PublishError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::PUBLISH_ERROR,
        });
    }
    if err.downcast_ref::<cabin_fmt::FormatError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::FMT_ERROR,
        });
    }
    if err.downcast_ref::<cabin_tidy::TidyError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::TIDY_ERROR,
        });
    }
    if err
        .downcast_ref::<cabin_source_discovery::SourceDiscoveryError>()
        .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::SOURCE_DISCOVERY_ERROR,
        });
    }
    if err.downcast_ref::<cabin_test::TestRunError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::TEST_ERROR,
        });
    }
    if err.downcast_ref::<cabin_explain::ExplainError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::EXPLAIN_ERROR,
        });
    }
    if err.downcast_ref::<cabin_ninja::NinjaError>().is_some() {
        return Some(DiagnosticCandidate::Coded {
            code: code::NINJA_ERROR,
        });
    }
    if err
        .downcast_ref::<cabin_feature::FeatureResolverError>()
        .is_some()
    {
        return Some(DiagnosticCandidate::Coded {
            code: code::FEATURE_ERROR,
        });
    }
    None
}

fn config_error_code(error: &cabin_config::ConfigError) -> &'static str {
    use cabin_config::{ConfigError, ConfigParseError};
    use cabin_diagnostics::code;

    match error {
        ConfigError::Parse {
            source: ConfigParseError::InvalidBuildJobs { .. },
            ..
        } => code::CONFIG_INVALID_BUILD_JOBS,
        _ => code::CONFIG_LOAD_FAILED,
    }
}