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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
#![warn(missing_docs)]
use std::sync::Arc;
use async_recursion::async_recursion;
use async_trait::async_trait;
use super::CustomMessage;
use super::MaybeEncrypted;
use super::Message;
use super::MessagePayload;
use super::OriginVerificationGen;
use super::PayloadSender;
use crate::dht::Did;
use crate::dht::PeerRing;
use crate::err::Error;
use crate::err::Result;
use crate::session::SessionManager;
use crate::swarm::Swarm;
pub mod connection;
pub mod custom;
pub mod stabilization;
pub mod storage;
pub mod subring;
#[cfg_attr(feature = "wasm", async_trait(?Send))]
#[cfg_attr(not(feature = "wasm"), async_trait)]
pub trait MessageCallback {
async fn custom_message(
&self,
handler: &MessageHandler,
ctx: &MessagePayload<Message>,
msg: &MaybeEncrypted<CustomMessage>,
);
async fn builtin_message(&self, handler: &MessageHandler, ctx: &MessagePayload<Message>);
}
#[cfg_attr(feature = "wasm", async_trait(?Send))]
#[cfg_attr(not(feature = "wasm"), async_trait)]
pub trait MessageValidator {
async fn validate(
&self,
handler: &MessageHandler,
ctx: &MessagePayload<Message>,
) -> Option<String>;
}
#[cfg(not(feature = "wasm"))]
pub type CallbackFn = Box<dyn MessageCallback + Send + Sync>;
#[cfg(feature = "wasm")]
pub type CallbackFn = Box<dyn MessageCallback>;
#[cfg(not(feature = "wasm"))]
pub type ValidatorFn = Box<dyn MessageValidator + Send + Sync>;
#[cfg(feature = "wasm")]
pub type ValidatorFn = Box<dyn MessageValidator>;
#[derive(Clone)]
pub struct MessageHandler {
dht: Arc<PeerRing>,
swarm: Arc<Swarm>,
callback: Arc<Option<CallbackFn>>,
validator: Arc<Option<ValidatorFn>>,
}
#[cfg_attr(feature = "wasm", async_trait(?Send))]
#[cfg_attr(not(feature = "wasm"), async_trait)]
pub trait HandleMsg<T> {
async fn handle(&self, ctx: &MessagePayload<Message>, msg: &T) -> Result<()>;
}
impl MessageHandler {
pub fn new(
swarm: Arc<Swarm>,
callback: Option<CallbackFn>,
validator: Option<ValidatorFn>,
) -> Self {
Self {
dht: swarm.dht(),
swarm,
callback: Arc::new(callback),
validator: Arc::new(validator),
}
}
async fn invoke_callback(&self, payload: &MessagePayload<Message>) -> Result<()> {
if let Some(ref cb) = *self.callback {
match payload.data {
Message::CustomMessage(ref msg) => {
if self.dht.did == payload.relay.destination {
tracing::debug!("INVOKE CUSTOM MESSAGE CALLBACK {}", &payload.tx_id);
cb.custom_message(self, payload, msg).await
}
}
_ => cb.builtin_message(self, payload).await,
};
} else if let Message::CustomMessage(ref msg) = payload.data {
if self.dht.did == payload.relay.destination {
tracing::warn!("No callback registered, skip invoke_callback of {:?}", msg);
}
}
Ok(())
}
async fn validate(&self, payload: &MessagePayload<Message>) -> Result<()> {
if let Some(ref v) = *self.validator {
v.validate(self, payload)
.await
.map(|info| Err(Error::InvalidMessage(info)))
.unwrap_or(Ok(()))?;
};
Ok(())
}
pub fn decrypt_msg(&self, msg: &MaybeEncrypted<CustomMessage>) -> Result<CustomMessage> {
let key = self.swarm.session_manager().session_key()?;
let (decrypt_msg, _) = msg.to_owned().decrypt(key)?;
Ok(decrypt_msg)
}
#[cfg_attr(feature = "wasm", async_recursion(?Send))]
#[cfg_attr(not(feature = "wasm"), async_recursion)]
pub async fn handle_payload(&self, payload: &MessagePayload<Message>) -> Result<()> {
#[cfg(test)]
{
println!("{} got msg {}", self.swarm.did(), &payload.data);
}
tracing::debug!("START HANDLE MESSAGE: {} {}", &payload.tx_id, &payload.data);
self.validate(payload).await?;
match &payload.data {
Message::JoinDHT(ref msg) => self.handle(payload, msg).await,
Message::LeaveDHT(ref msg) => self.handle(payload, msg).await,
Message::ConnectNodeSend(ref msg) => self.handle(payload, msg).await,
Message::ConnectNodeReport(ref msg) => self.handle(payload, msg).await,
Message::AlreadyConnected(ref msg) => self.handle(payload, msg).await,
Message::FindSuccessorSend(ref msg) => self.handle(payload, msg).await,
Message::FindSuccessorReport(ref msg) => self.handle(payload, msg).await,
Message::NotifyPredecessorSend(ref msg) => self.handle(payload, msg).await,
Message::NotifyPredecessorReport(ref msg) => self.handle(payload, msg).await,
Message::SearchVNode(ref msg) => self.handle(payload, msg).await,
Message::FoundVNode(ref msg) => self.handle(payload, msg).await,
Message::OperateVNode(ref msg) => self.handle(payload, msg).await,
Message::CustomMessage(ref msg) => self.handle(payload, msg).await,
Message::MultiCall(ref msg) => {
for message in msg.messages.iter().cloned() {
let payload = MessagePayload::new(
message,
self.swarm.session_manager(),
OriginVerificationGen::Stick(payload.origin_verification.clone()),
payload.relay.clone(),
)?;
self.handle_payload(&payload).await.unwrap_or(());
}
Ok(())
}
x => Err(Error::MessageHandlerUnsupportedMessageType(format!(
"{:?}",
x
))),
}?;
tracing::debug!("INVOKE CALLBACK {}", &payload.tx_id);
if let Err(e) = self.invoke_callback(payload).await {
tracing::warn!("invoke callback error: {}", e);
}
tracing::debug!("FINISH HANDLE MESSAGE {}", &payload.tx_id);
Ok(())
}
pub async fn listen_once(&self) -> Option<MessagePayload<Message>> {
if let Some(payload) = self.swarm.poll_message().await {
if !payload.verify() {
tracing::error!("Cannot verify msg or it's expired: {:?}", payload);
}
if let Err(e) = self.handle_payload(&payload).await {
tracing::error!("Error in handle_message: {}", e);
#[cfg(test)]
{
println!("Error in handle_message: {}", e);
}
}
Some(payload)
} else {
None
}
}
}
#[cfg_attr(feature = "wasm", async_trait(?Send))]
#[cfg_attr(not(feature = "wasm"), async_trait)]
impl PayloadSender<Message> for MessageHandler {
fn session_manager(&self) -> &SessionManager {
self.swarm.session_manager()
}
async fn do_send_payload(&self, did: Did, payload: MessagePayload<Message>) -> Result<()> {
self.swarm.do_send_payload(did, payload).await
}
}
#[cfg(not(feature = "wasm"))]
mod listener {
use std::sync::Arc;
use async_trait::async_trait;
use futures::pin_mut;
use futures::stream::StreamExt;
use super::MessageHandler;
use crate::types::message::MessageListener;
#[async_trait]
impl MessageListener for MessageHandler {
async fn listen(self: Arc<Self>) {
let payloads = self.swarm.iter_messages().await;
pin_mut!(payloads);
while let Some(payload) = payloads.next().await {
if !payload.verify() {
tracing::error!("Cannot verify msg or it's expired: {:?}", payload);
continue;
}
if let Err(e) = self.handle_payload(&payload).await {
tracing::error!("Error in handle_message: {}", e);
continue;
}
}
}
}
}
#[cfg(feature = "wasm")]
mod listener {
use std::sync::Arc;
use async_trait::async_trait;
use wasm_bindgen_futures::spawn_local;
use super::MessageHandler;
use crate::poll;
use crate::types::message::MessageListener;
#[async_trait(?Send)]
impl MessageListener for MessageHandler {
async fn listen(self: Arc<Self>) {
let handler = Arc::clone(&self);
let func = move || {
let handler = handler.clone();
spawn_local(Box::pin(async move {
handler.listen_once().await;
}));
};
poll!(func, 1000);
}
}
}
#[cfg(not(feature = "wasm"))]
#[cfg(test)]
pub mod tests {
use futures::lock::Mutex;
use tokio::time::sleep;
use tokio::time::Duration;
use super::*;
use crate::dht::Did;
use crate::ecc::SecretKey;
use crate::message::MessageHandler;
use crate::tests::default::prepare_node;
use crate::tests::manually_establish_connection;
use crate::types::message::MessageListener;
#[derive(Clone)]
struct MessageCallbackInstance {
#[allow(clippy::type_complexity)]
handler_messages: Arc<Mutex<Vec<(Did, Vec<u8>)>>>,
}
#[tokio::test]
async fn test_custom_message_handling() -> Result<()> {
let key1 = SecretKey::random();
let key2 = SecretKey::random();
let (did1, _dht1, swarm1, _handler1, _path1) = prepare_node(key1).await;
let (did2, _dht2, swarm2, _handler2, _path2) = prepare_node(key2).await;
manually_establish_connection(&swarm1, &swarm2).await?;
#[async_trait]
impl MessageCallback for MessageCallbackInstance {
async fn custom_message(
&self,
handler: &MessageHandler,
ctx: &MessagePayload<Message>,
msg: &MaybeEncrypted<CustomMessage>,
) {
let decrypted_msg = handler.decrypt_msg(msg).unwrap();
self.handler_messages
.lock()
.await
.push((ctx.addr, decrypted_msg.0));
println!("{:?}, {:?}, {:?}", ctx, ctx.addr, msg);
}
async fn builtin_message(
&self,
_handler: &MessageHandler,
ctx: &MessagePayload<Message>,
) {
println!("{:?}, {:?}", ctx, ctx.addr);
}
}
let msg_callback1 = MessageCallbackInstance {
handler_messages: Arc::new(Mutex::new(vec![])),
};
let msg_callback2 = MessageCallbackInstance {
handler_messages: Arc::new(Mutex::new(vec![])),
};
let cb1: CallbackFn = Box::new(msg_callback1.clone());
let cb2: CallbackFn = Box::new(msg_callback2.clone());
let handler1 = swarm1.create_message_handler(Some(cb1), None);
let handler2 = swarm2.create_message_handler(Some(cb2), None);
handler1
.send_direct_message(
Message::custom("Hello world 1 to 2 - 1".as_bytes(), None)?,
did2,
)
.await
.unwrap();
handler1
.send_direct_message(
Message::custom("Hello world 1 to 2 - 2".as_bytes(), None)?,
did2,
)
.await
.unwrap();
handler2
.send_direct_message(
Message::custom("Hello world 2 to 1 - 1".as_bytes(), None)?,
did1,
)
.await
.unwrap();
handler1
.send_direct_message(
Message::custom("Hello world 1 to 2 - 3".as_bytes(), None)?,
did2,
)
.await
.unwrap();
handler2
.send_direct_message(
Message::custom("Hello world 2 to 1 - 2".as_bytes(), None)?,
did1,
)
.await
.unwrap();
tokio::spawn(async { Arc::new(handler1).listen().await });
tokio::spawn(async { Arc::new(handler2).listen().await });
sleep(Duration::from_secs(5)).await;
assert_eq!(msg_callback1.handler_messages.lock().await.as_slice(), &[
(did2, "Hello world 2 to 1 - 1".as_bytes().to_vec()),
(did2, "Hello world 2 to 1 - 2".as_bytes().to_vec())
]);
assert_eq!(msg_callback2.handler_messages.lock().await.as_slice(), &[
(did1, "Hello world 1 to 2 - 1".as_bytes().to_vec()),
(did1, "Hello world 1 to 2 - 2".as_bytes().to_vec()),
(did1, "Hello world 1 to 2 - 3".as_bytes().to_vec())
]);
Ok(())
}
pub async fn assert_no_more_msg(
node1: &MessageHandler,
node2: &MessageHandler,
node3: &MessageHandler,
) {
tokio::select! {
_ = node1.listen_once() => unreachable!("node1 should not receive any message"),
_ = node2.listen_once() => unreachable!("node2 should not receive any message"),
_ = node3.listen_once() => unreachable!("node3 should not receive any message"),
_ = sleep(Duration::from_secs(3)) => {}
}
}
pub async fn wait_for_msgs(
node1: &MessageHandler,
node2: &MessageHandler,
node3: &MessageHandler,
) {
loop {
tokio::select! {
_ = node1.listen_once() => {}
_ = node2.listen_once() => {}
_ = node3.listen_once() => {}
_ = sleep(Duration::from_secs(3)) => break
}
}
}
}