Merge pull request #8 from graphql-java-kickstart/feature/custom-headers

Feature/custom headers

Author: oliemansm

gradle.properties

@@ -1,4 +1,4 @@
-version=0.2.0-SNAPSHOT
+version=0.3.0-SNAPSHOT
 
 PROJECT_GROUP = com.graphql-java-kickstart
 PROJECT_NAME = graphql-spring-webclient
@@ -17,6 +17,8 @@ LIB_PROJECT_REACTOR_VER = 1.0.1
 
 LIB_GRAPHQL_TOOLS_VER = 6.0.0
 LIB_GRAPHQL_SPRING_VER = 7.0.0
+LIB_GRAPHQL_JAVA_VER = 14.0
+LIB_GRAPHQL_SERVLET_VER = 9.0.1
 
 ### Gradle Plugins
 

graphql-webclient/build.gradle

@@ -6,4 +6,6 @@ dependencies {
     testImplementation "com.graphql-java-kickstart:graphql-kickstart-spring-boot-starter-webflux:$LIB_GRAPHQL_SPRING_VER"
     testImplementation "com.graphql-java-kickstart:graphql-kickstart-spring-boot-starter-tools:$LIB_GRAPHQL_SPRING_VER"
     testImplementation "com.graphql-java-kickstart:graphql-java-tools:$LIB_GRAPHQL_TOOLS_VER"
+    testImplementation "com.graphql-java-kickstart:graphql-kickstart-spring-support:$LIB_GRAPHQL_SPRING_VER"
+    testImplementation "com.graphql-java-kickstart:graphql-java-kickstart:$LIB_GRAPHQL_SERVLET_VER"
 }

graphql-webclient/src/main/java/graphql/kickstart/spring/webclient/boot/GraphQLRequest.java

@@ -1,14 +1,21 @@
 package graphql.kickstart.spring.webclient.boot;
 
-import lombok.Builder;
-import lombok.Value;
+import org.springframework.http.HttpHeaders;
 
