systemprompt_runtime/startup_validation/

extension_validator.rs

//! Per-extension config and asset validation at startup.
//!
//! Copyright (c) systemprompt.io — Business Source License 1.1.
//! See <https://systemprompt.io> for licensing details.

use std::path::Path;
use systemprompt_config::ProfileBootstrap;
use systemprompt_config::paths::AppPaths;
use systemprompt_extension::{ExtensionConfigError, ExtensionRegistry, LoaderError};
use systemprompt_identifiers::ExtensionId;
use systemprompt_logging::CliService;
use systemprompt_logging::services::cli::{BrandColors, render_phase_success};
use systemprompt_manifest::Config;
use systemprompt_traits::validation_report::ValidationIssue;
use systemprompt_traits::{StartupValidationReport, ValidationReport};

use super::config_loaders::{ConfigFileError, load_extension_config};

pub(super) fn validate_extensions(
    config: &Config,
    report: &mut StartupValidationReport,
    verbose: bool,
) {
    let extensions = match ExtensionRegistry::discover() {
        Ok(extensions) => extensions,
        Err(e) => {
            let mut ext_report = ValidationReport::new("ext:registry".to_owned());
            ext_report.add_error(ValidationIssue::new(
                "extension_discovery",
                format!("Failed to discover extensions: {}", e),
            ));
            report.add_extension(ext_report);
            return;
        },
    };
    let config_extensions = extensions.config_extensions();
    let asset_extensions = extensions.asset_extensions();

    let has_extensions = !config_extensions.is_empty() || !asset_extensions.is_empty();

    if !has_extensions {
        return;
    }

    if verbose {
        CliService::output("");
        CliService::output(&format!(
            "{} {}",
            BrandColors::primary("▸"),
            BrandColors::white_bold("Validating extensions")
        ));
    }

    for ext in config_extensions {
        validate_single_extension(config, ext.as_ref(), report, verbose);
    }

    let paths = ProfileBootstrap::get().ok().and_then(|p| {
        AppPaths::from_profile(
            &p.paths,
            p.path_resolution(),
            systemprompt_loader::ServicesRootBootstrap::get().map(|r| r.path.as_path()),
        )
        .ok()
    });

    match paths {
        Some(paths) => validate_extension_assets(&extensions, &paths, report, verbose),
        None if verbose => {
            CliService::output(&format!(
                "  {} Asset validation skipped (profile not loaded)",
                BrandColors::dim("○")
            ));
        },
        None => {},
    }
}

fn validate_extension_assets(
    registry: &ExtensionRegistry,
    paths: &AppPaths,
    report: &mut StartupValidationReport,
    verbose: bool,
) {
    for ext in registry.asset_extensions() {
        let ext_id = ext.id();
        let mut has_errors = false;

        for asset in ext.required_assets(paths) {
            if asset.is_required() && !asset.source().exists() {
                has_errors = true;
                let mut ext_report = ValidationReport::new(format!("ext:{}", ext_id));
                ext_report.add_error(
                    ValidationIssue::new(
                        "required_asset",
                        format!("Missing required asset: {}", asset.source().display()),
                    )
                    .with_suggestion("Ensure the asset file exists at the specified path"),
                );
                report.add_extension(ext_report);

                CliService::output(&format!(
                    "  {} [ext:{}] Missing asset: {}",
                    BrandColors::stopped("✗"),
                    ext_id,
                    asset.source().display()
                ));
            }
        }

        if !has_errors && verbose {
            render_phase_success(&format!("[ext:{}]", ext_id), Some("assets valid"));
        }
    }
}

/// A single extension's resolved config-validation result.
///
/// Produced by [`validate_extension_configs`] so callers outside the serve
/// boot path (e.g. the `cloud doctor` preflight) can run the exact same
/// `validate_config` pass without a `Config` or a [`StartupValidationReport`].
#[derive(Debug)]
pub struct ExtensionConfigOutcome {
    pub extension_id: ExtensionId,
    pub config_key: String,
    pub error: Option<String>,
}

#[derive(Debug, thiserror::Error)]
enum ExtConfigError {
    #[error("{0}")]
    Load(#[source] ConfigFileError),
    #[error("{0}")]
    Validate(#[source] ExtensionConfigError),
}

fn evaluate_extension_config(
    ext: &dyn systemprompt_extension::Extension,
    services_path: &Path,
) -> Result<(), ExtConfigError> {
    let Some(prefix) = ext.config_prefix() else {
        return Ok(());
    };

    let config_path = services_path
        .join("config")
        .join(format!("{}.yaml", prefix));

    let config_json = if config_path.exists() {
        load_extension_config(&config_path).map_err(ExtConfigError::Load)?
    } else {
        serde_json::json!({})
    };

    ext.validate_config(&config_json)
        .map_err(ExtConfigError::Validate)
}

pub fn validate_extension_configs(
    services_path: &Path,
) -> Result<Vec<ExtensionConfigOutcome>, LoaderError> {
    let extensions = ExtensionRegistry::discover()?;

    Ok(extensions
        .config_extensions()
        .iter()
        .filter_map(|ext| {
            let prefix = ext.config_prefix()?;
            let error = evaluate_extension_config(ext.as_ref(), services_path)
                .err()
                .map(|e| e.to_string());
            Some(ExtensionConfigOutcome {
                extension_id: ExtensionId::new(ext.id()),
                config_key: format!("{}.config", prefix),
                error,
            })
        })
        .collect())
}

fn validate_single_extension(
    config: &Config,
    ext: &dyn systemprompt_extension::Extension,
    report: &mut StartupValidationReport,
    verbose: bool,
) {
    let ext_id = ext.id();
    let Some(prefix) = ext.config_prefix() else {
        return;
    };

    match evaluate_extension_config(ext, Path::new(&config.services_path)) {
        Ok(()) => {
            if verbose {
                render_phase_success(&format!("[ext:{}]", ext_id), Some("valid"));
            }
        },
        Err(e) => {
            let report_message = match &e {
                ExtConfigError::Load(cause) => format!("Failed to load config: {cause}"),
                ExtConfigError::Validate(cause) => cause.to_string(),
            };
            let mut ext_report = ValidationReport::new(format!("ext:{}", ext_id));
            ext_report.add_error(ValidationIssue::new(
                format!("{}.config", prefix),
                report_message,
            ));
            report.add_extension(ext_report);
            CliService::output(&format!(
                "  {} [ext:{}] {}",
                BrandColors::stopped("✗"),
                ext_id,
                e
            ));
        },
    }
}