summaryrefslogtreecommitdiff
path: root/ecs/src/error.rs
blob: f70524db011134805fd2cda03fc15996fca8a99b (plain)
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
use std::fmt::{Debug, Display, Write as _};

use backtrace::Backtrace;

#[macro_export]
macro_rules! error {
    ($lit: literal) => {
        $crate::error::Error::from($lit)
    };

    ($lit: literal, $($tt: tt)*) => {
        $crate::error::Error::from(std::format!($lit, $($tt)*))
    };

    ($err: expr) => {
        $crate::error::Error::from($err)
    };
}

pub struct Error
{
    inner: Box<dyn std::error::Error + Send + Sync>,
    backtrace: Backtrace,
}

impl Debug for Error
{
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result
    {
        let error = &*self.inner;

        write!(formatter, "{error}")?;

        if let Some(cause) = error.source() {
            write!(formatter, "\n\nCaused by:")?;
            let multiple = cause.source().is_some();
            for (n, error) in anyhow::Chain::new(cause).enumerate() {
                writeln!(formatter)?;

                let mut indented = Indented {
                    inner: formatter,
                    number: if multiple { Some(n) } else { None },
                    started: false,
                };
                write!(indented, "{error}")?;
            }
        }

        write!(
            formatter,
            "\n\nStack backtrace:\n{:?}",
            std::fmt::from_fn(|backtrace_formatter| fmt_backtrace(
                &self.backtrace,
                backtrace_formatter
            ))
        )?;

        Ok(())
    }
}

impl Display for Error
{
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result
    {
        let error = &*self.inner;

        write!(formatter, "{error}")?;

        if formatter.alternate() {
            let chain = anyhow::Chain::new(error);
            for cause in chain.skip(1) {
                write!(formatter, ": {}", cause)?;
            }
        }

        Ok(())
    }
}

impl<Err: Send + Sync + 'static> From<Err> for Error
where
    Box<dyn std::error::Error + Send + Sync>: From<Err>,
{
    fn from(err: Err) -> Self
    {
        Self {
            inner: err.into(),
            backtrace: Backtrace::new(),
        }
    }
}

pub type ErrorHandler = fn(Error, Metadata);

/// Error metadata.
#[derive(Debug)]
pub struct Metadata
{
    pub source_name: &'static str,
    pub source_kind: SourceKind,
}

/// Error source kind.
#[derive(Debug)]
#[non_exhaustive]
pub enum SourceKind
{
    System,
    Observer,
}

impl Display for SourceKind
{
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result
    {
        match self {
            SourceKind::System => formatter.write_str("system"),
            SourceKind::Observer => formatter.write_str("observer"),
        }
    }
}

pub fn err_handler_panic(err: Error, err_metadata: Metadata)
{
    panic!(
        "Error occurred in {} '{}': {err:?}",
        err_metadata.source_kind, err_metadata.source_name
    );
}

pub fn err_handler_log_error(err: Error, err_metadata: Metadata)
{
    tracing::error!(
        "Error occurred in {} '{}': {err:#}",
        err_metadata.source_kind,
        err_metadata.source_name
    );
}

fn fmt_backtrace(
    backtrace: &Backtrace,
    fmt: &mut std::fmt::Formatter<'_>,
) -> std::fmt::Result
{
    let style = if fmt.alternate() {
        backtrace::PrintFmt::Full
    } else {
        backtrace::PrintFmt::Short
    };

    // When printing paths we try to strip the cwd if it exists, otherwise
    // we just print the path as-is. Note that we also only do this for the
    // short format, because if it's full we presumably want to print
    // everything.
    let cwd = std::env::current_dir();
    let mut print_path =
        move |fmt: &mut std::fmt::Formatter<'_>,
              path: backtrace::BytesOrWideString<'_>| {
            let path = path.into_path_buf();
            if style != backtrace::PrintFmt::Full {
                if let Ok(cwd) = &cwd {
                    if let Ok(suffix) = path.strip_prefix(cwd) {
                        return std::fmt::Display::fmt(&suffix.display(), fmt);
                    }
                }
            }
            std::fmt::Display::fmt(&path.display(), fmt)
        };

    let mut f = backtrace::BacktraceFmt::new(fmt, style, &mut print_path);

    f.add_context()?;

    for frame in backtrace.frames() {
        if frame.symbols().iter().all(|symbol| {
            symbol.name().is_some_and(|symbol_name| {
                let symbol_name = symbol_name.to_string();

                symbol_name
                    .contains("<ecs::error::Error as core::convert::From<Err>>::from")
            })
        }) {
            continue;
        }

        f.frame().backtrace_frame(frame)?;
    }
    f.finish()?;
    Ok(())
}

struct Indented<'a, D>
{
    inner: &'a mut D,
    number: Option<usize>,
    started: bool,
}

impl<T> std::fmt::Write for Indented<'_, T>
where
    T: std::fmt::Write,
{
    fn write_str(&mut self, s: &str) -> std::fmt::Result
    {
        for (i, line) in s.split('\n').enumerate() {
            if !self.started {
                self.started = true;
                match self.number {
                    Some(number) => write!(self.inner, "{: >5}: ", number)?,
                    None => self.inner.write_str("    ")?,
                }
            } else if i > 0 {
                self.inner.write_char('\n')?;
                if self.number.is_some() {
                    self.inner.write_str("       ")?;
                } else {
                    self.inner.write_str("    ")?;
                }
            }

            self.inner.write_str(line)?;
        }

        Ok(())
    }
}