scour_secrets/processor/

registry.rs

//! Processor registry — discovers and dispatches structured processors.
//!
//! The [`ProcessorRegistry`] holds a set of registered [`Processor`]
//! implementations and provides methods to:
//!
//! 1. Look up a processor by name.
//! 2. Auto-detect a processor for given content + profile.
//! 3. Process content using a matching processor, falling back to `None`
//!    if no processor matches (caller can then use the streaming scanner).

use super::{FileTypeProfile, Processor};
use crate::error::Result;
use crate::store::MappingStore;
use std::collections::HashMap;
use std::sync::Arc;

/// Registry of structured processors.
///
/// Thread-safe (processors are `Arc<dyn Processor>`) and can be shared
/// across threads via `Arc<ProcessorRegistry>`.
pub struct ProcessorRegistry {
    /// Processors indexed by name.
    processors: HashMap<String, Arc<dyn Processor>>,
}

impl ProcessorRegistry {
    /// Create an empty registry.
    #[must_use]
    pub fn new() -> Self {
        Self {
            processors: HashMap::new(),
        }
    }

    /// Create a registry pre-populated with all built-in processors.
    #[must_use]
    pub fn with_builtins() -> Self {
        let mut reg = Self::new();
        // Registered under "key_value" (canonical, from name()) and "key-value" (hyphen alias)
        // so profile files can use either naming convention.
        reg.register_with_alias(Arc::new(super::key_value::KeyValueProcessor), "key-value");
        reg.register(Arc::new(super::json_proc::JsonProcessor));
        reg.register(Arc::new(super::jsonl_proc::JsonLinesProcessor));
        reg.register(Arc::new(super::yaml_proc::YamlProcessor));
        #[cfg(feature = "structured")]
        reg.register(Arc::new(super::xml_proc::XmlProcessor));
        #[cfg(feature = "structured")]
        reg.register(Arc::new(super::csv_proc::CsvProcessor));
        reg.register(Arc::new(super::toml_proc::TomlProcessor));
        reg.register(Arc::new(super::env_proc::EnvProcessor));
        reg.register(Arc::new(super::ini_proc::IniProcessor));
        reg.register(Arc::new(super::log_line::LogLineProcessor::new()));
        reg.register(Arc::new(super::command_output::CommandOutputProcessor));
        reg.register(Arc::new(super::columns::ColumnsProcessor));
        reg
    }

    /// Register a processor. Overwrites any existing processor with the
    /// same name.
    pub fn register(&mut self, processor: Arc<dyn Processor>) {
        self.processors
            .insert(processor.name().to_string(), processor);
    }

    /// Register a processor under its canonical name and an additional alias.
    pub fn register_with_alias(&mut self, processor: Arc<dyn Processor>, alias: &str) {
        self.processors
            .insert(alias.to_string(), Arc::clone(&processor));
        self.processors
            .insert(processor.name().to_string(), processor);
    }

    /// Look up a processor by its name.
    pub fn get(&self, name: &str) -> Option<&Arc<dyn Processor>> {
        self.processors.get(name)
    }

    /// List all registered processor names.
    pub fn names(&self) -> Vec<&str> {
        self.processors.keys().map(|s| s.as_str()).collect()
    }

    /// Number of registered processors.
    #[must_use]
    pub fn len(&self) -> usize {
        self.processors.len()
    }

    /// Whether the registry is empty.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.processors.is_empty()
    }

    /// Find a processor that can handle the given content + profile.
    ///
    /// 1. If the profile names a specific processor, look it up directly.
    /// 2. Otherwise, iterate all processors and return the first whose
    ///    `can_handle` returns `true`.
    ///
    /// Returns `None` if no processor matches (caller should fall back
    /// to the streaming scanner).
    pub fn find_processor(
        &self,
        content: &[u8],
        profile: &FileTypeProfile,
    ) -> Option<&Arc<dyn Processor>> {
        // Direct lookup by profile's processor name.
        if let Some(proc) = self.processors.get(&profile.processor) {
            if proc.can_handle(content, profile) {
                return Some(proc);
            }
        }

        // Auto-detect: first matching processor.
        self.processors
            .values()
            .find(|proc| proc.can_handle(content, profile))
    }

    /// Process content using the matching processor.
    ///
    /// Returns `Ok(Some(output))` if a processor matched and succeeded,
    /// `Ok(None)` if no processor matches (caller should fall back),
    /// or `Err(...)` if processing failed.
    ///
    /// # Errors
    ///
    /// Returns the underlying processor's error if processing fails.
    pub fn process(
        &self,
        content: &[u8],
        profile: &FileTypeProfile,
        store: &MappingStore,
    ) -> Result<Option<Vec<u8>>> {
        match self.find_processor(content, profile) {
            Some(proc) => {
                let output = proc.process(content, profile, store)?;
                Ok(Some(output))
            }
            None => Ok(None),
        }
    }

    /// Span-based structured processing: returns the edited bytes when the
    /// matching processor supports [`Processor::process_to_edits`], or `None`
    /// when there is no matching processor or it does not support span editing
    /// (the caller then falls back to [`Self::process`] + the scanner).
    ///
    /// # Errors
    ///
    /// Propagates parse/replacement errors from the processor.
    pub fn process_to_edits(
        &self,
        content: &[u8],
        profile: &FileTypeProfile,
        store: &MappingStore,
    ) -> Result<Option<(Vec<u8>, usize)>> {
        match self.find_processor(content, profile) {
            Some(proc) => match proc.process_to_edits(content, profile, store)? {
                Some(edits) => {
                    let count = edits.len();
                    Ok(Some((super::apply_edits(content, edits), count)))
                }
                None => Ok(None),
            },
            None => Ok(None),
        }
    }
}

