Add CountDownActionListener #92308
Merged
Add CountDownActionListener #92308
Conversation
This file contains hidden or 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
It's very much like GroupedActionListener, but for when you don't care about the individual results at all.
It's a common enough calling pattern that it seems handy to add special support for it.
We don't want to allow too many invocations of the listener
So this is inspired by CountDown, but doesn't *use* CountDown. Crucially, this gives us the additional validation that you don't over-invoke the listener -- you get groupSize invocations, no more.
joegallo
added
>non-issue
:Core/Infra/Core
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
DaveCTurner
reviewed
Dec 12, 2022
server/src/main/java/org/elasticsearch/action/support/CountDownActionListener.java
Outdated
Show resolved
Hide resolved
thecoop
reviewed
Dec 14, 2022
server/src/main/java/org/elasticsearch/action/support/CountDownActionListener.java
Show resolved
Hide resolved
thecoop
reviewed
Dec 14, 2022
server/src/main/java/org/elasticsearch/action/support/CountDownActionListener.java
Show resolved
Hide resolved
thecoop
reviewed
Dec 14, 2022
server/src/test/java/org/elasticsearch/action/support/CountDownActionListenerTests.java
Show resolved
Hide resolved
grcevski
approved these changes
Dec 15, 2022
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.
It's very similar to
GroupedActionListener-- it's basically a purpose-built class forGroupedActionListener<Void>(that is, the existing uses ofGroupedActionListenerwhere the results tracking thatGroupedActionListenerprovides is not actually useful).I originally used
CountDowninternally (hence the name), butCountDowndoesn't validate that you only call it at most N times, so I dropped the use ofCountDownin favor of direct invocation counting and being able to do that additional validation.The part I'm least sure about is the application of this class to existing callers of
GroupedActionListener<Void>-- I hunted them with search and replace, but given that there's additional validation thatCountDownActionListeneris doing it's possible that in some cases that is not actually correct.Note: I'm happy to back out any or all applications of this to existing code, this class is something I want with more-or-less these semantics for a soon-to-be-existing PR, so even with zero callers in the current codebase it will end up with a caller soon.
Adversarial reviews are most welcome, I really don't want to break anything, and I'm changing a lot of things that I'm not actually all that familiar with.