Files
Kigi-CLI/crates/codegen/kigi-tui/src/unified_log.rs
T
ZacharyZhang-NY a02b555e66 docs(comments): rewrite comments across all crates to the guidelines
Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
2026-07-23 16:55:39 -04:00

138 lines
4.3 KiB
Rust

//! Unified log forwarding for the pager.
//!
//! Buffers log entries in memory and flushes them to the shell via
//! `kigi/log` ACP notifications. Call [`init`] once at startup with
//! the ACP sender, then use [`info`], [`warn`], [`error`], [`debug`]
//! from anywhere.
use std::sync::{Mutex, OnceLock};
use agent_client_protocol as acp;
use kigi_acp_lib::AcpAgentTx;
use kigi_log::unified_log::{
ClientLogEntry, LOG_METHOD, LogLevel, LogNotificationParams, LogSource,
};
use tokio::runtime::Handle;
static ACP_TX: OnceLock<AcpAgentTx> = OnceLock::new();
static BUFFER: Mutex<Vec<ClientLogEntry>> = Mutex::new(Vec::new());
/// Initialize the unified log forwarder with the ACP sender.
///
/// Must be called once after the ACP connection is established.
/// Spawns a background task that flushes buffered entries every few
/// seconds so events are delivered promptly without manual flush calls.
/// Entries buffered before this call will be picked up on the first tick.
pub fn init(tx: AcpAgentTx) {
let _ = ACP_TX.set(tx);
tokio::spawn(async {
let mut interval = tokio::time::interval(std::time::Duration::from_secs(1));
interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
loop {
interval.tick().await;
flush();
}
});
}
fn now_ts() -> String {
chrono::Utc::now().to_rfc3339_opts(chrono::SecondsFormat::Millis, true)
}
fn push_entry(lvl: LogLevel, msg: &str, sid: Option<&str>, ctx: Option<serde_json::Value>) {
let entry = ClientLogEntry {
ts: now_ts(),
pid: Some(std::process::id()),
ver: Some(kigi_version::VERSION.to_owned()),
lvl,
sid: sid.map(Into::into),
msg: msg.into(),
ctx,
};
if let Ok(mut buf) = BUFFER.lock() {
buf.push(entry);
// Auto-flush when we have a reasonable batch, but only if the ACP
// sender is ready -- otherwise keep buffering until an explicit flush().
if buf.len() >= 16 && ACP_TX.get().is_some() {
let entries: Vec<ClientLogEntry> = buf.drain(..).collect();
drop(buf);
send_entries(entries);
}
}
}
fn build_notification(entries: Vec<ClientLogEntry>) -> Option<acp::ExtNotification> {
if entries.is_empty() {
return None;
}
let params = LogNotificationParams {
src: LogSource::KigiPager,
entries,
};
let raw = serde_json::value::to_raw_value(&params).ok()?;
Some(acp::ExtNotification::new(LOG_METHOD, raw.into()))
}
fn send_entries(entries: Vec<ClientLogEntry>) {
let Some(tx) = ACP_TX.get() else { return };
let Some(notification) = build_notification(entries) else {
return;
};
// Guard against panic if called from a non-tokio thread (e.g., a
// tracing::Layer callback on a blocking thread).
let Ok(handle) = Handle::try_current() else {
return;
};
let tx = tx.clone();
handle.spawn(async move {
let _ = kigi_acp_lib::acp_send(notification, &tx).await;
});
}
/// Flush any buffered entries to the shell (fire-and-forget).
pub fn flush() {
let entries = {
let Ok(mut buf) = BUFFER.lock() else { return };
if buf.is_empty() {
return;
}
buf.drain(..).collect::<Vec<_>>()
};
send_entries(entries);
}
/// Flush buffered entries and await delivery.
///
/// Use this before process exit to ensure entries are delivered
/// before the agent shuts down.
pub async fn flush_blocking() {
let entries = {
let Ok(mut buf) = BUFFER.lock() else { return };
if buf.is_empty() {
return;
}
buf.drain(..).collect::<Vec<_>>()
};
let Some(tx) = ACP_TX.get() else { return };
let Some(notification) = build_notification(entries) else {
return;
};
let _ = kigi_acp_lib::acp_send(notification, tx).await;
}
pub fn info(msg: &str, sid: Option<&str>, ctx: Option<serde_json::Value>) {
push_entry(LogLevel::Info, msg, sid, ctx);
}
pub fn warn(msg: &str, sid: Option<&str>, ctx: Option<serde_json::Value>) {
push_entry(LogLevel::Warn, msg, sid, ctx);
}
pub fn error(msg: &str, sid: Option<&str>, ctx: Option<serde_json::Value>) {
push_entry(LogLevel::Error, msg, sid, ctx);
}
pub fn debug(msg: &str, sid: Option<&str>, ctx: Option<serde_json::Value>) {
push_entry(LogLevel::Debug, msg, sid, ctx);
}