tact 0.3.0

Terminal interface for Nanocodex
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

use crate::tui::pane::PaneId;
use tokio::task::JoinHandle;
use tokio_util::sync::CancellationToken;

pub(crate) type ReviewResult = std::result::Result<Option<String>, crate::review::ReviewError>;
pub(crate) type ReviewTask = JoinHandle<ReviewCompletion>;

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(crate) struct ReviewIdentity {
    pub(crate) pane: PaneId,
    pub(crate) pane_generation: u64,
    pub(crate) controller_generation: u64,
}

pub(crate) struct ReviewCompletion {
    pub(crate) identity: ReviewIdentity,
    pub(crate) result: ReviewResult,
}

struct ActiveReview {
    identity: ReviewIdentity,
    url: Option<String>,
    cancellation: CancellationToken,
    task: ReviewTask,
}

/// Owns the complete lifetime of the one browser review exposed by the TUI.
pub(crate) struct ReviewController {
    next_generation: u64,
    active: Option<ActiveReview>,
}

impl ReviewController {
    pub(crate) const fn new() -> Self {
        Self {
            next_generation: 0,
            active: None,
        }
    }

    pub(crate) fn is_active(&self) -> bool {
        self.active.is_some()
    }

    pub(crate) fn start(
        &mut self,
        pane: PaneId,
        pane_generation: u64,
        spawn: impl FnOnce(ReviewIdentity, CancellationToken) -> ReviewTask,
    ) -> Option<ReviewIdentity> {
        if self.active.is_some() {
            return None;
        }

        let identity = ReviewIdentity {
            pane,
            pane_generation,
            controller_generation: self.next_generation,
        };
        self.next_generation = self.next_generation.saturating_add(1);
        let cancellation = CancellationToken::new();
        let task = spawn(identity, cancellation.clone());
        self.active = Some(ActiveReview {
            identity,
            url: None,
            cancellation,
            task,
        });
        Some(identity)
    }

    pub(crate) fn task_mut(&mut self) -> Option<&mut ReviewTask> {
        self.active.as_mut().map(|review| &mut review.task)
    }

    pub(crate) fn accepts(&self, identity: ReviewIdentity, shutdown: &CancellationToken) -> bool {
        !shutdown.is_cancelled()
            && self
                .active
                .as_ref()
                .is_some_and(|review| review.identity == identity)
    }

    pub(crate) fn set_url(&mut self, identity: ReviewIdentity, url: String) -> bool {
        let Some(review) = self
            .active
            .as_mut()
            .filter(|review| review.identity == identity)
        else {
            return false;
        };
        review.url = Some(url);
        true
    }

    pub(crate) fn identity(&self) -> Option<ReviewIdentity> {
        self.active.as_ref().map(|review| review.identity)
    }

    pub(crate) fn url(&self, pane: PaneId) -> Option<&str> {
        self.active
            .as_ref()
            .filter(|review| review.identity.pane == pane)
            .and_then(|review| review.url.as_deref())
    }

    pub(crate) fn cancel(&mut self) -> Option<ReviewIdentity> {
        let review = self.active.take()?;
        review.cancellation.cancel();
        review.task.abort();
        Some(review.identity)
    }

    pub(crate) fn complete(&mut self, identity: ReviewIdentity) -> bool {
        let matches = self
            .active
            .as_ref()
            .is_some_and(|review| review.identity == identity);
        if matches {
            self.active = None;
        }
        matches
    }
}

#[cfg(test)]
mod tests {
    use super::{ReviewCompletion, ReviewController, ReviewIdentity};
    use crate::tui::pane::PaneId;

    fn pending_review(
        identity: ReviewIdentity,
        _: tokio_util::sync::CancellationToken,
    ) -> super::ReviewTask {
        tokio::spawn(async move {
            std::future::pending::<()>().await;
            ReviewCompletion {
                identity,
                result: Ok(None),
            }
        })
    }

    #[tokio::test]
    async fn controller_rejects_stale_generations_and_cancels_owned_task() {
        let mut controller = ReviewController::new();
        let identity = controller
            .start(PaneId::Main, 4, pending_review)
            .expect("the first review should start");
        assert!(controller.set_url(identity, "http://127.0.0.1/review".to_owned()));
        assert_eq!(
            controller.url(PaneId::Main),
            Some("http://127.0.0.1/review")
        );

        let stale = ReviewIdentity {
            controller_generation: identity.controller_generation + 1,
            ..identity
        };
        assert!(!controller.accepts(stale, &tokio_util::sync::CancellationToken::new()));
        let cancelled = tokio_util::sync::CancellationToken::new();
        cancelled.cancel();
        assert!(!controller.accepts(identity, &cancelled));
        let abort = controller.task_mut().unwrap().abort_handle();
        assert_eq!(controller.cancel(), Some(identity));
        tokio::task::yield_now().await;
        assert!(abort.is_finished());
        assert!(!controller.is_active());
    }
}