impl Default for ProcessorRegistry {
    fn default() -> Self {
        Self::with_builtins()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::category::Category;
    use crate::generator::HmacGenerator;
    use crate::processor::profile::{FieldRule, FileTypeProfile};
    use std::sync::Arc;

    fn make_store() -> MappingStore {
        let gen = Arc::new(HmacGenerator::new([42u8; 32]));
        MappingStore::new(gen, None)
    }

    #[test]
    fn new_registry_is_empty() {
        let reg = ProcessorRegistry::new();
        assert!(reg.is_empty());
        assert_eq!(reg.len(), 0);
    }

    #[test]
    fn with_builtins_registers_known_processors() {
        let reg = ProcessorRegistry::with_builtins();
        assert!(!reg.is_empty());
        let names = reg.names();
        for expected in &["json", "yaml", "xml", "csv", "toml", "jsonl"] {
            assert!(names.contains(expected), "missing processor: {expected}");
        }
    }

    #[test]
    fn register_and_get_roundtrip() {
        let mut reg = ProcessorRegistry::new();
        reg.register(Arc::new(crate::processor::json_proc::JsonProcessor));
        assert!(reg.get("json").is_some());
        assert!(reg.get("xml").is_none());
    }

    #[test]
    fn register_overwrites_existing() {
        let mut reg = ProcessorRegistry::new();
        reg.register(Arc::new(crate::processor::json_proc::JsonProcessor));
        reg.register(Arc::new(crate::processor::json_proc::JsonProcessor));
        assert_eq!(reg.len(), 1);
    }

    #[test]
    fn names_lists_all_registered() {
        let mut reg = ProcessorRegistry::new();
        reg.register(Arc::new(crate::processor::json_proc::JsonProcessor));
        reg.register(Arc::new(crate::processor::yaml_proc::YamlProcessor));
        let names = reg.names();
        assert_eq!(names.len(), 2);
        assert!(names.contains(&"json"));
        assert!(names.contains(&"yaml"));
    }

    #[test]
    fn find_processor_by_profile_name() {
        let reg = ProcessorRegistry::with_builtins();
        let profile = FileTypeProfile::new("json", vec![]).with_extension(".json");
        let content = b"{}";
        assert!(reg.find_processor(content, &profile).is_some());
    }

    #[test]
    fn find_processor_returns_none_for_unrecognised_content() {
        let reg = ProcessorRegistry::new(); // empty — nothing registered
        let profile = FileTypeProfile::new("json", vec![]).with_extension(".json");
        assert!(reg.find_processor(b"{}", &profile).is_none());
    }

    #[test]
    fn process_returns_some_for_matching_content() {
        let reg = ProcessorRegistry::with_builtins();
        let store = make_store();
        let profile = FileTypeProfile::new(
            "json",
            vec![FieldRule::new("*.secret").with_category(Category::Custom("s".into()))],
        )
        .with_extension(".json");
        let result = reg
            .process(br#"{"secret":"abc"}"#, &profile, &store)
            .unwrap();
        assert!(result.is_some());
    }

    #[test]
    fn process_returns_none_when_no_processor_matches() {
        let reg = ProcessorRegistry::new(); // empty
        let store = make_store();
        let profile = FileTypeProfile::new("json", vec![]).with_extension(".json");
        let result = reg.process(b"{}", &profile, &store).unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn default_impl_gives_builtins() {
        let reg = ProcessorRegistry::default();
        assert!(reg.get("json").is_some());
    }
}