Flush pending writes before closing the connection on caught exceptions#6177
Flush pending writes before closing the connection on caught exceptions#6177asalajan wants to merge 5 commits into
Conversation
a937b81 to
213479e
Compare
|
for this fix we need a test in |
I have added |
|
Hello @vietj ! |
|
@asalajan as I understand we are testing the behavior using the NetClient communication to the HTTP server ? |
|
@vietj Yes, for For the second test, |
|
@vietj I've edited my previous response to try to clarify why NetClient was used. |
|
I would like actually this test to be in NetClientTest and avoid make it an HTTP test because it is not related to HTTP protocol |
Motivation: When an exception is caught on a connection, VertxHandler#exceptionCaught dispatches the throwable to the user handlers and then closes the channel with chctx.close(). A response written from the handler -- for instance a 400 written from request().exceptionHandler() when HttpContentDecompressor throws a DecoderException on a malformed compressed body -- is enqueued in the outbound message queue but not flushed, because VertxConnection#write skips the flush while a read is in progress. chctx.close() then causes Netty to discard the unflushed entries from the ChannelOutboundBuffer, so the response never reaches the client: the client observes a connection reset instead of the intended HTTP response. Changes: Route the exception-driven close through the channel so it traverses the pipeline tail and invokes VertxHandler#close -> VertxConnection#writeClose, which flushes pending writes (an empty buffer with forceFlush=true) and closes the channel only once the flush has completed. This is the same flush-then-close path already used by graceful shutdown, idle close and the regular close(); the exception path simply was not using it. The bare chctx.close() is kept as a fallback for the case where no connection has been set yet (handlerAdded has not run), since VertxHandler#close dereferences it. Add a regression test, Http1xTest#testRequestDecompressionInvalidBodyDeliversErrorResponse, that sends a malformed gzip body to a server with decompression enabled and asserts the client receives the response written from the request exception handler. HTTP/2 is unaffected: its codec replaces VertxHandler in the pipeline, so connection-level exceptions do not go through this path. Signed-off-by: Alexandru Salajan <alexandru17@gmail.com>
…tion Covers the fix at the connection layer: a write queued (unflushed) when a caught exception triggers the close must reach the channel before it closes, otherwise Netty's ChannelOutboundBuffer discards the unflushed entry. The test fails without the VertxHandler.exceptionCaught change and passes with it. Signed-off-by: Alexandru Salajan <alexandru17@gmail.com>
The fix is at the transport layer (VertxHandler/VertxConnection) and is not HTTP specific, so exercise it over plain TCP rather than HTTP. Drop Http1xTest#testRequestDecompressionInvalidBodyDeliversErrorResponse and add NetTest#testFlushPendingWriteOnExceptionClose, which parks an unflushed write on a NetServer connection, triggers a caught exception that closes it, and asserts the client still receives the bytes before the close. Signed-off-by: Alexandru Salajan <alexandru17@gmail.com>
eb45653 to
00b3174
Compare
@vietj I moved the test. Please let me know if you see any other issues. |
A regular connection close already closes at the channel level, so the exception-driven close should too; there is no good reason to close from the channel handler context. Drop the connection != null / chctx.close() fallback and always use chctx.channel().close(). Signed-off-by: Alexandru Salajan <alexandru17@gmail.com>
Signed-off-by: Alexandru Salajan <alexandru17@gmail.com>
|
I see 3 WebSocket tests are failing because of this change. I missed running them locally: They pass on master and fail with the fix with both the unconditional and the earlier guarded form - anything that reaches VertxHandler.close. I am not familiar with WebSockets but I can try to look into it more with the help of AI. Maybe one option could be to narrow the fix to the HTTP/1 layer by flushing the response in the server connection exception handling before close, and VertxHandler.exceptionCaught remains as it is: chctx.close(). I don't know if a generic protocol agnostic solution exists. |
|
@asalajan I will have a look myself |
Fixes #6155
Motivation:
When an exception is caught on a connection, VertxHandler#exceptionCaught dispatches the throwable to the user handlers and then closes the channel with chctx.close(). A response written from the handler -- for instance a 400 written from request().exceptionHandler() when HttpContentDecompressor throws a DecoderException on a malformed compressed body -- is enqueued in the outbound message queue but not flushed, because VertxConnection#write skips the flush while a read is in progress. chctx.close() then causes Netty to discard the unflushed entries from the ChannelOutboundBuffer, so the response never reaches the client: the client observes a connection reset instead of the intended HTTP response.
Changes:
Route the exception-driven close through the channel so it traverses the pipeline tail and invokes VertxHandler#close -> VertxConnection#writeClose, which flushes pending writes (an empty buffer with forceFlush=true) and closes the channel only once the flush has completed. This is the same flush-then-close path already used by graceful shutdown, idle close and the regular close(); the exception path simply was not using it. The bare chctx.close() is kept as a fallback for the case where no connection has been set yet (handlerAdded has not run), since VertxHandler#close dereferences it.
Add a regression test, Http1xTest#testRequestDecompressionInvalidBodyDeliversErrorResponse, that sends a malformed gzip body to a server with decompression enabled and asserts the client receives the response written from the request exception handler.
HTTP/2 is unaffected: its codec replaces VertxHandler in the pipeline, so connection-level exceptions do not go through this path.
I'm happy to open the backport PRs for version 5.0.x and 5.1.x once this one is reviewed/merged
Developed with assistance from an AI coding agent (Claude Code). I reviewed and tested the changes.