crabka-operator 0.3.6

//! Logging resolution — compose the broker's `RUST_LOG` env-filter
//! from `Kafka.spec.logging`.
//!
//! `inline` loggers are composed by a pure, deterministic function
//! ([`compose_inline_filter`]); `external` references are read from a
//! user-managed `ConfigMap` at reconcile time. The resolved filter is
//! rendered into the broker `ConfigMap` (`rust.log` key) by
//! [`crate::controller::common::render_configmap`] and folded into the
//! config hash so a change rolls the cluster.

use std::collections::BTreeMap;

use k8s_openapi::api::core::v1::ConfigMap;
use kube::api::Api;

use crate::context::Context;
use crate::controller::common::{ReconcileError, condition};
use crate::crd::{Kafka, KafkaCondition, LoggingType};

/// Canonicalize a level string to a `tracing` env-filter level. Accepts the
/// `tracing` set (`trace|debug|info|warn|error|off`) case-insensitively, plus
/// the log4j-friendly aliases `warning` → `warn`, `fatal` → `error`, and
/// `none` → `off`. Returns `None` for anything else.
fn normalize_level(level: &str) -> Option<&'static str> {
    match level.trim().to_ascii_lowercase().as_str() {
        "trace" => Some("trace"),
        "debug" => Some("debug"),
        "info" => Some("info"),
        "warn" | "warning" => Some("warn"),
        "error" | "fatal" => Some("error"),
        "off" | "none" => Some("off"),
        _ => None,
    }
}

/// Logging resolution failures. Each maps to a `LoggingReady=False` reason.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum LoggingError {
    /// `type: inline` with an empty `loggers` map.
    EmptyLoggers,
    /// A logger key was blank after trimming.
    EmptyLoggerName,
    /// A level value was not a recognized `tracing` level.
    InvalidLevel { logger: String, level: String },
    /// `type: external` without a `valueFrom.configMapKeyRef`.
    ExternalMissingRef,
    /// The referenced `ConfigMap` does not exist.
    ExternalConfigMapNotFound { name: String },
    /// The referenced `ConfigMap` exists but the key is missing or blank.
    ExternalKeyNotFound { config_map: String, key: String },
}

impl LoggingError {
    pub(crate) fn reason(&self) -> &'static str {
        match self {
            LoggingError::EmptyLoggers => "EmptyLoggers",
            LoggingError::EmptyLoggerName => "EmptyLoggerName",
            LoggingError::InvalidLevel { .. } => "InvalidLogLevel",
            LoggingError::ExternalMissingRef => "ExternalRefMissing",
            LoggingError::ExternalConfigMapNotFound { .. } => "LoggingConfigMapNotFound",
            LoggingError::ExternalKeyNotFound { .. } => "LoggingConfigMapKeyNotFound",
        }
    }

    pub(crate) fn message(&self) -> String {
        match self {
            LoggingError::EmptyLoggers => {
                "logging.type=inline requires a non-empty loggers map".into()
            }
            LoggingError::EmptyLoggerName => "logging.loggers contains a blank key".into(),
            LoggingError::InvalidLevel { logger, level } => format!(
                "logger '{logger}' has invalid level '{level}' (want trace|debug|info|warn|error|off)"
            ),
            LoggingError::ExternalMissingRef => {
                "logging.type=external requires valueFrom.configMapKeyRef".into()
            }
            LoggingError::ExternalConfigMapNotFound { name } => {
                format!("logging ConfigMap '{name}' not found")
            }
            LoggingError::ExternalKeyNotFound { config_map, key } => {
                format!("logging ConfigMap '{config_map}' has no non-empty key '{key}'")
            }
        }
    }
}

