summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Yue <jiacheng.yue@foxmail.com>2026-09-16 20:41:41 +0800
committerGitHub <noreply@github.com>2026-09-16 14:41:41 +0200
commitab15da285e9d74bea476375f635f73148d551d24 (patch)
tree57549bb52ebee34fa4015268710a7e6973193377
parent68ae6adea0add496cea227030c94e5d3172f4e86 (diff)
fix: require exact session names before deletion (#4233)
* fix: require exact session names before deletion refs #3819 * test: isolate session deletion regression tests refs #3819 --------- Co-authored-by: JJ Liebig <jonathan.liebig@gmail.com>
-rw-r--r--docs/next/website/src/content/docs/ja/persistence-remote.mdx2
-rw-r--r--docs/next/website/src/content/docs/persistence-remote.mdx2
-rw-r--r--docs/next/website/src/content/docs/zh-cn/persistence-remote.mdx2
-rw-r--r--src/session.rs31
-rw-r--r--tests/session_delete.rs180
5 files changed, 215 insertions, 2 deletions
diff --git a/docs/next/website/src/content/docs/ja/persistence-remote.mdx b/docs/next/website/src/content/docs/ja/persistence-remote.mdx
index 77eefb51..acd75b86 100644
--- a/docs/next/website/src/content/docs/ja/persistence-remote.mdx
+++ b/docs/next/website/src/content/docs/ja/persistence-remote.mdx
@@ -27,6 +27,8 @@ herdr session delete side-project
名前付きセッションは独自のペイン、タブ、ワークスペース、ソケット、ランタイム状態を持ちます。グローバル設定ファイルは共有されます。
+セッションを削除するときは、大文字と小文字も含めて `herdr session list` に表示される名前を正確に指定してください。大文字と小文字を区別しないファイルシステムでは、`herdr session delete foo` は `Foo` という名前のセッションの削除を拒否します。
+
スクリプトでは `--json` を使ってください:
```bash
diff --git a/docs/next/website/src/content/docs/persistence-remote.mdx b/docs/next/website/src/content/docs/persistence-remote.mdx
index 6f3cb695..4f42cef5 100644
--- a/docs/next/website/src/content/docs/persistence-remote.mdx
+++ b/docs/next/website/src/content/docs/persistence-remote.mdx
@@ -27,6 +27,8 @@ herdr session delete side-project
A named session has its own panes, tabs, workspaces, sockets, and runtime state. It still shares the same global config file.
+When deleting a session, use the exact name shown by `herdr session list`, including letter case. On case-insensitive filesystems, `herdr session delete foo` refuses to delete a session named `Foo`.
+
Use `--json` for scripts:
```bash
diff --git a/docs/next/website/src/content/docs/zh-cn/persistence-remote.mdx b/docs/next/website/src/content/docs/zh-cn/persistence-remote.mdx
index b8e335a8..65567bc3 100644
--- a/docs/next/website/src/content/docs/zh-cn/persistence-remote.mdx
+++ b/docs/next/website/src/content/docs/zh-cn/persistence-remote.mdx
@@ -27,6 +27,8 @@ herdr session delete side-project
命名会话拥有自己的窗格、标签页、工作区、socket 和运行时状态。它仍然共享同一个全局配置文件。
+删除会话时,请使用 `herdr session list` 显示的完整名称,大小写必须一致。在不区分大小写的文件系统上,`herdr session delete foo` 会拒绝删除名为 `Foo` 的会话。
+
脚本中使用 `--json`:
```bash
diff --git a/src/session.rs b/src/session.rs
index 09657fa0..29e3e17e 100644
--- a/src/session.rs
+++ b/src/session.rs
@@ -301,14 +301,16 @@ pub fn delete_session(name: &str) -> Result<SessionInfo, String> {
return Err("deleting the default session is not supported".to_string());
}
validate_name(name)?;
- let socket_path = api_socket_path_for(Some(name));
+ let Some(dir) = exact_session_dir_for_delete(name)? else {
+ return Ok(session_info(Some(name)));
+ };
+ let socket_path = dir.join("herdr.sock");
if is_running_at(&socket_path) {
return Err(format!(
"session {name} is running; stop it before deleting"
));
}
let info = session_info(Some(name));
- let dir = data_dir_for(Some(name));
match std::fs::remove_dir_all(&dir) {
Ok(()) => Ok(info),
Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(info),
@@ -316,6 +318,31 @@ pub fn delete_session(name: &str) -> Result<SessionInfo, String> {
}
}
+fn exact_session_dir_for_delete(name: &str) -> Result<Option<PathBuf>, String> {
+ let sessions_dir = crate::config::config_dir().join("sessions");
+ let entries = match std::fs::read_dir(&sessions_dir) {
+ Ok(entries) => entries,
+ Err(err) if err.kind() == std::io::ErrorKind::NotFound => return Ok(None),
+ Err(err) => return Err(err.to_string()),
+ };
+ for entry in entries {
+ let entry = entry.map_err(|err| err.to_string())?;
+ if entry.file_name() == std::ffi::OsStr::new(name) {
+ return Ok(Some(entry.path()));
+ }
+ }
+
+ // A path lookup alone can resolve a different spelling on case-insensitive
+ // filesystems. Never probe its socket or delete it without an exact entry.
+ match std::fs::symlink_metadata(sessions_dir.join(name)) {
+ Ok(_) => Err(format!(
+ "session {name} does not match an exact session name; use the spelling shown by `herdr session list`"
+ )),
+ Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(None),
+ Err(err) => Err(err.to_string()),
+ }
+}
+
fn send_stop_request(
mut stream: LocalStream,
request: &serde_json::Value,
diff --git a/tests/session_delete.rs b/tests/session_delete.rs
new file mode 100644
index 00000000..0aa80582
--- /dev/null
+++ b/tests/session_delete.rs
@@ -0,0 +1,180 @@
+use std::fs;
+use std::path::PathBuf;
+use std::process::{Command, Output};
+use std::sync::atomic::{AtomicU64, Ordering};
+
+/// Owns a unique configuration directory; only child CLIs receive its environment.
+struct SessionConfig {
+ root: PathBuf,
+}
+
+impl SessionConfig {
+ fn new() -> Self {
+ static NEXT_ID: AtomicU64 = AtomicU64::new(0);
+ // Keep Unix socket paths below the host's length limit.
+ #[cfg(unix)]
+ let base = PathBuf::from("/tmp");
+ #[cfg(not(unix))]
+ let base = std::env::temp_dir();
+ let root = base.join(format!(
+ "hs-delete-{}-{}-{}",
+ std::process::id(),
+ std::time::SystemTime::now()
+ .duration_since(std::time::UNIX_EPOCH)
+ .unwrap()
+ .as_micros(),
+ NEXT_ID.fetch_add(1, Ordering::Relaxed)
+ ));
+ fs::create_dir(&root).unwrap();
+ Self { root }
+ }
+
+ fn session_dir(&self, name: &str) -> PathBuf {
+ let app_dir = if cfg!(debug_assertions) {
+ "herdr-dev"
+ } else {
+ "herdr"
+ };
+ self.root.join(app_dir).join("sessions").join(name)
+ }
+
+ fn create_session(&self, name: &str) -> PathBuf {
+ let dir = self.session_dir(name);
+ fs::create_dir_all(&dir).unwrap();
+ fs::write(dir.join("session.json"), b"saved session").unwrap();
+ dir
+ }
+
+ fn delete(&self, name: &str) -> Output {
+ Command::new(env!("CARGO_BIN_EXE_herdr"))
+ .args(["session", "delete", name, "--json"])
+ .env("XDG_CONFIG_HOME", &self.root)
+ .env_remove("HERDR_SESSION")
+ .env_remove("HERDR_SOCKET_PATH")
+ .env_remove("HERDR_CLIENT_SOCKET_PATH")
+ .output()
+ .unwrap()
+ }
+}
+
+impl Drop for SessionConfig {
+ fn drop(&mut self) {
+ // Cleanup must not cause a second panic if a test assertion failed.
+ let _ = fs::remove_dir_all(&self.root);
+ }
+}
+
+fn assert_success(output: &Output) -> serde_json::Value {
+ assert!(
+ output.status.success(),
+ "stdout={} stderr={}",
+ String::from_utf8_lossy(&output.stdout),
+ String::from_utf8_lossy(&output.stderr)
+ );
+ let response: serde_json::Value = serde_json::from_slice(&output.stdout).unwrap();
+ assert_eq!(response["deleted"], true);
+ response
+}
+
+#[test]
+fn delete_session_preserves_differently_cased_name() {
+ let config = SessionConfig::new();
+ let dir = config.create_session("Foo");
+ let case_insensitive = config.session_dir("foo").exists();
+
+ let output = config.delete("foo");
+
+ assert_eq!(
+ fs::read(dir.join("session.json")).unwrap(),
+ b"saved session"
+ );
+ if case_insensitive {
+ assert_eq!(output.status.code(), Some(1));
+ let error: serde_json::Value = serde_json::from_slice(&output.stderr).unwrap();
+ assert_eq!(error["error"]["code"], "session_delete_failed");
+ assert!(error["error"]["message"]
+ .as_str()
+ .unwrap()
+ .contains("exact"));
+ } else {
+ assert_success(&output);
+ }
+}
+
+#[test]
+fn delete_session_removes_exact_stopped_name_only() {
+ let config = SessionConfig::new();
+ let dir = config.create_session("Foo");
+ let other = config.create_session("other");
+
+ let response = assert_success(&config.delete("Foo"));
+
+ assert_eq!(response["session"]["name"], "Foo");
+ assert_eq!(response["session"]["running"], false);
+ assert!(!dir.exists());
+ assert_eq!(
+ fs::read(other.join("session.json")).unwrap(),
+ b"saved session"
+ );
+}
+
+#[test]
+fn delete_session_missing_name_remains_idempotent() {
+ let config = SessionConfig::new();
+ assert_success(&config.delete("missing"));
+ config.create_session("other");
+ assert_success(&config.delete("missing"));
+}
+
+#[test]
+fn delete_session_distinguishes_case_sensitive_siblings() {
+ let config = SessionConfig::new();
+ let upper = config.create_session("Foo");
+ if config.session_dir("foo").exists() {
+ return; // This filesystem cannot store both spellings independently.
+ }
+ let lower = config.create_session("foo");
+
+ assert_success(&config.delete("foo"));
+
+ assert!(!lower.exists());
+ assert_eq!(
+ fs::read(upper.join("session.json")).unwrap(),
+ b"saved session"
+ );
+}
+
+#[cfg(unix)]
+#[test]
+fn delete_session_preserves_running_session() {
+ let config = SessionConfig::new();
+ let dir = config.create_session("Foo");
+ let _listener = std::os::unix::net::UnixListener::bind(dir.join("herdr.sock")).unwrap();
+
+ let output = config.delete("Foo");
+
+ assert_eq!(output.status.code(), Some(1));
+ let error: serde_json::Value = serde_json::from_slice(&output.stderr).unwrap();
+ assert!(error["error"]["message"]
+ .as_str()
+ .unwrap()
+ .contains("running"));
+ assert_eq!(
+ fs::read(dir.join("session.json")).unwrap(),
+ b"saved session"
+ );
+}
+
+#[test]
+fn session_config_cleans_up_after_panic() {
+ let mut root = None;
+ let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
+ let config = SessionConfig::new();
+ root = Some(config.root.clone());
+ config.create_session("Foo");
+ panic!("simulate a failed assertion");
+ }));
+
+ assert!(result.is_err());
+ assert!(!root.unwrap().exists());
+}