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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
use crate::{
error::{ConnectionError, RecvError, SendError, StreamError},
wire_msg::WireMsg,
UsrMsgBytes,
};
use quinn::VarInt;
use std::{fmt, net::SocketAddr};
use tokio::sync::mpsc::{Receiver, Sender};
use tracing::{trace, warn};
const INCOMING_MESSAGE_BUFFER_LEN: usize = 1;
const QP2P_CLOSED_CONNECTION: &str = "The connection was closed intentionally by qp2p.";
type IncomingMsg = Result<(WireMsg, Option<SendStream>), RecvError>;
pub struct Connection {
inner: quinn::Connection,
}
impl Drop for Connection {
fn drop(&mut self) {
warn!(
"Connection handle dropped, thus closing it, conn_id={}",
self.id()
);
self.inner.close(VarInt::from_u32(0), b"lost interest");
}
}
impl Connection {
pub(crate) fn new(connection: quinn::Connection) -> (Connection, ConnectionIncoming) {
let (tx, rx) = tokio::sync::mpsc::channel(INCOMING_MESSAGE_BUFFER_LEN);
listen_on_uni_streams(connection.clone(), tx.clone());
listen_on_bi_streams(connection.clone(), tx);
(Self { inner: connection }, ConnectionIncoming(rx))
}
pub fn close_reason(&self) -> Option<ConnectionError> {
self.inner.close_reason().map(|e| e.into())
}
pub fn id(&self) -> String {
build_conn_id(&self.inner)
}
pub fn remote_address(&self) -> SocketAddr {
self.inner.remote_address()
}
pub async fn send(&self, user_msg_bytes: UsrMsgBytes) -> Result<(), SendError> {
self.send_with(user_msg_bytes, 0).await
}
pub async fn open_uni(&self) -> Result<SendStream, ConnectionError> {
let send_stream = self.inner.open_uni().await?;
Ok(SendStream::new(send_stream, self.id()))
}
pub async fn open_bi(&self) -> Result<(SendStream, RecvStream), ConnectionError> {
let (send_stream, recv_stream) = self.inner.open_bi().await?;
let conn_id = self.id();
Ok((
SendStream::new(send_stream, conn_id.clone()),
RecvStream::new(recv_stream, conn_id),
))
}
pub fn close(&self, reason: Option<String>) {
let reason = reason.unwrap_or_else(|| QP2P_CLOSED_CONNECTION.to_string());
warn!("Closing connection witn conn_id={}", self.id());
self.inner.close(0u8.into(), &reason.into_bytes());
}
pub async fn send_with(
&self,
user_msg_bytes: UsrMsgBytes,
priority: i32,
) -> Result<(), SendError> {
let mut send_stream = self.open_uni().await.map_err(SendError::ConnectionLost)?;
send_stream.set_priority(priority);
send_stream.send_user_msg(user_msg_bytes).await?;
send_stream.finish().await.or_else(|err| match err {
SendError::StreamLost(StreamError::Stopped(_)) => Ok(()),
_ => Err(err),
})?;
Ok(())
}
}
fn build_conn_id(conn: &quinn::Connection) -> String {
format!("{}{}", conn.remote_address(), conn.stable_id())
}
fn listen_on_uni_streams(connection: quinn::Connection, tx: Sender<IncomingMsg>) {
let conn_id = build_conn_id(&connection);
let _handle = tokio::spawn(async move {
trace!("Connection {conn_id}: listening for incoming uni-streams");
loop {
let uni = connection.accept_uni().await.map_err(ConnectionError::from);
let recv = match uni {
Ok(recv) => recv,
Err(err) => {
trace!(
"Connection {conn_id}: failure when awaiting incoming uni-streams: {err:?}"
);
let _ = tx.send(Err(RecvError::ConnectionLost(err))).await;
break;
}
};
trace!("Connection {conn_id}: incoming uni-stream accepted");
let tx = tx.clone();
let _handle = tokio::spawn(async move {
let reserved_sender = match tx.reserve().await {
Ok(p) => p,
Err(error) => {
tracing::error!(
"Could not reserve sender for new conn msg read: {error:?}"
);
return;
}
};
let msg = WireMsg::read_from_stream(recv).await;
reserved_sender.send(msg.map(|r| (r, None)));
});
}
trace!("Connection {conn_id}: stopped listening for uni-streams");
});
}
#[allow(clippy::type_complexity)]
fn listen_on_bi_streams(connection: quinn::Connection, tx: Sender<IncomingMsg>) {
let conn_id = build_conn_id(&connection);
let _handle = tokio::spawn(async move {
trace!("Connection {conn_id}: listening for incoming bi-streams");
loop {
let bi = connection.accept_bi().await.map_err(ConnectionError::from);
let (send, recv) = match bi {
Ok(recv) => recv,
Err(err) => {
trace!(
"Connection {conn_id}: failure when awaiting incoming bi-streams: {err:?}"
);
let _ = tx.send(Err(RecvError::ConnectionLost(err))).await;
break;
}
};
trace!("Connection {conn_id}: incoming bi-stream accepted");
let tx = tx.clone();
let conn_id = conn_id.clone();
let _handle = tokio::spawn(async move {
let reserved_sender = match tx.reserve().await {
Ok(p) => p,
Err(error) => {
tracing::error!(
"Could not reserve sender for new conn msg read: {error:?}"
);
return;
}
};
let msg = WireMsg::read_from_stream(recv).await;
let msg = msg.map(|msg| (msg, Some(SendStream::new(send, conn_id.clone()))));
reserved_sender.send(msg);
trace!("Incoming new msg on conn_id={conn_id} sent to user in upper layer");
});
}
trace!("Connection {conn_id}: stopped listening for bi-streams");
});
}
impl fmt::Debug for Connection {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Connection")
.field("id", &self.id())
.field("remote_address", &self.remote_address())
.finish_non_exhaustive()
}
}
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct StreamId {
stream_id: quinn::StreamId,
conn_id: String,
}
impl fmt::Display for StreamId {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let initiator = if self.stream_id.initiator().is_client() {
"initiator"
} else {
"acceptor"
};
let dir = self.stream_id.dir();
write!(
f,
"{initiator} {dir:?}directional stream {}@{}",
self.stream_id.index(),
self.conn_id
)
}
}
#[derive(Debug)]
pub struct ConnectionIncoming(Receiver<IncomingMsg>);
impl ConnectionIncoming {
pub async fn next(&mut self) -> Result<Option<WireMsg>, RecvError> {
if let Some((bytes, _opt)) = self.next_with_stream().await? {
Ok(Some(bytes))
} else {
Ok(None)
}
}
pub async fn next_with_stream(
&mut self,
) -> Result<Option<(WireMsg, Option<SendStream>)>, RecvError> {
self.0.recv().await.transpose()
}
}
pub struct SendStream {
conn_id: String,
inner: quinn::SendStream,
}
impl SendStream {
fn new(inner: quinn::SendStream, conn_id: String) -> Self {
Self { conn_id, inner }
}
pub fn id(&self) -> StreamId {
StreamId {
stream_id: self.inner.id(),
conn_id: self.conn_id.clone(),
}
}
pub fn set_priority(&self, priority: i32) {
let _ = self.inner.set_priority(priority);
}
pub async fn send_user_msg(&mut self, user_msg_bytes: UsrMsgBytes) -> Result<(), SendError> {
WireMsg(user_msg_bytes)
.write_to_stream(&mut self.inner)
.await
}
pub async fn finish(&mut self) -> Result<(), SendError> {
self.inner.finish().await?;
Ok(())
}
}
impl fmt::Debug for SendStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("SendStream").finish_non_exhaustive()
}
}
pub struct RecvStream {
conn_id: String,
inner: quinn::RecvStream,
}
impl RecvStream {
fn new(inner: quinn::RecvStream, conn_id: String) -> Self {
Self { conn_id, inner }
}
pub fn id(&self) -> StreamId {
StreamId {
stream_id: self.inner.id(),
conn_id: self.conn_id.clone(),
}
}
pub async fn read(self) -> Result<UsrMsgBytes, RecvError> {
self.read_wire_msg().await.map(|v| v.0)
}
pub(crate) async fn read_wire_msg(self) -> Result<WireMsg, RecvError> {
WireMsg::read_from_stream(self.inner).await
}
}
impl fmt::Debug for RecvStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("RecvStream").finish_non_exhaustive()
}
}
#[cfg(test)]
mod tests {
use super::Connection;
use crate::{
endpoint_builder::SERVER_NAME,
error::{ConnectionError, SendError},
tests::local_addr,
wire_msg::WireMsg,
};
use bytes::Bytes;
use color_eyre::eyre::{bail, Result};
use futures::future::OptionFuture;
use std::time::Duration;
#[test_log::test(tokio::test(flavor = "multi_thread"))]
async fn basic_usage() -> Result<()> {
let (cfg_srv, cfg_cli) = crate::Endpoint::builder().config()?;
let mut peer1 = quinn::Endpoint::server(cfg_srv.clone(), local_addr())?;
peer1.set_default_client_config(cfg_cli);
let peer2 = quinn::Endpoint::server(cfg_srv, local_addr())?;
{
let (p1_conn, mut p1_incoming) =
Connection::new(peer1.connect(peer2.local_addr()?, SERVER_NAME)?.await?);
let (p2_conn, mut p2_incoming) = if let Some(connection) =
timeout(OptionFuture::from(peer2.accept().await))
.await?
.and_then(|c| c.ok())
{
Connection::new(connection)
} else {
bail!("did not receive incoming connection when one was expected");
};
p1_conn
.open_uni()
.await?
.send_user_msg((Bytes::new(), Bytes::new(), Bytes::from_static(b"hello")))
.await?;
if let Ok(Some(WireMsg((_, _, msg)))) = timeout(p2_incoming.next()).await? {
assert_eq!(&msg[..], b"hello");
} else {
bail!("did not receive message when one was expected");
}
p2_conn
.open_uni()
.await?
.send_user_msg((Bytes::new(), Bytes::new(), Bytes::from_static(b"world")))
.await?;
if let Ok(Some(WireMsg((_, _, msg)))) = timeout(p1_incoming.next()).await? {
assert_eq!(&msg[..], b"world");
} else {
bail!("did not receive message when one was expected");
}
}
timeout(peer1.wait_idle()).await?;
timeout(peer2.wait_idle()).await?;
Ok(())
}
#[tokio::test]
async fn connection_loss() -> Result<()> {
let (cfg_srv, cfg_cli) = crate::Endpoint::builder()
.idle_timeout(1000)
.config()?;
let mut peer1 = quinn::Endpoint::server(cfg_srv.clone(), local_addr())?;
peer1.set_default_client_config(cfg_cli);
let peer2 = quinn::Endpoint::server(cfg_srv, local_addr())?;
let (p1_conn, _) = Connection::new(peer1.connect(peer2.local_addr()?, SERVER_NAME)?.await?);
let (_p2_conn, mut p2_incoming) = if let Some(connection) =
timeout(OptionFuture::from(peer2.accept().await))
.await?
.and_then(|c| c.ok())
{
Connection::new(connection)
} else {
bail!("did not receive incoming connection when one was expected");
};
tokio::time::sleep(Duration::from_secs(2)).await;
match p1_conn
.send((Bytes::new(), Bytes::new(), b"hello"[..].into()))
.await
{
Err(SendError::ConnectionLost(ConnectionError::TimedOut)) => {}
res => bail!("unexpected send result: {:?}", res),
}
match p2_incoming.next().await {
Err(_) => {}
res => bail!("unexpected recv result: {:?}", res),
}
Ok(())
}
async fn timeout<F: std::future::Future>(
f: F,
) -> Result<F::Output, tokio::time::error::Elapsed> {
tokio::time::timeout(Duration::from_millis(500), f).await
}
}