/// Compose an env-filter directive string from an inline `loggers` map.
///
/// Pure + deterministic: directives are sorted so the resulting string (and
/// therefore the config hash) is stable across reconciles regardless of map
/// iteration order. The key `root` (case-insensitive) yields a bare level
/// token (the env-filter global default); every other key yields
/// `target=level`.
///
/// # Errors
///
/// Returns [`LoggingError::EmptyLoggers`] for an empty map,
/// [`LoggingError::EmptyLoggerName`] for a blank key, and
/// [`LoggingError::InvalidLevel`] for an unrecognized level.
pub fn compose_inline_filter(loggers: &BTreeMap<String, String>) -> Result<String, LoggingError> {
    if loggers.is_empty() {
        return Err(LoggingError::EmptyLoggers);
    }
    let mut directives: Vec<String> = Vec::with_capacity(loggers.len());
    for (logger, level) in loggers {
        let logger = logger.trim();
        if logger.is_empty() {
            return Err(LoggingError::EmptyLoggerName);
        }
        let lvl = normalize_level(level).ok_or_else(|| LoggingError::InvalidLevel {
            logger: logger.to_string(),
            level: level.clone(),
        })?;
        if logger.eq_ignore_ascii_case("root") {
            directives.push(lvl.to_string());
        } else {
            directives.push(format!("{logger}={lvl}"));
        }
    }
    directives.sort();
    Ok(directives.join(","))
}

/// Outcome of resolving `Kafka.spec.logging`.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum LoggingOutcome {
    /// `spec.logging` is unset.
    Disabled,
    /// A `RUST_LOG` filter string was successfully composed/read.
    Resolved(String),
    /// `spec.logging` is set but could not be resolved (user error).
    Invalid(LoggingError),
}

impl LoggingOutcome {
    /// The resolved filter string, if any. `None` for `Disabled`/`Invalid`.
    #[must_use]
    pub fn filter(&self) -> Option<&str> {
        match self {
            LoggingOutcome::Resolved(f) => Some(f.as_str()),
            _ => None,
        }
    }
}

/// Resolve `Kafka.spec.logging` to a `RUST_LOG` filter. `inline` is composed
/// in-process; `external` issues a single `ConfigMap` GET. A transient API
/// error during that GET propagates as `Err` (the reconcile requeues); a
/// missing ConfigMap/key surfaces as `Ok(Invalid(..))` (a user error the
/// operator reports without retry-spinning).
pub async fn resolve_logging(
    ctx: &Context,
    owner: &Kafka,
    namespace: &str,
) -> Result<LoggingOutcome, ReconcileError> {
    let Some(logging) = owner.spec.logging.as_ref() else {
        return Ok(LoggingOutcome::Disabled);
    };
    match logging.r#type {
        LoggingType::Inline => Ok(match compose_inline_filter(&logging.loggers) {
            Ok(f) => LoggingOutcome::Resolved(f),
            Err(e) => LoggingOutcome::Invalid(e),
        }),
        LoggingType::External => {
            let Some(src) = logging.value_from.as_ref() else {
                return Ok(LoggingOutcome::Invalid(LoggingError::ExternalMissingRef));
            };
            let cm_api: Api<ConfigMap> = Api::namespaced(ctx.client.clone(), namespace);
            let Some(cm) = cm_api.get_opt(&src.config_map_key_ref.name).await? else {
                return Ok(LoggingOutcome::Invalid(
                    LoggingError::ExternalConfigMapNotFound {
                        name: src.config_map_key_ref.name.clone(),
                    },
                ));
            };
            let value = cm
                .data
                .as_ref()
                .and_then(|d| d.get(&src.config_map_key_ref.key))
                .map(|v| v.trim())
                .filter(|v| !v.is_empty());
            Ok(match value {
                Some(v) => LoggingOutcome::Resolved(v.to_string()),
                None => LoggingOutcome::Invalid(LoggingError::ExternalKeyNotFound {
                    config_map: src.config_map_key_ref.name.clone(),
                    key: src.config_map_key_ref.key.clone(),
                }),
            })
        }
    }
}

