apollo-errors 0.7.0

Structured error handling with automatic format conversion
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

//! Tests for ErrorExt trait (dynamic dispatch)

mod common;

use apollo_errors::{CodeCase, ErrorExt, FieldCase, FormatConfig};
use common::{ErrorWithFields, SimpleError};
use insta::assert_snapshot;
use insta::{assert_debug_snapshot, assert_json_snapshot};

#[test]
fn test_error_ext_json() {
    let error = SimpleError::Simple;
    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "error": "errors::simple",
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_error_ext_graphql() {
    let error = SimpleError::Simple;
    let graphql = error.to_graphql(FormatConfig::default()).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "errors::simple"
      },
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_error_ext_text() {
    let error = SimpleError::Simple;
    let text = error.to_text(FormatConfig::default());
    assert_snapshot!(text, @"[errors::simple] Something went wrong");
}

#[test]
fn test_error_ext_html() {
    let error = SimpleError::Simple;
    let html = error.to_html(FormatConfig::default());
    assert_snapshot!(html, @r#"
    <div class="error">
    <h3 class="error-code">errors::simple</h3>
    <p class="error-message">Something went wrong</p>

    </div>
    "#);
}

#[test]
fn test_error_ext_debug() {
    let error = SimpleError::Simple;
    assert_debug_snapshot!(error, @"Simple");
}

#[test]
fn test_fallback_for_unregistered_error() {
    // std::io::Error is not registered with apollo-errors
    let error = std::io::Error::new(std::io::ErrorKind::NotFound, "file not found");

    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "error": "UNKNOWN_ERROR",
      "message": "file not found"
    }
    "#);
}

#[test]
fn test_fallback_graphql_for_unregistered_error() {
    let error = std::io::Error::new(std::io::ErrorKind::PermissionDenied, "access denied");

    let graphql = error.to_graphql(FormatConfig::default()).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "UNKNOWN_ERROR"
      },
      "message": "access denied"
    }
    "#);
}

#[test]
fn test_fallback_text_for_unregistered_error() {
    let error = std::io::Error::new(std::io::ErrorKind::TimedOut, "connection timed out");

    let text = error.to_text(FormatConfig::default());
    assert_snapshot!(text, @"[UNKNOWN_ERROR] connection timed out");
}

#[test]
fn test_boxerror() {
    let error = Box::new(SimpleError::Simple);
    let graphql = error.to_graphql(FormatConfig::default()).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "errors::simple"
      },
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_arc_error() {
    use std::sync::Arc;
    let error = Arc::new(SimpleError::Simple);
    let graphql = error.to_graphql(FormatConfig::default()).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "errors::simple"
      },
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_box_arc_error() {
    use std::sync::Arc;
    let error = Box::new(Arc::new(SimpleError::Simple));
    let graphql = error.to_graphql(FormatConfig::default()).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "errors::simple"
      },
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_format_config_threads_through_box() {
    let error = Box::new(ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    });
    let config = FormatConfig {
        field_case: FieldCase::CamelCase,
        code_case: CodeCase::KebabCase,
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "configFile": "/etc/config.toml",
      "error": "config-invalid-port",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}