tears 0.9.0

A simple and elegant framework for building TUI applications using The Elm Architecture (TEA)
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

use std::time::Duration;

/// The reason a query stream is reconciling its cell state.
#[non_exhaustive]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) enum ReconcileReason {
    InitialObserve,
    WatchChanged,
}

/// Snapshot of the state needed to decide whether reconcile should fetch.
#[allow(clippy::struct_excessive_bools)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) struct FetchDecisionInput {
    pub(super) has_data: bool,
    pub(super) generation_stale: bool,
    pub(super) time_since_data: Option<Duration>,
    pub(super) stale_time: Duration,
    pub(super) has_in_flight: bool,
    pub(super) last_error_generation_matches_current: bool,
}

/// Decides whether a reconcile pass should start a fetch.
///
/// Data absence and generation staleness are fetch reasons for every reconcile
/// reason. Time staleness is only a fetch reason for observe boundaries, not
/// for [`ReconcileReason::WatchChanged`].
#[must_use]
pub(super) fn should_fetch(reason: ReconcileReason, input: FetchDecisionInput) -> bool {
    let time_stale = input
        .time_since_data
        .is_some_and(|elapsed| elapsed >= input.stale_time);
    let time_stale_can_fetch = matches!(reason, ReconcileReason::InitialObserve);
    let needs_data_or_generation_fetch = !input.has_data || input.generation_stale;
    let needs_time_stale_fetch = input.has_data && time_stale && time_stale_can_fetch;

    (needs_data_or_generation_fetch || needs_time_stale_fetch)
        && !input.has_in_flight
        && !input.last_error_generation_matches_current
}

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

    use std::time::Duration;

    #[test]
    fn watch_changed_does_not_refetch_for_time_stale_same_generation() {
        let should_fetch = should_fetch(
            ReconcileReason::WatchChanged,
            FetchDecisionInput {
                has_data: true,
                generation_stale: false,
                time_since_data: Some(Duration::ZERO),
                stale_time: Duration::ZERO,
                has_in_flight: false,
                last_error_generation_matches_current: false,
            },
        );

        assert!(
            !should_fetch,
            "WatchChanged must not start a same-generation refetch for time-stale data"
        );
    }

    #[test]
    fn watch_changed_fetches_for_missing_data_or_generation_stale_data() {
        let missing_data = should_fetch(
            ReconcileReason::WatchChanged,
            FetchDecisionInput {
                has_data: false,
                generation_stale: false,
                time_since_data: None,
                stale_time: Duration::ZERO,
                has_in_flight: false,
                last_error_generation_matches_current: false,
            },
        );
        assert!(missing_data, "missing data should fetch for every reason");

        let generation_stale = should_fetch(
            ReconcileReason::WatchChanged,
            FetchDecisionInput {
                has_data: true,
                generation_stale: true,
                time_since_data: Some(Duration::ZERO),
                stale_time: Duration::ZERO,
                has_in_flight: false,
                last_error_generation_matches_current: false,
            },
        );
        assert!(
            generation_stale,
            "generation-stale data should fetch for every reason"
        );
    }
}