provenant/

progress.rs

// SPDX-FileCopyrightText: nexB Inc. and others
// ScanCode is a trademark of nexB Inc.
// SPDX-FileCopyrightText: Provenant contributors
// SPDX-License-Identifier: Apache-2.0
// Derived from ScanCode Toolkit (Apache-2.0); modified. See NOTICE.

use std::collections::HashMap;
use std::env;
use std::io::IsTerminal;
use std::path::Path;
use std::sync::Mutex;
use std::time::Instant;

use env_logger::Env;
use indicatif::{MultiProgress, ProgressBar, ProgressDrawTarget, ProgressStyle};
use indicatif_log_bridge::LogWrapper;
use log::LevelFilter;

use crate::cli::ProcessMode;
use crate::models::{DiagnosticSeverity, FileInfo, FileType, Header, ScanDiagnostic};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ProgressMode {
    Quiet,
    Default,
    Verbose,
}

#[derive(Debug, Default, Clone)]
pub struct ScanStats {
    pub processes: ProcessMode,
    pub scan_names: String,
    pub initial_files: usize,
    pub initial_dirs: usize,
    pub initial_size: u64,
    pub excluded_count: usize,
    pub final_files: usize,
    pub final_dirs: usize,
    pub final_size: u64,
    pub error_count: usize,
    pub warning_count: usize,
    pub total_bytes_scanned: u64,
    pub packages_assembled: usize,
    pub manifests_seen: usize,
    pub top_level_timings: Vec<(String, f64)>,
    pub detail_timings: Vec<(String, f64)>,
    pub incremental_reused: usize,
}

pub struct ScanProgress {
    mode: ProgressMode,
    multi: MultiProgress,
    scan_bar: ProgressBar,
    stats: Mutex<ScanStats>,
    phase_starts: Mutex<HashMap<&'static str, Instant>>,
    phase_spinner: Mutex<Option<ProgressBar>>,
    stderr_is_tty: bool,
}

impl ScanProgress {
    pub fn new(mode: ProgressMode) -> Self {
        let stderr_is_tty = std::io::stderr().is_terminal();
        let multi = match mode {
            ProgressMode::Quiet => MultiProgress::with_draw_target(ProgressDrawTarget::hidden()),
            ProgressMode::Default if stderr_is_tty => {
                MultiProgress::with_draw_target(ProgressDrawTarget::stderr_with_hz(15))
            }
            ProgressMode::Default | ProgressMode::Verbose => {
                MultiProgress::with_draw_target(ProgressDrawTarget::hidden())
            }
        };

        let scan_bar = if mode == ProgressMode::Default && stderr_is_tty {
            multi.add(ProgressBar::new(0))
        } else {
            ProgressBar::hidden()
        };

        scan_bar.set_style(
            ProgressStyle::default_bar()
                .template(
                    "{spinner:.green} [{elapsed_precise}] [{bar:40.cyan/blue}] {pos}/{len} files ({per_sec}) ({eta})",
                )
                .expect("Failed to create progress bar style")
                .progress_chars("#>-"),
        );

        Self {
            mode,
            multi,
            scan_bar,
            stats: Mutex::new(ScanStats::default()),
            phase_starts: Mutex::new(HashMap::new()),
            phase_spinner: Mutex::new(None),
            stderr_is_tty,
        }
    }

    pub fn start_setup(&self) {
        self.start_phase("setup");
    }

    pub fn finish_setup(&self) {
        self.finish_top_level_phase("setup");
    }

