Merge pull request #144 from vinayknl/connection-async

Add option to use Asynchronous loading of connection data.

Author: guy120494

src/main/java/graphql/annotations/connection/GraphQLConnection.java

@@ -52,4 +52,11 @@
      * @return a connection validator
      */
     Class <? extends ConnectionValidator> validator() default PaginatedDataConnectionTypeValidator.class;
+
+    /**
+     * By default, the paginated data is fetched synchronously. If explicitly specified, asynchronous data fetching
+     * will be used.
+     * @return if async fetching to be used.
+     */
+    boolean async() default false;
 }

src/main/java/graphql/annotations/dataFetchers/connection/AsyncConnectionDataFetcher.java

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2016 Yurii Rashkovskii
+ *
+ * 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
+ */
+package graphql.annotations.dataFetchers.connection;
+
+import graphql.schema.DataFetcher;
+import graphql.schema.DataFetchingEnvironment;
+
+import java.util.concurrent.CompletableFuture;
+
+import static java.util.concurrent.CompletableFuture.supplyAsync;
+
+public class AsyncConnectionDataFetcher<T> implements DataFetcher<CompletableFuture<graphql.relay.Connection<T>>> {
+    private final ConnectionDataFetcher connectionDataFetcher;
+
+    @SuppressWarnings("unchecked")
+    public AsyncConnectionDataFetcher(ConnectionDataFetcher connectionFetcher) {
+        this.connectionDataFetcher = connectionFetcher;
+    }
+
+    @Override
+    public CompletableFuture<graphql.relay.Connection<T>> get(DataFetchingEnvironment environment) {
+        return supplyAsync(() -> connectionDataFetcher.get(environment));
+    }
+}

src/main/java/graphql/annotations/processor/retrievers/fieldBuilders/field/FieldDataFetcherBuilder.java

@@ -19,17 +19,20 @@
 import graphql.annotations.connection.GraphQLConnection;
 import graphql.annotations.dataFetchers.ExtensionDataFetcherWrapper;
 import graphql.annotations.dataFetchers.MethodDataFetcher;
-import graphql.annotations.dataFetchers.connection.ConnectionDataFetcher;
 import graphql.annotations.processor.ProcessingElementsContainer;
 import graphql.annotations.processor.retrievers.fieldBuilders.Builder;
 import graphql.annotations.processor.typeFunctions.TypeFunction;
 import graphql.annotations.processor.util.DataFetcherConstructor;
-import graphql.schema.*;
+import graphql.schema.DataFetcher;
+import graphql.schema.GraphQLNonNull;
+import graphql.schema.GraphQLType;
+import graphql.schema.PropertyDataFetcher;
 
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 
 import static graphql.Scalars.GraphQLBoolean;
+import static graphql.annotations.processor.util.ConnectionUtil.getConnectionDataFetcher;
 import static java.util.Objects.nonNull;
 
 public class FieldDataFetcherBuilder implements Builder<DataFetcher> {
@@ -61,9 +64,8 @@ public DataFetcher build() {
             actualDataFetcher = handleNullCase(actualDataFetcher);
         }
 
-
         if (isConnection) {
-            actualDataFetcher = new ConnectionDataFetcher(field.getAnnotation(GraphQLConnection.class).connection(), actualDataFetcher);
+            actualDataFetcher = getConnectionDataFetcher(field.getAnnotation(GraphQLConnection.class), actualDataFetcher);
         }
         return actualDataFetcher;
     }
@@ -75,7 +77,7 @@ private DataFetcher handleNullCase(DataFetcher actualDataFetcher) {
             actualDataFetcher = getBooleanDataFetcher(actualDataFetcher);
         } else if (checkIfPrefixGetterExists(field.getDeclaringClass(), "get", field.getName())) {
             actualDataFetcher = wrapExtension(new PropertyDataFetcher(field.getName()), field);
-        } else{
+        } else {
             actualDataFetcher = getDataFetcherWithFluentGetter(actualDataFetcher);
         }
 

src/main/java/graphql/annotations/processor/retrievers/fieldBuilders/method/MethodDataFetcherBuilder.java

