Fix race condition where log.whenComplete may not complete
#5986
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
ikhoon
reviewed
Nov 19, 2024
| if (!hasInterestedFlags(deferredFlags, RequestLogProperty.REQUEST_CONTENT) || | ||
| isAvailable(RequestLogProperty.REQUEST_CONTENT)) { | ||
| // Set names if request content is not deferred | ||
| if (!hasInterestedFlags(deferredFlags, RequestLogProperty.REQUEST_CONTENT)) { |
There was a problem hiding this comment.
Previously, the default name was filled in if there was no custom value before a request ended. With this change, if a deferred request content is called before endRequest(), RequestLogBuilder.name() could be ignored, which may be a breaking change. Would it be worth specifying this change in Javadoc?
minwoox
pushed a commit
that referenced
this pull request
Nov 22, 2024
Motivation: It has been reported that `log.whenComplete` is not completing in some cases in #5981. The cause seems to be a race condition between `DefaultRequestLog#endRequest` and `DefaultRequestLog#requestContent`. Completion of `log.whenComplete` is important because 1) it is semantically bound to an HTTP request 2) users (including us) have clean up logic using `log.whenComplete`. I propose that simply `endRequest` only sets `name` if content is not deferred, and `requestContent` sets `name` if content is deferred. The logic is easier to reason about, and there are minimal performance implications since a lock is held anyways. Modifications: - `#endRequest` sets `name` if `requestContent` isn't deferred - `#requestContent` sets name if `requestContent` is deferred Result: - Closes #5981 <!-- Visit this URL to learn more about how to write a pull request description: https://armeria.dev/community/developer-guide#how-to-write-pull-request-description -->
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.
Motivation:
It has been reported that
log.whenCompleteis not completing in some cases in #5981.The cause seems to be a race condition between
DefaultRequestLog#endRequestandDefaultRequestLog#requestContent. Completion oflog.whenCompleteis important becauselog.whenComplete.I propose that simply
endRequestonly setsnameif content is not deferred, andrequestContentsetsnameif content is deferred. The logic is easier to reason about, and there are minimal performance implications since a lock is held anyways.Modifications:
#endRequestsetsnameifrequestContentisn't deferred#requestContentsets name ifrequestContentis deferredResult:
FramedGrpcServicewithctx.log.whenCompleteNot Completing in v1.30.1 #5981