feat: log query that was causing the timeout

Author: oliemansm

graphql-java-kickstart/src/main/java/graphql/kickstart/execution/input/GraphQLBatchedInvocationInput.java

@@ -19,4 +19,5 @@ default List<ExecutionInput> getExecutionInputs() {
   }
 
   ContextSetting getContextSetting();
+
 }

graphql-java-kickstart/src/main/java/graphql/kickstart/execution/input/GraphQLInvocationInput.java

@@ -1,3 +1,7 @@
 package graphql.kickstart.execution.input;
 
-public interface GraphQLInvocationInput {}
+import java.util.List;
+
+public interface GraphQLInvocationInput {
+  List<String> getQueries();
+}

graphql-java-kickstart/src/main/java/graphql/kickstart/execution/input/GraphQLSingleInvocationInput.java

@@ -1,10 +1,13 @@
 package graphql.kickstart.execution.input;
 
+import static java.util.Collections.singletonList;
+
 import graphql.ExecutionInput;
 import graphql.execution.ExecutionId;
 import graphql.kickstart.execution.GraphQLRequest;
 import graphql.kickstart.execution.context.GraphQLContext;
 import graphql.schema.GraphQLSchema;
+import java.util.List;
 import java.util.Optional;
 import javax.security.auth.Subject;
 
@@ -50,4 +53,10 @@ private ExecutionInput createExecutionInput(
   public ExecutionInput getExecutionInput() {
     return executionInput;
   }
+
+  @Override
+  public List<String> getQueries() {
+    return singletonList(executionInput.getQuery());
+  }
+
 }

graphql-java-kickstart/src/main/java/graphql/kickstart/execution/input/PerQueryBatchedInvocationInput.java

@@ -1,5 +1,7 @@
 package graphql.kickstart.execution.input;
 
+import static java.util.stream.Collectors.toList;
+
 import graphql.kickstart.execution.GraphQLRequest;
 import graphql.kickstart.execution.context.ContextSetting;
 import graphql.kickstart.execution.context.GraphQLContext;
@@ -30,4 +32,12 @@ public PerQueryBatchedInvocationInput(
             .collect(Collectors.toList());
     this.contextSetting = contextSetting;
   }
+
+  @Override
+  public List<String> getQueries() {
+    return invocationInputs.stream()
+        .map(GraphQLSingleInvocationInput::getQueries)
+        .flatMap(List::stream)
+        .collect(toList());
+  }
 }

graphql-java-kickstart/src/main/java/graphql/kickstart/execution/input/PerRequestBatchedInvocationInput.java

@@ -1,12 +1,13 @@
 package graphql.kickstart.execution.input;
 
+import static java.util.stream.Collectors.toList;
+
 import graphql.kickstart.execution.GraphQLRequest;
 import graphql.kickstart.execution.context.ContextSetting;
 import graphql.kickstart.execution.context.GraphQLContext;
 import graphql.schema.GraphQLSchema;
 import java.util.List;
 import java.util.function.Supplier;
-import java.util.stream.Collectors;
 import lombok.Getter;
 
 /** A collection of GraphQLSingleInvocationInputs that share a context object. */
@@ -26,7 +27,15 @@ public PerRequestBatchedInvocationInput(
     invocationInputs =
         requests.stream()
             .map(request -> new GraphQLSingleInvocationInput(request, schema, context, root))
-            .collect(Collectors.toList());
+            .collect(toList());
     this.contextSetting = contextSetting;
   }
+
+  @Override
+  public List<String> getQueries() {
+    return invocationInputs.stream()
+        .map(GraphQLSingleInvocationInput::getQueries)
+        .flatMap(List::stream)
+        .collect(toList());
+  }
 }

graphql-java-servlet/src/main/java/graphql/kickstart/servlet/HttpRequestInvokerImpl.java

@@ -13,7 +13,6 @@
 import graphql.kickstart.servlet.input.BatchInputPreProcessor;
 import java.io.IOException;
 import java.io.UncheckedIOException;
-import java.util.Optional;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
@@ -58,14 +57,27 @@ private void invokeAndHandleAsync(
     asyncContext.setTimeout(configuration.getAsyncTimeout());
     AtomicReference<FutureExecutionResult> futureHolder = new AtomicReference<>();
     AsyncTimeoutListener timeoutListener =
-        event -> Optional.ofNullable(futureHolder.get()).ifPresent(FutureExecutionResult::cancel);
+        event -> {
+          log.warn(
+              "GraphQL execution canceled because timeout of "
+                  + configuration.getAsyncTimeout()
+                  + " millis was reached. The following query was being executed when this happened:\n{}",
+              String.join("\n", invocationInput.getQueries()));
+          FutureExecutionResult futureResult = futureHolder.get();
+          if (futureResult != null) {
+            futureResult.cancel();
+          } else {
+            writeErrorResponse(
+                invocationInput, request, response, listenerHandler, new CancellationException());
+          }
+        };
     asyncContext.addListener(timeoutListener);
     asyncContext.start(
         () -> {
           FutureExecutionResult futureResult = invoke(invocationInput, request, response);
           futureHolder.set(futureResult);
           handle(futureResult, request, response, listenerHandler)
-            .thenAccept(it -> asyncContext.complete());
+              .thenAccept(it -> asyncContext.complete());
         });
   }