Skip to content

armgit / codex

Public Imported from GitHub
0

Lightweight coding agent that runs in your terminal

Rust

Omit payloads from multiline ANSI warnings (#49416)

Dmitriy Kovalenkoab84d71f5767
diff --git a/codex-rs/Cargo.lock b/codex-rs/Cargo.lock
index 9fd17b06a6..a26f2fd61e 100644
--- a/codex-rs/Cargo.lock
+++ b/codex-rs/Cargo.lock
@@ -2021,8 +2021,10 @@ name = "codex-ansi-escape"
version = "0.0.0"
dependencies = [
"ansi-to-tui",
+ "pretty_assertions",
"ratatui",
"tracing",
+ "tracing-subscriber",
]
[[package]]
diff --git a/codex-rs/ansi-escape/Cargo.toml b/codex-rs/ansi-escape/Cargo.toml
index edb5b6e514..60b1aedf29 100644
--- a/codex-rs/ansi-escape/Cargo.toml
+++ b/codex-rs/ansi-escape/Cargo.toml
@@ -7,7 +7,6 @@ license.workspace = true
[lib]
name = "codex_ansi_escape"
path = "src/lib.rs"
-test = false
doctest = false
[lints]
@@ -17,3 +16,7 @@ workspace = true
ansi-to-tui = { workspace = true }
ratatui = { workspace = true }
tracing = { workspace = true, features = ["log"] }
+
+[dev-dependencies]
+pretty_assertions = { workspace = true }
+tracing-subscriber = { workspace = true }
diff --git a/codex-rs/ansi-escape/src/ansi_escape_tests.rs b/codex-rs/ansi-escape/src/ansi_escape_tests.rs
new file mode 100644
index 0000000000..d51deb73aa
--- /dev/null
+++ b/codex-rs/ansi-escape/src/ansi_escape_tests.rs
@@ -0,0 +1,76 @@
+//! Check that multiline warnings omit payloads and preserve first-line rendering.
+
+use std::collections::BTreeMap;
+use std::sync::Arc;
+use std::sync::Mutex;
+
+use pretty_assertions::assert_eq;
+use ratatui::style::Stylize;
+use ratatui::text::Line;
+use tracing::Event;
+use tracing::Level;
+use tracing::Subscriber;
+use tracing::field::Field;
+use tracing::field::Visit;
+use tracing_subscriber::Layer;
+use tracing_subscriber::layer::Context;
+use tracing_subscriber::layer::SubscriberExt;
+
+use super::ansi_escape_line;
+
+#[derive(Debug, PartialEq, Eq)]
+struct CapturedEvent {
+ level: Level,
+ fields: BTreeMap<String, String>,
+}
+
+impl Visit for CapturedEvent {
+ fn record_debug(&mut self, field: &Field, value: &dyn std::fmt::Debug) {
+ self.fields
+ .insert(field.name().to_string(), format!("{value:?}"));
+ }
+}
+
+struct CaptureLayer(Arc<Mutex<Vec<CapturedEvent>>>);
+
+impl<S: Subscriber> Layer<S> for CaptureLayer {
+ fn on_event(&self, event: &Event<'_>, _ctx: Context<'_, S>) {
+ let mut captured = CapturedEvent {
+ level: *event.metadata().level(),
+ fields: BTreeMap::new(),
+ };
+ event.record(&mut captured);
+ self.0.lock().expect("capture events").push(captured);
+ }
+}
+
+#[test]
+fn multiline_warning_contains_counts_and_preserves_the_styled_first_line() {
+ let events = Arc::new(Mutex::new(Vec::new()));
+ let subscriber = tracing_subscriber::registry().with(CaptureLayer(Arc::clone(&events)));
+ let mut expected_events = Vec::new();
+
+ tracing::subscriber::with_default(subscriber, || {
+ for tail_bytes in [8, 128 * 1024] {
+ let tail = "x".repeat(tail_bytes);
+ let input = format!("\x1b[31mfirst\x1b[0m\n{tail}\nlast");
+ assert_eq!(ansi_escape_line(&input), Line::from("first".red()));
+ expected_events.push(CapturedEvent {
+ level: Level::WARN,
+ fields: BTreeMap::from([
+ ("input_bytes".to_string(), input.len().to_string()),
+ ("line_count".to_string(), "3".to_string()),
+ (
+ "message".to_string(),
+ "ansi_escape_line: expected a single line".to_string(),
+ ),
+ ]),
+ });
+ }
+ });
+
+ assert_eq!(
+ *events.lock().expect("read captured events"),
+ expected_events
+ );
+}
diff --git a/codex-rs/ansi-escape/src/lib.rs b/codex-rs/ansi-escape/src/lib.rs
index b47cf14f8e..caaabf2a7a 100644
--- a/codex-rs/ansi-escape/src/lib.rs
+++ b/codex-rs/ansi-escape/src/lib.rs
@@ -31,7 +31,11 @@ pub fn ansi_escape_line(s: &str) -> Line<'static> {
[] => "".into(),
[only] => only.clone(),
[first, rest @ ..] => {
- tracing::warn!("ansi_escape_line: expected a single line, got {first:?} and {rest:?}");
+ tracing::warn!(
+ input_bytes = s.len(),
+ line_count = rest.len() + 1,
+ "ansi_escape_line: expected a single line"
+ );
first.clone()
}
}
@@ -56,3 +60,7 @@ pub fn ansi_escape(s: &str) -> Text<'static> {
},
}
}
+
+#[cfg(test)]
+#[path = "ansi_escape_tests.rs"]
+mod tests;