dgf1988/codewhale
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix(tui): keep render debug logs in codewhale dir

Browse Source
This commit is contained in:
cyq
2026-05-29 08:26:54 +08:00
committed by Hunter Bown
parent 8f93713860
commit 63be80d835
2 changed files with 94 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/tui/src/runtime_log.rs
+38 -4
View File
@@ -1,5 +1,5 @@
//! TUI runtime logging. Initializes a `tracing-subscriber` that writes to a
//! per-process file under `~/.deepseek/logs/tui-YYYY-MM-DD-PID.log`, and (on
//! per-process file under `~/.codewhale/logs/tui-YYYY-MM-DD-PID.log`, and (on
//! Unix) redirects the process's `stderr` fd to that same file for the lifetime
//! of the alt-screen TUI.
//!
@@ -22,7 +22,7 @@
//!
//! Defence-in-depth:
//! 1. A `tracing-subscriber` writes formatted logs to
//! `~/.deepseek/logs/tui-YYYY-MM-DD-PID.log` so `tracing::warn!` /
//! `~/.codewhale/logs/tui-YYYY-MM-DD-PID.log` so `tracing::warn!` /
//! `tracing::error!` calls go somewhere observable instead of
//! disappearing into the void (the TUI previously had no global
//! subscriber, so contributors reached for `eprintln!`).
@@ -162,7 +162,11 @@ pub(crate) fn log_directory() -> Option<PathBuf> {
if primary.exists() {
return Some(primary);
}
Some(base.join(".deepseek").join("logs"))
let legacy = base.join(".deepseek").join("logs");
if legacy.exists() {
return Some(legacy);
}
Some(primary)
};
if let Some(home) = std::env::var_os("HOME").map(PathBuf::from)
&& !home.as_os_str().is_empty()
@@ -270,7 +274,37 @@ mod tests {
}
let resolved = log_directory().expect("log_directory should resolve");
assert_eq!(resolved, tmp.path().join(".deepseek").join("logs"));
assert_eq!(resolved, tmp.path().join(".codewhale").join("logs"));
// SAFETY: cleanup under the same lock.
unsafe {
match prev_home {
Some(v) => std::env::set_var("HOME", v),
None => std::env::remove_var("HOME"),
}
match prev_userprofile {
Some(v) => std::env::set_var("USERPROFILE", v),
None => std::env::remove_var("USERPROFILE"),
}
}
}
#[test]
fn log_directory_uses_existing_legacy_deepseek_logs() {
let _lock = crate::test_support::lock_test_env();
let tmp = tempfile::TempDir::new().unwrap();
let legacy = tmp.path().join(".deepseek").join("logs");
fs::create_dir_all(&legacy).unwrap();
let prev_home = std::env::var_os("HOME");
let prev_userprofile = std::env::var_os("USERPROFILE");
// SAFETY: serialised by lock_test_env.
unsafe {
std::env::set_var("HOME", tmp.path());
std::env::set_var("USERPROFILE", "");
}
let resolved = log_directory().expect("log_directory should resolve");
assert_eq!(resolved, legacy);
// SAFETY: cleanup under the same lock.
unsafe {
crates/tui/src/tui/color_compat.rs
+56 -30
View File
@@ -6,6 +6,7 @@
//! as stray green/cyan backgrounds. This backend adapts every cell to the
//! detected color depth before handing it to crossterm.
use std::fmt::Write as _;
use std::fs::{self, File, OpenOptions};
use std::io::{self, Write};
@@ -222,15 +223,30 @@ fn render_debug_line(
diff_cells: usize,
sample: &[(u16, u16)],
) -> String {
let size = viewport
.map(|size| format!("{}x{}", size.width, size.height))
.unwrap_or_else(|| "unknown".to_string());
let sample = sample
.iter()
.map(|(x, y)| format!("{x}:{y}"))
.collect::<Vec<_>>()
.join(",");
format!("frame={frame} size={size} diff_cells={diff_cells} sample={sample}\n")
let mut line = String::new();
match viewport {
Some(size) => {
let _ = write!(
&mut line,
"frame={frame} size={}x{} diff_cells={diff_cells} sample=",
size.width, size.height
);
}
None => {
let _ = write!(
&mut line,
"frame={frame} size=unknown diff_cells={diff_cells} sample="
);
}
}
for (index, (x, y)) in sample.iter().enumerate() {
if index > 0 {
line.push(',');
}
let _ = write!(&mut line, "{x}:{y}");
}
line.push('\n');
line
}
fn adapt_cell_colors(
@@ -258,7 +274,7 @@ fn adapt_cell_colors(
#[cfg(test)]
mod tests {
use std::{cell::RefCell, env, fs, io::Write, rc::Rc};
use std::{cell::RefCell, env, ffi::OsString, fs, io::Write, rc::Rc};
use ratatui::backend::Backend;
use ratatui::{buffer::Cell, style::Color};
@@ -280,6 +296,32 @@ mod tests {
}
}
struct EnvRestore {
key: &'static str,
value: Option<OsString>,
}
impl EnvRestore {
fn capture(key: &'static str) -> Self {
Self {
key,
value: env::var_os(key),
}
}
}
impl Drop for EnvRestore {
fn drop(&mut self) {
// SAFETY: environment mutation is serialized by lock_test_env.
unsafe {
match &self.value {
Some(value) => env::set_var(self.key, value),
None => env::remove_var(self.key),
}
}
}
}
#[test]
fn adapts_rgb_cells_to_indexed_on_ansi256() {
let mut cell = Cell::default();
@@ -427,9 +469,9 @@ mod tests {
fn backend_writes_render_debug_log_when_enabled() {
let _lock = lock_test_env();
let tmp = tempfile::tempdir().expect("tempdir");
let previous_home = env::var_os("HOME");
let previous_userprofile = env::var_os("USERPROFILE");
let previous_debug = env::var_os(RENDER_DEBUG_ENV);
let _home = EnvRestore::capture("HOME");
let _userprofile = EnvRestore::capture("USERPROFILE");
let _debug = EnvRestore::capture(RENDER_DEBUG_ENV);
// SAFETY: environment mutation is serialized by lock_test_env.
unsafe {
@@ -446,28 +488,12 @@ mod tests {
let log_path = tmp
.path()
.join(".deepseek")
.join(".codewhale")
.join("logs")
.join("tui-render.log");
let body = fs::read_to_string(log_path).expect("render debug log");
assert!(body.contains("frame=1"), "{body}");
assert!(body.contains("diff_cells=1"), "{body}");
assert!(body.contains("sample=3:4"), "{body}");
// SAFETY: environment mutation is serialized by lock_test_env.
unsafe {
match previous_home {
Some(value) => env::set_var("HOME", value),
None => env::remove_var("HOME"),
}
match previous_userprofile {
Some(value) => env::set_var("USERPROFILE", value),
None => env::remove_var("USERPROFILE"),
}
match previous_debug {
Some(value) => env::set_var(RENDER_DEBUG_ENV, value),
None => env::remove_var(RENDER_DEBUG_ENV),
}
}
}
}