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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
use super::{
Call, Cancel, Invocation, MessageDirection, Publish, Register, Subscribe, Unregister,
Unsubscribe, WampMessage,
};
use crate::{messages::helpers, roles::Roles};
use serde::{de::Visitor, Deserialize, Serialize};
use serde_json::{json, Value};
use serde_repr::{Deserialize_repr, Serialize_repr};
use std::marker::PhantomData;
#[derive(Debug, Clone, Serialize_repr, Deserialize_repr, PartialEq, Eq)]
#[repr(u64)]
pub enum WampErrorEvent {
Unsubscribe = Unsubscribe::ID,
Subscribe = Subscribe::ID,
Publish = Publish::ID,
Register = Register::ID,
Unregister = Unregister::ID,
Invocation = Invocation::ID,
Cancel = Cancel::ID,
Call = Call::ID,
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// # Error
/// Represents an Error message in WAMP protocol.
/// ## Wamp Docs
/// > [Protocol Errors](https://wamp-proto.org/wamp_latest_ietf.html#name-protocol-errors)
/// >
/// > [Subscribe Error](https://wamp-proto.org/wamp_latest_ietf.html#name-subscribe-error)
/// >
/// > [Unsubscribe Error](https://wamp-proto.org/wamp_latest_ietf.html#name-unsubscribe-error)
/// >
/// > [Publish Error](https://wamp-proto.org/wamp_latest_ietf.html#name-publish-error)
/// >
/// > [Register Error](https://wamp-proto.org/wamp_latest_ietf.html#name-register-error)
/// >
/// > [Unregister Error](https://wamp-proto.org/wamp_latest_ietf.html#name-unregister-error)
/// >
/// > [Invocation Error](https://wamp-proto.org/wamp_latest_ietf.html#name-invocation-error)
/// >
/// > [Call Error](https://wamp-proto.org/wamp_latest_ietf.html#name-call-error)
/// >
/// ## Examples
/// ```
/// use wamp_core::messages::{WampError, WampErrorEvent};
/// use serde_json::{json, from_value};
///
/// let error = WampError{
/// event: WampErrorEvent::Call,
/// request_id: 1,
/// details: json!({}),
/// error: "com.myapp.error.object_write_protected".to_string(),
/// args: json!(["Object is write protected."]),
/// kwargs: json!({"severity": 3})
/// };
/// ```
/// ### Serializer
/// Implementation of Serializer for WAMP Error
/// ```
/// use wamp_core::messages::{WampError, WampErrorEvent};
/// use serde_json::{json, to_string};
///
/// let error = WampError{
/// event: WampErrorEvent::Call,
/// request_id: 7814135,
/// details: json!({}),
/// error: "com.myapp.error.object_write_protected".to_string(),
/// args: json!(["Object is write protected."]),
/// kwargs: json!({"severity": 3})
/// };
///
/// let data = r#"[8,48,7814135,{},"com.myapp.error.object_write_protected",["Object is write protected."],{"severity":3}]"#;
///
/// let data2 = to_string(&error).unwrap();
///
/// assert_eq!(data, data2)
/// ```
/// ### Deserializer
/// Implementation of serde Deserialize for WAMP Error
/// ```
/// use wamp_core::messages::{WampError, WampErrorEvent};
/// use serde_json::{json, from_str};
///
/// let error = WampError {
/// event: WampErrorEvent::Call,
/// request_id: 7814135,
/// details: json!({}),
/// error: "com.myapp.error.object_write_protected".to_string(),
/// args: json!(["Object is write protected."]),
/// kwargs: json!({"severity": 3})
/// };
///
/// let data = r#"[8,48,7814135,{},"com.myapp.error.object_write_protected",["Object is write protected."],{"severity":3}]"#;
///
/// let error2 = from_str::<WampError>(data).unwrap();
///
/// assert_eq!(error, error2);
/// ```
pub struct WampError {
pub event: WampErrorEvent,
pub request_id: u64,
pub details: Value,
pub error: String,
pub args: Value,
pub kwargs: Value,
}
#[macro_export]
/// # Error Macro
/// This macro is used for constructing wamp errors with default empty or custom details, args, and kwargs.
/// ## Examples
/// ```
/// use wamp_core::messages::{WampErrorEvent, WampError};
/// use wamp_core::error;
/// use serde_json::{json, Value};
///
/// // Create an error with default values
/// let error = error!(WampErrorEvent::Call, 1, "wamp.error.unknown_realm");
///
/// // Which is the same as creating this
/// let error2 = WampError {
/// event: WampErrorEvent::Call,
/// request_id: 1,
/// details: json!({}),
/// error: "wamp.error.unknown_realm".to_string(),
/// args: Value::Null,
/// kwargs: Value::Null
/// };
///
/// assert_eq!(error, error2);
///
/// // Some other ways to use the macro
///
/// // Create error with custom details
/// let _ = error!(WampErrorEvent::Call, 1, "wamp.error.unknown", json!({ "key": "value" }));
///
/// // create error with empty default details and custom args or kwargs
/// let _ = error!(WampErrorEvent::Call, 1, "wamp.error.unknown", args: json!([ 1, 2, 3 ]));
/// let _ = error!(WampErrorEvent::Call, 1, "wamp.error.unknown", kwargs: json!({ "key": "value" }));
///
/// // create error with empty default details and custom args and kwargs
/// let _ = error!(WampErrorEvent::Call, 1, "wamp.error.unknown", args: json!([ 1, 2, 3 ]), kwargs: json!({ "key": "value" }));
///
/// // note that when you use all values, you do not need keyword arguments for args and kwargs
/// let _ = error!(WampErrorEvent::Call, 1, "wamp.error.unknown", json!({}), json!([1, 2, 3]), json!({ "key": "value" }));
/// ```
macro_rules! error {
($event:expr, $request_id:expr, $error:expr) => {
error! {$event, $request_id, $error, serde_json::json!({})}
};
($event:expr, $request_id:expr, $error:expr, args: $args:expr, kwargs: $kwargs:expr) => {
error! {$event, $request_id, $error, serde_json::json!({}), $args, $kwargs}
};
($event:expr, $request_id:expr, $error:expr, args: $args:expr) => {
error! {$event, $request_id, $error, serde_json::json!({}), $args, serde_json::Value::Null}
};
($event:expr, $request_id:expr, $error:expr, kwargs: $kwargs:expr) => {
error! {$event, $request_id, $error, serde_json::json!({}), serde_json::Value::Null, $kwargs}
};
($event:expr, $request_id:expr, $error:expr, $details:expr) => {
error! {$event, $request_id, $error, $details, serde_json::Value::Null, serde_json::Value::Null}
};
($event:expr, $request_id:expr, $error:expr, $details:expr, args: $args:expr) => {
error! {$event, $request_id, $error, $details, $args, serde_json::Value::Null}
};
($event:expr, $request_id:expr, $error:expr, $details:expr, kwargs: $kwargs:expr) => {
error! {$event, $request_id, $error, $details, serde_json::Value::Null, $kwargs}
};
($event:expr, $request_id:expr, $error:expr, $details:expr, $args:expr, $kwargs:expr) => {
WampError {
event: $event,
request_id: $request_id,
details: $details,
error: $error.to_string(),
args: $args,
kwargs: $kwargs,
}
};
}
impl WampMessage for WampError {
const ID: u64 = 8;
fn direction(role: Roles) -> &'static MessageDirection {
match role {
Roles::Callee => &MessageDirection {
receives: &true,
sends: &true,
},
Roles::Caller => &MessageDirection {
receives: &true,
sends: &false,
},
Roles::Publisher => &MessageDirection {
receives: &true,
sends: &false,
},
Roles::Subscriber => &MessageDirection {
receives: &true,
sends: &false,
},
Roles::Dealer => &MessageDirection {
receives: &true,
sends: &true,
},
Roles::Broker => &MessageDirection {
receives: &false,
sends: &true,
},
}
}
}
impl Serialize for WampError {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let details =
helpers::ser_value_is_object::<S, _>(&self.details, "Details must be Object like.")?;
let args =
helpers::ser_value_is_args::<S, _>(&self.args, "Args must be Array like or Null.")?;
let kwargs = helpers::ser_value_is_kwargs::<S, _>(
&self.kwargs,
"Kwargs must be Object like or Null.",
)?;
if args.is_null() {
if kwargs.is_null() {
(
Self::ID,
&self.event,
&self.request_id,
details,
&self.error,
)
.serialize(serializer)
} else {
(
Self::ID,
&self.event,
&self.request_id,
details,
&self.error,
json!([]),
kwargs,
)
.serialize(serializer)
}
} else {
if kwargs.is_null() {
(
Self::ID,
&self.event,
&self.request_id,
details,
&self.error,
args,
)
.serialize(serializer)
} else {
(
Self::ID,
&self.event,
&self.request_id,
details,
&self.error,
args,
kwargs,
)
.serialize(serializer)
}
}
}
}
impl<'de> Deserialize<'de> for WampError {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
struct WampErrorVisitor(
PhantomData<u64>,
PhantomData<WampErrorEvent>,
PhantomData<u64>,
PhantomData<Value>,
PhantomData<String>,
PhantomData<Value>,
PhantomData<Value>,
);
impl<'vi> Visitor<'vi> for WampErrorVisitor {
type Value = WampError;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("A sequence of WampError components.")
}
fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
where
A: serde::de::SeqAccess<'vi>,
{
let message_id: u64 = helpers::deser_seq_element(
&mut seq,
"Message id must be present and type u64.",
)?;
helpers::validate_id::<WampError, A, _>(&message_id, "WampError")?;
let event: WampErrorEvent = helpers::deser_seq_element(
&mut seq,
"Message type of error must be present and type u64",
)?;
let request_id: u64 = helpers::deser_seq_element(
&mut seq,
"Request ID must be present and type u64",
)?;
let details: Value = helpers::deser_seq_element(
&mut seq,
"Details must be present and object like",
)?;
helpers::deser_value_is_object::<A, _>(&details, "Details must be object like.")?;
let error: String = helpers::deser_seq_element(
&mut seq,
"Error URI must be present and type String",
)?;
helpers::deser_value_is_object::<A, _>(&details, "Details must be object like.")?;
let args: Value = helpers::deser_args_kwargs_element(
&mut seq,
"Args must be array like or null.",
)?;
let kwargs: Value = helpers::deser_args_kwargs_element(
&mut seq,
"Kwargs must be object like or null.",
)?;
Ok(WampError {
event,
request_id,
details,
error,
args,
kwargs,
})
}
}
deserializer.deserialize_struct(
"WampError",
&["event", "request_id", "details", "error", "args", "kwargs"],
WampErrorVisitor(
PhantomData,
PhantomData,
PhantomData,
PhantomData,
PhantomData,
PhantomData,
PhantomData,
),
)
}
}