Skip to content
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

Jump to bottom

Fix bridging for get #351

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix bridging for get #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
77 changes: 44 additions & 33 deletions ...ts/parseq-guava-interop/src/main/java/com/linkedin/parseq/guava/ListenableFutureUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
package com.linkedin.parseq.guava;

import com.linkedin.parseq.promise.Promises;
import java.util.Collection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.util.concurrent.AbstractFuture;
import com.google.common.util.concurrent.ListenableFuture;
Expand All @@ -15,6 +11,8 @@
import com.linkedin.parseq.promise.SettablePromise;
import java.util.concurrent.CancellationException;
import java.util.concurrent.ExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
Expand All @@ -29,38 +27,11 @@ private ListenableFutureUtil() {
}

public static <T> Task<T> fromListenableFuture(ListenableFuture<T> future) {

/**
* BaseTask's promise will be listening to this
* also see {@link BaseTask#contextRun(Context, Task, Collection)}
*/
final SettablePromise<T> promise = Promises.settable();

// Setup cancellation propagation from Task -> ListenableFuture.
final Task<T> task =
new BaseTask<T>("fromListenableFuture: " + Task._taskDescriptor.getDescription(future.getClass().getName())) {
@Override
public boolean cancel(Exception rootReason) {
// <BaseTask>.cancel()'s result indicates whether cancel() successfully trigger state transition to "CANCELLED"
// And we should only cancel GRPC future when the transition was conducted.
boolean shouldCancelTask = super.cancel(rootReason);
if (shouldCancelTask && !future.isCancelled()) {
boolean futureCancelResult = future.cancel(true);
if (!futureCancelResult) {
LOGGER.warn("Unexpected: GRPC future was not cancelled but new attempt to cancel also failed.");
}
}
return shouldCancelTask;
}

@Override
protected Promise<? extends T> run(Context context) throws Throwable {
return promise;
}
};

final ListenableFutureBridgedTask<T> task = new ListenableFutureBridgedTask<T>(future);

// Setup forward event propagation ListenableFuture -> Task.
SettablePromise<T> promise = task.getSettableDelegate();
Runnable callbackRunnable = () -> {
if (promise.isDone()) {
boolean isPromiseFailed = promise.isFailed();
Expand Down Expand Up @@ -143,4 +114,44 @@ public boolean setException(Throwable throwable) {
return super.setException(throwable);
}
}

@VisibleForTesting
static class ListenableFutureBridgedTask<T> extends BaseTask<T> {

private final ListenableFuture<T> _future;

ListenableFutureBridgedTask(ListenableFuture<T> future) {
super("fromListenableFuture: " + Task._taskDescriptor.getDescription(future.getClass().getName()));
_future = future;
}

@Override
public boolean cancel(Exception rootReason) {
// <BaseTask>.cancel()'s result indicates whether cancel() successfully trigger state transition to "CANCELLED"
// And we should only cancel GRPC future when the transition was conducted.
boolean shouldCancelTask = super.cancel(rootReason);
if (shouldCancelTask && !_future.isCancelled()) {
boolean futureCancelResult = _future.cancel(true);
if (!futureCancelResult) {
LOGGER.warn("Unexpected: GRPC future was not cancelled but new attempt to cancel also failed.");
}
}
return shouldCancelTask;
}

@Override
protected Promise<? extends T> run(Context context) throws Throwable {
return getDelegate();
}

/**
* {@inheritDoc}
*
* <p>Exposed as public for access from {@link ListenableFutureUtil#fromListenableFuture(ListenableFuture)}</p>
*/
@Override
public SettablePromise<T> getSettableDelegate() {
return super.getSettableDelegate();
}
}
}
7 changes: 7 additions & 0 deletions ...arseq-guava-interop/src/test/java/com/linkedin/parseq/guava/ListenableFutureUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ public void testFromListenableFuture() throws Exception {
Assert.assertTrue(task.isDone());
Assert.assertTrue(task.isFailed());
Assert.assertEquals(task.getError().getCause().getClass(), CancellationException.class);

listenableFuture = new ListenableFutureUtil.SettableFuture<>();
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand this change, did line 39-43 already test this path? Only difference is that there is runUntilComplete(task)

task = ListenableFutureUtil.fromListenableFuture(listenableFuture);

// Test get.
listenableFuture.set("Haha");
Assert.assertEquals(task.get(), "Haha");
}

@Test
Expand Down
Loading