@@ -21,7 +21,6 @@
 import graphql.annotations.dataFetchers.BatchedMethodDataFetcher;
 import graphql.annotations.dataFetchers.MethodDataFetcher;
 import graphql.annotations.dataFetchers.RelayMutationMethodDataFetcher;
-import graphql.annotations.dataFetchers.connection.ConnectionDataFetcher;
 import graphql.annotations.processor.ProcessingElementsContainer;
 import graphql.annotations.processor.retrievers.fieldBuilders.Builder;
 import graphql.annotations.processor.typeFunctions.TypeFunction;
@@ -34,6 +33,8 @@
 import java.lang.reflect.Method;
 import java.util.List;
 
+import static graphql.annotations.processor.util.ConnectionUtil.getConnectionDataFetcher;
+
 public class MethodDataFetcherBuilder implements Builder<DataFetcher> {
     private Method method;
     private GraphQLOutputType outputType;
@@ -74,7 +75,7 @@ public DataFetcher build() {
         }
 
         if (isConnection){
-            actualDataFetcher = new ConnectionDataFetcher(method.getAnnotation(GraphQLConnection.class).connection(), actualDataFetcher);
+            actualDataFetcher = getConnectionDataFetcher(method.getAnnotation(GraphQLConnection.class), actualDataFetcher);
         }
         return actualDataFetcher;
     }

src/main/java/graphql/annotations/processor/util/ConnectionUtil.java

@@ -16,6 +16,8 @@
 
 import graphql.annotations.connection.ConnectionValidator;
 import graphql.annotations.connection.GraphQLConnection;
+import graphql.annotations.dataFetchers.connection.AsyncConnectionDataFetcher;
+import graphql.annotations.dataFetchers.connection.ConnectionDataFetcher;
 import graphql.schema.*;
 
 import java.lang.reflect.AccessibleObject;
@@ -45,4 +47,12 @@ public static boolean isConnection(AccessibleObject obj, GraphQLType type) {
         }
     }
 
+    public static DataFetcher getConnectionDataFetcher(GraphQLConnection connectionAnnotation, DataFetcher actualDataFetcher) {
+        actualDataFetcher = new ConnectionDataFetcher(connectionAnnotation.connection(), actualDataFetcher);
+        if (connectionAnnotation.async()) {
+            actualDataFetcher = new AsyncConnectionDataFetcher((ConnectionDataFetcher) actualDataFetcher);
+        }
+        return actualDataFetcher;
+    }
+
 }

src/test/java/graphql/annotations/connection/GraphQLEnhancedConnectionTest.java

@@ -81,6 +81,11 @@ public static class TestListField {
         @GraphQLDataFetcher(GoodConnectionDataFetcher.class)
         public PaginatedData<Obj> objs;
 
+        @GraphQLField
+        @GraphQLConnection(connection = PaginatedDataConnectionFetcher.class, async = true)
+        @GraphQLDataFetcher(GoodConnectionDataFetcher.class)
+        public PaginatedData<Obj> objsAsync;
+
         public TestListField(PaginatedData<Obj> objs) {
             this.objs = objs;
         }
@@ -148,6 +153,21 @@ public void validDatafetcher_queryForCursors_getValidCursors() throws Exception
         assertEquals(edges.get(1).get("cursor"), "2");
     }
 
+    @Test
+    public void fetchConnectionAsync() throws Exception {
+        //Arrange
+        ExecutionInput executionInput = new ExecutionInput("{ objsAsync(first:2) { edges { cursor } } }",
+                null, "CONTEXT", null, null);
+        //Act
+        ExecutionResult result = graphQL.execute(executionInput);
+        Map<String, Map<String, List<Map<String, Map<String, Object>>>>> data = result.getData();
+        List<Map<String, Map<String, Object>>> edges = data.get("objsAsync").get("edges");
+
+        //Assert
+        assertEquals(edges.get(0).get("cursor"), "1");
+        assertEquals(edges.get(1).get("cursor"), "2");
+    }
+
     @Test
     public void validDatafetcher_queryForValues_returnsValidValues() throws Exception {
         //Arrange