T29: inside herdr the right column follows herdr's focused pane: herdr keeps its panes' OSC 7, so on macOS and Linux a session that finds herdr's client leading its pty's foreground reads the focused pane's folder from herdr's socket, found as herdr 0.9 finds it
CI / platforms (ubuntu-24.04) (push) Successful in 1m11s
CI / platforms (windows-latest) (push) Successful in 1m40s
CI / macos (push) Successful in 11m13s

This commit is contained in:
ZacharyZhang-NY committed 2026-10-16 02:58:38 -04:00
1 parent 6c610fdc6e
commit 3e30f95543
11 files changed
+606 -7

No files matched your search

+412
View File
@@ -0,0 +1,412 @@
use std::{
collections::HashMap,
ffi::{OsStr, OsString},
io::{self, BufRead, BufReader, Write},
os::unix::{ffi::OsStringExt, net::UnixStream},
path::{Path, PathBuf},
time::Duration,
};
use anyhow::Context as _;
use gpui::{Context, Task};
use serde::Deserialize;
use super::view::{TerminalEvent, TerminalView};
/// How often the session's foreground program is checked.
const CHECK: Duration = Duration::from_millis(500);
/// How long herdr may take to answer.
const WAIT: Duration = Duration::from_secs(1);
/// The socket request for herdr's session: its focus and its panes' folders.
const SNAPSHOT: &[u8] = b"{\"id\":\"elyterminal\",\"method\":\"session.snapshot\",\"params\":{}}\n";
/// A program's arguments, and its variables as the kernel holds them.
type Invocation = (Vec<String>, HashMap<String, OsString>);
/// Follows the pane herdr's server has focused while herdr's client runs in the foreground.
pub fn follow(cx: &mut Context<TerminalView>) -> Task<()> {
cx.spawn(async move |view, cx| {
let (mut group, mut socket, mut shown, mut failed) = (None, None, None, String::new());
loop {
cx.background_executor().timer(CHECK).await;
let Ok((pid, now)) = view.update(cx, |view, _| (view.pty.pid, view.pty.foreground()))
else {
break;
};
let now = match now {
Ok(now) => Some(now),
Err(error) => {
if group.is_some() {
log::debug!("terminal {pid}: its foreground does not read: {error}");
}
None
}
};
if now != group {
group = now;
shown = None;
failed.clear();
if socket.take().is_some() {
log::info!("terminal {pid}: herdr left the foreground");
}
let found = match now {
Some(now) => {
cx.background_executor()
.spawn(async move { client(now) })
.await
}
None => Ok(None),
};
socket = found.unwrap_or_else(|error| {
failure(&mut failed, pid, &error);
None
});
if let Some(socket) = &socket {
log::info!(
"terminal {pid}: herdr runs here, its server at {}",
socket.display()
);
}
}
let Some(path) = socket.clone() else {
continue;
};
match cx
.background_executor()
.spawn(async move { folder(&path) })
.await
{
Ok(Some(folder)) if shown.as_ref() != Some(&folder) => {
failed.clear();
let report = folder.clone();
// herdr may have left while it answered; the shell's own report then stands.
let Ok(still) = view.update(cx, |view, cx| {
let still = view.pty.foreground().ok() == group;
if still {
cx.emit(TerminalEvent::Folder(report));
}
still
}) else {
break;
};
if still {
log::info!(
"terminal {pid}: herdr's focused pane is in {}",
folder.display()
);
shown = Some(folder);
}
}
Ok(_) => failed.clear(),
Err(error) => failure(&mut failed, pid, &error),
}
}
})
}
/// Logs `error` once while it lasts; a server not up yet is no error.
fn failure(failed: &mut String, pid: u32, error: &anyhow::Error) {
let text = format!("{error:#}");
if text != *failed {
let level = if starting(error) {
log::Level::Info
} else {
log::Level::Error
};
log::log!(level, "terminal {pid}: {text}; the panel keeps its folder");
*failed = text;
}
}
/// herdr's client runs before its server listens: no socket yet, or none answering.
fn starting(error: &anyhow::Error) -> bool {
error.downcast_ref::<io::Error>().is_some_and(|error| {
matches!(
error.kind(),
io::ErrorKind::NotFound | io::ErrorKind::ConnectionRefused
)
})
}
/// The socket of the herdr server whose terminal client leads process group `group`, if one does.
fn client(group: i32) -> anyhow::Result<Option<PathBuf>> {
let path = match path(group) {
Ok(path) => path,
// Another user's program, such as sudo, or one already gone.
Err(error) => {
log::debug!("terminal: process {group} does not read: {error}");
return Ok(None);
}
};
if path.file_name().is_none_or(|name| name != "herdr") {
return Ok(None);
}
let (args, env) =
launch(group).with_context(|| format!("herdr: process {group} does not read"))?;
follows(&args, &env)
}
/// The socket a herdr process with `args` and `env` shows, if it is herdr's terminal client.
pub(super) fn follows(
args: &[String],
env: &HashMap<String, OsString>,
) -> anyhow::Result<Option<PathBuf>> {
if !attaches(args) {
return Ok(None);
}
let remote = |arg: &String| {
["--remote", "--machine"]
.iter()
.any(|flag| arg == flag || arg.starts_with(&format!("{flag}=")))
};
anyhow::ensure!(
!args.iter().any(remote),
"herdr: its client shows another machine's server, whose folders cannot show here"
);
socket(args, env).map(Some)
}
/// Whether `args` start herdr's terminal client, not one of its commands.
fn attaches(args: &[String]) -> bool {
let mut rest = args.iter().skip(1);
while let Some(arg) = rest.next() {
match arg.as_str() {
"--session" | "--remote" | "--machine" | "--remote-keybindings" => {
rest.next();
}
"--version" | "-V" | "--help" | "-h" | "--default-config" | "--skill" => return false,
"client" => return true,
"session" => return rest.next().is_some_and(|next| next == "attach"),
flag if flag.starts_with('-') => {}
_ => return false,
}
}
true
}
/// The socket herdr 0.9's client finds: a named session, `HERDR_SOCKET_PATH`, `HERDR_SESSION`, the default.
fn socket(args: &[String], env: &HashMap<String, OsString>) -> anyhow::Result<PathBuf> {
let dir = match (env.get("XDG_CONFIG_HOME"), env.get("HOME")) {
(Some(config), _) => PathBuf::from(config).join("herdr"),
(None, Some(home)) => PathBuf::from(home).join(".config/herdr"),
(None, None) => anyhow::bail!("herdr: its client has no HOME"),
};
let named = |name: &OsStr| {
if name == "default" {
dir.join("herdr.sock")
} else {
dir.join("sessions").join(name).join("herdr.sock")
}
};
if let Some(name) = session(args) {
return Ok(named(OsStr::new(&name)));
}
if let Some(path) = env.get("HERDR_SOCKET_PATH") {
return Ok(PathBuf::from(path));
}
Ok(env
.get("HERDR_SESSION")
.map_or_else(|| dir.join("herdr.sock"), |name| named(name)))
}
/// The session `session attach NAME`, `--session NAME` or `--session=NAME` names, as herdr reads it.
fn session(args: &[String]) -> Option<String> {
if let [_, noun, verb, name] = args
&& noun == "session"
&& verb == "attach"
{
return Some(name.clone());
}
let mut named = None;
let mut rest = args.iter().skip(1);
while let Some(arg) = rest.next() {
if arg == "--" {
break;
}
if arg == "--session" {
named = rest.next().cloned();
} else if let Some(name) = arg.strip_prefix("--session=") {
named = Some(name.to_owned());
}
}
named
}
/// The folder of the pane herdr's server has focused; none while it has none or knows none.
fn folder(socket: &Path) -> anyhow::Result<Option<PathBuf>> {
let ask = || -> io::Result<String> {
let mut stream = UnixStream::connect(socket)?;
stream.set_read_timeout(Some(WAIT))?;
stream.set_write_timeout(Some(WAIT))?;
stream.write_all(SNAPSHOT)?;
let mut reply = String::new();
BufReader::new(stream).read_line(&mut reply)?;
Ok(reply)
};
let reply = ask().with_context(|| format!("herdr: asking {}", socket.display()))?;
focused(&reply).with_context(|| format!("herdr: {}", socket.display()))
}
#[derive(Deserialize)]
struct Reply {
result: Option<Snapshot>,
error: Option<Failure>,
}
#[derive(Deserialize)]
struct Snapshot {
snapshot: Session,
}
#[derive(Deserialize)]
struct Session {
focused_pane_id: Option<String>,
panes: Vec<Pane>,
}
#[derive(Deserialize)]
struct Pane {
pane_id: String,
cwd: Option<PathBuf>,
}
#[derive(Deserialize)]
struct Failure {
code: String,
message: String,
}
/// The focused pane's folder in herdr's `session.snapshot` reply.
pub(super) fn focused(reply: &str) -> anyhow::Result<Option<PathBuf>> {
let reply: Reply = serde_json::from_str(reply).context("its reply does not parse")?;
if let Some(Failure { code, message }) = reply.error {
anyhow::bail!("{code}: {message}");
}
let session = reply.result.context("its reply holds no result")?.snapshot;
let Some(id) = session.focused_pane_id else {
return Ok(None);
};
let pane = session
.panes
.into_iter()
.find(|pane| pane.pane_id == id)
.with_context(|| format!("its focused pane {id} is not among its panes"))?;
if let Some(cwd) = &pane.cwd {
anyhow::ensure!(
cwd.is_absolute(),
"pane {id}'s folder {} is relative",
cwd.display()
);
}
Ok(pane.cwd)
}
#[cfg(target_os = "linux")]
fn path(pid: i32) -> io::Result<PathBuf> {
std::fs::read_link(format!("/proc/{pid}/exe"))
}
#[cfg(target_os = "linux")]
fn launch(pid: i32) -> io::Result<Invocation> {
let read = |name: &str| std::fs::read(format!("/proc/{pid}/{name}"));
let (args, env) = (read("cmdline")?, read("environ")?);
let args = strings(&args).map(lossy).collect();
let env = strings(&env).filter_map(variable).collect();
Ok((args, env))
}
/// Each NUL-ended string in `bytes`.
#[cfg(target_os = "linux")]
fn strings(bytes: &[u8]) -> impl Iterator<Item = &[u8]> {
bytes
.strip_suffix(b"\0")
.unwrap_or(bytes)
.split(|byte| *byte == 0)
}
#[cfg(target_os = "macos")]
fn path(pid: i32) -> io::Result<PathBuf> {
let mut buffer = vec![0u8; libc::PROC_PIDPATHINFO_MAXSIZE as usize];
// SAFETY: the buffer holds the size given.
let length =
unsafe { libc::proc_pidpath(pid, buffer.as_mut_ptr().cast(), buffer.len() as u32) };
if length <= 0 {
return Err(io::Error::last_os_error());
}
buffer.truncate(length as usize);
Ok(PathBuf::from(OsString::from_vec(buffer)))
}
#[cfg(target_os = "macos")]
fn launch(pid: i32) -> io::Result<Invocation> {
let mut name = [libc::CTL_KERN, libc::KERN_PROCARGS2, pid];
let mut ask = |buffer: &mut Vec<u8>| {
let mut size = buffer.len();
let into = if buffer.is_empty() {
std::ptr::null_mut()
} else {
buffer.as_mut_ptr().cast()
};
// SAFETY: `into` holds `size` bytes, or is null to ask for the size.
let done = unsafe {
libc::sysctl(
name.as_mut_ptr(),
3,
into,
&mut size,
std::ptr::null_mut(),
0,
)
};
if done != 0 {
return Err(io::Error::last_os_error());
}
Ok(size)
};
let mut buffer = Vec::new();
let size = ask(&mut buffer)?;
buffer.resize(size, 0);
let size = ask(&mut buffer)?;
buffer.truncate(size);
procargs(&buffer)
}
/// `KERN_PROCARGS2`'s layout: argc, the program's path, NUL padding, the arguments, the variables.
#[cfg(target_os = "macos")]
pub(super) fn procargs(buffer: &[u8]) -> io::Result<Invocation> {
let invalid =
|what: &str| io::Error::new(io::ErrorKind::InvalidData, format!("KERN_PROCARGS2 {what}"));
let (count, rest) = buffer
.split_first_chunk::<4>()
.ok_or_else(|| invalid("holds no argument count"))?;
let count = usize::try_from(i32::from_ne_bytes(*count))
.map_err(|_| invalid("holds a negative argument count"))?;
let mut parts = rest
.split(|byte| *byte == 0)
.skip(1)
.skip_while(|part| part.is_empty());
let args = parts.by_ref().take(count).map(lossy).collect();
let env = parts
.take_while(|part| !part.is_empty())
.filter_map(variable)
.collect();
Ok((args, env))
}
fn lossy(bytes: &[u8]) -> String {
String::from_utf8_lossy(bytes).into_owned()
}
/// A `NAME=value` variable; its value keeps its bytes.
fn variable(pair: &[u8]) -> Option<(String, OsString)> {
let at = pair.iter().position(|byte| *byte == b'=')?;
Some((
lossy(&pair[..at]),
OsString::from_vec(pair[at + 1..].to_vec()),
))
}
#[cfg(test)]
mod tests;
+143
View File
@@ -0,0 +1,143 @@
use std::{fs, os::unix::net::UnixListener};
use super::*;
fn args(words: &str) -> Vec<String> {
words.split(' ').map(str::to_owned).collect()
}
fn env(pairs: &[(&str, &str)]) -> HashMap<String, OsString> {
pairs
.iter()
.map(|(name, value)| ((*name).to_owned(), OsString::from(value)))
.collect()
}
fn found(words: &str, env: &HashMap<String, OsString>) -> PathBuf {
follows(&args(words), env)
.expect("a local client")
.expect("herdr's client")
}
#[test]
fn a_client_finds_its_server_as_herdr_does() {
let home = env(&[("HOME", "/h")]);
let default = PathBuf::from("/h/.config/herdr/herdr.sock");
let work = PathBuf::from("/h/.config/herdr/sessions/work/herdr.sock");
assert_eq!(found("herdr", &home), default);
assert_eq!(found("herdr client", &home), default);
assert_eq!(found("herdr --session work", &home), work);
assert_eq!(found("herdr --session=work", &home), work);
assert_eq!(found("herdr session attach work", &home), work);
assert_eq!(found("herdr --session default", &home), default);
let config = env(&[("HOME", "/h"), ("XDG_CONFIG_HOME", "/x")]);
assert_eq!(
found("herdr", &config),
PathBuf::from("/x/herdr/herdr.sock")
);
let socket = env(&[("HOME", "/h"), ("HERDR_SOCKET_PATH", "/s.sock")]);
assert_eq!(found("herdr", &socket), PathBuf::from("/s.sock"));
assert_eq!(found("herdr --session work", &socket), work);
let named = env(&[("HOME", "/h"), ("HERDR_SESSION", "work")]);
assert_eq!(found("herdr", &named), work);
assert!(follows(&args("herdr"), &env(&[])).is_err());
}
#[test]
fn only_herdr_s_terminal_client_is_followed() {
let home = env(&[("HOME", "/h")]);
for words in [
"herdr pane list",
"herdr api snapshot",
"herdr server",
"herdr session list",
"herdr --version",
"herdr --session work status",
] {
assert_eq!(follows(&args(words), &home).expect(words), None, "{words}");
}
for words in ["herdr --remote box", "herdr --remote=box --session work"] {
let error = follows(&args(words), &home).expect_err(words);
assert!(error.to_string().contains("another machine"), "{error}");
}
}
fn reply(focused_pane: &str, cwd: &str) -> String {
format!(
r#"{{"id":"elyterminal","result":{{"type":"session_snapshot","snapshot":{{"version":"0.9.5","protocol":22,"focused_pane_id":{focused_pane},"workspaces":[],"tabs":[],"panes":[{{"pane_id":"w1:p1","cwd":"/a","focused":false}},{{"pane_id":"w1:p2","cwd":{cwd},"focused":true}}],"layouts":[],"agents":[]}}}}}}"#
)
}
#[test]
fn the_focused_pane_s_folder_comes_from_herdr_s_snapshot() {
let read = |focused_pane: &str, cwd: &str| focused(&reply(focused_pane, cwd));
assert_eq!(
read(r#""w1:p2""#, r#""/srv/b""#).expect("a folder"),
Some("/srv/b".into())
);
assert_eq!(read("null", r#""/srv/b""#).expect("no focus"), None);
assert_eq!(read(r#""w1:p2""#, "null").expect("no folder"), None);
let error = read(r#""w1:p9""#, r#""/b""#).expect_err("a lost pane");
assert!(error.to_string().contains("w1:p9"), "{error}");
let error = read(r#""w1:p2""#, r#""b""#).expect_err("a relative folder");
assert!(error.to_string().contains("relative"), "{error}");
let failed =
r#"{"id":"elyterminal","error":{"code":"invalid_request","message":"no such method"}}"#;
let error = focused(failed).expect_err("an error");
assert_eq!(error.to_string(), "invalid_request: no such method");
assert!(focused("").is_err());
}
#[test]
fn herdr_answers_over_its_socket() {
let dir = std::env::temp_dir().join(format!("elyterminal-herdr-{}", std::process::id()));
if dir.exists() {
fs::remove_dir_all(&dir).expect("a stale test folder goes");
}
fs::create_dir_all(&dir).expect("a test folder");
let socket = dir.join("herdr.sock");
let listener = UnixListener::bind(&socket).expect("a socket");
let answer = reply(r#""w1:p2""#, r#""/srv""#);
let server = std::thread::spawn(move || {
let (stream, _) = listener.accept().expect("a client");
let mut request = String::new();
BufReader::new(&stream)
.read_line(&mut request)
.expect("a request");
(&stream)
.write_all(format!("{answer}\n").as_bytes())
.expect("a reply");
request
});
assert_eq!(folder(&socket).expect("an answer"), Some("/srv".into()));
assert_eq!(server.join().expect("the server").as_bytes(), SNAPSHOT);
fs::remove_dir_all(&dir).expect("the test folder goes");
let error = folder(&socket).expect_err("no server");
assert!(format!("{error:#}").contains("asking"), "{error:#}");
assert!(starting(&error), "{error:#}");
assert!(!starting(&focused("").expect_err("no reply")));
}
/// macOS hides the variables of its own programs, such as `/bin/sleep`, so the test reads itself.
#[test]
fn a_process_reads_with_its_path_arguments_and_variables() {
let pid = std::process::id() as i32;
let read = path(pid).expect("its path");
let (args, env) = launch(pid).expect("its arguments");
let exe = std::env::current_exe().expect("this test's path");
assert_eq!(fs::canonicalize(read).ok(), fs::canonicalize(exe).ok());
assert_eq!(args, std::env::args().collect::<Vec<_>>());
assert_eq!(env.get("HOME"), std::env::var_os("HOME").as_ref());
}
#[cfg(target_os = "macos")]
#[test]
fn macos_lays_out_the_arguments_after_the_program_s_path() {
let mut buffer = 2i32.to_ne_bytes().to_vec();
buffer.extend_from_slice(b"/usr/local/bin/herdr\0\0\0\0herdr\0\0HOME=/h\0X=a=b\0\0\0");
let (args, env) = procargs(&buffer).expect("it parses");
assert_eq!(args, ["herdr", ""]);
assert_eq!(env.get("HOME"), Some(&OsString::from("/h")));
assert_eq!(env.get("X"), Some(&OsString::from("a=b")));
assert!(procargs(&[1, 0]).is_err());
}
+2
View File
@@ -1,6 +1,8 @@
mod boxes;
mod find;
pub mod frame;
#[cfg(unix)]
mod herdr;
pub mod ink;
pub mod input;
pub mod keys;
+33 -3
View File
@@ -56,7 +56,7 @@ pub struct Pty {
pub term: Arc<FairMutex<Term<Listener>>>,
pub pid: u32,
notifier: Notifier,
#[cfg(all(test, unix))]
#[cfg(unix)]
master: std::fs::File,
}
@@ -111,7 +111,7 @@ pub fn spawn(
)
})?;
let pid = child_id(&raw)?;
#[cfg(all(test, unix))]
#[cfg(unix)]
let master = raw
.master()
.map_err(|error| anyhow::anyhow!("pty {pid}: no copy of the master: {error}"))?;
@@ -141,7 +141,7 @@ pub fn spawn(
term,
pid,
notifier,
#[cfg(all(test, unix))]
#[cfg(unix)]
master,
},
events,
@@ -184,6 +184,15 @@ impl Pty {
}
}
#[cfg(unix)]
impl Pty {
/// The process group the program runs in the foreground.
pub fn foreground(&self) -> std::io::Result<i32> {
let group = rustix_openpty::rustix::termios::tcgetpgrp(&self.master)?;
Ok(group.as_raw_nonzero().get())
}
}
#[cfg(all(test, unix))]
impl Pty {
/// Whether the program reads raw keys, canonical mode off.
@@ -305,6 +314,27 @@ mod tests {
assert_eq!(ran.text, "x");
}
#[test]
fn the_foreground_is_the_program_s_own_group() {
let launch = Launch {
program: Some(("/bin/sh".into(), vec!["-c".into(), "exec sleep 30".into()])),
cwd: std::env::temp_dir(),
env: Vec::new(),
reports: false,
};
let (pty, _events) =
spawn(&launch, (20, 4), (8, 16), config(&Settings::default())).expect("sh starts");
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(5);
while pty.foreground().ok() != Some(pty.pid as i32) {
assert!(
std::time::Instant::now() < deadline,
"{:?}",
pty.foreground()
);
std::thread::sleep(std::time::Duration::from_millis(10));
}
}
#[test]
fn a_size_past_the_kernel_is_one_size_for_grid_and_program() {
let ran = run("stty size", (9000, 8));
+1 -2
View File
@@ -45,8 +45,7 @@ impl Pty {
self.child.id()
}
/// A copy of the master; tests read its modes.
#[cfg(test)]
/// A copy of the master, which reads the foreground and, in tests, the modes.
pub fn master(&self) -> io::Result<File> {
self.file.try_clone()
}
+4
View File
@@ -73,6 +73,8 @@ pub struct TerminalView {
shown: bool,
_events: Task<()>,
_blink: Task<()>,
#[cfg(unix)]
_herdr: Task<()>,
_focus: [Subscription; 3],
_settings: Subscription,
_zoom: Subscription,
@@ -117,6 +119,8 @@ impl TerminalView {
shown: true,
_events: Self::pump(events, cx),
_blink: Self::blink(cx),
#[cfg(unix)]
_herdr: super::herdr::follow(cx),
_settings: cx.observe_global::<SettingsStore>(|view, cx| {
view.pty
.term