Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix] #2005: Fix Client::listen_for_events() not closing WebSocket stream #2095

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions cli/src/torii/routing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -233,18 +233,19 @@ mod subscription {
/// There should be a [`warp::filters::ws::Message::close()`] message to end subscription
#[iroha_futures::telemetry_future]
pub async fn handle_subscription(events: EventsSender, stream: WebSocket) -> eyre::Result<()> {
match subscribe_forever(events, stream).await {
Ok(()) | Err(Error::CloseMessage) => Ok(()),
let mut consumer = Consumer::new(stream).await?;

match subscribe_forever(events, &mut consumer).await {
Ok(()) | Err(Error::CloseMessage) => consumer.close_stream().await.map_err(Into::into),
Err(err) => Err(err.into()),
}
}

/// Make endless `stream` subscription for `events`
/// Make endless `consumer` subscription for `events`
///
/// Ideally should return `Result<!>` cause it either runs forever either returns `Err` variant
async fn subscribe_forever(events: EventsSender, stream: WebSocket) -> Result<()> {
async fn subscribe_forever(events: EventsSender, consumer: &mut Consumer) -> Result<()> {
let mut events = events.subscribe();
let mut consumer = Consumer::new(stream).await?;

loop {
tokio::select! {
Expand Down
17 changes: 17 additions & 0 deletions client/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,23 @@ impl Iterator for EventIterator {
}
}

impl Drop for EventIterator {
fn drop(&mut self) {
let mut close = || -> eyre::Result<()> {
self.stream.close(None)?;
let mes = self.stream.read_message()?;
if !mes.is_close() {
return Err(eyre!(
"Server hasn't sent `Close` message for websocket handshake"
));
}
Ok(())
};

let _ = close().map_err(|e| warn!(%e));
}
}

impl Debug for Client {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct("Client")
Expand Down
8 changes: 8 additions & 0 deletions core/src/event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,12 @@ impl Consumer {
}
Err(Error::CantReceiveMessage)
}

/// Close stream. See [`WebSocket::close()`]
///
/// # Errors
/// Throws up [`WebSocket::close()`] errors
pub async fn close_stream(self) -> Result<()> {
self.stream.close().await.map_err(Into::into)
}
}