Skip to content

Fix Connection Closing on Timeout #17690

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

Merged
alzimmermsft merged 2 commits into from
Nov 20, 2020
Merged

Fix Connection Closing on Timeout #17690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7b2464
Close connection when timeout occurs
alzimmermsft Nov 18, 2020
b474fa0
Add CHANGELOG entry
alzimmermsft Nov 19, 2020
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
3 changes: 3 additions & 0 deletions sdk/core/azure-core-http-netty/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## 1.7.0-beta.1 (Unreleased)

### Bug Fixes

- Fixed a bug where a connection would remain active when timed out instead of being closed.

## 1.6.3 (2020-10-29)

Expand Down
7 changes: 6 additions & 1 deletion ...http-netty/src/main/java/com/azure/core/http/netty/implementation/ReadTimeoutHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public final class ReadTimeoutHandler extends ChannelInboundHandlerAdapter {

private final long timeoutMillis;

private boolean closed;
private long lastReadMillis;
private ScheduledFuture<?> readTimeoutWatcher;

Expand Down Expand Up @@ -65,6 +66,10 @@ private void readTimeoutRunnable(ChannelHandlerContext ctx) {
}

// No progress has been made since the last timeout event, channel has timed out.
ctx.fireExceptionCaught(new TimeoutException(String.format(READ_TIMED_OUT_MESSAGE, timeoutMillis)));
if (!closed) {

@srnagar srnagar Nov 20, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this check required? Can this method be called multiple times? If yes, what's the impact of trying to close the context each time?

@alzimmermsft alzimmermsft Nov 20, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The check is there to ensure that we don't fire the exception multiple times. As for what happens if close is called multiple times I am not certain and can take a look into this.

@alzimmermsft alzimmermsft Nov 20, 2020 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looked into the safety of calling close multiple times and the answer is unknown as this will trigger the close handler for other handlers, so it would be dependent on the configuration of the Netty pipeline. In our default instance it is safe to call multiple times but that isn't a guarantee.

ctx.fireExceptionCaught(new TimeoutException(String.format(READ_TIMED_OUT_MESSAGE, timeoutMillis)));
ctx.close();
closed = true;
}
}
}
7 changes: 6 additions & 1 deletion ...-netty/src/main/java/com/azure/core/http/netty/implementation/ResponseTimeoutHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public final class ResponseTimeoutHandler extends ChannelInboundHandlerAdapter {

private final long timeoutMillis;

private boolean closed;
private ScheduledFuture<?> responseTimeoutWatcher;

/**
Expand Down Expand Up @@ -51,6 +52,10 @@ public void handlerRemoved(ChannelHandlerContext ctx) {
}

private void responseTimedOut(ChannelHandlerContext ctx) {
ctx.fireExceptionCaught(new TimeoutException(String.format(RESPONSE_TIMED_OUT_MESSAGE, timeoutMillis)));
if (!closed) {
ctx.fireExceptionCaught(new TimeoutException(String.format(RESPONSE_TIMED_OUT_MESSAGE, timeoutMillis)));
ctx.close();
closed = true;
}
}
}
7 changes: 6 additions & 1 deletion ...ttp-netty/src/main/java/com/azure/core/http/netty/implementation/WriteTimeoutHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public final class WriteTimeoutHandler extends ChannelOutboundHandlerAdapter {

private final long timeoutMillis;

private boolean closed;
private long lastWriteMillis;
private long lastWriteProgress;
private ScheduledFuture<?> writeTimeoutWatcher;
Expand Down Expand Up @@ -83,6 +84,10 @@ private void writeTimeoutRunnable(ChannelHandlerContext ctx) {
}

// No progress has been made since the last timeout event, channel has timed out.
ctx.fireExceptionCaught(new TimeoutException(String.format(WRITE_TIMED_OUT_MESSAGE, timeoutMillis)));
if (!closed) {
ctx.fireExceptionCaught(new TimeoutException(String.format(WRITE_TIMED_OUT_MESSAGE, timeoutMillis)));
ctx.close();
closed = true;
}
}
}