octorus 0.6.2

A TUI tool for GitHub PR review, designed for Helix editor users
Documentation
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
use anyhow::Result;
use crossterm::event;
use tokio::sync::mpsc;

use crate::filter::ListFilter;
use crate::github::{self, IssueStateFilter};
use crate::keybinding::{event_to_keybinding, SequenceMatch};

use super::types::{IssueState, LoadState};
use super::{App, AppState};

impl App {
    pub fn open_issue_list(&mut self) {
        let mut state = IssueState::new();
        state.issues = LoadState::Loading;
        self.issue_state = Some(state);
        self.state = AppState::IssueList;
        self.reload_issue_list();
    }

    pub(crate) fn reload_issue_list(&mut self) {
        let Some(ref mut state) = self.issue_state else {
            return;
        };
        state.selected_issue = 0;
        state.issue_list_scroll_offset = 0;
        state.issues = LoadState::Loading;
        state.issue_list_has_more = false;
        state.issue_list_filter = None;

        let (tx, rx) = mpsc::channel(2);
        state.issue_list_receiver = Some(rx);

        let repo = self.repo.clone();
        let filter = state.issue_list_state_filter;

        tokio::spawn(async move {
            let result = github::fetch_issue_list(&repo, filter, 20).await;
            let _ = tx.send(result.map_err(|e| e.to_string())).await;
        });
    }

    pub(crate) fn load_more_issues(&mut self) {
        let Some(ref mut state) = self.issue_state else {
            return;
        };
        if state.issues.is_loading() {
            return;
        }

        let offset = state.issues.as_loaded().map(|l| l.len()).unwrap_or(0) as u32;
        let existing = state.issues.as_loaded().cloned().unwrap_or_default();
        state.issues = LoadState::LoadingMore(existing);

        let (tx, rx) = mpsc::channel(2);
        state.issue_list_receiver = Some(rx);

        let repo = self.repo.clone();
        let filter = state.issue_list_state_filter;

        tokio::spawn(async move {
            let result = github::fetch_issue_list_with_offset(&repo, filter, offset, 20).await;
            let _ = tx.send(result.map_err(|e| e.to_string())).await;
        });
    }

    pub fn select_issue(&mut self, issue_number: u32) {
        let Some(ref mut state) = self.issue_state else {
            return;
        };

        state.issue_detail = LoadState::Loading;
        state.issue_detail_scroll_offset = 0;
        state.issue_detail_cache = None;
        state.issue_comments = None;
        state.selected_issue_comment = 0;
        state.issue_comment_list_scroll_offset = 0;
        state.issue_comment_detail_mode = false;
        state.issue_comment_detail_scroll = 0;
        // poll_issue_comment_submit_updates() checks the origin issue_number,
        // so in-flight submissions survive issue switches without data loss.
        state.selected_linked_pr = 0;
        state.detail_focus = Default::default();
        state.linked_prs = LoadState::Loading;

        let (detail_tx, detail_rx) = mpsc::channel(1);
        state.issue_detail_receiver = Some((issue_number, detail_rx));
        let repo = self.repo.clone();
        tokio::spawn(async move {
            let result = github::fetch_issue_detail(&repo, issue_number).await;
            let _ = detail_tx.send(result.map_err(|e| e.to_string())).await;
        });

        let (prs_tx, prs_rx) = mpsc::channel(1);
        state.linked_prs_receiver = Some((issue_number, prs_rx));
        let repo = self.repo.clone();
        tokio::spawn(async move {
            let result = github::fetch_linked_prs(&repo, issue_number).await;
            let _ = prs_tx.send(result.map_err(|e| e.to_string())).await;
        });

        self.state = AppState::IssueDetail;
    }

    pub(crate) fn open_issue_in_browser(&self, issue_number: u32) {
        let repo = self.repo.clone();
        tokio::spawn(async move {
            let _ = github::gh_command(&[
                "issue",
                "view",
                &issue_number.to_string(),
                "-R",
                &repo,
                "--web",
            ])
            .await;
        });
    }

