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
use std::collections::VecDeque;
use std::future::Future;
use std::marker::PhantomData;
use std::mem;
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll};
use futures_channel::{mpsc, oneshot};
use futures_sink::Sink;
use futures_util::{future::TryFutureExt, stream::StreamExt};
use super::{
connect::{connect_with_auth, RespConnection},
ConnectionBuilder,
};
use crate::{
error,
reconnect::{reconnect, Reconnect},
resp,
};
enum SendStatus {
Ok,
End,
Full(resp::RespValue),
}
#[derive(Debug)]
enum ReceiveStatus {
ReadyFinished,
ReadyMore,
NotReady,
}
type CommandResult = Result<resp::RespValue, error::Error>;
type Responder = oneshot::Sender<CommandResult>;
type SendPayload = (resp::RespValue, Responder);
struct PairedConnectionInner {
connection: RespConnection,
out_rx: mpsc::UnboundedReceiver<SendPayload>,
waiting: VecDeque<Responder>,
send_status: SendStatus,
}
impl PairedConnectionInner {
fn new(
con: RespConnection,
out_rx: mpsc::UnboundedReceiver<(resp::RespValue, Responder)>,
) -> Self {
PairedConnectionInner {
connection: con,
out_rx,
waiting: VecDeque::new(),
send_status: SendStatus::Ok,
}
}
fn impl_start_send(
&mut self,
cx: &mut Context,
msg: resp::RespValue,
) -> Result<bool, error::Error> {
match Pin::new(&mut self.connection).poll_ready(cx) {
Poll::Ready(Ok(())) => (),
Poll::Ready(Err(e)) => return Err(e.into()),
Poll::Pending => {
self.send_status = SendStatus::Full(msg);
return Ok(false);
}
}
self.send_status = SendStatus::Ok;
Pin::new(&mut self.connection).start_send(msg)?;
Ok(true)
}
fn poll_start_send(&mut self, cx: &mut Context) -> Result<bool, error::Error> {
let mut status = SendStatus::Ok;
mem::swap(&mut status, &mut self.send_status);
let message = match status {
SendStatus::End => {
self.send_status = SendStatus::End;
return Ok(false);
}
SendStatus::Full(msg) => msg,
SendStatus::Ok => match self.out_rx.poll_next_unpin(cx) {
Poll::Ready(Some((msg, tx))) => {
self.waiting.push_back(tx);
msg
}
Poll::Ready(None) => {
self.send_status = SendStatus::End;
return Ok(false);
}
Poll::Pending => return Ok(false),
},
};
self.impl_start_send(cx, message)
}
fn poll_complete(&mut self, cx: &mut Context) -> Result<(), error::Error> {
let _ = Pin::new(&mut self.connection).poll_flush(cx)?;
Ok(())
}
fn receive(&mut self, cx: &mut Context) -> Result<ReceiveStatus, error::Error> {
if let SendStatus::End = self.send_status {
if self.waiting.is_empty() {
return Ok(ReceiveStatus::ReadyFinished);
}
}
match self.connection.poll_next_unpin(cx) {
Poll::Ready(None) => Err(error::unexpected("Connection to Redis closed unexpectedly")),
Poll::Ready(Some(Ok(msg))) => {
let tx = match self.waiting.pop_front() {
Some(tx) => tx,
None => panic!("Received unexpected message: {:?}", msg),
};
let _ = tx.send(Ok(msg));
Ok(ReceiveStatus::ReadyMore)
}
Poll::Ready(Some(Err(e))) => Err(e),
Poll::Pending => Ok(ReceiveStatus::NotReady),
}
}
fn handle_error(&mut self, e: &error::Error) {
for tx in self.waiting.drain(..) {
let _ = tx.send(Err(error::internal(format!(
"Failed due to underlying failure: {}",
e
))));
}
log::error!("Internal error in PairedConnectionInner: {}", e);
}
}
impl Future for PairedConnectionInner {
type Output = ();
#[allow(clippy::unit_arg)]
fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
let mut_self = self.get_mut();
let mut sending = true;
while sending {
sending = match mut_self.poll_start_send(cx) {
Ok(sending) => sending,
Err(ref e) => return Poll::Ready(mut_self.handle_error(e)),
};
}
if let Err(ref e) = mut_self.poll_complete(cx) {
return Poll::Ready(mut_self.handle_error(e));
};
loop {
match mut_self.receive(cx) {
Ok(ReceiveStatus::NotReady) => return Poll::Pending,
Ok(ReceiveStatus::ReadyMore) => (),
Ok(ReceiveStatus::ReadyFinished) => return Poll::Ready(()),
Err(ref e) => return Poll::Ready(mut_self.handle_error(e)),
}
}
}
}
#[derive(Debug, Clone)]
pub struct PairedConnection {
out_tx_c: Arc<Reconnect<SendPayload, mpsc::UnboundedSender<SendPayload>>>,
}
async fn inner_conn_fn(
host: String,
port: u16,
username: Option<Arc<str>>,
password: Option<Arc<str>>,
tls: bool,
) -> Result<mpsc::UnboundedSender<SendPayload>, error::Error> {
let username = username.as_ref().map(|u| u.as_ref());
let password = password.as_ref().map(|p| p.as_ref());
let connection = connect_with_auth(&host, port, username, password, tls).await?;
let (out_tx, out_rx) = mpsc::unbounded();
let paired_connection_inner = PairedConnectionInner::new(connection, out_rx);
tokio::spawn(paired_connection_inner);
Ok(out_tx)
}
impl ConnectionBuilder {
pub fn paired_connect(&self) -> impl Future<Output = Result<PairedConnection, error::Error>> {
let host = self.host.clone();
let port = self.port;
let username = self.username.clone();
let password = self.password.clone();
let work_fn = |con: &mpsc::UnboundedSender<SendPayload>, act| {
con.unbounded_send(act).map_err(|e| e.into())
};
#[cfg(feature = "tls")]
let tls = self.tls;
#[cfg(not(feature = "tls"))]
let tls = false;
let conn_fn = move || {
let con_f = inner_conn_fn(host.clone(), port, username.clone(), password.clone(), tls);
Box::pin(con_f) as Pin<Box<dyn Future<Output = Result<_, error::Error>> + Send + Sync>>
};
let reconnecting_con = reconnect(work_fn, conn_fn);
reconnecting_con.map_ok(|con| PairedConnection {
out_tx_c: Arc::new(con),
})
}
}
pub async fn paired_connect(
host: impl Into<String>,
port: u16,
) -> Result<PairedConnection, error::Error> {
ConnectionBuilder::new(host, port)?.paired_connect().await
}
impl PairedConnection {
pub fn send<T>(&self, msg: resp::RespValue) -> SendFuture<T>
where
T: resp::FromResp + Unpin,
{
match &msg {
resp::RespValue::Array(_) => (),
_ => {
return SendFuture::new(error::internal("Command must be a RespValue::Array"));
}
}
let (tx, rx) = oneshot::channel();
match self.out_tx_c.do_work((msg, tx)) {
Ok(()) => SendFuture::new(rx),
Err(e) => SendFuture::new(e),
}
}
pub fn send_and_forget(&self, msg: resp::RespValue) {
let send_f = self.send::<resp::RespValue>(msg);
let forget_f = async {
if let Err(e) = send_f.await {
log::error!("Error in send_and_forget: {}", e);
}
};
tokio::spawn(forget_f);
}
}
#[derive(Debug)]
enum SendFutureType {
Wait(oneshot::Receiver<Result<resp::RespValue, error::Error>>),
Error(Option<error::Error>),
}
impl From<oneshot::Receiver<Result<resp::RespValue, error::Error>>> for SendFutureType {
fn from(from: oneshot::Receiver<Result<resp::RespValue, error::Error>>) -> Self {
Self::Wait(from)
}
}
impl From<error::Error> for SendFutureType {
fn from(e: error::Error) -> Self {
Self::Error(Some(e))
}
}
#[derive(Debug)]
pub struct SendFuture<T> {
send_type: SendFutureType,
_phantom: PhantomData<T>,
}
impl<T> SendFuture<T> {
fn new(send_type: impl Into<SendFutureType>) -> Self {
Self {
send_type: send_type.into(),
_phantom: Default::default(),
}
}
}
impl<T> Future for SendFuture<T>
where
T: resp::FromResp + Unpin,
{
type Output = Result<T, error::Error>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
match self.get_mut().send_type {
SendFutureType::Error(ref mut e) => match e.take() {
Some(e) => Poll::Ready(Err(e)),
None => panic!("Future polled several times after completion"),
},
SendFutureType::Wait(ref mut rx) => match Pin::new(rx).poll(cx) {
Poll::Ready(Ok(Ok(v))) => Poll::Ready(T::from_resp(v)),
Poll::Ready(Ok(Err(e))) => Poll::Ready(Err(e)),
Poll::Ready(Err(_)) => Poll::Ready(Err(error::internal(
"Connection closed before response received",
))),
Poll::Pending => Poll::Pending,
},
}
}
}
#[cfg(test)]
mod test {
use super::ConnectionBuilder;
#[tokio::test]
async fn can_paired_connect() {
let connection = super::paired_connect("127.0.0.1", 6379)
.await
.expect("Cannot establish connection");
let res_f = connection.send(resp_array!["PING", "TEST"]);
connection.send_and_forget(resp_array!["SET", "X", "123"]);
let wait_f = connection.send(resp_array!["GET", "X"]);
let result_1: String = res_f.await.expect("Cannot read result of first thing");
let result_2: String = wait_f.await.expect("Cannot read result of second thing");
assert_eq!(result_1, "TEST");
assert_eq!(result_2, "123");
}
#[tokio::test]
async fn complex_paired_connect() {
let connection = super::paired_connect("127.0.0.1", 6379)
.await
.expect("Cannot establish connection");
let value: String = connection
.send(resp_array!["INCR", "CTR"])
.await
.expect("Cannot increment counter");
let result: String = connection
.send(resp_array!["SET", "LASTCTR", value])
.await
.expect("Cannot set value");
assert_eq!(result, "OK");
}
#[tokio::test]
async fn sending_a_lot_of_data_test() {
let connection = super::paired_connect("127.0.0.1", 6379)
.await
.expect("Cannot connect to Redis");
let mut futures = Vec::with_capacity(1000);
for i in 0..1000 {
let key = format!("X_{}", i);
connection.send_and_forget(resp_array!["SET", &key, i.to_string()]);
futures.push(connection.send(resp_array!["GET", key]));
}
let last_future = futures.remove(999);
let result: String = last_future.await.expect("Cannot wait for result");
assert_eq!(result, "999");
}
#[tokio::test]
async fn test_builder() {
let mut builder =
ConnectionBuilder::new("127.0.0.1", 6379).expect("Cannot construct builder...");
builder.password("password");
builder.username(String::from("username"));
let connection_result = builder.paired_connect().await;
assert!(connection_result.is_err());
}
}