quinjet 0.0.1

A fast, live, keyboard-first Git source-control interface for the terminal
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use std::path::{Component, Path};

use anyhow::{Context, Result};
use crossbeam_channel::{Receiver, bounded};
use notify::{Event, EventKind, RecommendedWatcher, RecursiveMode, Watcher};

pub struct RepoWatcher {
    receiver: Receiver<()>,
    _watcher: RecommendedWatcher,
}

impl RepoWatcher {
    pub fn new(root: &Path) -> Result<Self> {
        let (sender, receiver) = bounded(1);
        let mut watcher = notify::recommended_watcher(move |result: notify::Result<Event>| {
            let Ok(event) = result else {
                return;
            };
            if should_refresh(&event) {
                // Coalesce event storms. Missing an individual event is safe because a
                // status refresh always reads the complete Git state.
                let _ = sender.try_send(());
            }
        })
        .context("failed to create filesystem watcher")?;
        watcher
            .watch(root, RecursiveMode::Recursive)
            .with_context(|| format!("failed to watch {}", root.display()))?;

        Ok(Self {
            receiver,
            _watcher: watcher,
        })
    }

    pub fn changes(&self) -> &Receiver<()> {
        &self.receiver
    }
}

fn should_refresh(event: &Event) -> bool {
    if matches!(event.kind, EventKind::Access(_)) {
        return false;
    }
    event.paths.iter().any(|path| !is_noisy_git_path(path))
}

fn is_noisy_git_path(path: &Path) -> bool {
    let components: Vec<_> = path.components().collect();
    let Some(git_index) = components
        .iter()
        .position(|component| component.as_os_str() == ".git")
    else {
        return false;
    };
    let tail = &components[git_index + 1..];
    if tail
        .first()
        .is_some_and(|component| component.as_os_str() == "objects")
    {
        return true;
    }
    tail.last().is_some_and(|component| {
        let name = component.as_os_str().to_string_lossy();
        name == "index.lock" || name.starts_with(".watchman-cookie-")
    }) || components
        .iter()
        .any(|component| matches!(component, Component::ParentDir))
}

#[cfg(test)]
mod tests {
    use std::path::Path;

    use super::*;

    #[test]
    fn filters_git_object_and_lock_noise_but_not_refs() {
        assert!(is_noisy_git_path(Path::new("/repo/.git/objects/ab/cdef")));
        assert!(is_noisy_git_path(Path::new("/repo/.git/index.lock")));
        assert!(!is_noisy_git_path(Path::new("/repo/.git/HEAD")));
        assert!(!is_noisy_git_path(Path::new("/repo/.git/refs/heads/main")));
        assert!(!is_noisy_git_path(Path::new("/repo/src/main.rs")));
    }
}