sluuz 0.10.0

git, but it sleuths - a git superset with cross-repo search, secret scanning, and multi-repo management
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Loading and highlighting a diff off the UI thread.
//!
//! `git diff` on a big file plus the syntect pass is long enough to stall a held
//! `j`, and both the four-level browser and `istatus` move a cursor over files.
//! They differ only in which git command produces the raw text, so that is the
//! one thing a caller passes in.

use std::sync::mpsc::{self, Receiver, Sender};
use std::time::{Duration, Instant};

use crate::tui::highlight::{DiffContext, RenderedDiff, prepare_diff};

/// How long that may take before a pane admits it is loading. A wait nobody
/// notices says nothing, or the word blinks on every keypress in a small repo.
const SLOW: Duration = Duration::from_millis(120);

pub struct DiffFeed {
    tx: Sender<(u64, RenderedDiff)>,
    rx: Receiver<(u64, RenderedDiff)>,
    /// The newest request. An answer carrying anything else belongs to a row the
    /// cursor has already left.
    seq: u64,
    loading: bool,
    since: Option<Instant>,
}

impl Default for DiffFeed {
    fn default() -> Self {
        let (tx, rx) = mpsc::channel();
        DiffFeed {
            tx,
            rx,
            seq: 0,
            loading: false,
            since: None,
        }
    }
}

impl DiffFeed {
    /// Ask for a diff. `raw` runs on the worker and returns what git said,
    /// paired with where to read the file's two sides when a hunk starts too far
    /// down the file to highlight on its own.
    pub fn request(&mut self, raw: impl FnOnce() -> (String, DiffContext) + Send + 'static) {
        self.seq += 1;
        self.loading = true;
        self.since = Some(Instant::now());
        let (seq, tx) = (self.seq, self.tx.clone());
        std::thread::spawn(move || {
            let (text, ctx) = raw();
            let _ = tx.send((seq, prepare_diff(&text, ctx)));
        });
    }

    /// Nothing is coming: the cursor is on a row with no diff to show.
    pub fn idle(&mut self) {
        self.seq += 1;
        self.loading = false;
        self.since = None;
    }

    /// The newest prepared diff, if one has arrived since the last call.
    pub fn take(&mut self) -> Option<RenderedDiff> {
        let mut newest = None;
        while let Ok((seq, prepared)) = self.rx.try_recv() {
            if seq == self.seq {
                newest = Some(prepared);
                self.loading = false;
            }
        }
        newest
    }

    pub fn loading(&self) -> bool {
        self.loading
    }

    pub fn slow(&self) -> bool {
        self.loading && self.since.is_some_and(|t| t.elapsed() >= SLOW)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    /// A prepared diff carrying nothing: the sequence is what these test.
    fn empty() -> RenderedDiff {
        RenderedDiff::default()
    }

    /// A request that asks git for nothing.
    fn nothing() -> (String, DiffContext) {
        (String::new(), DiffContext::default())
    }

    #[test]
    fn an_answer_to_a_row_you_have_left_is_dropped() {
        // The whole point of the sequence: a held `j` starts a load per row it
        // passes, and the slow one must not land on the row you stopped on.
        let mut feed = DiffFeed::default();
        let (first, second) = (feed.tx.clone(), feed.tx.clone());
        feed.request(nothing); // seq 1
        feed.request(nothing); // seq 2, supersedes it

        let _ = first.send((1, empty()));
        assert!(feed.take().is_none(), "the answer to seq 1 is not wanted");

        let _ = second.send((2, empty()));
        assert!(feed.take().is_some(), "the answer to seq 2 is");
        assert!(!feed.loading(), "and the pane has stopped waiting");
    }

    #[test]
    fn a_row_with_no_diff_stops_the_waiting() {
        let mut feed = DiffFeed::default();
        feed.request(nothing);
        assert!(feed.loading());
        feed.idle();
        assert!(
            !feed.loading(),
            "nothing is coming, so nothing is waited for"
        );
        assert!(!feed.slow());
    }
}