/// Map a [`LoggingOutcome`] to the cluster's `LoggingReady` condition.
/// Mirrors the `MetricsReady` shape: `Disabled` surfaces a
/// `False`/`Disabled` condition rather than omitting it.
#[must_use]
pub fn condition_for(outcome: &LoggingOutcome) -> KafkaCondition {
    match outcome {
        LoggingOutcome::Disabled => condition(
            "LoggingReady",
            "False",
            "Disabled",
            "spec.logging is not set",
        ),
        LoggingOutcome::Resolved(filter) => condition(
            "LoggingReady",
            "True",
            "Available",
            &format!("RUST_LOG filter resolved: {filter}"),
        ),
        LoggingOutcome::Invalid(e) => condition("LoggingReady", "False", e.reason(), &e.message()),
    }
}

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

    fn loggers(pairs: &[(&str, &str)]) -> BTreeMap<String, String> {
        pairs
            .iter()
            .map(|(k, v)| ((*k).to_string(), (*v).to_string()))
            .collect()
    }

    #[test]
    fn compose_root_is_bare_level() {
        let f = compose_inline_filter(&loggers(&[("root", "info")])).unwrap();
        assert!(f == "info");
    }

    #[test]
    fn compose_target_is_target_equals_level() {
        let f = compose_inline_filter(&loggers(&[("crabka_broker", "debug")])).unwrap();
        assert!(f == "crabka_broker=debug");
    }

    #[test]
    fn compose_is_sorted_and_deterministic() {
        // Insertion order shouldn't matter — output is sorted.
        let f = compose_inline_filter(&loggers(&[
            ("root", "info"),
            ("crabka_raft", "warn"),
            ("crabka_broker", "debug"),
        ]))
        .unwrap();
        assert!(f == "crabka_broker=debug,crabka_raft=warn,info");
    }

    #[test]
    fn compose_levels_are_canonicalized() {
        // Uppercase + log4j aliases normalize to tracing levels.
        let f = compose_inline_filter(&loggers(&[
            ("root", "INFO"),
            ("crabka_broker", "WARNING"),
            ("crabka_log", "FATAL"),
            ("crabka_raft", "OFF"),
        ]))
        .unwrap();
        assert!(f == "crabka_broker=warn,crabka_log=error,crabka_raft=off,info");
    }

    #[test]
    fn compose_root_is_case_insensitive() {
        let f = compose_inline_filter(&loggers(&[("ROOT", "debug")])).unwrap();
        assert!(f == "debug");
    }

    #[test]
    fn compose_rejects_empty_map() {
        assert!(compose_inline_filter(&BTreeMap::new()).unwrap_err() == LoggingError::EmptyLoggers);
    }

    #[test]
    fn compose_rejects_blank_logger_name() {
        let err = compose_inline_filter(&loggers(&[("  ", "info")])).unwrap_err();
        assert!(err == LoggingError::EmptyLoggerName);
    }

    #[test]
    fn compose_rejects_invalid_level() {
        let err = compose_inline_filter(&loggers(&[("root", "verbose")])).unwrap_err();
        assert!(
            err == LoggingError::InvalidLevel {
                logger: "root".into(),
                level: "verbose".into()
            }
        );
        assert!(err.reason() == "InvalidLogLevel");
    }

    #[test]
    fn outcome_filter_accessor() {
        assert!(LoggingOutcome::Resolved("info".into()).filter() == Some("info"));
        assert!(LoggingOutcome::Disabled.filter() == None);
        assert!(LoggingOutcome::Invalid(LoggingError::EmptyLoggers).filter() == None);
    }

    #[test]
    fn condition_disabled_is_false() {
        let c = condition_for(&LoggingOutcome::Disabled);
        assert!(c.type_ == "LoggingReady");
        assert!(c.status == "False");
        assert!(c.reason == "Disabled");
    }

    #[test]
    fn condition_resolved_is_true_and_echoes_filter() {
        let c = condition_for(&LoggingOutcome::Resolved("crabka_broker=debug,info".into()));
        assert!(c.status == "True");
        assert!(c.reason == "Available");
        assert!(c.message.contains("crabka_broker=debug,info"));
    }

    #[test]
    fn condition_invalid_carries_reason() {
        let c = condition_for(&LoggingOutcome::Invalid(
            LoggingError::ExternalConfigMapNotFound {
                name: "missing-cm".into(),
            },
        ));
        assert!(c.status == "False");
        assert!(c.reason == "LoggingConfigMapNotFound");
        assert!(c.message.contains("missing-cm"));
    }
}