    pub fn set_processes(&self, processes: ProcessMode) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.processes = processes;
    }

    pub fn set_scan_names(&self, scan_names: String) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.scan_names = scan_names;
    }

    pub fn init_logging_bridge(&self) {
        if self.mode == ProgressMode::Quiet {
            return;
        }

        let logger = build_env_logger();
        let level = logger.filter();
        if LogWrapper::new(self.multi.clone(), logger)
            .try_init()
            .is_ok()
        {
            log::set_max_level(level);
        }
    }

    pub fn start_discovery(&self) {
        self.start_phase("inventory");
        match self.mode {
            ProgressMode::Quiet => {}
            ProgressMode::Default => {
                self.start_spinner("Collecting files...");
            }
            ProgressMode::Verbose => {
                self.message("Collecting files...");
            }
        }
    }

    pub fn finish_discovery(&self, files: usize, dirs: usize, size: u64, excluded: usize) {
        self.finish_spinner();
        self.finish_top_level_phase("inventory");
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.initial_files = files;
        stats.initial_dirs = dirs;
        stats.initial_size = size;
        stats.excluded_count = excluded;
    }

    pub fn start_license_detection_engine_creation(&self) {
        self.start_phase("license_detection_engine_creation");
    }

    /// Surface the one-time cold-build latency notice. Invoked by the engine
    /// initializer only when it actually rebuilds the index (cache miss,
    /// `--reindex`, or an invalidated cache); the common warm path loads the
    /// rkyv cache in a fraction of a second and stays silent.
    pub fn notify_license_index_cold_build(&self) {
        self.message("Building license index (first run may take a few seconds)...");
    }

    pub fn finish_license_detection_engine_creation(&self, detail_name: impl Into<String>) {
        self.finish_detail_phase(detail_name.into(), "license_detection_engine_creation");
    }

    pub fn start_scan(&self, total_files: usize) {
        self.start_phase("scan");
        self.scan_bar.set_length(total_files as u64);
        self.scan_bar.set_position(0);

        if matches!(self.mode, ProgressMode::Default | ProgressMode::Verbose) && !self.stderr_is_tty
        {
            self.message(&format!(
                "Scanning {total_files} {}...",
                pluralize_files(total_files)
            ));
        }
    }

    pub fn file_completed(&self, path: &Path, bytes: u64, scan_diagnostics: &[ScanDiagnostic]) {
        self.scan_bar.inc(1);
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.total_bytes_scanned += bytes;

        let PartitionedDiagnostics {
            errors,
            warnings,
            infos,
        } = partition_scan_diagnostics(scan_diagnostics);

        if !errors.is_empty() {
            stats.error_count += 1;
        } else if !warnings.is_empty() {
            stats.warning_count += 1;
        }
        drop(stats);

        match self.mode {
            ProgressMode::Quiet => {}
            ProgressMode::Default => {
                if let Some(formatted) =
                    format_default_scan_error_from_diagnostics(path, scan_diagnostics)
                {
                    self.error(&formatted);
                } else if let Some(formatted) =
                    format_default_scan_warning_from_list(path, &warnings)
                {
                    self.message(&format!("Warning: {formatted}"));
                }
            }
            ProgressMode::Verbose => {
                if self.stderr_is_tty
                    || !errors.is_empty()
                    || !warnings.is_empty()
                    || !infos.is_empty()
                {
                    self.message(&path.to_string_lossy());
                }
                for err in &errors {
                    for line in err.lines() {
                        self.error(&format!("  {line}"));
                    }
                }
                for warning in &warnings {
                    for line in warning.lines() {
                        self.message(&format!("  warning: {line}"));
                    }
                }
                for info in &infos {
                    for line in info.lines() {
                        self.message(&format!("  info: {line}"));
                    }
                }
            }
        }
    }

    pub fn record_runtime_error(&self, path: &Path, err: &str) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.error_count += 1;
        drop(stats);

        match self.mode {
            ProgressMode::Quiet => {}
            ProgressMode::Default => self.error(&format_default_scan_error(path, err)),
            ProgressMode::Verbose => {
                self.error(&format!("Path: {}", path.to_string_lossy()));
                for line in err.lines() {
                    self.error(&format!("  {line}"));
                }
            }
        }
    }

    pub fn record_additional_error(&self, err: &str) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.error_count += 1;
        drop(stats);

        if self.mode != ProgressMode::Quiet {
            self.error(err);
        }
    }

    pub fn finish_scan(&self) {
        self.finish_top_level_phase("scan");
        if self.mode == ProgressMode::Default && self.stderr_is_tty {
            self.scan_bar.finish_with_message("Scan complete!");
        } else {
            self.scan_bar.finish_and_clear();
            if matches!(self.mode, ProgressMode::Default)
                || (self.mode == ProgressMode::Verbose && !self.stderr_is_tty)
            {
                self.message("Scan complete.");
            }
        }
    }

    pub fn record_incremental_reused(&self, count: usize) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.incremental_reused += count;
    }

    pub fn start_assembly(&self) {
        self.start_phase("assembly");
        match self.mode {
            ProgressMode::Quiet => {}
            ProgressMode::Default => self.start_spinner("Assembling packages..."),
            ProgressMode::Verbose => self.message("Assembling packages..."),
        }
    }

    pub fn assembly_step(&self, step: &str) {
        if self.mode == ProgressMode::Verbose {
            self.message(&format!("  {step}"));
        }
    }

    pub fn finish_assembly(&self, packages_assembled: usize, manifests_seen: usize) {
        self.finish_spinner();
        self.finish_top_level_phase("assembly");
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.packages_assembled = packages_assembled;
        stats.manifests_seen = manifests_seen;
    }

    pub fn start_output(&self) {
        self.start_phase("output");
        match self.mode {
            ProgressMode::Quiet => {}
            ProgressMode::Default => self.start_spinner("Writing output..."),
            ProgressMode::Verbose => self.message("Writing output..."),
        }
    }

    pub fn output_written(&self, text: &str) {
        self.message(text);
    }

    pub fn finish_output(&self) {
        self.finish_spinner();
        self.finish_top_level_phase("output");
    }

    pub fn start_post_scan(&self) {
        self.start_phase("post-scan");
        if self.mode == ProgressMode::Verbose {
            self.message("Post-processing scan results...");
        }
    }

    pub fn post_scan_step(&self, step: &str) {
        if self.mode == ProgressMode::Verbose {
            self.message(&format!("  {step}"));
        }
    }

    pub fn finish_post_scan(&self) {
        self.finish_top_level_phase("post-scan");
    }

    pub fn start_finalize(&self) {
        self.start_phase("finalize");
        if self.mode == ProgressMode::Verbose {
            self.message("Finalizing scan results...");
        }
    }

    pub fn finalize_step(&self, step: &str) {
        if self.mode == ProgressMode::Verbose {
            self.message(&format!("  {step}"));
        }
    }

    pub fn finish_finalize(&self) {
        self.finish_top_level_phase("finalize");
    }

    pub fn record_detail_timing(&self, name: impl Into<String>, duration: f64) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        accumulate_timing(&mut stats.detail_timings, name.into(), duration);
    }

    pub fn record_final_counts(&self, files: &[FileInfo]) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        stats.final_files = files
            .iter()
            .filter(|f| f.file_type == FileType::File)
            .count();
        stats.final_dirs = files
            .iter()
            .filter(|f| f.file_type == FileType::Directory)
            .count();
        stats.final_size = files
            .iter()
            .filter(|f| f.file_type == FileType::File)
            .map(|f| f.size)
            .sum();
    }

    pub fn record_final_header_counts(&self, headers: &[Header]) {
        let mut stats = self.stats.lock().expect("stats lock poisoned");
        let header_error_count: usize = headers.iter().map(|header| header.errors.len()).sum();
        let header_warning_count: usize = headers.iter().map(|header| header.warnings.len()).sum();

        stats.error_count = stats.error_count.max(header_error_count);
        stats.warning_count = stats.warning_count.max(header_warning_count);
    }

    pub fn display_summary(&self, scan_start: &str, scan_end: &str) {
        if self.mode == ProgressMode::Quiet {
            return;
        }

        let stats = self.stats.lock().expect("stats lock poisoned");

        if stats.error_count > 0 {
            self.error("Some files failed to scan properly:");
        } else if stats.warning_count > 0 {
            self.message("Some files reported recoverable scan warnings:");
        }
        for line in build_summary_messages(
            &stats,
            scan_start,
            scan_end,
            self.mode == ProgressMode::Verbose,
        ) {
            self.message(&line);
        }
        if stats.incremental_reused > 0 {
            self.message(&format!(
                "Incremental:    {} unchanged file(s) reused",
                stats.incremental_reused
            ));
        }
    }

    fn message(&self, msg: &str) {
        if self.mode == ProgressMode::Quiet {
            return;
        }

        if self.mode == ProgressMode::Default && self.stderr_is_tty {
            let _ = self.multi.println(msg);
        } else {
            eprintln!("{msg}");
        }
    }

    fn error(&self, msg: &str) {
        if self.mode == ProgressMode::Quiet {
            return;
        }

        if supports_color(self.stderr_is_tty) {
            self.message(&format!("\u{1b}[31m{msg}\u{1b}[0m"));
        } else {
            self.message(msg);
        }
    }

    fn start_phase(&self, phase: &'static str) {
        self.phase_starts
            .lock()
            .expect("phase lock poisoned")
            .insert(phase, Instant::now());
    }

    fn finish_top_level_phase(&self, phase: &'static str) {
        let start = self
            .phase_starts
            .lock()
            .expect("phase lock poisoned")
            .remove(phase);
        if let Some(start) = start {
            let mut stats = self.stats.lock().expect("stats lock poisoned");
            accumulate_timing(
                &mut stats.top_level_timings,
                phase.to_string(),
                start.elapsed().as_secs_f64(),
            );
        }
    }

    fn finish_detail_phase(&self, name: String, phase: &'static str) {
        let start = self
            .phase_starts
            .lock()
            .expect("phase lock poisoned")
            .remove(phase);
        if let Some(start) = start {
            let mut stats = self.stats.lock().expect("stats lock poisoned");
            accumulate_timing(
                &mut stats.detail_timings,
                name,
                start.elapsed().as_secs_f64(),
            );
        }
    }

    fn start_spinner(&self, message: &str) {
        if self.mode != ProgressMode::Default || !self.stderr_is_tty {
            self.message(message);
            return;
        }

        let spinner = self.multi.add(ProgressBar::new_spinner());
        spinner.set_style(
            ProgressStyle::default_spinner()
                .template("{spinner:.green} {msg}")
                .expect("Failed to create spinner style"),
        );
        spinner.enable_steady_tick(std::time::Duration::from_millis(80));
        spinner.set_message(message.to_string());
        *self
            .phase_spinner
            .lock()
            .expect("phase spinner lock poisoned") = Some(spinner);
    }

    fn finish_spinner(&self) {
        if let Some(spinner) = self
            .phase_spinner
            .lock()
            .expect("phase spinner lock poisoned")
            .take()
        {
            spinner.finish_and_clear();
        }
    }
}

