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).
290 lines
8.8 KiB
Rust
290 lines
8.8 KiB
Rust
use std::process::{Command, Stdio};
|
|
use std::time::Duration;
|
|
|
|
use crate::notifications::NotificationEvent;
|
|
use crate::notifications::config::NotificationHook;
|
|
|
|
fn execute_hook(
|
|
command: &str,
|
|
event_str: &str,
|
|
message: &str,
|
|
session_id: Option<&str>,
|
|
timeout: Duration,
|
|
) {
|
|
let mut cmd = Command::new("sh");
|
|
cmd.arg("-c")
|
|
.arg(command)
|
|
.env("KIGI_EVENT", event_str)
|
|
.env("KIGI_MESSAGE", message)
|
|
.stdin(Stdio::null())
|
|
.stdout(Stdio::null())
|
|
.stderr(Stdio::null());
|
|
if let Some(sid) = session_id {
|
|
cmd.env("KIGI_SESSION_ID", sid);
|
|
}
|
|
|
|
// Create a new process group so we can kill the entire tree on timeout,
|
|
// preventing orphaned subprocesses from accumulating.
|
|
#[cfg(unix)]
|
|
{
|
|
use std::os::unix::process::CommandExt;
|
|
// SAFETY: setsid is async-signal-safe per POSIX and does not
|
|
// allocate or take locks. Called between fork and exec.
|
|
unsafe {
|
|
cmd.pre_exec(|| {
|
|
nix::unistd::setsid().ok();
|
|
Ok(())
|
|
});
|
|
}
|
|
}
|
|
|
|
match cmd.spawn() {
|
|
Ok(mut child) => {
|
|
use wait_timeout::ChildExt;
|
|
match child.wait_timeout(timeout) {
|
|
Ok(Some(_)) => {}
|
|
Ok(None) => {
|
|
// Kill the entire process group, not just the direct child.
|
|
#[cfg(unix)]
|
|
{
|
|
let pid = child.id() as i32;
|
|
let _ = nix::sys::signal::killpg(
|
|
nix::unistd::Pid::from_raw(pid),
|
|
nix::sys::signal::Signal::SIGKILL,
|
|
);
|
|
}
|
|
#[cfg(not(unix))]
|
|
{
|
|
let _ = child.kill();
|
|
}
|
|
let _ = child.wait();
|
|
tracing::warn!("hook timed out");
|
|
}
|
|
Err(e) => tracing::debug!(error = %e, command, "hook wait failed"),
|
|
}
|
|
}
|
|
Err(e) => tracing::debug!(error = %e, command, "hook spawn failed"),
|
|
}
|
|
}
|
|
|
|
pub fn run_hook(hook: &NotificationHook, event: &NotificationEvent) {
|
|
let command = hook.command.clone();
|
|
let event_str: &'static str = event.kind.as_str();
|
|
let message = event.body.clone();
|
|
let session_id = event.session_id.clone();
|
|
let timeout = Duration::from_secs(hook.timeout_secs.max(1));
|
|
|
|
std::thread::spawn(move || {
|
|
execute_hook(
|
|
&command,
|
|
event_str,
|
|
&message,
|
|
session_id.as_deref(),
|
|
timeout,
|
|
);
|
|
});
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::notifications::config::NotificationEventKind;
|
|
use std::time::Instant;
|
|
|
|
fn test_event() -> NotificationEvent {
|
|
NotificationEvent {
|
|
kind: NotificationEventKind::TurnComplete,
|
|
title: "Kigi".into(),
|
|
body: "test body payload".into(),
|
|
session_id: Some("test-session-123".into()),
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn sets_environment_variables() {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let out = dir.path().join("env.txt");
|
|
let command = format!(
|
|
"printf 'KIGI_EVENT=%s\\nKIGI_MESSAGE=%s\\nKIGI_SESSION_ID=%s\\n' \
|
|
\"$KIGI_EVENT\" \"$KIGI_MESSAGE\" \"$KIGI_SESSION_ID\" > {}",
|
|
out.display()
|
|
);
|
|
|
|
execute_hook(
|
|
&command,
|
|
"Turn complete",
|
|
"hello world",
|
|
Some("sess-42"),
|
|
Duration::from_secs(5),
|
|
);
|
|
|
|
let content = std::fs::read_to_string(&out).unwrap();
|
|
assert!(
|
|
content.contains("KIGI_EVENT=Turn complete"),
|
|
"missing KIGI_EVENT: {content}"
|
|
);
|
|
assert!(
|
|
content.contains("KIGI_MESSAGE=hello world"),
|
|
"missing KIGI_MESSAGE: {content}"
|
|
);
|
|
assert!(
|
|
content.contains("KIGI_SESSION_ID=sess-42"),
|
|
"missing KIGI_SESSION_ID: {content}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn omits_session_id_when_none() {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let out = dir.path().join("env.txt");
|
|
let command = format!("env > {}", out.display());
|
|
|
|
execute_hook(
|
|
&command,
|
|
"Turn complete",
|
|
"msg",
|
|
None,
|
|
Duration::from_secs(5),
|
|
);
|
|
|
|
let content = std::fs::read_to_string(&out).unwrap();
|
|
assert!(
|
|
!content.contains("KIGI_SESSION_ID"),
|
|
"KIGI_SESSION_ID should not be set: {content}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn kills_on_timeout() {
|
|
let start = Instant::now();
|
|
execute_hook(
|
|
"sleep 100",
|
|
"Turn complete",
|
|
"msg",
|
|
None,
|
|
Duration::from_secs(1),
|
|
);
|
|
let elapsed = start.elapsed();
|
|
assert!(
|
|
elapsed < Duration::from_secs(3),
|
|
"should return within timeout, took {elapsed:?}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn handles_failed_shell_command_gracefully() {
|
|
execute_hook(
|
|
"/nonexistent/path/binary",
|
|
"Turn complete",
|
|
"msg",
|
|
None,
|
|
Duration::from_secs(1),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn handles_nonzero_exit_gracefully() {
|
|
execute_hook(
|
|
"exit 1",
|
|
"Turn complete",
|
|
"msg",
|
|
None,
|
|
Duration::from_secs(5),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn successful_command_completes_without_error() {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let marker = dir.path().join("done");
|
|
let command = format!("touch {}", marker.display());
|
|
|
|
execute_hook(
|
|
&command,
|
|
"Turn complete",
|
|
"msg",
|
|
None,
|
|
Duration::from_secs(5),
|
|
);
|
|
|
|
assert!(marker.exists());
|
|
}
|
|
|
|
#[test]
|
|
fn run_hook_spawns_thread_without_panic() {
|
|
let hook = NotificationHook {
|
|
command: "true".into(),
|
|
events: vec![],
|
|
only_unfocused: false,
|
|
timeout_secs: 5,
|
|
};
|
|
run_hook(&hook, &test_event());
|
|
std::thread::sleep(Duration::from_millis(200));
|
|
}
|
|
|
|
#[test]
|
|
fn timeout_clamped_to_minimum_one_second() {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let marker = dir.path().join("done");
|
|
let hook = NotificationHook {
|
|
command: format!("sleep 100; touch {}", marker.display()),
|
|
events: vec![],
|
|
only_unfocused: false,
|
|
// exercises the .max(1) clamp inside run_hook
|
|
timeout_secs: 0,
|
|
};
|
|
let start = Instant::now();
|
|
run_hook(&hook, &test_event());
|
|
// Wait for the spawned thread to finish (clamp turns 0 -> 1s timeout)
|
|
std::thread::sleep(Duration::from_millis(2500));
|
|
let elapsed = start.elapsed();
|
|
// The hook should have been killed by the 1s timeout, so the marker
|
|
// file should NOT exist (sleep 100 never completes).
|
|
assert!(
|
|
!marker.exists(),
|
|
"hook should have been killed by timeout before creating marker"
|
|
);
|
|
// Sanity: the whole thing completed well under 10s, confirming the
|
|
// timeout was ~1s (clamped) not 0s (instant) or unbounded.
|
|
assert!(
|
|
elapsed < Duration::from_secs(5),
|
|
"should complete within a few seconds, took {elapsed:?}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn run_hook_passes_correct_env_via_thread() {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let out = dir.path().join("env.txt");
|
|
let hook = NotificationHook {
|
|
command: format!(
|
|
"printf 'KIGI_EVENT=%s\\nKIGI_MESSAGE=%s\\nKIGI_SESSION_ID=%s\\n' \
|
|
\"$KIGI_EVENT\" \"$KIGI_MESSAGE\" \"$KIGI_SESSION_ID\" > {}",
|
|
out.display()
|
|
),
|
|
events: vec![],
|
|
only_unfocused: false,
|
|
timeout_secs: 5,
|
|
};
|
|
let event = test_event();
|
|
run_hook(&hook, &event);
|
|
|
|
// Poll for the output file instead of a fixed sleep — the spawned
|
|
// thread + fork/exec may take variable time on loaded systems.
|
|
let deadline = Instant::now() + Duration::from_secs(5);
|
|
let content = loop {
|
|
if let Ok(c) = std::fs::read_to_string(&out) {
|
|
break c;
|
|
}
|
|
assert!(
|
|
Instant::now() < deadline,
|
|
"hook did not produce output file within 5s (sh or printf may not be available)"
|
|
);
|
|
std::thread::sleep(Duration::from_millis(50));
|
|
};
|
|
assert!(content.contains("KIGI_EVENT=Turn complete"));
|
|
assert!(content.contains("KIGI_MESSAGE=test body payload"));
|
|
assert!(content.contains("KIGI_SESSION_ID=test-session-123"));
|
|
}
|
|
}
|