Skip to content

Add ActionListener.releaseBefore #123591

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
merged 4 commits into from
Feb 28, 2025
Merged

Add ActionListener.releaseBefore #123591

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
69ce93e
Add ActionListener.releaseBefore
fcofdez Feb 27, 2025
264f10e
Wrap into a CheckedRunnable directly
fcofdez Feb 27, 2025
48d82a8
Permute arguments
fcofdez Feb 27, 2025
3da61cf
Merge branch 'main' into add-release-before-action-listener
elasticmachine Feb 28, 2025
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
11 changes: 11 additions & 0 deletions server/src/main/java/org/elasticsearch/action/ActionListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.util.function.Consumer;
import java.util.function.Function;

import static org.elasticsearch.action.ActionListenerImplementations.checkedRunnableFromReleasable;
import static org.elasticsearch.action.ActionListenerImplementations.runnableFromReleasable;
import static org.elasticsearch.action.ActionListenerImplementations.safeAcceptException;
import static org.elasticsearch.action.ActionListenerImplementations.safeOnFailure;
Expand Down Expand Up @@ -335,6 +336,16 @@ static <Response> ActionListener<Response> runBefore(ActionListener<Response> de
return assertOnce(new ActionListenerImplementations.RunBeforeActionListener<>(delegate, runBefore));
}

/**
* Wraps a given listener and returns a new listener which releases the provided {@code releaseBefore}
* resource before the listener is notified via either {@code #onResponse} or {@code #onFailure}.
*/
static <Response> ActionListener<Response> releaseBefore(ActionListener<Response> delegate, Releasable releaseBefore) {
Copy link
Contributor

@DaveCTurner DaveCTurner Feb 27, 2025

Choose a reason for hiding this comment

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

It's always irked me that these params are in the opposite order from their executioin. I guess it's consistent with runBefore(). But do contemplate whether you'd prefer this to be more readable the other way round.

return assertOnce(
new ActionListenerImplementations.RunBeforeActionListener<>(delegate, checkedRunnableFromReleasable(releaseBefore))
);
}

/**
* Wraps a given listener and returns a new listener which makes sure {@link #onResponse(Object)}
* and {@link #onFailure(Exception)} of the provided listener will be called at most once.
Expand Down
14 changes: 14 additions & 0 deletions server/src/main/java/org/elasticsearch/action/ActionListenerImplementations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,20 @@ public String toString() {
};
}

static CheckedRunnable<Exception> checkedRunnableFromReleasable(Releasable releasable) {
return new CheckedRunnable<>() {
@Override
public void run() {
Releasables.closeExpectNoException(releasable);
}

@Override
public String toString() {
return "release[" + releasable + "]";
}
};
}

static void safeAcceptException(Consumer<Exception> consumer, Exception e) {
assert e != null;
try {
Expand Down
21 changes: 16 additions & 5 deletions server/src/test/java/org/elasticsearch/action/ActionListenerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiFunction;
import java.util.function.Consumer;

import static org.hamcrest.Matchers.containsString;
Expand Down Expand Up @@ -610,16 +611,26 @@ public String toString() {
);
}

public void testReleaseBefore() {
runReleaseListenerTest(true, false, ActionListener::releaseBefore);
runReleaseListenerTest(true, true, ActionListener::releaseBefore);
runReleaseListenerTest(false, false, ActionListener::releaseBefore);
}

public void testReleaseAfter() {
runReleaseAfterTest(true, false);
runReleaseAfterTest(true, true);
runReleaseAfterTest(false, false);
runReleaseListenerTest(true, false, ActionListener::releaseAfter);
runReleaseListenerTest(true, true, ActionListener::releaseAfter);
runReleaseListenerTest(false, false, ActionListener::releaseAfter);
}

private static void runReleaseAfterTest(boolean successResponse, final boolean throwFromOnResponse) {
private static void runReleaseListenerTest(
boolean successResponse,
final boolean throwFromOnResponse,
BiFunction<ActionListener<Void>, Releasable, ActionListener<Void>> releaseListenerProvider
) {
final AtomicBoolean released = new AtomicBoolean();
final String description = randomAlphaOfLength(10);
final ActionListener<Void> l = ActionListener.releaseAfter(new ActionListener<>() {
final ActionListener<Void> l = releaseListenerProvider.apply(new ActionListener<>() {
@Override
public void onResponse(Void unused) {
if (throwFromOnResponse) {
Expand Down