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
use crate::net::SecretKeyError;
use derive_more::{Display, Error, From};
use futures::{SinkExt, StreamExt};
use serde::{de::DeserializeOwned, Serialize};
use std::marker::Unpin;
use tokio::io::{self, AsyncRead, AsyncWrite};
use tokio_util::codec::{Framed, FramedRead, FramedWrite};
mod codec;
pub use codec::*;
mod inmemory;
pub use inmemory::*;
mod tcp;
pub use tcp::*;
#[cfg(unix)]
mod unix;
#[cfg(unix)]
pub use unix::*;
#[derive(Debug, Display, Error, From)]
pub enum TransportError {
CryptoError(SecretKeyError),
IoError(io::Error),
SerializeError(serde_cbor::Error),
}
pub trait DataStream: AsyncRead + AsyncWrite + Unpin {
type Read: AsyncRead + Send + Unpin + 'static;
type Write: AsyncWrite + Send + Unpin + 'static;
fn to_connection_tag(&self) -> String;
fn into_split(self) -> (Self::Read, Self::Write);
}
#[derive(Debug)]
pub struct Transport<T, U>(Framed<T, U>)
where
T: DataStream,
U: Codec;
impl<T, U> Transport<T, U>
where
T: DataStream,
U: Codec,
{
pub fn new(stream: T, codec: U) -> Self {
Self(Framed::new(stream, codec))
}
pub async fn send<D: Serialize>(&mut self, data: D) -> Result<(), TransportError> {
let data = serde_cbor::to_vec(&data)?;
self.0.send(&data).await.map_err(TransportError::from)
}
pub async fn receive<R: DeserializeOwned>(&mut self) -> Result<Option<R>, TransportError> {
if let Some(data) = self.0.next().await {
let data = data?;
let data = serde_cbor::from_slice(&data)?;
Ok(Some(data))
} else {
Ok(None)
}
}
pub fn to_connection_tag(&self) -> String {
self.0.get_ref().to_connection_tag()
}
pub fn into_split(
self,
) -> (
TransportReadHalf<T::Read, U>,
TransportWriteHalf<T::Write, U>,
) {
let parts = self.0.into_parts();
let (read_half, write_half) = parts.io.into_split();
let mut f_read = FramedRead::new(read_half, parts.codec.clone());
*f_read.read_buffer_mut() = parts.read_buf;
let mut f_write = FramedWrite::new(write_half, parts.codec);
*f_write.write_buffer_mut() = parts.write_buf;
let t_read = TransportReadHalf(f_read);
let t_write = TransportWriteHalf(f_write);
(t_read, t_write)
}
}
pub struct TransportWriteHalf<T, U>(FramedWrite<T, U>)
where
T: AsyncWrite + Unpin,
U: Codec;
impl<T, U> TransportWriteHalf<T, U>
where
T: AsyncWrite + Unpin,
U: Codec,
{
pub async fn send<D: Serialize>(&mut self, data: D) -> Result<(), TransportError> {
let data = serde_cbor::to_vec(&data)?;
self.0.send(&data).await.map_err(TransportError::from)
}
}
pub struct TransportReadHalf<T, U>(FramedRead<T, U>)
where
T: AsyncRead + Unpin,
U: Codec;
impl<T, U> TransportReadHalf<T, U>
where
T: AsyncRead + Unpin,
U: Codec,
{
pub async fn receive<R: DeserializeOwned>(&mut self) -> Result<Option<R>, TransportError> {
if let Some(data) = self.0.next().await {
let data = data?;
let data = serde_cbor::from_slice(&data)?;
Ok(Some(data))
} else {
Ok(None)
}
}
}
#[cfg(test)]
impl Transport<crate::net::InmemoryStream, crate::net::PlainCodec> {
pub fn make_pair() -> (
Transport<crate::net::InmemoryStream, crate::net::PlainCodec>,
Transport<crate::net::InmemoryStream, crate::net::PlainCodec>,
) {
Self::pair(crate::constants::test::BUFFER_SIZE)
}
}
#[cfg(test)]
mod tests {
use super::*;
use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct TestData {
name: String,
value: usize,
}
#[tokio::test]
async fn send_should_convert_data_into_byte_stream_and_send_through_stream() {
let (_tx, mut rx, stream) = InmemoryStream::make(1);
let mut transport = Transport::new(stream, PlainCodec::new());
let data = TestData {
name: String::from("test"),
value: 123,
};
let bytes = serde_cbor::to_vec(&data).unwrap();
let len = (bytes.len() as u64).to_be_bytes();
let mut frame = Vec::new();
frame.extend(len);
frame.extend(bytes);
transport.send(data).await.unwrap();
let outgoing = rx.recv().await.unwrap();
assert_eq!(outgoing, frame);
}
#[tokio::test]
async fn receive_should_return_none_if_stream_is_closed() {
let (_, _, stream) = InmemoryStream::make(1);
let mut transport = Transport::new(stream, PlainCodec::new());
let result = transport.receive::<TestData>().await;
match result {
Ok(None) => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[tokio::test]
async fn receive_should_fail_if_unable_to_convert_to_type() {
let (tx, _rx, stream) = InmemoryStream::make(1);
let mut transport = Transport::new(stream, PlainCodec::new());
#[derive(Serialize, Deserialize)]
struct OtherTestData(usize);
let data = OtherTestData(123);
let bytes = serde_cbor::to_vec(&data).unwrap();
let len = (bytes.len() as u64).to_be_bytes();
let mut frame = Vec::new();
frame.extend(len);
frame.extend(bytes);
tx.send(frame).await.unwrap();
let result = transport.receive::<TestData>().await;
match result {
Err(TransportError::SerializeError(_)) => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[tokio::test]
async fn receive_should_return_some_instance_of_type_when_coming_into_stream() {
let (tx, _rx, stream) = InmemoryStream::make(1);
let mut transport = Transport::new(stream, PlainCodec::new());
let data = TestData {
name: String::from("test"),
value: 123,
};
let bytes = serde_cbor::to_vec(&data).unwrap();
let len = (bytes.len() as u64).to_be_bytes();
let mut frame = Vec::new();
frame.extend(len);
frame.extend(bytes);
tx.send(frame).await.unwrap();
let received_data = transport.receive::<TestData>().await.unwrap().unwrap();
assert_eq!(received_data, data);
}
mod read_half {
use super::*;
#[tokio::test]
async fn receive_should_return_none_if_stream_is_closed() {
let (_, _, stream) = InmemoryStream::make(1);
let transport = Transport::new(stream, PlainCodec::new());
let (mut rh, _) = transport.into_split();
let result = rh.receive::<TestData>().await;
match result {
Ok(None) => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[tokio::test]
async fn receive_should_fail_if_unable_to_convert_to_type() {
let (tx, _rx, stream) = InmemoryStream::make(1);
let transport = Transport::new(stream, PlainCodec::new());
let (mut rh, _) = transport.into_split();
#[derive(Serialize, Deserialize)]
struct OtherTestData(usize);
let data = OtherTestData(123);
let bytes = serde_cbor::to_vec(&data).unwrap();
let len = (bytes.len() as u64).to_be_bytes();
let mut frame = Vec::new();
frame.extend(len);
frame.extend(bytes);
tx.send(frame).await.unwrap();
let result = rh.receive::<TestData>().await;
match result {
Err(TransportError::SerializeError(_)) => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[tokio::test]
async fn receive_should_return_some_instance_of_type_when_coming_into_stream() {
let (tx, _rx, stream) = InmemoryStream::make(1);
let transport = Transport::new(stream, PlainCodec::new());
let (mut rh, _) = transport.into_split();
let data = TestData {
name: String::from("test"),
value: 123,
};
let bytes = serde_cbor::to_vec(&data).unwrap();
let len = (bytes.len() as u64).to_be_bytes();
let mut frame = Vec::new();
frame.extend(len);
frame.extend(bytes);
tx.send(frame).await.unwrap();
let received_data = rh.receive::<TestData>().await.unwrap().unwrap();
assert_eq!(received_data, data);
}
}
mod write_half {
use super::*;
#[tokio::test]
async fn send_should_convert_data_into_byte_stream_and_send_through_stream() {
let (_tx, mut rx, stream) = InmemoryStream::make(1);
let transport = Transport::new(stream, PlainCodec::new());
let (_, mut wh) = transport.into_split();
let data = TestData {
name: String::from("test"),
value: 123,
};
let bytes = serde_cbor::to_vec(&data).unwrap();
let len = (bytes.len() as u64).to_be_bytes();
let mut frame = Vec::new();
frame.extend(len);
frame.extend(bytes);
wh.send(data).await.unwrap();
let outgoing = rx.recv().await.unwrap();
assert_eq!(outgoing, frame);
}
}
}