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

@@ -37,6 +37,7 @@
 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;
@@ -87,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
@@ -133,14 +140,14 @@ public final Object instrumentInvocation(Object instance, Method method, Object[
     private Object handleResult(InvocationContext context, Object result) {
         if (result instanceof ListenableFuture) {
             return handleFuture(context, (ListenableFuture) result);
-        } else if (result instanceof CompletableFuture) {
-            return handleFuture(context, (CompletableFuture) result);
+        } else if (result instanceof CompletionStage) {
+            return handleFuture(context, (CompletionStage) result);
         } else {
             return handleOnSuccess(context, result);
         }
     }
 
-    private CompletableFuture<?> handleFuture(InvocationContext context, CompletableFuture<?> future) {
+    private CompletionStage<?> handleFuture(InvocationContext context, CompletionStage<?> future) {
         future.handleAsync((result, throwable) -> {
             if (throwable == null) {
                 return handleOnSuccess(context, result);

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

@@ -21,6 +21,7 @@
 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;
@@ -52,6 +53,7 @@ public void before() {
                 .build();
         when(handler.isEnabled()).thenCallRealMethod();
         when(handler.preInvocation(any(), any(), any())).thenCallRealMethod();
+        when(handler.asyncSupport()).thenReturn(true);
     }
 
     @Test
@@ -83,6 +85,17 @@ public void testCfThrows() {
         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();
@@ -112,6 +125,17 @@ public void testLfThrows() {
         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();
 

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);