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.

Sign up for GitHub

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

Jump to bottom

Fix shutdown race condition in re_sdk_comms client #1861

Merged
merged 2 commits into from
Apr 15, 2023
Merged

Fix shutdown race condition in re_sdk_comms client #1861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e077349
Wait for encoder to shut down before shutting down the other threads
emilk Apr 15, 2023
3d16793
Remove TODOs and clean up the code
emilk Apr 15, 2023
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
29 changes: 11 additions & 18 deletions crates/re_sdk_comms/src/buffered_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,12 @@ impl Drop for Client {
re_log::debug!("Shutting down the client connection…");
self.send(LogMsg::Goodbye(RowId::random()));
self.flush();
// First shut down the encoder:
self.encode_quit_tx.send(QuitMsg).ok();
self.encode_join.take().map(|j| j.join().ok());
// Then the other threads:
self.send_quit_tx.send(InterruptMsg::Quit).ok();
self.drop_quit_tx.send(QuitMsg).ok();
self.encode_join.take().map(|j| j.join().ok());
self.send_join.take().map(|j| j.join().ok());
self.drop_join.take().map(|j| j.join().ok());
re_log::debug!("TCP client has shut down.");
Expand Down Expand Up @@ -196,23 +198,14 @@ fn msg_encode(
MsgMsg::Flush => PacketMsg::Flush,
};

// TODO(jleibs): It's not clear why we're hitting this case, but an error here is still better than
// a panic. See: https://github.com/rerun-io/rerun/issues/1855
match packet_tx.send(packet_msg) {
Ok(_) => {},
Err(_) => {
re_log::error!("Failed to send message to tcp_sender thread. Likely a shutdown race-condition.");
},
};

// TODO(jleibs): It's not clear why we're hitting this case, but an error here is still better than
// a panic. See: https://github.com/rerun-io/rerun/issues/1855
match msg_drop_tx.send(msg_msg) {
Ok(_) => {},
Err(_) => {
re_log::error!("Failed to send message to msg_dropp thread. Likely a shutdown race-condition");
},
};
if packet_tx.send(packet_msg).is_err() {
re_log::error!("Failed to send message to tcp_sender thread. Likely a shutdown race-condition.");
return;
}
if msg_drop_tx.send(msg_msg).is_err() {
re_log::error!("Failed to send message to msg_drop thread. Likely a shutdown race-condition");
return;
}
} else {
return; // channel has closed
}
Expand Down