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

//! Tests for diagnostic code format

mod common;

use apollo_errors::{CodeCase, Error as ErrorTrait, FormatConfig};
use common::{ErrorWithFields, SimpleError};
use insta::assert_json_snapshot;

#[test]
fn test_simple_code_format() {
    // Error codes use namespace::area::code format
    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_nested_code_format() {
    // Error codes use namespace::area::code format
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: String::new(),
    };
    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "config_file": "",
      "error": "config::invalid_port",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}

#[test]
fn test_code_in_graphql_extensions() {
    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_code_case_screaming_snake_in_graphql() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: String::new(),
    };
    let config = FormatConfig {
        code_case: CodeCase::ScreamingSnakeCase,
        ..FormatConfig::default()
    };
    let graphql = error.to_graphql(config).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "CONFIG_INVALID_PORT",
        "config_file": "",
        "port": 8080
      },
      "message": "Invalid port"
    }
    "#);
}

#[test]
fn test_code_case_camel_in_graphql() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: String::new(),
    };
    let config = FormatConfig {
        code_case: CodeCase::CamelCase,
        ..FormatConfig::default()
    };
    let graphql = error.to_graphql(config).unwrap();
    assert_json_snapshot!(graphql, @r#"
    {
      "extensions": {
        "code": "configInvalidPort",
        "config_file": "",
        "port": 8080
      },
      "message": "Invalid port"
    }
    "#);
}

#[test]
fn test_code_case_pascal_in_json() {
    let error = SimpleError::Simple;
    let config = FormatConfig {
        code_case: CodeCase::PascalCase,
        ..FormatConfig::default()
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "error": "ErrorsSimple",
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_code_case_kebab_in_json() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: String::new(),
    };
    let config = FormatConfig {
        code_case: CodeCase::KebabCase,
        ..FormatConfig::default()
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "config_file": "",
      "error": "config-invalid-port",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}