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
163
164
165
166
167
168
169
170
171
172
173

//! Tests for JSON-RPC format output (to_jsonrpc)

mod common;

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

#[test]
fn test_custom_code_with_extension_field() {
    let error = JsonRpcError::MethodNotFound {
        method: "eth_call".to_string(),
    };
    let jsonrpc = error.to_jsonrpc(FormatConfig::default()).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32601,
      "data": {
        "diagnostic_code": "jsonrpc::method_not_found",
        "method": "eth_call"
      },
      "message": "Method not found: eth_call"
    }
    "#);
}

#[test]
fn test_default_code() {
    // When no jsonrpc_code is specified, defaults to -32000
    let error = JsonRpcError::DefaultCode;
    let jsonrpc = error.to_jsonrpc(FormatConfig::default()).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32000,
      "data": {
        "diagnostic_code": "jsonrpc::default_code"
      },
      "message": "No code specified, uses default"
    }
    "#);
}

#[test]
fn test_struct_error_with_extensions() {
    let error = RpcValidationError {
        field: "amount".to_string(),
        reason: "must be positive".to_string(),
    };
    let jsonrpc = error.to_jsonrpc(FormatConfig::default()).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32602,
      "data": {
        "diagnostic_code": "rpc::validation_error",
        "field": "amount",
        "reason": "must be positive"
      },
      "message": "RPC validation failed for field amount"
    }
    "#);
}

#[test]
fn test_error_without_jsonrpc_attribute() {
    // SimpleError doesn't have jsonrpc_code, should use default -32000
    let error = SimpleError::Simple;
    let jsonrpc = error.to_jsonrpc(FormatConfig::default()).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32000,
      "data": {
        "diagnostic_code": "errors::simple"
      },
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_kebab_field_case_screaming_snake_code_case_jsonrpc() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let config = FormatConfig {
        field_case: FieldCase::KebabCase,
        code_case: CodeCase::ScreamingSnakeCase,
    };
    let jsonrpc = error.to_jsonrpc(config).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32000,
      "data": {
        "config-file": "/etc/config.toml",
        "diagnostic_code": "CONFIG_INVALID_PORT",
        "port": 8080
      },
      "message": "Invalid port"
    }
    "#);
}

#[test]
fn test_camel_field_case_default_code_case_jsonrpc() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let config = FormatConfig {
        field_case: FieldCase::CamelCase,
        ..FormatConfig::default()
    };
    let jsonrpc = error.to_jsonrpc(config).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32000,
      "data": {
        "configFile": "/etc/config.toml",
        "diagnostic_code": "config::invalid_port",
        "port": 8080
      },
      "message": "Invalid port"
    }
    "#);
}

#[test]
fn test_default_field_case_screaming_snake_code_case_jsonrpc() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let config = FormatConfig {
        code_case: CodeCase::ScreamingSnakeCase,
        ..FormatConfig::default()
    };
    let jsonrpc = error.to_jsonrpc(config).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32000,
      "data": {
        "config_file": "/etc/config.toml",
        "diagnostic_code": "CONFIG_INVALID_PORT",
        "port": 8080
      },
      "message": "Invalid port"
    }
    "#);
}

#[test]
fn test_renamed_field_pascal_case_screaming_snake_code_jsonrpc() {
    let error = ErrorWithRenamedField::WithRename {
        my_field: "value".to_string(),
    };
    let config = FormatConfig {
        field_case: FieldCase::PascalCase,
        code_case: CodeCase::ScreamingSnakeCase,
    };
    let jsonrpc = error.to_jsonrpc(config).unwrap();
    assert_json_snapshot!(jsonrpc, @r#"
    {
      "code": -32000,
      "data": {
        "MyRenamedField": "value",
        "diagnostic_code": "TEST_RENAMED_FIELD"
      },
      "message": "Field was renamed"
    }
    "#);
}