fn build_env_logger() -> env_logger::Logger {
    let mut builder = env_logger::Builder::from_env(Env::default().default_filter_or("warn"));
    apply_default_log_filters(&mut builder);
    builder.build()
}

/// Install a plain global logger for CLI subcommands other than `scan`.
///
/// `scan` installs an indicatif-aware bridge via [`ScanProgress::init_logging_bridge`]
/// so log lines never corrupt its progress bars; the other subcommands have no
/// bars and use this simpler logger. `default_level` sets the baseline filter
/// (derived from `-q`/`-v`); an explicit `RUST_LOG` still overrides it. Safe to
/// call at most once — a second call, or a call after a bridge is installed, is
/// a no-op.
pub fn init_cli_logger(default_level: LevelFilter) {
    let default_filter = match default_level {
        LevelFilter::Off => "off",
        LevelFilter::Error => "error",
        LevelFilter::Warn => "warn",
        LevelFilter::Info => "info",
        LevelFilter::Debug => "debug",
        LevelFilter::Trace => "trace",
    };
    let mut builder =
        env_logger::Builder::from_env(Env::default().default_filter_or(default_filter));
    apply_default_log_filters(&mut builder);
    // Concise CLI-facing format: informational lines print bare, warnings and
    // errors carry a prefix, and debug/trace keep their module target.
    builder.format(|buf, record| {
        use std::io::Write as _;
        match record.level() {
            log::Level::Error => writeln!(buf, "error: {}", record.args()),
            log::Level::Warn => writeln!(buf, "warning: {}", record.args()),
            log::Level::Info => writeln!(buf, "{}", record.args()),
            log::Level::Debug | log::Level::Trace => {
                writeln!(buf, "[{}] {}", record.target(), record.args())
            }
        }
    });
    let _ = builder.try_init();
}

fn apply_default_log_filters(builder: &mut env_logger::Builder) {
    apply_default_log_filters_from(builder, env::var("RUST_LOG").ok().as_deref());
}

fn apply_default_log_filters_from(builder: &mut env_logger::Builder, rust_log: Option<&str>) {
    if let Some(level) = pdf_oxide_default_log_filter_from(rust_log) {
        builder.filter_module("pdf_oxide", level);
    }
}

pub(crate) fn format_default_scan_error(path: &Path, err: &str) -> String {
    let reason = concise_scan_error_reason(err);
    format!("{reason}: {}", path.to_string_lossy())
}

pub(crate) fn format_default_scan_error_from_diagnostics(
    path: &Path,
    scan_diagnostics: &[ScanDiagnostic],
) -> Option<String> {
    let errors: Vec<&ScanDiagnostic> = scan_diagnostics
        .iter()
        .filter(|d| {
            d.severity == DiagnosticSeverity::Error || d.severity == DiagnosticSeverity::Timeout
        })
        .collect();

    errors
        .iter()
        .find(|d| d.is_timeout())
        .or_else(|| errors.first())
        .map(|d| format_default_scan_error(path, &d.message))
}

pub(crate) fn format_default_scan_warning_from_list(
    path: &Path,
    scan_warnings: &[String],
) -> Option<String> {
    scan_warnings
        .first()
        .map(|warning| format_default_scan_error(path, warning))
}

/// Diagnostics split by severity in a single pass.
#[derive(Default)]
pub(crate) struct PartitionedDiagnostics {
    pub errors: Vec<String>,
    pub warnings: Vec<String>,
    /// Informational outcomes (for example, benign binary-content skips). These
    /// are neither failures nor warnings: they are excluded from `scan_errors`
    /// and from error/warning counts, and only surface in verbose output.
    pub infos: Vec<String>,
}

pub(crate) fn partition_scan_diagnostics(
    scan_diagnostics: &[ScanDiagnostic],
) -> PartitionedDiagnostics {
    let mut partitioned = PartitionedDiagnostics::default();

    for diagnostic in scan_diagnostics {
        match diagnostic.severity {
            DiagnosticSeverity::Error | DiagnosticSeverity::Timeout => {
                partitioned.errors.push(diagnostic.message.clone())
            }
            DiagnosticSeverity::Warning => partitioned.warnings.push(diagnostic.message.clone()),
            DiagnosticSeverity::Info => partitioned.infos.push(diagnostic.message.clone()),
        }
    }

    partitioned
}

fn concise_scan_error_reason(err: &str) -> String {
    let first_line = err
        .lines()
        .find(|line| !line.trim().is_empty())
        .map(str::trim)
        .unwrap_or("Scan failed");

    if let Some((prefix, _)) = first_line.split_once(" at ")
        && is_structured_error_prefix(prefix)
    {
        return prefix.to_string();
    }

    if let Some((prefix, _)) = first_line.split_once(": ")
        && is_structured_error_prefix(prefix)
    {
        return prefix.to_string();
    }

    first_line.to_string()
}

fn is_structured_error_prefix(prefix: &str) -> bool {
    let lowercase = prefix.to_ascii_lowercase();
    lowercase.starts_with("failed to ")
        || lowercase.ends_with(" failed")
        || lowercase.starts_with("timeout ")
        || lowercase.starts_with("processing interrupted")
}

fn pluralize_files(count: usize) -> &'static str {
    if count == 1 { "file" } else { "files" }
}

fn pdf_oxide_default_log_filter_from(rust_log: Option<&str>) -> Option<LevelFilter> {
    should_filter_pdf_oxide_default_warnings_from(rust_log).then_some(LevelFilter::Off)
}

fn should_filter_pdf_oxide_default_warnings_from(rust_log: Option<&str>) -> bool {
    rust_log.is_none_or(|value| !value.contains("pdf_oxide"))
}

fn accumulate_timing(timings: &mut Vec<(String, f64)>, name: String, duration: f64) {
    if let Some((_, existing)) = timings
        .iter_mut()
        .find(|(existing_name, _)| *existing_name == name)
    {
        *existing += duration;
    } else {
        timings.push((name, duration));
    }
}

fn supports_color(stderr_is_tty: bool) -> bool {
    if !stderr_is_tty {
        return false;
    }
    if env::var_os("NO_COLOR").is_some() {
        return false;
    }
    !matches!(env::var("TERM"), Ok(term) if term == "dumb")
}

fn build_summary_messages(
    stats: &ScanStats,
    scan_start: &str,
    scan_end: &str,
    verbose: bool,
) -> Vec<String> {
    let total = stats
        .top_level_timings
        .iter()
        .map(|(_, value)| *value)
        .sum::<f64>()
        .max(0.0);
    let scan_time = stats
        .top_level_timings
        .iter()
        .find_map(|(name, value)| (name == "scan").then_some(*value))
        .unwrap_or(0.0);

    let speed_files = if scan_time > 0.0 {
        stats.final_files as f64 / scan_time
    } else {
        0.0
    };
    let speed_bytes = if scan_time > 0.0 {
        stats.total_bytes_scanned as f64 / scan_time
    } else {
        0.0
    };

    let scan_names = if stats.scan_names.is_empty() {
        "scan".to_string()
    } else {
        stats.scan_names.clone()
    };

    let mut lines = vec![
        format!(
            "Summary:        {scan_names} with {} process(es)",
            stats.processes.to_i32()
        ),
        format!("Errors count:   {}", stats.error_count),
        format!("Warnings count: {}", stats.warning_count),
        format!(
            "Scan Speed:     {speed_files:.2} files/sec. {}/sec.",
            format_size(speed_bytes)
        ),
        format!(
            "Initial counts: {} resource(s): {} file(s) and {} directorie(s) for {}",
            stats.initial_files + stats.initial_dirs,
            stats.initial_files,
            stats.initial_dirs,
            format_size(stats.initial_size as f64)
        ),
        format!(
            "Final counts:   {} resource(s): {} file(s) and {} directorie(s) for {}",
            stats.final_files + stats.final_dirs,
            stats.final_files,
            stats.final_dirs,
            format_size(stats.final_size as f64)
        ),
        format!("Excluded count: {}", stats.excluded_count),
        format!(
            "Packages:       {} assembled from {} manifests",
            stats.packages_assembled, stats.manifests_seen
        ),
        "Timings:".to_string(),
        format!("  scan_start: {scan_start}"),
        format!("  scan_end:   {scan_end}"),
    ];

    // The per-phase breakdown is developer-facing diagnostic detail; keep the
    // default summary compact (counts, ScanCode-style timestamps, and total) and
    // surface the full tree only under --verbose.
    if verbose {
        for (name, value) in &stats.top_level_timings {
            lines.push(format!("  {name}: {value:.2}s"));

            let detail_timings = stats
                .detail_timings
                .iter()
                .filter(|(detail_name, _)| detail_parent_phase(detail_name) == Some(name.as_str()));

            if name == "scan" {
                let scan_breakdown: Vec<_> = detail_timings.collect();
                if !scan_breakdown.is_empty() {
                    lines.push("  scan breakdown (cumulative worker time):".to_string());
                    lines.extend(
                        scan_breakdown
                            .into_iter()
                            .map(|(detail_name, detail_value)| {
                                format!("    {detail_name}: {detail_value:.2}s")
                            }),
                    );
                }
            } else {
                lines.extend(detail_timings.map(|(detail_name, detail_value)| {
                    format!("    {detail_name}: {detail_value:.2}s")
                }));
            }
        }
    }
    lines.push(format!("  total: {total:.2}s"));

    lines
}

fn detail_parent_phase(detail_name: &str) -> Option<&'static str> {
    if detail_name.starts_with("setup:") || detail_name.starts_with("setup_scan:") {
        Some("setup")
    } else if detail_name.starts_with("scan:") {
        Some("scan")
    } else if detail_name.starts_with("post-scan:") || detail_name.starts_with("output-filter:") {
        Some("post-scan")
    } else if detail_name.starts_with("assembly:") {
        Some("assembly")
    } else if detail_name.starts_with("finalize:") {
        Some("finalize")
    } else if detail_name.starts_with("output:") {
        Some("output")
    } else {
        None
    }
}

pub fn format_size(bytes: f64) -> String {
    if bytes < 1.0 {
        return "0 Bytes".to_string();
    }
    if bytes == 1.0 {
        return "1 Byte".to_string();
    }

    let mut size = bytes;
    let units = ["Bytes", "KB", "MB", "GB", "TB"];
    let mut idx = 0;
    while size >= 1024.0 && idx < units.len() - 1 {
        size /= 1024.0;
        idx += 1;
    }

    if idx == 0 {
        format!("{:.0} {}", size, units[idx])
    } else {
        format!("{size:.2} {}", units[idx])
    }
}

#[cfg(test)]
mod tests {
    use super::{
        ProgressMode, ScanProgress, ScanStats, apply_default_log_filters_from,
        build_summary_messages, concise_scan_error_reason, format_default_scan_error, format_size,
        pdf_oxide_default_log_filter_from, pluralize_files,
        should_filter_pdf_oxide_default_warnings_from,
    };
    use crate::cli::ProcessMode;
    use crate::models::ScanDiagnostic;

    use std::path::Path;

    use log::{Level, LevelFilter, Log, MetadataBuilder};