    pub(crate) async fn handle_issue_list_input(&mut self, key: event::KeyEvent) -> Result<()> {
        let kb = self.config.keybindings.clone();

        if self.handle_filter_input(&key, "issue") {
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.quit) {
            if self.handle_filter_esc("issue") {
                return Ok(());
            }
            // Dropping issue_state would lose the receiver, so the user would
            // get no success/failure feedback and caches would not be updated.
            if self.is_issue_comment_submitting() {
                return Ok(());
            }
            if self.home_state == Some(AppState::Cockpit) {
                self.return_to_cockpit();
            } else {
                self.issue_state = None;
                self.state = AppState::PullRequestList;
            }
            return Ok(());
        }

        let Some(ref state) = self.issue_state else {
            return Ok(());
        };

        if matches!(state.issues, LoadState::Loading) {
            return Ok(());
        }

        let issue_count = state.issues.as_loaded().map(|l| l.len()).unwrap_or(0);
        let has_filter = state.issue_list_filter.is_some();

        if self.matches_single_key(&key, &kb.move_down) {
            if has_filter {
                self.handle_filter_navigation("issue", true);
            } else if issue_count > 0 {
                let needs_load_more = {
                    let state = self.issue_state.as_mut().unwrap();
                    state.selected_issue =
                        (state.selected_issue + 1).min(issue_count.saturating_sub(1));
                    state.issue_list_has_more
                        && !state.issues.is_loading()
                        && state.selected_issue + 5 >= issue_count
                };
                if needs_load_more {
                    self.load_more_issues();
                }
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.move_up) {
            if has_filter {
                self.handle_filter_navigation("issue", false);
            } else {
                let state = self.issue_state.as_mut().unwrap();
                state.selected_issue = state.selected_issue.saturating_sub(1);
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.page_down) || Self::is_shift_char_shortcut(&key, 'j') {
            if issue_count > 0 && !has_filter {
                let needs_load_more = {
                    let state = self.issue_state.as_mut().unwrap();
                    state.selected_issue =
                        (state.selected_issue + 20).min(issue_count.saturating_sub(1));
                    state.issue_list_has_more
                        && !state.issues.is_loading()
                        && state.selected_issue + 5 >= issue_count
                };
                if needs_load_more {
                    self.load_more_issues();
                }
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.page_up) || Self::is_shift_char_shortcut(&key, 'k') {
            if !has_filter {
                let state = self.issue_state.as_mut().unwrap();
                state.selected_issue = state.selected_issue.saturating_sub(20);
            }
            return Ok(());
        }

        if let Some(kb_event) = event_to_keybinding(&key) {
            self.check_sequence_timeout();

            if !self.pending_keys.is_empty() {
                self.push_pending_key(kb_event);

                if self.try_match_sequence(&kb.jump_to_first) == SequenceMatch::Full {
                    self.clear_pending_keys();
                    if !has_filter {
                        if let Some(ref mut state) = self.issue_state {
                            state.selected_issue = 0;
                        }
                    }
                    return Ok(());
                }

                if self.try_match_sequence(&kb.filter) == SequenceMatch::Full {
                    self.clear_pending_keys();
                    let state = self.issue_state.as_mut().unwrap();
                    if let Some(ref mut filter) = state.issue_list_filter {
                        filter.input_active = true;
                    } else {
                        let mut filter = ListFilter::new();
                        if let Some(issues) = state.issues.as_loaded() {
                            filter.apply(issues, |_issue, _q| true);
                            if let Some(idx) = filter.sync_selection() {
                                state.selected_issue = idx;
                            }
                        }
                        state.issue_list_filter = Some(filter);
                    }
                    return Ok(());
                }

                self.clear_pending_keys();
            } else if self.key_could_match_sequence(&key, &kb.jump_to_first)
                || self.key_could_match_sequence(&key, &kb.filter)
            {
                self.push_pending_key(kb_event);
                return Ok(());
            }
        }

        if self.matches_single_key(&key, &kb.jump_to_last) {
            if issue_count > 0 && !has_filter {
                let state = self.issue_state.as_mut().unwrap();
                state.selected_issue = issue_count.saturating_sub(1);
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.open_panel) {
            if self.is_filter_selection_empty("issue") {
                return Ok(());
            }
            let issue_number = {
                let state = self.issue_state.as_ref().unwrap();
                state
                    .issues
                    .as_loaded()
                    .and_then(|issues| issues.get(state.selected_issue))
                    .map(|i| i.number)
            };
            if let Some(number) = issue_number {
                self.select_issue(number);
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.open_in_browser) {
            if self.is_filter_selection_empty("issue") {
                return Ok(());
            }
            let state = self.issue_state.as_ref().unwrap();
            if let Some(issues) = state.issues.as_loaded() {
                if let Some(issue) = issues.get(state.selected_issue) {
                    self.open_issue_in_browser(issue.number);
                }
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.filter_open) {
            let needs_reload = {
                let state = self.issue_state.as_mut().unwrap();
                if state.issue_list_state_filter != IssueStateFilter::Open {
                    state.issue_list_state_filter = IssueStateFilter::Open;
                    true
                } else {
                    false
                }
            };
            if needs_reload {
                self.reload_issue_list();
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.filter_closed) {
            let needs_reload = {
                let state = self.issue_state.as_mut().unwrap();
                if state.issue_list_state_filter != IssueStateFilter::Closed {
                    state.issue_list_state_filter = IssueStateFilter::Closed;
                    true
                } else {
                    false
                }
            };
            if needs_reload {
                self.reload_issue_list();
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.filter_all) {
            let needs_reload = {
                let state = self.issue_state.as_mut().unwrap();
                if state.issue_list_state_filter != IssueStateFilter::All {
                    state.issue_list_state_filter = IssueStateFilter::All;
                    true
                } else {
                    false
                }
            };
            if needs_reload {
                self.reload_issue_list();
            }
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.refresh) {
            self.reload_issue_list();
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.toggle_zen_mode) {
            self.toggle_zen_mode();
            return Ok(());
        }

        if self.matches_single_key(&key, &kb.help) {
            self.open_help(AppState::IssueList);
            return Ok(());
        }

        Ok(())
    }
}

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

    #[tokio::test]
    async fn test_open_issue_list_initializes_state() {
        let mut app = App::new_for_test();
        app.state = AppState::PullRequestList;
        app.open_issue_list();
        assert_eq!(app.state, AppState::IssueList);
        assert!(app.issue_state.is_some());
        let state = app.issue_state.as_ref().unwrap();
        assert!(state.issues.is_loading());
    }

    #[test]
    fn test_issue_state_new_defaults() {
        let state = IssueState::new();
        assert!(!state.issues.is_loaded());
        assert_eq!(state.selected_issue, 0);
        assert!(!state.issues.is_loading());
        assert!(!state.linked_prs.is_loaded());
        assert!(!state.linked_prs.is_loading());
        assert!(!state.issue_detail.is_loaded());
        assert!(!state.issue_detail.is_loading());
    }

    #[tokio::test]
    async fn test_select_issue_replaces_receivers_on_rapid_reselection() {
        let mut app = App::new_for_test();
        app.issue_state = Some(IssueState::new());
        app.state = AppState::IssueList;

        // Select issue A
        app.select_issue(100);
        let state = app.issue_state.as_ref().unwrap();
        assert_eq!(state.issue_detail_receiver.as_ref().unwrap().0, 100);
        assert_eq!(state.linked_prs_receiver.as_ref().unwrap().0, 100);

        // Rapidly select issue B before polling A's response
        app.select_issue(200);
        let state = app.issue_state.as_ref().unwrap();
        // Receivers should now track issue B, not A
        assert_eq!(state.issue_detail_receiver.as_ref().unwrap().0, 200);
        assert_eq!(state.linked_prs_receiver.as_ref().unwrap().0, 200);
        // Previous detail should be cleared (now Loading)
        assert!(state.issue_detail.is_loading());
        assert!(state.linked_prs.is_loading());
    }

    #[tokio::test]
    async fn test_quit_blocked_while_issue_comment_submitting() {
        let mut app = App::new_for_test();
        let mut state = IssueState::new();
        state.issues = LoadState::Loaded(vec![]);
        state.issue_comment_submitting = true;
        app.issue_state = Some(state);
        app.state = AppState::IssueList;

        // Press 'q' — should be blocked because submission is in flight
        let key = crossterm::event::KeyEvent::new(
            KeyCode::Char('q'),
            crossterm::event::KeyModifiers::NONE,
        );
        app.handle_issue_list_input(key).await.unwrap();

        // issue_state must NOT be dropped
        assert!(app.issue_state.is_some());
        assert_eq!(app.state, AppState::IssueList);
    }

    #[tokio::test]
    async fn test_quit_allowed_when_not_submitting() {
        let mut app = App::new_for_test();
        let mut state = IssueState::new();
        state.issues = LoadState::Loaded(vec![]);
        state.issue_comment_submitting = false;
        app.issue_state = Some(state);
        app.state = AppState::IssueList;

        // Press 'q' — should navigate away
        let key = crossterm::event::KeyEvent::new(
            KeyCode::Char('q'),
            crossterm::event::KeyModifiers::NONE,
        );
        app.handle_issue_list_input(key).await.unwrap();

        assert!(app.issue_state.is_none());
        assert_eq!(app.state, AppState::PullRequestList);
    }
}