Attempt to write a response log when flushBuffer() fails #1997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In cases when a reactive client closes a connection, flushBuffer() operation may throw a "java.io.IOException: Broken pipe" exception, that in its own turn leads to a connection close, and `LogbookAsyncListener.onComplete` call. But as this happens AFTER `ServletResponse.freeResources()` is called (by HttpServerExchange.endExchange() in case of undertow, for example), the `responseWritingStageSynchronizationName` attribute is not present anymore in the response object, which leads to an NPE. This fix attempts to overcome this edge case, by trying to write the response anyway, even after the flush fails.
kasmarian
requested review from
whiskeysierra,
lukasniemeier-zalando and
msdousti
as code owners
|
I suggest having a mock-based test to reproduce the NPE, in order to quench the thirst for 100% coverage. |
added the test in 12c63a7 ^^ |
msdousti
approved these changes
Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In cases when a reactive client closes a connection, flushBuffer() operation may throw a "java.io.IOException: Broken pipe" exception, that in its own turn leads to a connection close, and
LogbookAsyncListener.onCompletecall. But as this happens AFTERServletResponse.freeResources()is called (by HttpServerExchange.endExchange() in case of undertow, for example), theresponseWritingStageSynchronizationNameattribute is not present anymore in the response object, which leads to an NPE. This fix attempts to overcome this edge case, by trying to write the response anyway, even after the flush fails.I wasn't able to add a reproducible unit test with MockMvc for this use case so far, but added an isolated one. Any suggestions are welcome
Motivation and Context
#1963
Types of changes
Checklist: