use std::io;
use tracing_subscriber::EnvFilter;
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::util::SubscriberInitExt;
use crate::cli::Cli;
use crate::config::DEFAULT_LOG_DIRECTIVE;
pub fn init_tracing(cli: &Cli, toml_directive: Option<&str>) {
let directive = resolve_directive(cli, toml_directive);
let filter =
EnvFilter::try_new(directive).unwrap_or_else(|_| EnvFilter::new(DEFAULT_LOG_DIRECTIVE));
let filter_display = filter.to_string();
let ansi = crate::platform::ansi_colors_enabled(cli.no_color);
let fmt_layer = tracing_subscriber::fmt::layer()
.with_writer(io::stderr)
.with_ansi(ansi)
.with_target(true)
.with_level(true)
.with_thread_ids(false)
.with_thread_names(false);
let result = tracing_subscriber::registry()
.with(filter)
.with(fmt_layer)
.try_init();
match result {
Ok(()) => {
tracing::debug!(
target: "docsrs_cli::diagnostics",
filter = %filter_display,
ansi,
"tracing subscriber installed (stderr diagnostics)"
);
}
Err(_) => {
}
}
}
pub(crate) fn resolve_directive<'a>(cli: &Cli, toml_directive: Option<&'a str>) -> &'a str {
if let Some(explicit) = cli_directive(cli) {
return explicit;
}
toml_directive
.map(str::trim)
.filter(|d| !d.is_empty())
.unwrap_or(DEFAULT_LOG_DIRECTIVE)
}
fn cli_directive(cli: &Cli) -> Option<&'static str> {
if cli.quiet {
Some("error")
} else if cli.verbose >= 2 {
Some("trace")
} else if cli.verbose == 1 {
Some("debug")
} else {
None
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::cli::{Cli, Commands};
use clap::Parser;
fn cli_with(args: &[&str]) -> Cli {
Cli::try_parse_from(args).expect("parse test argv")
}
#[test]
fn no_flags_and_no_toml_key_is_error() {
let cli = cli_with(&["docsrs-cli", "version"]);
assert_eq!(resolve_directive(&cli, None), "error");
}
#[test]
fn verbose_maps_to_debug_and_trace() {
let v1 = cli_with(&["docsrs-cli", "-v", "version"]);
assert_eq!(resolve_directive(&v1, None), "debug");
let v2 = cli_with(&["docsrs-cli", "-vv", "version"]);
assert_eq!(resolve_directive(&v2, None), "trace");
}
#[test]
fn quiet_wins_over_verbose() {
let cli = cli_with(&["docsrs-cli", "-q", "-vv", "version"]);
assert_eq!(resolve_directive(&cli, None), "error");
let _ = cli.command;
}
#[test]
fn init_tracing_is_idempotent() {
let cli = cli_with(&["docsrs-cli", "version"]);
init_tracing(&cli, None);
init_tracing(&cli, None);
assert!(matches!(cli.command, Commands::Version));
}
#[test]
fn toml_directive_applies_only_without_explicit_flags() {
let bare = cli_with(&["docsrs-cli", "version"]);
assert_eq!(
resolve_directive(&bare, Some("docsrs_cli=debug")),
"docsrs_cli=debug"
);
let quiet = cli_with(&["docsrs-cli", "-q", "version"]);
assert_eq!(resolve_directive(&quiet, Some("docsrs_cli=trace")), "error");
let verbose = cli_with(&["docsrs-cli", "-v", "version"]);
assert_eq!(
resolve_directive(&verbose, Some("docsrs_cli=trace")),
"debug"
);
}
#[test]
fn blank_toml_directive_falls_back_to_default() {
let cli = cli_with(&["docsrs-cli", "version"]);
assert_eq!(resolve_directive(&cli, Some(" ")), DEFAULT_LOG_DIRECTIVE);
assert_eq!(resolve_directive(&cli, None), DEFAULT_LOG_DIRECTIVE);
}
}