unigraph_error 0.1.1-alpha.0

Structured error formatting for graph operations
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
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

// Copyright (c) Meta Platforms, Inc. and affiliates.
use anyhow::Context;
use anyhow::Result;
use k9::*;

use crate::*;

fn bails() -> Result<()> {
    bail!("Unigraph broke");
}

fn adds_context() -> Result<()> {
    bails().context("Added context")?;
    Ok(())
}

fn more_layers_of_context() -> Result<()> {
    adds_context()
        .context("More context")
        .with_context(|| format!("Some extensive multiline context:\n\n{:?}\n", vec![1, 2, 3]))
        .context("Another layer of context")
        .context("Lots of trailing newlines that should be trimmed\n\n\n\n")
        .with_context(|| {
            format!(
                "One of those weird errors
with weird indentation and stuff
and some random multiline debug info:\n{:#?}",
                vec![Some(1), None, Some(9999)]
            )
        })
        .context("And even more stuff")
}

fn anyhow_err() -> Result<()> {
    anyhow::bail!("Root cause that used anyhow::bail!()");
}

fn more_anyhow_context() -> Result<()> {
    anyhow_err()
        .context("more context")
        .context("some stuff")
        .context("some high level thing failed")?;
    Ok(())
}

#[test]
fn basic_test() -> Result<()> {
    let err = more_layers_of_context().unwrap_err();

    snapshot!(
        format_for_user(&err),
        "
Unigraph broke
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<UnigraphError did not provide any debug info>

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Error chain and added context:

[0]: Added context
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[1]: More context
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[2]: Some extensive multiline context:

[1, 2, 3]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[3]: Another layer of context
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[4]: Lots of trailing newlines that should be trimmed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[5]: One of those weird errors
with weird indentation and stuff
and some random multiline debug info:
[
    Some(
        1,
    ),
    None,
    Some(
        9999,
    ),
]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[6]: And even more stuff
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"
    );

    let err = more_anyhow_context().unwrap_err();
    snapshot!(
        format_for_user(&err),
        "
Root cause that used anyhow::bail!()
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Error chain and added context:

[0]: more context
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[1]: some stuff
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[2]: some high level thing failed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"
    );
    Ok(())
}

#[test]
fn colored_test() -> Result<()> {
    // Some environments disable colors and it makes the test break.
    // This setting will force colors to always be present.
    // I'm a bit worried about introducing other flaky tests, since this option
    // is global and will likely leak to other tests, but it's a pretty rare
    // thing to rely on.
    colored::control::set_override(true);
    let err = more_anyhow_context().unwrap_err();

    snapshot!(
        format!("{}", format_with_colors(&err)),
        r"
\u{1b}[1;31mRoot cause that used anyhow::bail!()\u{1b}[0m
\u{1b}[2m~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\u{1b}[0m
\u{1b}[2mError chain and added context:
\u{1b}[0m
\u{1b}[2m[0]:\u{1b}[0m \u{1b}[31mmore context\u{1b}[0m
\u{1b}[2m~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\u{1b}[0m
\u{1b}[2m[1]:\u{1b}[0m \u{1b}[31msome stuff\u{1b}[0m
\u{1b}[2m~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\u{1b}[0m
\u{1b}[2m[2]:\u{1b}[0m \u{1b}[31msome high level thing failed\u{1b}[0m
\u{1b}[2m~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\u{1b}[0m

"
    );
    Ok(())
}
#[test]
fn json_test() -> Result<()> {
    let err = more_anyhow_context().unwrap_err();

    snapshot!(
        format!("{}", to_json(&err)?),
        r#"
{
  "display": "Root cause that used anyhow::bail!()\
",
  "debug": "\
Error chain and added context:\
\
[0]: more context\
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
[1]: some stuff\
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
[2]: some high level thing failed\
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
"
}
"#
    );
    Ok(())
}