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 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
use std::{
convert,
fmt::{self, Debug},
marker::PhantomData,
pin::Pin,
task::{Context, Poll},
};
use cfg_if::cfg_if;
use exponential_backoff::Backoff;
use futures::{
channel::mpsc::{self, SendError, TrySendError, UnboundedReceiver, UnboundedSender},
ready,
stream::{self, Fuse, FusedStream},
Sink, Stream, StreamExt,
};
use gloo::{
net::websocket::{futures::WebSocket, Message, WebSocketError},
timers::future::TimeoutFuture,
};
use crate::{
debug, error,
event::{map_err, map_poll},
info, trace, Error, Event, SocketInput, SocketOutput, State, DEFAULT_BACKOFF_MAX,
DEFAULT_BACKOFF_MIN, DEFAULT_MAX_RETRIES,
};
/// Enum to track which sub future/stream we polled most recently
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum NextPoll {
Socket,
Channel,
}
impl Default for NextPoll {
fn default() -> Self {
Self::Socket
}
}
impl NextPoll {
fn next(self) -> NextPoll {
use NextPoll::*;
match self {
Socket => Channel,
Channel => Socket,
}
}
}
impl IntoIterator for NextPoll {
type IntoIter = NextPollIter;
type Item = NextPoll;
fn into_iter(self) -> Self::IntoIter {
use NextPoll::*;
let items = match self {
Socket => [Socket, Channel],
Channel => [Channel, Socket],
};
NextPollIter { i: 0, items }
}
}
/// An iterator that always contains all the things to poll in the right sequence
pub(crate) struct NextPollIter {
i: usize,
items: [NextPoll; 2],
}
impl Iterator for NextPollIter {
type Item = NextPoll;
fn next(&mut self) -> Option<Self::Item> {
if self.i >= self.items.len() {
None
} else {
self.i += 1;
Some(self.items[self.i - 1])
}
}
}
/// A handle that implements [`Sink`] for sending messages from the client to the server
///
/// Cheap and safe to clone (internally it's a channel sender)
#[derive(Debug, Clone)]
pub struct SocketSink<I> {
sender: UnboundedSender<I>,
}
impl<I> From<UnboundedSender<I>> for SocketSink<I> {
fn from(sender: UnboundedSender<I>) -> Self {
Self { sender }
}
}
impl<I> Sink<I> for SocketSink<I>
where
I: SocketInput,
Message: TryFrom<I>,
<Message as TryFrom<I>>::Error: Debug,
{
type Error = SendError;
fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
UnboundedSender::poll_ready(&self.sender, cx)
}
fn start_send(self: Pin<&mut Self>, msg: I) -> Result<(), Self::Error> {
self.sender.unbounded_send(msg).map_err(TrySendError::into_send_error)
}
fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
Poll::Ready(Ok(()))
}
fn poll_close(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
self.sender.close_channel();
Poll::Ready(Ok(()))
}
}
/// A wrapper around [`WebSocket`] that reconnects when the socket
/// drops. Uses [`Backoff`] to determine the delay between reconnects
///
/// See the [`crate`] documentation for usage and examples
///
/// An error returned by the [`Stream`] aren't necessarily fatal. Check [`Error`] for more detail.
/// `Poll::Ready(None)` is the main fatal case that requires a new instance of [`Socket`]
pub struct Socket<I, O> {
/// The server URL to connect to on reconnect
pub(crate) url: String,
/// The sending end of the input message channel
/// Retained to implement [`Self::get_sink`] and [`Self::send`]
pub(crate) sink_sender: UnboundedSender<I>,
/// The receiving side of the input message channel
/// Polled by the [`Stream`] implementation
pub(crate) sink_receiver: UnboundedReceiver<I>,
/// The inner socket, None when a reconnect is pending
pub(crate) socket: Option<WebSocket>,
/// A queued message that needs to be sent as soon as the socket is [`State::Open`] This
/// happens when the inner socket exists but hasn't yet fully connected. When in this
/// state the [`WebSocket`] [`Sink`] implementation returns [`Poll::Pending`]. Since we
/// can't reliably know that with any certainty until we've already created the
/// [`Message`] from the input channel and called [`Sink::poll_ready`]. Calling
/// [`Sink::poll_ready`] before creating the [`Message`] isn't really an option because we
/// have no way of undoing anything the Sink does to prepare a slot for us to send to -
/// in this specific case, [`WebSocket`] doesn't actually do anything that needs to be
/// reversed but we can't rely on that always being the case. See
/// <https://github.com/rust-lang/futures-rs/issues/2109> for a discussion about this
/// problem. So what we do is take the [`Message`] but don't try and send it directly,
/// instead calling [`Sink::poll_ready`] and only sending it if this returns [`Poll::Ready`]
pub(crate) queued_message: Option<Message>,
pub(crate) state: State,
pub(crate) backoff: Backoff,
pub(crate) max_retries: u32,
pub(crate) retry: u32,
pub(crate) timeout: Fuse<stream::Once<TimeoutFuture>>,
pub(crate) next_poll: NextPoll,
pub(crate) closed: bool,
pub(crate) _phantom: PhantomData<(I, O)>,
}
impl<I, O> Default for Socket<I, O>
where
I: SocketInput,
O: SocketOutput,
Message: TryFrom<I>,
<Message as TryFrom<I>>::Error: Debug,
<O as TryFrom<Message>>::Error: Debug,
{
fn default() -> Self {
let (sender, receiver) = mpsc::unbounded();
Self {
url: String::new(),
sink_sender: sender,
sink_receiver: receiver,
socket: None,
queued_message: None,
state: State::Connecting,
backoff: Backoff::new(DEFAULT_MAX_RETRIES, DEFAULT_BACKOFF_MIN, DEFAULT_BACKOFF_MAX),
max_retries: DEFAULT_MAX_RETRIES,
retry: 0,
timeout: stream::once(TimeoutFuture::new(0)).fuse(),
next_poll: NextPoll::Socket,
closed: false,
_phantom: PhantomData,
}
}
}
impl<I, O> fmt::Debug for Socket<I, O> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Socket")
.field("url", &self.url)
.field("sink_sender", &self.sink_sender)
.field("sink_receiver", &self.sink_receiver)
.field("socket.is_some", &self.socket.is_some())
.field("state", &self.state)
.field("backoff", &self.backoff)
.field("max_retries", &self.max_retries)
.field("retry", &self.retry)
.field("timeout", &self.timeout)
.field("next_poll", &self.next_poll)
.field("closed", &self.closed)
.finish()
}
}
impl<I, O> Socket<I, O>
where
I: SocketInput,
O: SocketOutput,
Message: TryFrom<I>,
<Message as TryFrom<I>>::Error: Debug,
<O as TryFrom<Message>>::Error: Debug,
{
/// Send the given `message` for sending
///
/// Internally it is added to a channel which is polled by the [`Stream`] implementation
/// when the underlying [`WebSocket`] is open and ready to transmit it
pub async fn send(&mut self, message: I) -> Result<(), TrySendError<I>> {
self.sink_sender.unbounded_send(message)
}
/// Get a sink handle for sending messages from the client to the server
pub fn get_sink(&self) -> SocketSink<I> {
self.sink_sender.clone().into()
}
/// Close the inner socket with the given `code` and `reason`
///
/// The socket will try and reconnect after a timeout if there are sufficient retries remaining
///
/// This is mainly an implementation detail but it's exposed so it can be used in test code
/// to force a reconnect. If used in this way it's worth noting that the Closing/Closed state
/// events won't be emitted
pub fn close_socket(&mut self, code: Option<u16>, reason: Option<&str>) {
// Take and drop the socket
if let Some(socket) = self.socket.take() {
// Attempt to send the close but don't fail if it can't be sent (the socket could be
// dead already)
let _ = socket.close(code, reason);
}
// Update our state
self.state = State::Closed;
if let Some(timeout) = self.backoff.next(self.retry) {
debug!("Backoff retry: {}, timeout: {:.3}s", self.retry, timeout.as_secs_f32());
let millis = timeout.as_millis() as u32;
self.timeout = stream::once(TimeoutFuture::new(millis)).fuse();
} else {
// If we have exceeded our retries the next poll of the stream will close it and error
// no need to have a timeout in that case
self.timeout = Self::default().timeout;
}
}
/// Permanently close the reconnecting socket. No further reconnects will be possible
///
/// The socket implements [`FusedStream`] so polling it after close won't panic
pub fn close(&mut self, code: Option<u16>, reason: Option<&str>) {
self.closed = true;
let _ = self.close_socket(code, reason);
}
fn map_socket_output(
output: Option<Result<Message, WebSocketError>>,
) -> Option<Result<O, Error<I, O>>> {
output.map(|result| {
result
// Map the gloo socket error
.map_err(Error::from)
// Convert the return value into the consumers type
.map(|message| {
debug!("Got output message: {message:?}");
O::try_from(message)
// Map the consumers try_from error into our error so we can
// flatten the result
.map_err(Error::<I, O>::from_output)
})
// Equivalent to .flatten unstable feature
.and_then(convert::identity)
})
}
fn map_channel_input(input: Option<I>) -> Option<Result<Message, Error<I, O>>> {
input.map(|input| {
debug!("Got input message: {input:?}");
Message::try_from(input)
// Map the consumers try_from error into our error
.map_err(Error::<I, O>::from_input)
})
}
}
impl<I, O> FusedStream for Socket<I, O>
where
I: SocketInput,
O: SocketOutput,
Message: TryFrom<I>,
<Message as TryFrom<I>>::Error: Debug,
<O as TryFrom<Message>>::Error: Debug,
{
fn is_terminated(&self) -> bool {
self.closed
}
}
impl<I, O> Stream for Socket<I, O>
where
I: SocketInput,
O: SocketOutput,
Message: TryFrom<I>,
<Message as TryFrom<I>>::Error: Debug,
<O as TryFrom<Message>>::Error: Debug,
{
type Item = Event<I, O>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
if self.closed {
trace!("polled when closed");
return Poll::Ready(None);
}
// Reconnect & queue loop
// Loops in two cases
// 1. When we disconnected and need to reconnect: socket is none && !self.closed
// 2. When we sent a queued message and need to re-poll the channel: queued == true &&
// self.queued_message.is_none()
while !self.closed {
// Check we have a socket first
if let Some(socket) = self.socket.as_ref() {
// Update our copy of the state and notify if it's changed
let current_state = socket.state().into();
if self.state != current_state {
self.state = current_state;
#[cfg(feature = "state-events")]
return Poll::Ready(Some(self.state.into()));
}
} else {
trace!("socket is none");
ready!(Pin::new(&mut self.timeout).poll_next(cx));
if self.retry > self.max_retries {
error!("retries exceeded. Closing");
self.close(None, None);
return Poll::Ready(None);
}
info!("Reconnecting socket...");
self.retry += 1;
match WebSocket::open(&self.url).map_err(Error::<I, O>::from) {
Ok(v) => self.socket = Some(v),
Err(e) => {
error!("WebSocket::open err: {e:?}");
return map_err(e);
},
}
// Update our state
self.state = State::Connecting;
// Announce it if state events are turned on
#[cfg(feature = "state-events")]
return Poll::Ready(Some(self.state.into()));
}
let next_poll_iter = if self.state == State::Open {
// If the socket is established we need to poll each future in turn even if we
// return in between If we return Pending before polling each future, we won't get
// woken when the unpolled future wakes
self.next_poll.into_iter()
} else {
// If the socket is not established, we want to poll the socket first and if it is
// still !Open skip polling the incomming message channel since there is nothing we
// can do with any messages we unqueue from there at this point. The socket has
// extra waker logic to make sure it wakes up after the socket opens even though it
// doesn't produce any values at that point so we'll also get woken up and go back
// to normal polling logic
NextPoll::Socket.into_iter()
};
// Stash if we have a queued item so we can work out if we need to loop again before
// returning Poll::Pending
let queued = self.queued_message.is_some();
for next in next_poll_iter {
// Update so if we return Ready we resume with the right future
self.next_poll = next.next();
use NextPoll::*;
match next {
Socket => {
// Unwrap ok because we assigned it above if one didn't exist
let mut socket = self.socket.as_mut().unwrap();
let poll = Pin::new(&mut socket).poll_next(cx).map(Self::map_socket_output);
match poll {
// Just continue to poll the next thing if this is pending
Poll::Pending => {},
// If it's None (closed) disconnect the socket
Poll::Ready(None) => {
self.close_socket(None, None);
cfg_if! {
if #[cfg(feature = "state-events")] {
// Announce it if state events are turned on
return Poll::Ready(Some(self.state.into()));
} else {
// If not break the next_poll loop to go back to the top of the retry loop
break;
}
}
},
other @ Poll::Ready(Some(_)) => return map_poll(other),
}
},
Channel => {
// Get the value directly from socket here because plausibly this could be
// the 2nd poll of the loop and it could have updated in between
// Unwrap ok because we assigned it above if one didn't exist
if State::Open != self.socket.as_mut().unwrap().state().into() {
// Don't take anything off the incomming message channel if the socket
// isn't open because messages sent to WebSocket when it's not yet open
// are lost Don't poll the channel because the next time we want to be
// woken is when the socket is established, there's no point being woken
// if the consumer keeps adding data to the channel
trace!("socket not open, skipping channel poll");
continue;
}
let message_poll = self
.queued_message
// Take the queued message if there is one
.take()
// Map it into a poll result to match the stream result
.map(|m| {
trace!("attempting to send queued message: {m:?}");
Poll::Ready(Some(Ok(m)))
})
// If there isn't one, poll the stream
.unwrap_or_else(|| {
Pin::new(&mut self.sink_receiver)
.poll_next(cx)
.map(Self::map_channel_input)
});
if let Poll::Ready(message_result) = message_poll {
if let Some(try_from_result) = message_result {
let message = match try_from_result {
Err(e) => return map_err(e),
Ok(payload) => payload,
};
// Unwrap ok because we assigned it above if one didn't exist
let mut socket = self.socket.as_mut().unwrap();
// Check that the Sink is ready to receive the message before trying
// to send it because otherwise we'd have to clone the Message when
// the send fails See [`Socket::queued_message`] for some more
// context
match Pin::new(&mut socket)
.poll_ready(cx)
.map_err(Error::<I, O>::from)
{
Poll::Pending => {
// We don't need to register a waker for the channel here
// because we can't do anything if it wakes us when we
// already have a queued message. We will next be woken by
// the socket when it is ready and it's already queued to
// wake because of the poll_ready
trace!(
"socket Sink::poll_ready == Poll::Pending. Queuing \
message: {message:?}"
);
self.queued_message = Some(message);
},
Poll::Ready(ready) => {
trace!("socket Sink::poll_ready == Poll::Ready");
match ready {
Err(e) => {
error!("socket Sink::poll_ready err: {e:?}");
return map_err(e);
},
Ok(()) => match Pin::new(&mut socket)
.start_send(message)
.map_err(Error::<I, O>::from)
{
Ok(()) => {
trace!("socket Sink::start_send Ok");
if let Err(e) =
ready!(Pin::new(&mut socket).poll_flush(cx))
.map_err(Error::<I, O>::from)
{
error!(
"socket Sink::poll_flush err: {e:?}"
);
return map_err(e);
}
},
Err(e) => {
error!("socket Sink::start_send err: {e:?}");
return map_err(e);
},
},
}
},
}
} else {
info!("Input channel closed. Closing");
self.close(None, None);
return Poll::Ready(None);
}
}
},
}
}
// Break out of loop if we have a socket and don't need to reconnect
if self.socket.is_some()
// and we didn't dispatch a queued message
&& !(queued && self.queued_message.is_none())
{
break;
}
}
Poll::Pending
}
}