Skip to content

Better handling for stream reset #55

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

Merged
merged 1 commit into from
Feb 12, 2025
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changes

## [1.8.5] - 2025-02-11
## [1.8.5] - 2025-02-12

* Fix handle for REFUSED_STREAM reset

Expand Down
20 changes: 12 additions & 8 deletions src/dispatcher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

use crate::connection::{Connection, RecvHalfConnection};
use crate::control::{Control, ControlAck};
use crate::error::{ConnectionError, OperationError, StreamErrorInner};
use crate::error::{ConnectionError, OperationError, StreamError, StreamErrorInner};
use crate::frame::{Frame, GoAway, Ping, Reason, Reset, StreamId};
use crate::{codec::Codec, message::Message, stream::StreamRef};

Expand Down Expand Up @@ -71,14 +71,18 @@
}
Err(Either::Right(err)) => {
let (stream, kind) = err.into_inner();
log::error!(
"{}: Failed to handle message, err: {:?} stream: {:?}",
stream.tag(),
kind,
stream
);

stream.set_failed_stream(kind.into());
if !matches!(kind, StreamError::Reset(_)) {
log::error!(
"{}: Failed to handle frame, err: {:?} stream: {:?}",
stream.tag(),

Check warning on line 78 in src/dispatcher.rs

View check run for this annotation

Codecov / codecov/patch

src/dispatcher.rs#L76-L78

Added lines #L76 - L78 were not covered by tests
kind,
stream
);
} else {
stream.set_failed_stream(kind.into());
}

self.connection
.encode(Reset::new(stream.id(), kind.reason()));
publish(Message::error(kind, &stream), stream, &self.inner, ctx).await
Expand Down
18 changes: 6 additions & 12 deletions src/stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,7 @@ impl StreamState {
self.review_state();
}

fn set_failed(&self) {
self.insert_flag(StreamFlags::FAILED);
self.send_cap.wake();
self.send_reset.wake();
}

fn reset_stream(&self, reason: Option<Reason>) {
self.set_failed();
self.recv.set(HalfState::Closed(reason));
self.send.set(HalfState::Closed(None));
if let Some(reason) = reason {
Expand All @@ -200,22 +193,21 @@ impl StreamState {
}

fn remote_reset_stream(&self, reason: Reason) {
self.set_failed();
self.recv.set(HalfState::Closed(None));
self.send.set(HalfState::Closed(Some(reason)));
self.error.set(Some(OperationError::RemoteReset(reason)));
self.review_state();
}

fn failed(&self, err: OperationError) {
self.set_failed();
if !self.recv.get().is_closed() {
self.recv.set(HalfState::Closed(None));
}
if !self.send.get().is_closed() {
self.send.set(HalfState::Closed(None));
}
self.error.set(Some(err));
self.insert_flag(StreamFlags::FAILED);
self.review_state();
}

Expand Down Expand Up @@ -246,11 +238,12 @@ impl StreamState {

if let HalfState::Closed(reason) = self.send.get() {
// stream is closed
if reason.is_some() {
if let Some(reason) = reason {
log::trace!(
"{}: {:?} is closed with local reset, dropping stream",
"{}: {:?} is closed with remote reset {:?}, dropping stream",
self.tag(),
self.id
self.id,
reason
);
} else {
log::trace!(
Expand All @@ -259,6 +252,7 @@ impl StreamState {
self.id
);
}
self.send_cap.wake();
self.con.drop_stream(self.id);
}
}
Expand Down
36 changes: 36 additions & 0 deletions tests/connection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,42 @@ async fn test_goaway_on_overflow() {
assert!(io.recv(&codec).await.unwrap().is_none());
}

#[ntex::test]
async fn test_stream_cancel() {
let srv = start_server();
let addr = srv.addr();

let io = connect(addr).await;
let codec = Codec::default();
let _ = io.with_write_buf(|buf| buf.extend_from_slice(&PREFACE));

let settings = frame::Settings::default();
io.encode(settings.into(), &codec).unwrap();

// settings & window
let _ = io.recv(&codec).await;
let _ = io.recv(&codec).await;
let _ = io.recv(&codec).await;

let id = frame::StreamId::CLIENT;
let pseudo = frame::PseudoHeaders {
method: Some(Method::GET),
scheme: Some("HTTPS".into()),
authority: Some("localhost".into()),
path: Some("/".into()),
..Default::default()
};

let hdrs = frame::Headers::new(id, pseudo.clone(), HeaderMap::new(), false);
io.send(hdrs.into(), &codec).await.unwrap();
io.send(frame::Reset::new(id, frame::Reason::CANCEL).into(), &codec)
.await
.unwrap();

let reset = get_reset(io.recv(&codec).await.unwrap().unwrap());
assert!(reset.reason() == frame::Reason::CANCEL);
}

#[ntex::test]
async fn test_goaway_on_reset() {
let srv = start_server();
Expand Down
Loading