sabiql 3.0.0

A fast, driver-less TUI for browsing and editing PostgreSQL, MySQL, and SQLite databases
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

use std::io::stdout;
use std::panic;

use color_eyre::eyre::Result;
use crossterm::{
    cursor::SetCursorStyle,
    event::{DisableBracketedPaste, DisableMouseCapture},
    execute,
    terminal::{LeaveAlternateScreen, disable_raw_mode},
};

#[allow(
    clippy::print_stderr,
    reason = "panic hook must write to stderr after terminal restore"
)]
#[allow(
    clippy::redundant_pub_crate,
    reason = "the binary entrypoint calls this through its private panic hook module"
)]
pub(super) fn install_hooks() -> Result<()> {
    let hook_builder = color_eyre::config::HookBuilder::default().display_env_section(false);
    let (panic_hook, eyre_hook) = hook_builder.into_hooks();
    eyre_hook.install()?;

    panic::set_hook(Box::new(move |panic_info| {
        let _ = restore_terminal();
        eprintln!("{}", panic_hook.panic_report(panic_info));
    }));

    Ok(())
}

fn restore_terminal() -> Result<()> {
    restore_terminal_with_probe(
        crossterm::terminal::is_raw_mode_enabled().map_err(Into::into),
        |step| match step {
            RestoreStep::Cursor => {
                execute!(stdout(), SetCursorStyle::DefaultUserShape).map_err(Into::into)
            }
            RestoreStep::AlternateScreen => {
                execute!(stdout(), LeaveAlternateScreen).map_err(Into::into)
            }
            RestoreStep::MouseCapture => {
                execute!(stdout(), DisableMouseCapture).map_err(Into::into)
            }
            RestoreStep::BracketedPaste => {
                execute!(stdout(), DisableBracketedPaste).map_err(Into::into)
            }
            RestoreStep::Raw => disable_raw_mode().map_err(Into::into),
        },
    )
}

fn restore_terminal_with_probe<F>(raw_mode: Result<bool>, restore: F) -> Result<()>
where
    F: FnMut(RestoreStep) -> Result<()>,
{
    let mut first_error = match raw_mode {
        Ok(true) => None,
        Ok(false) => return Ok(()),
        Err(error) => Some(error),
    };

    if let Err(error) = restore_terminal_steps(restore)
        && first_error.is_none()
    {
        first_error = Some(error);
    }
    first_error.map_or(Ok(()), Err)
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum RestoreStep {
    Cursor,
    BracketedPaste,
    MouseCapture,
    AlternateScreen,
    Raw,
}

fn restore_terminal_steps<F>(mut restore: F) -> Result<()>
where
    F: FnMut(RestoreStep) -> Result<()>,
{
    let mut first_error = None;
    for step in [
        RestoreStep::Cursor,
        RestoreStep::BracketedPaste,
        RestoreStep::MouseCapture,
        RestoreStep::AlternateScreen,
        RestoreStep::Raw,
    ] {
        if let Err(error) = restore(step)
            && first_error.is_none()
        {
            first_error = Some(error);
        }
    }
    first_error.map_or(Ok(()), Err)
}

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

    #[test]
    fn continues_restore_steps_after_a_failure() {
        let mut restored = Vec::new();

        let error = restore_terminal_steps(|step| {
            restored.push(step);
            if step == RestoreStep::BracketedPaste {
                Err(color_eyre::eyre::eyre!("bracketed paste restore failed"))
            } else {
                Ok(())
            }
        })
        .unwrap_err();

        assert_eq!(error.to_string(), "bracketed paste restore failed");
        assert_eq!(
            restored,
            vec![
                RestoreStep::Cursor,
                RestoreStep::BracketedPaste,
                RestoreStep::MouseCapture,
                RestoreStep::AlternateScreen,
                RestoreStep::Raw,
            ]
        );
    }

    #[test]
    fn continues_restore_when_raw_mode_probe_fails() {
        let mut restored = Vec::new();

        let error = restore_terminal_with_probe(
            Err(std::io::Error::other("raw mode probe failed").into()),
            |step| {
                restored.push(step);
                Ok(())
            },
        )
        .unwrap_err();

        assert_eq!(error.to_string(), "raw mode probe failed");
        assert_eq!(
            restored,
            vec![
                RestoreStep::Cursor,
                RestoreStep::BracketedPaste,
                RestoreStep::MouseCapture,
                RestoreStep::AlternateScreen,
                RestoreStep::Raw,
            ]
        );
    }
}