add concept of GraphQLInvocation

test

Author: andimarek

README.md

@@ -1,3 +1,4 @@
+# THIS IS STILL WIP AND NOT RELEASED YET
 # GraphQL Java Spring
 
 
@@ -9,10 +10,18 @@ While the GraphQL Specification itself doesn't specify any transport protocol th
 Goals / Design:
 
 - Just HTTP JSON: the current focus is on HTTP execution via JSON.
-- Minimal Dependencies: the only dependencies are GraphQL Java and Spring projects.
+- Minimal Dependencies: the only dependencies are GraphQL Java and Spring projects (including Jackson for JSON handling).
 - No additional abstraction layer on top of GraphQL Java: GraphQL Java is meant to be used directly. 
 
 
+## Supported HTTP Requests
+
+As outlined in https://graphql.org/learn/serving-over-http this project supports:
+
+1. GET request with `query`, `operationName` and `variables` parameters. The variable parameters are json encoded
+2. POST request with body `application/json` and keys `query` (string), `operationName` (string) and `variables` (map).
+
+Both produce `application/json`.
 
 ## Spring Boot Starter
 
@@ -39,3 +48,9 @@ or to your `pom.xml`
 </dependency>
 
 ```
+
+## Spring Web Artifact
+
+We also provide a artifact for non Boot Application. 
+
+

graphql-java-spring-web/build.gradle

@@ -1,6 +1,15 @@
+def springVersion = "5.1.2.RELEASE"
+def jacksonVersion = "2.9.6"
+def graphqlJavaVersion = "11.0"
 
 dependencies {
-    compile "org.springframework:spring-web:5.1.2.RELEASE"
-    compile "com.graphql-java:graphql-java:11.0"
+    compile "org.springframework:spring-webmvc:$springVersion"
+    compile "org.springframework:spring-context:$springVersion"
+    compile "com.fasterxml.jackson.core:jackson-databind:$jacksonVersion"
+    compile "com.graphql-java:graphql-java:$graphqlJavaVersion"
+    compile "javax.servlet:javax.servlet-api:4.0.1"
+
     testCompile group: 'junit', name: 'junit', version: '4.12'
+    testCompile "org.springframework:spring-test:$springVersion"
+    testCompile "org.mockito:mockito-core:2.+"
 }

graphql-java-spring-web/src/main/java/graphql/spring/controller/DefaultGraphQLInvocation.java

@@ -0,0 +1,31 @@
+package graphql.spring.controller;
+
+import graphql.ExecutionInput;
+import graphql.ExecutionResult;
+import graphql.GraphQL;
+import graphql.Internal;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.web.context.request.WebRequest;
+
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+
+@Component
+@Internal
+public class DefaultGraphQLInvocation implements GraphQLInvocation {
+
+    @Autowired
+    private GraphQL graphQL;
+
+    @Override
+    public CompletableFuture<Map<String, Object>> invoke(GraphQLInvocationData invocationData, WebRequest webRequest) {
+        ExecutionInput executionInput = ExecutionInput.newExecutionInput()
+                .query(invocationData.getQuery())
+                .operationName(invocationData.getOperationName())
+                .variables(invocationData.getVariables())
+                .build();
+        return graphQL.executeAsync(executionInput).thenApply(ExecutionResult::toSpecification);
+    }
+
+}

graphql-java-spring-web/src/main/java/graphql/spring/controller/GraphQLController.java

@@ -1,46 +1,61 @@
 package graphql.spring.controller;
 
 
-import graphql.ExecutionInput;
-import graphql.GraphQL;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import graphql.Internal;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.context.request.WebRequest;
 
-import java.util.LinkedHashMap;
+import java.io.IOException;
 import java.util.Map;
 
 @RestController
+@Internal
 public class GraphQLController {
 
     @Autowired
-    private GraphQL graphql;
+    private GraphQLInvocation graphQLInvocation;
 
-
-    @RequestMapping(value = "${graphql.url:graphql}", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
-    public Map<String, Object> graphql(@RequestBody Map<String, Object> body) {
-        String query = (String) body.get("query");
+    @Autowired
+    private ObjectMapper objectMapper;
+
+    @RequestMapping(value = "${graphql.url:graphql}",
+            method = RequestMethod.POST,
+            consumes = MediaType.APPLICATION_JSON_VALUE,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    public Object graphqlPOST(@RequestBody GraphQLRequestBody body, WebRequest webRequest) {
+        String query = body.getQuery();
         if (query == null) {
             query = "";
         }
-        String operationName = (String) body.get("operationName");
-        Map<String, Object> variables = (Map<String, Object>) body.get("variables");
-        if (variables == null) {
-            variables = new LinkedHashMap<>();
-        }
-        return executeGraphqlQuery(query, operationName, variables);
+        return graphQLInvocation.invoke(new GraphQLInvocationData(query, body.getOperationName(), body.getVariables()), webRequest);
+    }
+
+    @RequestMapping(value = "${graphql.url:graphql}",
+            method = RequestMethod.GET,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    public Object graphqlGET(
+            @RequestParam("query") String query,
+            @RequestParam(value = "operationName", required = false) String operationName,
+            @RequestParam(value = "variables", required = false) String variablesJson,
+            WebRequest webRequest) {
+        return graphQLInvocation.invoke(new GraphQLInvocationData(query, operationName, convertVariablesJson(variablesJson)), webRequest);
     }
 
-    private Map<String, Object> executeGraphqlQuery(String query, String operationName, Map<String, Object> variables) {
-        ExecutionInput executionInput = ExecutionInput.newExecutionInput()
-                .query(query)
-                .operationName(operationName)
-                .variables(variables)
-                .build();
-        return this.graphql.execute(executionInput).toSpecification();
+    private Map<String, Object> convertVariablesJson(String jsonMap) {
+        try {
+            return objectMapper.readValue(jsonMap, Map.class);
+        } catch (IOException e) {
+            throw new RuntimeException("Could not convert variables GET parameter: expected a JSON map", e);
+        }
+
     }
 
+
 }

graphql-java-spring-web/src/main/java/graphql/spring/controller/GraphQLInvocation.java

@@ -0,0 +1,11 @@
+package graphql.spring.controller;
+
+import graphql.PublicApi;
+import org.springframework.web.context.request.WebRequest;
+
+@PublicApi
+public interface GraphQLInvocation {
+
+    Object invoke(GraphQLInvocationData invocationData, WebRequest webRequest);
+
+}

graphql-java-spring-web/src/main/java/graphql/spring/controller/GraphQLInvocationData.java

@@ -0,0 +1,33 @@
+package graphql.spring.controller;
+
+import graphql.Assert;
+import graphql.PublicApi;
+
+import java.util.Collections;
+import java.util.Map;
+
+@PublicApi
+public class GraphQLInvocationData {
+
+    private final String query;
+    private final String operationName;
+    private final Map<String, Object> variables;
+
+    public GraphQLInvocationData(String query, String operationName, Map<String, Object> variables) {
+        this.query = Assert.assertNotNull(query, "query must be provided");
+        this.operationName = operationName;
+        this.variables = variables != null ? variables : Collections.emptyMap();
+    }
+
+    public String getQuery() {
+        return query;
+    }
+
+    public String getOperationName() {
+        return operationName;
+    }
+
+    public Map<String, Object> getVariables() {
+        return variables;
+    }
+}

graphql-java-spring-web/src/main/java/graphql/spring/controller/GraphQLRequestBody.java

@@ -0,0 +1,36 @@
+package graphql.spring.controller;
+
+import graphql.Internal;
+
+import java.util.Map;
+
+@Internal
+public class GraphQLRequestBody {
+    private String query;
+    private String operationName;
+    private Map<String, Object> variables;
+
+    public String getQuery() {
+        return query;
+    }
+
+    public void setQuery(String query) {
+        this.query = query;
+    }
+
+    public String getOperationName() {
+        return operationName;
+    }
+
+    public void setOperationName(String operationName) {
+        this.operationName = operationName;
+    }
+
+    public Map<String, Object> getVariables() {
+        return variables;
+    }
+
+    public void setVariables(Map<String, Object> variables) {
+        this.variables = variables;
+    }
+}

graphql-java-spring-web/src/test/java/graphql/spring/controller/GraphQLControllerTest.java

@@ -0,0 +1,47 @@
+package graphql.spring.controller;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = {TestAppConfig.class})
+@WebAppConfiguration
+public class GraphQLControllerTest {
+
+    private MockMvc mockMvc;
+
+    @Autowired
+    private WebApplicationContext wac;
+
+    @Before
+    public void setup() throws Exception {
+        this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
+    }
+
+
+    @Test
+    public void testVariableJson() throws Exception {
+        String query = "{foo}";
+        String variablesJson = "{\"key\":\"value\"}";
+        MvcResult mvcResult = this.mockMvc.perform(get("/graphql")
+                .param("query", query)
+                .param("variables", variablesJson))
+                .andDo(print()).andExpect(status().isOk())
+                .andReturn();
+
+    }
+
+}

graphql-java-spring-web/src/test/java/graphql/spring/controller/TestAppConfig.java

@@ -0,0 +1,38 @@
+package graphql.spring.controller;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import graphql.ExecutionInput;
+import graphql.ExecutionResultImpl;
+import graphql.GraphQL;
+import org.mockito.ArgumentMatchers;
+import org.mockito.Mockito;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+
+import java.util.concurrent.CompletableFuture;
+
+@Configuration
+@EnableWebMvc
+@ComponentScan(basePackageClasses = GraphQLController.class)
+public class TestAppConfig {
+
+
+    @Bean
+    public GraphQL graphQL() {
+        GraphQL graphql = Mockito.mock(GraphQL.class);
+        ExecutionResultImpl executionResult = ExecutionResultImpl.newExecutionResult()
+                .data("foo")
+                .build();
+        CompletableFuture cf = CompletableFuture.completedFuture(executionResult);
+        Mockito.when(graphql.executeAsync(ArgumentMatchers.<ExecutionInput>any())).thenReturn(cf);
+        return graphql;
+    }
+
+    @Bean
+    public ObjectMapper objectMapper() {
+        return new ObjectMapper();
+    }
+
+}