helix-toolbox 1.25.4

Build, configure and optimize a Linux machine from a terminal menu: installs, dotfiles, updates, backups and health checks, every change planned and confirmed first.
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

//! Bug reports and reports that a run worked.

use super::super::*;

impl App {
    /// Gather a bug report in the background: the health checks take a few
    /// seconds.
    pub(in crate::tui::app) fn make_report(&mut self) {
        let platform = self.platform.clone();
        self.reporting.start(&self.host, move |host| {
            crate::report::markdown(&crate::report::gather(&host, &platform, true))
        });
        self.popup = Some(Popup::Text(TextPopup::new(
            "Bug report",
            "Gathering the report; the health checks take a few seconds…",
            true,
        )));
    }

    /// Show the gathered report, and keep a copy to paste from.
    pub(in crate::tui::app) fn show_report(&mut self, report: &str) {
        let saved = self.reports_dir.as_ref().map(|directory| {
            let path = directory.join("bug-report.md");
            std::fs::create_dir_all(directory)
                .and_then(|()| std::fs::write(&path, report))
                .map(|()| path)
        });
        let kept = match saved {
            Some(Ok(path)) => {
                let shown = path.display().to_string();
                let home = self.host.home().to_string_lossy().into_owned();
                let shown = match shown.strip_prefix(&home) {
                    Some(rest) if home.len() > 1 => format!("~{rest}"),
                    _ => shown,
                };
                format!("It is saved as {shown}, to copy from or attach.\n\n")
            }
            Some(Err(error)) => format!("It could not be saved: {error}\n\n"),
            None => String::new(),
        };
        let text = format!(
            "Paste it into a new issue at github.com/Commanderx-code/Helix-toolbox/issues, with what happened and how to make it happen again. It shows your home folder as ~ and holds no host name or logs, but read it before posting. {kept}{report}"
        );
        // Over anything but a run or a question.
        if matches!(self.popup, None | Some(Popup::Text(_))) {
            self.popup = Some(Popup::Text(
                TextPopup::new("Bug report", text, true).copying(report),
            ));
        }
    }

    /// A report that a run worked on this machine, to read, then send as an
    /// issue from the browser.
    pub(in crate::tui::app) fn report_worked(
        &mut self,
        record: &history::Record,
        only: Option<&str>,
    ) {
        let machine = hardware_report::machine(
            &self.host,
            &self.platform,
            &helix_toolbox_engine::desktop::detect_on(&self.host),
        );
        let report = match hardware_report::prepare(record, only, machine, crate::VERSION, "") {
            Ok(report) => report,
            Err(why) => {
                self.popup = Some(Popup::Text(TextPopup::new("No hardware report", why, true)));
                return;
            }
        };
        let url = report.issue_url();
        let text = report.text();
        if let Some(directory) = &self.reports_dir {
            let kept = std::fs::create_dir_all(directory).and_then(|()| {
                std::fs::write(
                    directory.join("hardware-report.md"),
                    format!("{text}\nThe issue, filled in:\n\n{url}\n"),
                )
            });
            if let Err(error) = kept {
                tracing::warn!(%error, "the hardware report was not saved");
            }
        }
        self.popup = Some(Popup::HardwareReport(
            TextPopup::new(
                "Hardware report",
                format!(
                    "{text}\no opens the issue in your browser, filled in; GitHub asks you to sign in, and the form asks what you checked. Nothing is sent until you submit it there. c copies the report."
                ),
                true,
            )
            .copying(format!("{text}\nThe issue, filled in:\n\n{url}\n")),
            url,
        ));
    }
}