use std::io::{self, Write};
use std::net::TcpStream;
use std::path::{Path, PathBuf};
use std::time::Duration;
pub const DIR_NAME: &str = crate::paths::SYMFORGE_DIR_NAME;
const LEGACY_PORT_FILE: &str = "sidecar.port";
const LEGACY_PID_FILE: &str = "sidecar.pid";
const LEGACY_SESSION_FILE: &str = "sidecar.session";
fn port_file_name() -> String {
crate::paths::os_tagged_runtime_file_name("sidecar", "port")
}
fn pid_file_name() -> String {
crate::paths::os_tagged_runtime_file_name("sidecar", "pid")
}
fn session_file_name() -> String {
crate::paths::os_tagged_runtime_file_name("sidecar", "session")
}
fn read_runtime_file(dir: &Path, tagged: &str, legacy: &str) -> io::Result<String> {
match std::fs::read_to_string(dir.join(tagged)) {
Ok(contents) => Ok(contents),
Err(e) if e.kind() == io::ErrorKind::NotFound => std::fs::read_to_string(dir.join(legacy)),
Err(e) => Err(e),
}
}
pub fn ensure_symforge_dir(project_root: Option<&Path>) -> io::Result<PathBuf> {
crate::paths::ensure_runtime_symforge_dir(project_root)
}
fn resolve_symforge_dir(project_root: Option<&Path>) -> PathBuf {
let cwd = std::env::current_dir().ok();
crate::paths::select_runtime_data_base(project_root, cwd.as_deref())
}
pub fn write_port_file(port: u16, project_root: Option<&Path>) -> io::Result<()> {
let dir = ensure_symforge_dir(project_root)?;
let path = dir.join(port_file_name());
let mut file = std::fs::File::create(&path)?;
write!(file, "{port}")?;
Ok(())
}
pub fn write_pid_file(pid: u32, project_root: Option<&Path>) -> io::Result<()> {
let dir = ensure_symforge_dir(project_root)?;
let path = dir.join(pid_file_name());
let mut file = std::fs::File::create(&path)?;
write!(file, "{pid}")?;
Ok(())
}
pub fn write_session_file(session_id: &str, project_root: Option<&Path>) -> io::Result<()> {
let dir = ensure_symforge_dir(project_root)?;
let path = dir.join(session_file_name());
let mut file = std::fs::File::create(&path)?;
write!(file, "{session_id}")?;
Ok(())
}
pub fn cleanup_session_file() {
let dir = PathBuf::from(DIR_NAME);
let _ = std::fs::remove_file(dir.join(session_file_name()));
let _ = std::fs::remove_file(dir.join(LEGACY_SESSION_FILE));
}
pub fn read_port() -> io::Result<u16> {
read_port_at(&resolve_symforge_dir(None))
}
fn read_port_at(dir: &Path) -> io::Result<u16> {
let contents = read_runtime_file(dir, &port_file_name(), LEGACY_PORT_FILE)?;
contents
.trim()
.parse::<u16>()
.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}
fn read_pid_at(dir: &Path) -> io::Result<u32> {
let contents = read_runtime_file(dir, &pid_file_name(), LEGACY_PID_FILE)?;
contents
.trim()
.parse::<u32>()
.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}
const SESSIONS_DIR: &str = "sessions";
fn descriptor_file_name(pid: u32) -> String {
crate::paths::os_tagged_runtime_file_name(&format!("sidecar.{pid}"), "json")
}
fn now_unix_secs() -> u64 {
std::time::SystemTime::now()
.duration_since(std::time::SystemTime::UNIX_EPOCH)
.unwrap_or_default()
.as_secs()
}
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct SessionDescriptor {
pub session_id: Option<String>,
pub project_root: Option<String>,
pub pid: u32,
pub port: u16,
pub updated_at_unix_secs: u64,
}
pub(crate) fn write_descriptor_for_pid_at(
dir: &Path,
pid: u32,
port: u16,
session_id: Option<&str>,
project_root: Option<&Path>,
) -> io::Result<()> {
let sessions = dir.join(SESSIONS_DIR);
std::fs::create_dir_all(&sessions)?;
let descriptor = SessionDescriptor {
session_id: session_id.map(str::to_string),
project_root: project_root.map(|root| root.display().to_string()),
pid,
port,
updated_at_unix_secs: now_unix_secs(),
};
let bytes = serde_json::to_vec_pretty(&descriptor)
.map_err(|error| io::Error::new(io::ErrorKind::InvalidData, error))?;
let final_path = sessions.join(descriptor_file_name(pid));
let tmp_path = sessions.join(format!("{}.tmp", descriptor_file_name(pid)));
std::fs::write(&tmp_path, &bytes)?;
match std::fs::rename(&tmp_path, &final_path) {
Ok(()) => Ok(()),
Err(error) => {
let _ = std::fs::remove_file(&tmp_path);
Err(error)
}
}
}
pub fn write_session_descriptor(
port: u16,
session_id: Option<&str>,
project_root: Option<&Path>,
) -> io::Result<()> {
let dir = ensure_symforge_dir(project_root)?;
write_descriptor_for_pid_at(&dir, std::process::id(), port, session_id, project_root)
}
pub(crate) fn cleanup_descriptor_for_pid_at(dir: &Path, pid: u32) {
let _ = std::fs::remove_file(dir.join(SESSIONS_DIR).join(descriptor_file_name(pid)));
let _ = std::fs::remove_file(
dir.join(SESSIONS_DIR)
.join(format!("{}.tmp", descriptor_file_name(pid))),
);
}
pub fn cleanup_own_descriptor(project_root: Option<&Path>) {
cleanup_descriptor_for_pid_at(&resolve_symforge_dir(project_root), std::process::id());
}
pub fn cleanup_own_descriptor_at(dir: &Path) {
cleanup_descriptor_for_pid_at(dir, std::process::id());
}
pub fn cleanup_stale_descriptors_at(dir: &Path, bind_host: &str) {
for descriptor in read_descriptors_at(dir) {
let alive = sidecar_port_is_alive(bind_host, descriptor.port).unwrap_or(false);
if !alive {
cleanup_descriptor_for_pid_at(dir, descriptor.pid);
}
}
}
fn read_descriptors_at(dir: &Path) -> Vec<SessionDescriptor> {
let os_tag = format!(".{}.json", std::env::consts::OS);
let mut descriptors = Vec::new();
let Ok(entries) = std::fs::read_dir(dir.join(SESSIONS_DIR)) else {
return descriptors;
};
for entry in entries.flatten() {
let name = entry.file_name();
let Some(name) = name.to_str() else { continue };
if !name.starts_with("sidecar.") || !name.ends_with(&os_tag) {
continue;
}
if let Ok(contents) = std::fs::read_to_string(entry.path())
&& let Ok(descriptor) = serde_json::from_str::<SessionDescriptor>(&contents)
{
descriptors.push(descriptor);
}
}
descriptors
}
fn select_descriptor_status(dir: &Path, bind_host: &str) -> Option<SidecarStatus> {
let expected_root = dir.parent().map(|parent| parent.display().to_string());
let mut candidates: Vec<(SessionDescriptor, bool)> = Vec::new();
let mut rejected = 0usize;
for descriptor in read_descriptors_at(dir) {
if let (Some(declared), Some(expected)) =
(descriptor.project_root.as_deref(), expected_root.as_deref())
&& !same_root_identity(declared, expected)
{
rejected += 1;
continue;
}
let alive = sidecar_port_is_alive(bind_host, descriptor.port).unwrap_or(false);
candidates.push((descriptor, alive));
}
if candidates.is_empty() {
return (rejected > 0).then(|| SidecarStatus {
pid: None,
port: None,
liveness: SidecarLiveness::NoSidecar,
detail: Some(format!(
"{rejected} descriptor(s) rejected: project-root identity mismatch"
)),
});
}
candidates.sort_by(|a, b| {
b.1.cmp(&a.1) .then(b.0.updated_at_unix_secs.cmp(&a.0.updated_at_unix_secs))
.then(a.0.pid.cmp(&b.0.pid))
});
let (best, alive) = &candidates[0];
Some(SidecarStatus {
pid: Some(best.pid),
port: Some(best.port),
liveness: if *alive {
SidecarLiveness::Alive
} else {
SidecarLiveness::Dead
},
detail: Some(format!(
"descriptor sidecar.{} ({} candidate(s){})",
best.pid,
candidates.len(),
if rejected > 0 {
format!(", {rejected} identity-rejected")
} else {
String::new()
}
)),
})
}
fn same_root_identity(a: &str, b: &str) -> bool {
let canon = |raw: &str| {
let normalized = raw.replace('\\', "/");
let trimmed = normalized.trim_end_matches('/').to_string();
if cfg!(windows) {
trimmed.to_lowercase()
} else {
trimmed
}
};
canon(a) == canon(b)
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SidecarLiveness {
Alive,
Dead,
Unknown,
NoSidecar,
}
impl SidecarLiveness {
pub fn as_str(self) -> &'static str {
match self {
Self::Alive => "alive",
Self::Dead => "dead",
Self::Unknown => "unknown",
Self::NoSidecar => "none",
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SidecarStatus {
pub pid: Option<u32>,
pub port: Option<u16>,
pub liveness: SidecarLiveness,
pub detail: Option<String>,
}
impl SidecarStatus {
fn no_sidecar() -> Self {
Self {
pid: None,
port: None,
liveness: SidecarLiveness::NoSidecar,
detail: None,
}
}
}
fn sidecar_files_exist(dir: &Path) -> bool {
dir.join(port_file_name()).exists()
|| dir.join(pid_file_name()).exists()
|| dir.join(session_file_name()).exists()
|| dir.join(LEGACY_PORT_FILE).exists()
|| dir.join(LEGACY_PID_FILE).exists()
|| dir.join(LEGACY_SESSION_FILE).exists()
}
fn sidecar_socket_addr(bind_host: &str, port: u16) -> io::Result<std::net::SocketAddr> {
let addr = if bind_host.contains(':') {
format!("[{bind_host}]:{port}")
} else {
format!("{bind_host}:{port}")
};
addr.parse()
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))
}
fn sidecar_port_is_alive(bind_host: &str, port: u16) -> io::Result<bool> {
let sock_addr = sidecar_socket_addr(bind_host, port)?;
Ok(TcpStream::connect_timeout(&sock_addr, Duration::from_millis(200)).is_ok())
}
pub fn read_sidecar_status_at(symforge_dir: &Path, bind_host: &str) -> SidecarStatus {
if let Some(status) = select_descriptor_status(symforge_dir, bind_host) {
return status;
}
if !sidecar_files_exist(symforge_dir) {
return SidecarStatus::no_sidecar();
}
let mut details = Vec::new();
let pid = match read_pid_at(symforge_dir) {
Ok(pid) => Some(pid),
Err(error) if error.kind() == io::ErrorKind::NotFound => {
details.push("sidecar.pid missing".to_string());
None
}
Err(error) => {
details.push(format!("sidecar.pid invalid: {error}"));
None
}
};
let port = match read_port_at(symforge_dir) {
Ok(port) => Some(port),
Err(error) if error.kind() == io::ErrorKind::NotFound => {
details.push("sidecar.port missing".to_string());
None
}
Err(error) => {
details.push(format!("sidecar.port invalid: {error}"));
None
}
};
let liveness = match port {
Some(port) => match sidecar_port_is_alive(bind_host, port) {
Ok(true) => SidecarLiveness::Alive,
Ok(false) => SidecarLiveness::Dead,
Err(error) => {
details.push(format!("sidecar port probe unavailable: {error}"));
SidecarLiveness::Unknown
}
},
None => SidecarLiveness::Unknown,
};
SidecarStatus {
pid,
port,
liveness,
detail: (!details.is_empty()).then(|| details.join("; ")),
}
}
pub fn read_sidecar_status(bind_host: &str) -> SidecarStatus {
read_sidecar_status_at(&resolve_symforge_dir(None), bind_host)
}
pub fn cleanup_files() {
cleanup_files_at(&resolve_symforge_dir(None));
}
pub fn cleanup_files_at(dir: &std::path::Path) {
let _ = std::fs::remove_file(dir.join(port_file_name()));
let _ = std::fs::remove_file(dir.join(pid_file_name()));
let _ = std::fs::remove_file(dir.join(session_file_name()));
let _ = std::fs::remove_file(dir.join(LEGACY_PORT_FILE));
let _ = std::fs::remove_file(dir.join(LEGACY_PID_FILE));
let _ = std::fs::remove_file(dir.join(LEGACY_SESSION_FILE));
}
pub fn check_stale(bind_host: &str) -> bool {
let port = match read_port() {
Ok(p) => p,
Err(_) => return false, };
match sidecar_port_is_alive(bind_host, port) {
Ok(true) => false, Ok(false) => {
cleanup_files();
true
}
Err(_) => {
false
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::Mutex;
use tempfile::TempDir;
static CWD_LOCK: Mutex<()> = Mutex::new(());
fn stable_cwd() -> PathBuf {
std::env::current_dir().unwrap_or_else(|_| PathBuf::from(env!("CARGO_MANIFEST_DIR")))
}
fn restore_cwd(path: &std::path::Path) {
if std::env::set_current_dir(path).is_err() {
std::env::set_current_dir(env!("CARGO_MANIFEST_DIR"))
.expect("manifest dir must be a valid cwd fallback");
}
}
fn with_temp_dir<F: FnOnce() + std::panic::UnwindSafe>(f: F) {
let _guard = CWD_LOCK
.lock()
.unwrap_or_else(|poisoned| poisoned.into_inner());
let tmp = TempDir::new().unwrap();
let original = stable_cwd();
std::env::set_current_dir(tmp.path()).unwrap();
let result = std::panic::catch_unwind(f);
restore_cwd(&original);
drop(tmp);
if let Err(e) = result {
std::panic::resume_unwind(e);
}
}
#[test]
fn test_per_session_descriptors_do_not_delete_siblings() {
let tmp = TempDir::new().unwrap();
let dir = tmp.path();
{
write_descriptor_for_pid_at(dir, 111, 40001, Some("session-a"), None)
.expect("write descriptor A");
write_descriptor_for_pid_at(dir, 222, 40002, Some("session-b"), None)
.expect("write descriptor B");
assert_eq!(read_descriptors_at(dir).len(), 2, "both descriptors exist");
cleanup_descriptor_for_pid_at(dir, 111);
let remaining = read_descriptors_at(dir);
assert_eq!(
remaining.len(),
1,
"only the caller's descriptor is removed"
);
assert_eq!(remaining[0].pid, 222, "sibling descriptor survives");
assert_eq!(remaining[0].session_id.as_deref(), Some("session-b"));
}
}
#[test]
fn test_reader_selects_live_descriptor_and_rejects_foreign_root() {
let tmp = TempDir::new().unwrap();
let dir = tmp.path();
{
let listener =
std::net::TcpListener::bind("127.0.0.1:0").expect("bind live probe port");
let live_port = listener.local_addr().expect("live addr").port();
let dead_port = {
let l = std::net::TcpListener::bind("127.0.0.1:0").expect("bind dead port");
l.local_addr().expect("dead addr").port()
};
write_descriptor_for_pid_at(dir, 111, live_port, Some("session-live"), None)
.expect("write live descriptor");
write_descriptor_for_pid_at(dir, 222, dead_port, Some("session-dead"), None)
.expect("write dead descriptor");
std::thread::sleep(std::time::Duration::from_millis(1100));
write_descriptor_for_pid_at(dir, 222, dead_port, Some("session-dead"), None)
.expect("refresh dead descriptor");
let status = read_sidecar_status_at(dir, "127.0.0.1");
assert_eq!(status.liveness, SidecarLiveness::Alive);
assert_eq!(
status.pid,
Some(111),
"live beats fresher-but-dead: {status:?}"
);
assert_eq!(status.port, Some(live_port));
cleanup_descriptor_for_pid_at(dir, 111);
cleanup_descriptor_for_pid_at(dir, 222);
write_descriptor_for_pid_at(
dir,
333,
live_port,
Some("session-foreign"),
Some(std::path::Path::new("/somewhere/else/entirely")),
)
.expect("write foreign descriptor");
let status = read_sidecar_status_at(dir, "127.0.0.1");
assert_ne!(
status.pid,
Some(333),
"foreign-root descriptor must be identity-rejected: {status:?}"
);
drop(listener);
}
}
#[test]
fn test_write_read_port_roundtrip() {
with_temp_dir(|| {
write_port_file(12345, None).expect("write_port_file should succeed");
let port = read_port().expect("read_port should succeed after write");
assert_eq!(port, 12345, "port roundtrip must preserve value");
});
}
#[test]
fn test_write_port_file_no_trailing_newline() {
with_temp_dir(|| {
write_port_file(8080, None).expect("write_port_file should succeed");
let port_path = PathBuf::from(DIR_NAME).join(port_file_name());
let bytes = std::fs::read(&port_path).unwrap();
assert_eq!(
bytes, b"8080",
"port file must contain ONLY the digits, no newline"
);
});
}
#[test]
fn test_write_is_os_tagged_only() {
with_temp_dir(|| {
write_port_file(8080, None).expect("write_port_file should succeed");
let dir = PathBuf::from(DIR_NAME);
assert!(
dir.join(port_file_name()).exists(),
"OS-tagged port file must exist after write"
);
assert!(
!dir.join(LEGACY_PORT_FILE).exists(),
"writer must NOT create a legacy un-tagged port file (would re-open cross-OS collision)"
);
assert!(
port_file_name().contains(std::env::consts::OS),
"tagged name must carry this OS"
);
});
}
#[test]
fn test_read_falls_back_to_legacy_untagged() {
with_temp_dir(|| {
let dir = ensure_symforge_dir(None).expect("dir");
std::fs::write(dir.join(LEGACY_PORT_FILE), b"7777").unwrap();
let port = read_port().expect("read_port must fall back to legacy file");
assert_eq!(port, 7777, "legacy fallback must read the un-tagged port");
});
}
#[test]
fn test_tagged_wins_over_legacy() {
with_temp_dir(|| {
let dir = ensure_symforge_dir(None).expect("dir");
std::fs::write(dir.join(LEGACY_PORT_FILE), b"1111").unwrap();
std::fs::write(dir.join(port_file_name()), b"2222").unwrap();
let port = read_port().expect("read_port should succeed");
assert_eq!(
port, 2222,
"OS-tagged file must take precedence over legacy"
);
});
}
#[test]
fn test_cleanup_removes_files() {
with_temp_dir(|| {
write_port_file(9000, None).expect("write should succeed");
write_pid_file(12345, None).expect("write should succeed");
let dir = PathBuf::from(DIR_NAME);
std::fs::write(dir.join(LEGACY_PORT_FILE), b"9000").unwrap();
std::fs::write(dir.join(LEGACY_PID_FILE), b"12345").unwrap();
assert!(
dir.join(port_file_name()).exists(),
"tagged port file should exist before cleanup"
);
assert!(
dir.join(pid_file_name()).exists(),
"tagged pid file should exist before cleanup"
);
cleanup_files();
for name in [
port_file_name(),
pid_file_name(),
LEGACY_PORT_FILE.to_string(),
LEGACY_PID_FILE.to_string(),
] {
assert!(
!dir.join(&name).exists(),
"{name} should be gone after cleanup (tagged + legacy)"
);
}
});
}
#[test]
fn test_cleanup_is_noop_when_no_files() {
with_temp_dir(|| {
cleanup_files();
});
}
#[test]
fn test_read_port_missing_returns_error() {
with_temp_dir(|| {
let result = read_port();
assert!(
result.is_err(),
"read_port should return error when file is missing"
);
});
}
#[test]
fn test_ensure_symforge_dir_creates_directory() {
with_temp_dir(|| {
let dir = ensure_symforge_dir(None).expect("ensure_symforge_dir should succeed");
assert!(
dir.exists(),
".symforge directory should exist after ensure_symforge_dir"
);
assert!(dir.is_dir(), "path should be a directory");
});
}
#[test]
fn test_ensure_symforge_dir_idempotent() {
with_temp_dir(|| {
ensure_symforge_dir(None).expect("first call should succeed");
ensure_symforge_dir(None).expect("second call should also succeed (idempotent)");
});
}
#[test]
fn test_check_stale_returns_false_when_no_port_file() {
with_temp_dir(|| {
let is_stale = check_stale("127.0.0.1");
assert!(!is_stale, "no port file means nothing is stale");
});
}
#[test]
fn test_check_stale_cleans_up_when_port_is_closed() {
with_temp_dir(|| {
write_port_file(19999, None).expect("write should succeed");
write_pid_file(99999, None).expect("write should succeed");
let is_stale = check_stale("127.0.0.1");
assert!(
is_stale,
"port 19999 should be detected as stale (nothing listening)"
);
let dir = PathBuf::from(DIR_NAME);
assert!(
!dir.join(port_file_name()).exists(),
"port file cleaned up after stale detection"
);
});
}
}