    #[test]
    fn format_size_matches_expected_shape() {
        assert_eq!(format_size(0.0), "0 Bytes");
        assert_eq!(format_size(1.0), "1 Byte");
        assert_eq!(format_size(1024.0), "1.00 KB");
        assert_eq!(format_size(2_567_000.0), "2.45 MB");
    }

    #[test]
    fn summary_messages_render_detail_timings_hierarchically() {
        let stats = ScanStats {
            processes: ProcessMode::Parallel(4),
            scan_names: "licenses, packages".to_string(),
            initial_files: 10,
            initial_dirs: 2,
            initial_size: 2_048,
            excluded_count: 1,
            final_files: 8,
            final_dirs: 1,
            final_size: 1_024,
            error_count: 0,
            warning_count: 0,
            total_bytes_scanned: 800,
            packages_assembled: 3,
            manifests_seen: 5,
            incremental_reused: 0,
            top_level_timings: vec![
                ("setup".to_string(), 1.0),
                ("inventory".to_string(), 2.0),
                ("scan".to_string(), 3.0),
                ("post-scan".to_string(), 4.0),
                ("assembly".to_string(), 5.0),
                ("finalize".to_string(), 6.0),
                ("output".to_string(), 7.0),
            ],
            detail_timings: vec![
                ("setup_scan:licenses".to_string(), 0.5),
                ("scan:packages".to_string(), 1.25),
                ("output-filter:only-findings".to_string(), 1.5),
                ("finalize:output-prepare".to_string(), 2.0),
            ],
        };

        let lines = build_summary_messages(&stats, "start", "end", true);
        let line_index = |needle: &str| {
            lines
                .iter()
                .position(|line| line == needle)
                .unwrap_or_else(|| panic!("missing line: {needle}"))
        };

        assert!(lines.contains(&"  total: 28.00s".to_string()));
        assert!(lines.contains(&"    setup_scan:licenses: 0.50s".to_string()));
        assert!(lines.contains(&"  scan breakdown (cumulative worker time):".to_string()));
        assert!(lines.contains(&"    scan:packages: 1.25s".to_string()));
        assert!(lines.contains(&"    output-filter:only-findings: 1.50s".to_string()));
        assert!(lines.contains(&"    finalize:output-prepare: 2.00s".to_string()));
        assert!(line_index("  setup: 1.00s") < line_index("    setup_scan:licenses: 0.50s"));
        assert!(
            line_index("  scan: 3.00s") < line_index("  scan breakdown (cumulative worker time):")
        );
        assert!(
            line_index("  scan breakdown (cumulative worker time):")
                < line_index("    scan:packages: 1.25s")
        );
        assert!(
            line_index("  post-scan: 4.00s") < line_index("    output-filter:only-findings: 1.50s")
        );
        assert!(line_index("  finalize: 6.00s") < line_index("    finalize:output-prepare: 2.00s"));
    }

    #[test]
    fn summary_messages_use_scan_time_for_scan_speed() {
        let stats = ScanStats {
            final_files: 20,
            total_bytes_scanned: 2_048,
            top_level_timings: vec![("scan".to_string(), 4.0)],
            ..ScanStats::default()
        };

        let lines = build_summary_messages(&stats, "start", "end", false);

        assert!(lines.contains(&"Scan Speed:     5.00 files/sec. 512 Bytes/sec.".to_string()));
    }

    #[test]
    fn default_summary_keeps_total_but_omits_phase_breakdown() {
        let stats = ScanStats {
            final_files: 10,
            total_bytes_scanned: 800,
            top_level_timings: vec![("setup".to_string(), 1.0), ("scan".to_string(), 3.0)],
            detail_timings: vec![("scan:packages".to_string(), 1.25)],
            ..ScanStats::default()
        };

        let lines = build_summary_messages(&stats, "start", "end", false);

        // Compact default: counts, ScanCode-style timestamps, and total wall time.
        assert!(lines.contains(&"Timings:".to_string()));
        assert!(lines.contains(&"  scan_start: start".to_string()));
        assert!(lines.contains(&"  scan_end:   end".to_string()));
        assert!(lines.contains(&"  total: 4.00s".to_string()));
        // No per-phase breakdown without --verbose.
        assert!(!lines.contains(&"  setup: 1.00s".to_string()));
        assert!(!lines.contains(&"  scan: 3.00s".to_string()));
        assert!(!lines.iter().any(|line| line.contains("scan breakdown")));
        assert!(!lines.contains(&"    scan:packages: 1.25s".to_string()));
    }

