Invoke onSuccess and onFailure handlers properly for async methods

tritium-api/src/main/java/com/palantir/tritium/event/InvocationEventHandler.java

@@ -35,6 +35,17 @@ public interface InvocationEventHandler<C extends InvocationContext> {
      */
     boolean isEnabled();
 
+    /**
+     * Returns true if this event handler instance is able to support asynchronous method invocations by being invoked
+     * on another thread. A handler that relies on {@link ThreadLocal} state, for example, will not be able to support
+     * async operations.
+     *
+     * @return true if the handler supports async operations
+     */
+    default boolean asyncSupport() {
+        return false;
+    }
+
     /**
      * Invoked before invoking the method on the instance.
      *

tritium-core/src/main/java/com/palantir/tritium/event/CompositeInvocationEventHandler.java

@@ -51,6 +51,16 @@ public static InvocationEventHandler<InvocationContext> of(
         }
     }
 
+    @Override
+    public boolean asyncSupport() {
+        for (InvocationEventHandler<?> handler : handlers) {
+            if (!handler.asyncSupport()) {
+                return false;
+            }
+        }
+        return true;
+    }
+
     @Override
     public InvocationContext preInvocation(Object instance, Method method, Object[] args) {
         InvocationContext[] contexts = new InvocationContext[handlers.size()];

tritium-lib/src/main/java/com/palantir/tritium/proxy/InvocationEventProxy.java

@@ -19,6 +19,10 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.google.common.reflect.AbstractInvocationHandler;
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.MoreExecutors;
 import com.google.errorprone.annotations.CompileTimeConstant;
 import com.palantir.logsafe.SafeArg;
 import com.palantir.logsafe.UnsafeArg;
@@ -32,6 +36,8 @@
 import java.lang.reflect.Method;
 import java.util.Arrays;
 import java.util.List;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
 import javax.annotation.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -82,13 +88,19 @@ public String toString() {
     private boolean isEnabled(Object instance, Method method, Object[] args) {
         try {
             return eventHandler.isEnabled()
-                    && filter.shouldInstrument(instance, method, args);
+                    && filter.shouldInstrument(instance, method, args)
+                    && (eventHandler.asyncSupport() || !isAsync(method));
         } catch (Throwable t) {
             logInvocationWarning("isEnabled", instance, method, args, t);
             return false;
         }
     }
 
+    private boolean isAsync(Method method) {
+        Class<?> returnType = method.getReturnType();
+        return ListenableFuture.class.isAssignableFrom(returnType)
+                || CompletionStage.class.isAssignableFrom(returnType);
+    }
 
     @Override
     @Nullable
@@ -116,14 +128,53 @@ public final Object instrumentInvocation(Object instance, Method method, Object[
         InvocationContext context = handlePreInvocation(instance, method, args);
         try {
             Object result = execute(method, args);
-            return handleOnSuccess(context, result);
+            return handleResult(context, result);
         } catch (InvocationTargetException e) {
             throw handleOnFailure(context, e.getCause());
         } catch (Throwable t) {
             throw handleOnFailure(context, t);
         }
     }
 
+    @Nullable
+    private Object handleResult(InvocationContext context, Object result) {
+        if (result instanceof ListenableFuture) {
+            return handleFuture(context, (ListenableFuture) result);
+        } else if (result instanceof CompletionStage) {
+            return handleFuture(context, (CompletionStage) result);
+        } else {
+            return handleOnSuccess(context, result);
+        }
+    }
+
+    private CompletionStage<?> handleFuture(InvocationContext context, CompletionStage<?> future) {
+        future.handleAsync((result, throwable) -> {
+            if (throwable == null) {
+                return handleOnSuccess(context, result);
+            } else {
+                return handleOnFailure(context, throwable);
+            }
+        }, MoreExecutors.directExecutor());
+
+        return future;
+    }
+
+    private ListenableFuture<?> handleFuture(InvocationContext context, ListenableFuture<?> future) {
+        Futures.addCallback(future, new FutureCallback<Object>() {
+            @Override
+            public void onSuccess(Object result) {
+                handleOnSuccess(context, result);
+            }
+
+            @Override
+            public void onFailure(Throwable throwable) {
+                handleOnFailure(context, throwable);
+            }
+        }, MoreExecutors.directExecutor());
+
+        return future;
+    }
+
     @Nullable
     final InvocationContext handlePreInvocation(Object instance, Method method, Object[] args) {
         try {

tritium-lib/src/test/java/com/palantir/tritium/proxy/AsyncInvocationEventProxyTest.java

@@ -0,0 +1,156 @@
+/*
+ * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.palantir.tritium.proxy;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+import static org.mockito.Mockito.when;
+
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.SettableFuture;
+import com.palantir.tritium.event.DefaultInvocationContext;
+import com.palantir.tritium.event.InvocationContext;
+import com.palantir.tritium.event.InvocationEventHandler;
+import java.lang.reflect.Method;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public final class AsyncInvocationEventProxyTest {
+    private static final String result = "Result";
+
+    @Mock private AsyncIface delegate;
+    @Mock private SimpleInvocationEventHandler handler;
+    private AsyncIface proxy;
+
+    @Before
+    public void before() {
+        proxy = Instrumentation.builder(AsyncIface.class, delegate)
+                .withHandler(handler)
+                .build();
+        when(handler.isEnabled()).thenCallRealMethod();
+        when(handler.preInvocation(any(), any(), any())).thenCallRealMethod();
+        when(handler.asyncSupport()).thenReturn(true);
+    }
+
+    @Test
+    public void testCfSuccess() throws ExecutionException, InterruptedException {
+        CompletableFuture<String> future = new CompletableFuture<>();
+        when(delegate.cf()).thenReturn(future);
+
+        CompletableFuture<String> ret = proxy.cf();
+        assertThat(ret.isDone()).isFalse();
+        verify(handler, never()).onSuccess(any(), any());
+
+        future.complete(result);
+        assertThat(ret.get()).isEqualTo(result);
+        verify(handler).onSuccess(any(), eq(result));
+    }
+
+    @Test
+    public void testCfThrows() {
+        RuntimeException exception = new RuntimeException();
+        CompletableFuture<String> future = new CompletableFuture<>();
+        when(delegate.cf()).thenReturn(future);
+
+        CompletableFuture<String> ret = proxy.cf();
+        assertThat(ret.isDone()).isFalse();
+        verify(handler, never()).onSuccess(any(), any());
+
+        future.completeExceptionally(exception);
+        assertThat(ret.isCompletedExceptionally()).isTrue();
+        verify(handler).onFailure(any(), eq(exception));
+    }
+
+    @Test
+    public void testCf_noAsyncSupport() {
+        when(handler.asyncSupport()).thenReturn(false);
+
+        proxy.cf();
+
+        verify(handler).isEnabled();
+        verify(handler).asyncSupport();
+        verifyNoMoreInteractions(handler);
+    }
+
+    @Test
+    public void testLfSuccess() {
+        SettableFuture<String> future = SettableFuture.create();
+        when(delegate.lf()).thenReturn(future);
+
+        ListenableFuture<String> ret = proxy.lf();
+        assertThat(ret.isDone()).isFalse();
+        verify(handler, never()).onSuccess(any(), any());
+
+        future.set(result);
+        assertThat(ret.isDone()).isTrue();
+        verify(handler).onSuccess(any(), eq(result));
+    }
+
+    @Test
+    public void testLfThrows() {
+        RuntimeException exception = new RuntimeException();
+        SettableFuture<String> future = SettableFuture.create();
+        when(delegate.lf()).thenReturn(future);
+
+        ListenableFuture<String> ret = proxy.lf();
+        assertThat(ret.isDone()).isFalse();
+        verify(handler, never()).onFailure(any(), any());
+
+        future.setException(exception);
+        assertThat(ret.isDone()).isTrue();
+        verify(handler).onFailure(any(), eq(exception));
+    }
+
+    @Test
+    public void testLf_noAsyncSupport() {
+        when(handler.asyncSupport()).thenReturn(false);
+
+        proxy.lf();
+
+        verify(handler).isEnabled();
+        verify(handler).asyncSupport();
+        verifyNoMoreInteractions(handler);
+    }
+
+    interface AsyncIface {
+        CompletableFuture<String> cf();
+
+        ListenableFuture<String> lf();
+    }
+
+    interface SimpleInvocationEventHandler extends InvocationEventHandler<InvocationContext> {
+        @Override
+        default boolean isEnabled() {
+            return true;
+        }
+
+        @Override
+        default InvocationContext preInvocation(Object instance, Method method, Object[] args) {
+            return DefaultInvocationContext.of(instance, method, args);
+        }
+    }
+}

tritium-metrics/src/main/java/com/palantir/tritium/event/metrics/MetricsInvocationEventHandler.java

@@ -100,6 +100,11 @@ static java.util.function.BooleanSupplier getEnabledSupplier(String serviceName)
         return InstrumentationProperties.getSystemPropertySupplier(serviceName);
     }
 
+    @Override
+    public boolean asyncSupport() {
+        return true;
+    }
+
     @Override
     public InvocationContext preInvocation(Object instance, Method method, Object[] args) {
         return DefaultInvocationContext.of(instance, method, args);

tritium-metrics/src/main/java/com/palantir/tritium/event/metrics/TaggedMetricsServiceInvocationEventHandler.java

@@ -66,6 +66,11 @@ private static BooleanSupplier getEnabledSupplier(final String serviceName) {
         return InstrumentationProperties.getSystemPropertySupplier(serviceName);
     }
 
+    @Override
+    public boolean asyncSupport() {
+        return true;
+    }
+
     @Override
     public final InvocationContext preInvocation(Object instance, Method method, Object[] args) {
         return DefaultInvocationContext.of(instance, method, args);

tritium-slf4j/src/main/java/com/palantir/tritium/event/log/LoggingInvocationEventHandler.java

@@ -86,6 +86,11 @@ public LoggingInvocationEventHandler(Logger logger, LoggingLevel level,
         this.durationPredicate = checkNotNull(durationPredicate, "durationPredicate");
     }
 
+    @Override
+    public boolean asyncSupport() {
+        return true;
+    }
+
     @Override
     public final InvocationContext preInvocation(Object instance, Method method, Object[] args) {
         return DefaultInvocationContext.of(instance, method, args);

tritium-test/src/main/java/com/palantir/tritium/test/event/ThrowingInvocationEventHandler.java

@@ -52,4 +52,9 @@ public void onFailure(@Nullable InvocationContext context, @Nonnull Throwable ca
     public boolean isEnabled() {
         return isEnabled;
     }
+
+    @Override
+    public boolean asyncSupport() {
+        return isEnabled;
+    }
 }

tritium-tracing/src/main/java/com/palantir/tritium/tracing/RemotingCompatibleTracingInvocationEventHandler.java

@@ -50,6 +50,12 @@ static InvocationEventHandler<InvocationContext> create(String component) {
         return new RemotingCompatibleTracingInvocationEventHandler(component, createTracer());
     }
 
+    @Override
+    public boolean asyncSupport() {
+        // Cannot support async operations until the Tracing library stops relying on ThreadLocal state
+        return false;
+    }
+
     @Override
     public InvocationContext preInvocation(Object instance, Method method, Object[] args) {
         InvocationContext context = DefaultInvocationContext.of(instance, method, args);

tritium-tracing/src/main/java/com/palantir/tritium/tracing/TracingInvocationEventHandler.java

@@ -61,6 +61,12 @@ public static InvocationEventHandler<InvocationContext> create(String component)
         return new TracingInvocationEventHandler(component);
     }
 
+    @Override
+    public boolean asyncSupport() {
+        // Cannot support async operations until the Tracing library stops relying on ThreadLocal state
+        return false;
+    }
+
     @Override
     public InvocationContext preInvocation(Object instance, Method method, Object[] args) {
         InvocationContext context = DefaultInvocationContext.of(instance, method, args);