fs: Improved responsiveness when watching paths on slow or unresponsive filesystems (#63410)

# Objective

When Zed watches a file or folder that doesn't exist yet, it retries
every couple of seconds. Two steps in that retry can be slow: asking the
filesystem whether it's case-sensitive (blocking sys call), and
registering the watcher itself (which reads the whole folder tree when
the watcher is recursive). If the system is slow to respond, those steps
can hang for a long time as you can see inside the following logs:

```
2026-08-23T11:42:56+02:00 INFO  [zed::reliability::hang_detection::logging] Background hang detected on Unknown:
Tasks(s) that ran too long
18.159457333s        - crates/fs/src/fs_watcher.rs:85:34

2026-08-23T11:42:56+02:00 INFO  [zed::reliability::hang_detection::logging] Background hang detected on Unknown:
Tasks(s) that ran too long
18.155837042s        - crates/fs/src/fs_watcher.rs:85:34

2026-08-23T11:42:56+02:00 INFO  [zed::reliability::hang_detection::logging] Background hang detected on Unknown:
Tasks(s) that ran too long
18.156099417s        - crates/fs/src/fs_watcher.rs:85:34

2026-08-23T11:42:56+02:00 INFO  [zed::reliability::hang_detection::logging] Background hang detected on Unknown:
Tasks(s) that ran too long
18.155881292s        - crates/fs/src/fs_watcher.rs:85:34

2026-08-23T11:42:56+02:00 INFO  [zed::reliability::hang_detection::logging] Background hang detected on Unknown:
Tasks(s) that ran too long
18.15603025s         - crates/fs/src/fs_watcher.rs:85:34

2026-08-23T11:42:56+02:00 INFO  [zed::reliability::hang_detection::logging] Background hang detected on Unknown:
Tasks(s) that ran too long
18.155880042s        - crates/fs/src/fs_watcher.rs:85:34
```

## Solution

My solution is to unblock the blocking code so that it doesn't hang a
background thread whenever the filesystem is slow to respond. The task
poll now returns pending while the syscall runs on the blocking pool, so
other tasks can be polled in the meantime.

## Testing

Behavior is unchanged, so just testing if Zed still picks up created
directories/files should be enough.

## Self-Review Checklist:

- [x] I've reviewed my own diff for quality, security, and reliability
- [x] Unsafe blocks (if any) have justifying comments
- [x] The content adheres to Zed's UI standards
([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
and
[icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md)
guidelines)
- [ ] Tests cover the new/changed behavior
- [x] Performance impact has been considered and is acceptable

---

Release Notes:

- Improved responsiveness when watching paths on slow or unresponsive
filesystems

---------

Co-authored-by: Ben Kunkle <ben@zed.dev>
This commit is contained in:
Remco Smits
2026-09-25 15:03:35 +00:00
committed by GitHub
parent adc8d7918e
commit 7ea077c78b
+36 -10
View File
@@ -598,7 +598,16 @@ async fn poll_path_until_created(
// Probe case sensitivity now that the path exists, rather than at add
// time when it didn't.
let case_insensitive = !fs.is_path_case_sensitive(&path);
let case_insensitive = if fs.is_fake() {
!fs.is_path_case_sensitive(&path)
} else {
smol::unblock({
let path = path.clone();
let fs = fs.clone();
move || !fs.is_path_case_sensitive(&path)
})
.await
};
let key = WatchKey::for_registration(SanitizedPath::new(&path), case_insensitive);
if registrations.lock().contains_key(&key) {
@@ -606,15 +615,32 @@ async fn poll_path_until_created(
return;
}
match register_existing_path(
&native_watcher,
&poll_watcher,
fs.as_ref(),
path.clone(),
case_insensitive,
tx.clone(),
pending_path_events.clone(),
) {
let register = {
let path = path.clone();
let tx = tx.clone();
let pending_path_events = pending_path_events.clone();
let fs = fs.clone();
let native_watcher = native_watcher.clone();
let poll_watcher = poll_watcher.clone();
move || {
register_existing_path(
&native_watcher,
&poll_watcher,
fs.as_ref(),
path,
case_insensitive,
tx,
pending_path_events,
)
}
};
let registration = if fs.is_fake() {
register()
} else {
smol::unblock(register).await
};
match registration {
Ok(Some(registration)) => {
{
let mut pending_registrations = pending_registrations.lock();