    #[test]
    fn default_pdf_oxide_warnings_are_suppressed() {
        assert_eq!(
            pdf_oxide_default_log_filter_from(None),
            Some(LevelFilter::Off)
        );
        assert!(should_filter_pdf_oxide_default_warnings_from(None));
    }

    #[test]
    fn explicit_pdf_oxide_rust_log_override_disables_default_filter() {
        assert!(!should_filter_pdf_oxide_default_warnings_from(Some(
            "pdf_oxide::fonts::font_dict=warn"
        )));
    }

    #[test]
    fn default_pdf_oxide_filter_covers_unlisted_submodules() {
        let mut builder = env_logger::Builder::new();
        builder.filter_level(LevelFilter::Warn);
        apply_default_log_filters_from(&mut builder, None);
        let logger = builder.build();
        let warn_metadata = MetadataBuilder::new()
            .target("pdf_oxide::content::parser")
            .level(Level::Warn)
            .build();
        let error_metadata = MetadataBuilder::new()
            .target("pdf_oxide::content::parser")
            .level(Level::Error)
            .build();

        assert!(!logger.enabled(&warn_metadata));
        assert!(!logger.enabled(&error_metadata));
    }

    #[test]
    fn concise_scan_error_reason_keeps_high_level_failure_context() {
        assert_eq!(
            concise_scan_error_reason(
                "Failed to read or parse package.json at \"fixtures/package.json\": key must be a string at line 1 column 3"
            ),
            "Failed to read or parse package.json"
        );
        assert_eq!(
            concise_scan_error_reason("License detection failed: missing query token"),
            "License detection failed"
        );
        assert_eq!(
            concise_scan_error_reason("Processing interrupted due to timeout after 2.00 seconds"),
            "Processing interrupted due to timeout after 2.00 seconds"
        );
    }

    #[test]
    fn default_scan_error_format_includes_reason_and_path() {
        let formatted = format_default_scan_error(
            Path::new("fixtures/package.json"),
            "Failed to read or parse package.json at \"fixtures/package.json\": key must be a string at line 1 column 3",
        );

        assert_eq!(
            formatted,
            "Failed to read or parse package.json: fixtures/package.json"
        );
    }

    #[test]
    fn pluralize_files_uses_expected_labels() {
        assert_eq!(pluralize_files(1), "file");
        assert_eq!(pluralize_files(2), "files");
    }

    #[test]
    fn file_completed_counts_warning_diagnostics_without_prefix_heuristics() {
        let progress = ScanProgress::new(ProgressMode::Quiet);

        progress.file_completed(
            Path::new("project/custom.txt"),
            42,
            &[ScanDiagnostic::warning("custom recoverable warning")],
        );

        let stats = progress.stats.lock().expect("stats lock poisoned");
        assert_eq!(stats.warning_count, 1);
        assert_eq!(stats.error_count, 0);
    }

    #[test]
    fn final_header_counts_raise_summary_warning_count() {
        let progress = ScanProgress::new(ProgressMode::Quiet);

        progress.record_final_header_counts(&[crate::models::Header {
            tool_name: "provenant".to_string(),
            tool_version: "0.0.0-test".to_string(),
            options: serde_json::Map::new(),
            notice: "test".to_string(),
            start_timestamp: "start".to_string(),
            end_timestamp: "end".to_string(),
            output_format_version: "4.1.0".to_string(),
            duration: 0.0,
            errors: vec![],
            warnings: vec!["custom replay warning".to_string()],
            extra_data: crate::models::ExtraData {
                system_environment: crate::models::SystemEnvironment {
                    operating_system: "linux".to_string(),
                    cpu_architecture: "x86_64".to_string(),
                    platform: "linux".to_string(),
                    platform_version: "test".to_string(),
                    rust_version: "1.0.0".to_string(),
                },
                spdx_license_list_version: "test".to_string(),
                files_count: 0,
                directories_count: 0,
                excluded_count: 0,
                license_index_provenance: None,
            },
        }]);

        let stats = progress.stats.lock().expect("stats lock poisoned");
        assert_eq!(stats.warning_count, 1);
        assert_eq!(stats.error_count, 0);
    }
}