Merge pull request #3859 from reubenmiller/feat-support-no-color-env-variable

feat: add support for NO_COLOR standard for controlling usage of colour in console messages

Author: reubenmiller

Cargo.lock

@@ -211,7 +211,10 @@ which = "4.2"
 whoami = "1.5.0"
 ws_stream_tungstenite = "0.14"
 x509-parser = "0.16"
-yansi = "1.0.1"
+yansi = { version = "1.0.1", default-features = false, features = [
+    "detect-env",
+    "detect-tty",
+] }
 zeroize = "1.5"
 
 

Cargo.toml

@@ -11,9 +11,7 @@ use rustls::RootCertStore;
 use std::fmt::Debug;
 use std::fs::File;
 use std::io;
-use std::io::stderr;
 use std::io::Cursor;
-use std::io::IsTerminal;
 use std::path::Path;
 use tedge_config::OptionalConfig;
 use tracing::info;
@@ -68,11 +66,6 @@ pub fn load_ssl_config(
     ca_path: OptionalConfig<impl TrustStoreLoader>,
     service_name: &'static str,
 ) -> anyhow::Result<Option<rustls::ServerConfig>> {
-    // TODO this could be moved somewhere more generic (e.g. where we initialize tracing subscriber)
-    if !stderr().is_terminal() {
-        yansi::disable();
-    }
-
     let enabled = Paint::green("enabled").bold();
     let disabled = Paint::red("disabled").bold();
     let service_name = service_name.bold();

crates/common/axum_tls/src/config.rs

@@ -39,6 +39,7 @@ tracing = { workspace = true }
 tracing-subscriber = { workspace = true }
 url = { workspace = true }
 which = { workspace = true }
+yansi = { workspace = true }
 
 [dev-dependencies]
 assert_matches = { workspace = true }

crates/common/tedge_config/Cargo.toml

@@ -12,7 +12,7 @@ macro_rules! subscriber_builder {
     () => {
         tracing_subscriber::fmt()
             .with_writer(std::io::stderr)
-            .with_ansi(std::io::stderr().is_terminal())
+            .with_ansi(std::io::stderr().is_terminal() && yansi::Condition::no_color())
             .with_timer(tracing_subscriber::fmt::time::UtcTime::rfc_3339())
     };
 }
@@ -75,7 +75,7 @@ fn logger(
 ) -> Result<Arc<dyn tracing::Subscriber + Send + Sync>, SystemTomlError> {
     let subscriber = tracing_subscriber::fmt()
         .with_writer(std::io::stderr)
-        .with_ansi(std::io::stderr().is_terminal())
+        .with_ansi(std::io::stderr().is_terminal() && yansi::Condition::no_color())
         .with_timer(tracing_subscriber::fmt::time::UtcTime::rfc_3339());
     let log_level = flags
         .log_level
@@ -124,7 +124,7 @@ pub fn get_log_level(
 pub fn set_log_level(log_level: tracing::Level) {
     let subscriber = tracing_subscriber::fmt()
         .with_writer(std::io::stderr)
-        .with_ansi(std::io::stderr().is_terminal())
+        .with_ansi(std::io::stderr().is_terminal() && yansi::Condition::no_color())
         .with_timer(tracing_subscriber::fmt::time::UtcTime::rfc_3339());
 
     if std::env::var("RUST_LOG").is_ok() {

crates/common/tedge_config/src/system_toml/log_level.rs

@@ -7,7 +7,6 @@ use clap::CommandFactory;
 use clap::FromArgMatches;
 use std::alloc;
 use std::ffi::OsString;
-use std::io::IsTerminal;
 use std::path::PathBuf;
 use std::time::Duration;
 use tedge::command::BuildCommand;
@@ -23,6 +22,11 @@ use tedge_config::unconfigured_logger;
 use tedge_file_log_plugin::bin::TEdgeConfigView;
 use tracing::log;
 
+// Control when to use console colors (`stdout` and `stderr` is a TTY, `NO_COLOR` is not set)
+static USE_COLOR: yansi::Condition = yansi::Condition::from(|| {
+    yansi::Condition::stdouterr_are_tty() && yansi::Condition::no_color()
+});
+
 #[global_allocator]
 static ALLOCATOR: Cap<alloc::System> = Cap::new(alloc::System, usize::MAX);
 
@@ -35,6 +39,8 @@ async fn main() -> anyhow::Result<()> {
     })
     .unwrap_or_else(|code| std::process::exit(code));
 
+    yansi::whenever(USE_COLOR);
+
     match opt {
         TEdgeOptMulticall::Component(Component::TedgeMapper(opt)) => {
             let tedge_config = tedge_config::TEdgeConfig::load(&opt.common.config_dir).await?;
@@ -87,10 +93,6 @@ async fn main() -> anyhow::Result<()> {
                 .build_command(&tedge_config)
                 .with_context(|| "missing configuration parameter")?;
 
-            if !std::io::stdout().is_terminal() {
-                yansi::disable();
-            }
-
             match cmd.execute(tedge_config).await {
                 Ok(()) => Ok(()),
                 // If the command already prints its own nicely formatted errors

crates/core/tedge/src/main.rs

@@ -33,6 +33,7 @@ tokio = { workspace = true, features = [
 toml.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
+yansi.workspace = true
 
 [dev-dependencies]
 tempfile.workspace = true

crates/extensions/tedge-p11-server/Cargo.toml

@@ -218,6 +218,11 @@ async fn try_read_config(args: Args) -> anyhow::Result<ValidConfig> {
     })
 }
 
+// Control when to use console colors (`stdout` and `stderr` is a TTY, `NO_COLOR` is not set)
+static USE_COLOR: yansi::Condition = yansi::Condition::from(|| {
+    yansi::Condition::stdouterr_are_tty() && yansi::Condition::no_color()
+});
+
 #[tokio::main(flavor = "current_thread")]
 async fn main() -> anyhow::Result<()> {
     let args = Args::parse();
@@ -234,6 +239,8 @@ async fn main() -> anyhow::Result<()> {
         )
         .init();
 
+    yansi::whenever(USE_COLOR);
+
     let args = Args::parse();
     let config = try_read_config(args).await?;
     let cryptoki_config = CryptokiConfigDirect {