-@Value
-@Builder
-class GraphQLRequest {
+public interface GraphQLRequest<T> {
 
-  String query;
-  Object variables;
-  String operationName;
+  static GraphQLRequestBuilder<Object> builder() {
+    return new GraphQLRequestBuilder<>(Object.class);
+  }
+
+  static <T> GraphQLRequestBuilder<T> builder(Class<T> returnType) {
+    return new GraphQLRequestBuilder<>(returnType);
+  }
+
+  GraphQLRequestBody getRequestBody();
+
+  HttpHeaders getHeaders();
+
+  Class<T> getReturnType();
 
 }

graphql-webclient/src/main/java/graphql/kickstart/spring/webclient/boot/GraphQLRequestBody.java

@@ -0,0 +1,22 @@
+package graphql.kickstart.spring.webclient.boot;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+class GraphQLRequestBody {
+
+  String query;
+  Object variables;
+  String operationName;
+
+  static GraphQLRequestBodyBuilder builder() {
+    return new GraphQLRequestBodyBuilder();
+  }
+
+  static class GraphQLRequestBodyBuilder {
+    // added this partial builder to let Javadoc play nice with Lombok, see https://stackoverflow.com/a/58809436/12507062
+  }
+
+}

graphql-webclient/src/main/java/graphql/kickstart/spring/webclient/boot/GraphQLRequestBuilder.java

@@ -0,0 +1,67 @@
+package graphql.kickstart.spring.webclient.boot;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
+import lombok.SneakyThrows;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.core.io.Resource;
+import org.springframework.http.HttpHeaders;
+import org.springframework.util.StreamUtils;
+
+public class GraphQLRequestBuilder<T> {
+
+  private final HttpHeaders headers = new HttpHeaders();
+  private final GraphQLRequestBody.GraphQLRequestBodyBuilder bodyBuilder = GraphQLRequestBody.builder();
+  private final Class<T> returnType;
+
+  GraphQLRequestBuilder(Class<T> returnType) {
+    this.returnType = returnType;
+  }
+
+  public GraphQLRequestBuilder<T> header(String name, String value) {
+    headers.add(name, value);
+    return this;
+  }
+
+  public GraphQLRequestBuilder<T> header(String name, String... values) {
+    headers.addAll(name, Arrays.asList(values));
+    return this;
+  }
+
+  public GraphQLRequestBuilder<T> resource(String resource) {
+    return query(loadQuery(resource));
+  }
+
+  @SneakyThrows
+  private String loadQuery(String path) {
+    return loadResource(new ClassPathResource(path));
+  }
+
+  private String loadResource(Resource resource) throws IOException {
+    try (InputStream inputStream = resource.getInputStream()) {
+      return StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
+    }
+  }
+
+  public GraphQLRequestBuilder<T> query(String query) {
+    bodyBuilder.query(query);
+    return this;
+  }
+
+  public GraphQLRequestBuilder<T> variables(Object variables) {
+    bodyBuilder.variables(variables);
+    return this;
+  }
+
+  public GraphQLRequestBuilder<T> operationName(String operationName) {
+    bodyBuilder.operationName(operationName);
+    return this;
+  }
+
+  public GraphQLRequest<T> build() {
+    return new GraphQLRequestImpl<>(headers, bodyBuilder.build(), returnType);
+  }
+
+}

graphql-webclient/src/main/java/graphql/kickstart/spring/webclient/boot/GraphQLRequestImpl.java

@@ -0,0 +1,13 @@
+package graphql.kickstart.spring.webclient.boot;
+
+import lombok.Value;
+import org.springframework.http.HttpHeaders;
+
+@Value
+class GraphQLRequestImpl<T> implements GraphQLRequest<T> {
+
+  HttpHeaders headers;
+  GraphQLRequestBody requestBody;
+  Class<T> returnType;
+
+}

graphql-webclient/src/main/java/graphql/kickstart/spring/webclient/boot/GraphQLWebClient.java

@@ -16,8 +16,12 @@ static GraphQLWebClient newInstance(WebClient webClient, ObjectMapper objectMapp
 
   <T> Mono<T> post(String resource, Map<String, Object> variables, Class<T> returnType);
 
+  <T> Mono<T> post(GraphQLRequest<T> request);
+
   <T> Flux<T> flux(String resource, Class<T> returnType);
 
   <T> Flux<T> flux(String resource, Map<String, Object> variables, Class<T> returnType);
 
+  @SuppressWarnings("unchecked")
+  <T> Flux<T> flux(GraphQLRequest<T> request);
 }

graphql-webclient/src/main/java/graphql/kickstart/spring/webclient/boot/GraphQLWebClientImpl.java

@@ -1,18 +1,12 @@
 package graphql.kickstart.spring.webclient.boot;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import java.io.IOException;
-import java.io.InputStream;
-import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.Map;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.core.io.ClassPathResource;
-import org.springframework.core.io.Resource;
 import org.springframework.http.MediaType;
-import org.springframework.util.StreamUtils;
 import org.springframework.web.reactive.function.client.WebClient;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
@@ -40,15 +34,9 @@ private <T> T readValue(Object value, Class<T> returnType) {
     return objectMapper.convertValue(value, returnType);
   }
 
-  @SneakyThrows
-  private String loadQuery(String path) {
-    return loadResource(new ClassPathResource(path));
-  }
-
-  private String loadResource(Resource resource) throws IOException {
-    try (InputStream inputStream = resource.getInputStream()) {
-      return StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
-    }
+  @Override
+  public <T> Mono<T> post(GraphQLRequest<T> request) {
+    return execute(request).map(it -> readValue(it, request.getReturnType()));
   }
 
   @Override
@@ -66,15 +54,28 @@ public <T> Flux<T> flux(String resource, Map<String, Object> variables, Class<T>
         .map(it -> readValue(it, returnType));
   }
 
+  @Override
+  @SuppressWarnings("unchecked")
+  public <T> Flux<T> flux(GraphQLRequest<T> request) {
+    Mono<Object> responseObject = execute(request);
+    return responseObject.map(List.class::cast)
+        .flatMapMany(Flux::fromIterable)
+        .map(it -> readValue(it, request.getReturnType()));
+  }
+
   private Mono<Object> execute(String resource, Map<String, Object> variables) {
-    GraphQLRequest request = GraphQLRequest.builder()
-        .query(loadQuery(resource))
+    GraphQLRequest<?> request = GraphQLRequest.builder(Object.class)
+        .resource(resource)
         .variables(variables)
         .build();
+    return execute(request);
+  }
 
-    return webClient.post()
-        .contentType(MediaType.APPLICATION_JSON)
-        .bodyValue(request)
+  private Mono<Object> execute(GraphQLRequest<?> request) {
+    WebClient.RequestBodySpec spec = webClient.post()
+        .contentType(MediaType.APPLICATION_JSON);
+    request.getHeaders().forEach((header, values) -> spec.header(header, values.toArray(new String[0])));
+    return spec.bodyValue(request.getRequestBody())
         .retrieve()
         .bodyToMono(GraphQLResponse.class)
         .flatMap(it -> Mono.justOrEmpty(it.getFirstObject()));

graphql-webclient/src/test/java/graphql/kickstart/spring/webclient/boot/GraphQLWebClientTest.java

@@ -66,6 +66,19 @@ void simpleTypeSucceeds() {
     assertEquals("response id should equal 'my-id'", "my-id", object.getId());
   }
 
+  @Test
+  void simpleTypeAsRequestSucceeds() {
+    GraphQLRequest<Simple> request = GraphQLRequest.builder(Simple.class)
+        .resource("query-simple.graphql")
+        .variables(Map.of("id", "my-id"))
+        .build();
+    Mono<Simple> response = graphqlClient.post(request);
+    assertNotNull("response should not be null", response);
+    Simple object = response.block();
+    assertNotNull(object);
+    assertEquals("response id should equal 'my-id'", "my-id", object.getId());
+  }
+
   @Test
   void errorResponseSucceeds() {
     Mono<String> response = graphqlClient.post("error.graphql", String.class);
@@ -87,4 +100,16 @@ void listSucceeds() {
     assertEquals(1, list.size());
   }
 
+  @Test
+  void headerIsAdded() {
+    GraphQLRequest<String> request = GraphQLRequest.builder(String.class)
+        .resource("query-header.graphql")
+        .variables(Map.of("name", "my-custom-header"))
+        .header("my-custom-header", "my-custom-header-value")
+        .build();
+    Mono<String> response = graphqlClient.post(request);
+    assertNotNull("response should not be null", response);
+    assertEquals("response should equal 'my-custom-header-value'", "my-custom-header-value", response.block());
+  }
+
 }

graphql-webclient/src/test/java/graphql/kickstart/spring/webclient/testapp/Query.java

@@ -2,7 +2,9 @@
 
 import static java.util.Collections.singletonList;
 
+import graphql.kickstart.spring.GraphQLSpringContext;
 import graphql.kickstart.tools.GraphQLQueryResolver;
+import graphql.schema.DataFetchingEnvironment;
 import java.util.List;
 import org.springframework.stereotype.Component;
 
@@ -29,4 +31,13 @@ List<Simple> list() {
     return singletonList(simple("1"));
   }
 
+  String header(String name, DataFetchingEnvironment env) {
+    GraphQLSpringContext context = env.getContext();
+    List<String> headers = context.getServerWebExchange().getRequest().getHeaders().get(name);
+    if (headers != null && !headers.isEmpty()) {
+      return headers.get(0);
+    }
+    return null;
+  }
+
 }