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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
use serde::{Deserialize, Serialize};
use serde_enum_str::{Deserialize_enum_str, Serialize_enum_str};
use serde_json::{Map, Value};
const CODE_STATUS_CODE_AND_BODY: i32 = -2_147_483_001;
#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct Error {
pub message: String,
pub r#type: Option<ErrorType>,
pub code: i32,
pub error_subcode: Option<i32>,
pub error_user_title: Option<String>,
pub error_user_msg: Option<String>,
pub fbtrace_id: Option<String>,
#[serde(flatten, skip_serializing_if = "Option::is_none")]
_extra: Option<Map<String, Value>>,
}
impl Error {
pub fn extra(&self) -> Option<&Map<String, Value>> {
self._extra.as_ref()
}
pub fn new_with_status_code_and_body(status_code: u16, body: &str) -> Self {
let mut extra = Map::new();
extra.insert("status_code".to_string(), Value::from(status_code));
extra.insert("body".to_string(), Value::from(body));
Self {
message: format!("status_code:{} body:{}", status_code, body),
r#type: None,
code: CODE_STATUS_CODE_AND_BODY,
error_subcode: None,
error_user_title: None,
error_user_msg: None,
fbtrace_id: None,
_extra: Some(extra),
}
}
pub fn as_status_code_and_body(&self) -> Option<(u16, &str)> {
if self.code != CODE_STATUS_CODE_AND_BODY {
return None;
}
if let Some(extra) = self.extra() {
if let Some(status_code) = extra.get("status_code").and_then(|x| x.as_i64()) {
if let Some(body) = extra.get("body").and_then(|x| x.as_str()) {
return Some((status_code as u16, body));
}
}
}
None
}
}
impl Error {
pub fn is_error_validating_access_token(&self) -> bool {
self.message
.to_lowercase()
.contains("error validating access token")
}
pub fn is_access_token_session_has_been_invalidated(&self) -> bool {
self.message
.to_lowercase()
.contains("session has been invalidated")
}
pub fn is_access_token_session_has_expired(&self) -> bool {
self.message.to_lowercase().contains("session has expired")
}
pub fn is_access_token_session_key_is_malformed(&self) -> bool {
self.message
.to_lowercase()
.contains("session key is malformed")
|| (self.message.to_lowercase().contains("session key ")
&& self.message.to_lowercase().contains(" is malformed"))
}
}
#[derive(Deserialize_enum_str, Serialize_enum_str, Debug, Clone)]
pub enum ErrorType {
OAuthException,
GraphMethodException,
#[serde(other)]
Other(String),
}
impl core::fmt::Display for Error {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "{:?}", self)
}
}
impl std::error::Error for Error {}
#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub enum KnownErrorCase {
ApiTooManyCalls,
ApiUserTooManyCalls,
AccessTokenExpiredOrRevokedOrInvalid,
PermissionNotGrantedOrRemoved,
RetryLater,
}
impl KnownErrorCase {
pub fn is_api_too_many_calls(&self) -> bool {
matches!(self, Self::ApiTooManyCalls)
}
pub fn is_api_user_too_many_calls(&self) -> bool {
matches!(self, Self::ApiUserTooManyCalls)
}
pub fn is_access_token_expired_or_revoked_or_invalid(&self) -> bool {
matches!(self, Self::AccessTokenExpiredOrRevokedOrInvalid)
}
pub fn is_permission_not_granted_or_removed(&self) -> bool {
matches!(self, Self::PermissionNotGrantedOrRemoved)
}
pub fn is_retry_later(&self) -> bool {
matches!(self, Self::RetryLater)
}
}
impl core::fmt::Display for KnownErrorCase {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "{:?}", self)
}
}
impl std::error::Error for KnownErrorCase {}
impl Error {
pub fn to_known_error_case(&self) -> Option<KnownErrorCase> {
if let Some(error_subcode) = self.error_subcode {
#[allow(clippy::single_match)]
match error_subcode {
463 | 467 => return Some(KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid),
_ => {}
}
}
match self.code {
102 => {
if self.error_subcode.is_none() {
return Some(KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid);
}
}
2 => return Some(KnownErrorCase::RetryLater),
4 => return Some(KnownErrorCase::ApiTooManyCalls),
17 => return Some(KnownErrorCase::ApiUserTooManyCalls),
10 => return Some(KnownErrorCase::PermissionNotGrantedOrRemoved),
190 => return Some(KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid),
200..=299 => return Some(KnownErrorCase::PermissionNotGrantedOrRemoved),
_ => {}
}
None
}
}
impl From<&Error> for Option<KnownErrorCase> {
fn from(error: &Error) -> Self {
error.to_known_error_case()
}
}
impl From<Error> for Option<KnownErrorCase> {
fn from(error: Error) -> Self {
error.to_known_error_case()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[derive(Deserialize, Debug)]
struct ResponseBodyErrJson {
error: Error,
}
#[test]
fn test_de_error() {
let content = include_str!(
"../tests/response_body_json_files/err__access_token_session_has_been_invalidated.json"
);
match serde_json::from_str::<ResponseBodyErrJson>(content) {
Ok(err_json) => {
assert!(matches!(
err_json.error.to_known_error_case().unwrap(),
KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid
));
assert!(err_json.error.is_error_validating_access_token());
assert!(err_json
.error
.is_access_token_session_has_been_invalidated());
}
Err(err) => panic!("{}", err),
}
let content = include_str!(
"../tests/response_body_json_files/err__access_token_session_has_expired.json"
);
match serde_json::from_str::<ResponseBodyErrJson>(content) {
Ok(err_json) => {
assert!(matches!(
err_json.error.to_known_error_case().unwrap(),
KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid
));
assert!(err_json.error.is_error_validating_access_token());
assert!(err_json.error.is_access_token_session_has_expired());
}
Err(err) => panic!("{}", err),
}
let content = include_str!(
"../tests/response_body_json_files/err__access_token_session_key_is_malformed.json"
);
match serde_json::from_str::<ResponseBodyErrJson>(content) {
Ok(err_json) => {
assert!(matches!(
err_json.error.to_known_error_case().unwrap(),
KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid
));
assert!(err_json.error.is_error_validating_access_token());
assert!(err_json.error.is_access_token_session_key_is_malformed());
}
Err(err) => panic!("{}", err),
}
let content = include_str!(
"../tests/response_body_json_files/err__access_token_session_key_x_is_malformed.json"
);
match serde_json::from_str::<ResponseBodyErrJson>(content) {
Ok(err_json) => {
assert!(matches!(
err_json.error.to_known_error_case().unwrap(),
KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid
));
assert!(err_json.error.is_error_validating_access_token());
assert!(err_json.error.is_access_token_session_key_is_malformed());
}
Err(err) => panic!("{}", err),
}
let content =
include_str!("../tests/response_body_json_files/err__access_token_unknown_1.json");
match serde_json::from_str::<ResponseBodyErrJson>(content) {
Ok(err_json) => {
assert!(matches!(
err_json.error.to_known_error_case().unwrap(),
KnownErrorCase::AccessTokenExpiredOrRevokedOrInvalid
));
assert!(!err_json.error.is_error_validating_access_token());
}
Err(err) => panic!("{}", err),
}
}
}