feat(#322): send csrf header in voyager request

Author: oliemansm

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/EditorConstants.java

@@ -0,0 +1,10 @@
+package graphql.kickstart.autoconfigure.editor;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class EditorConstants {
+
+  public static final String CSRF_ATTRIBUTE_NAME = "_csrf";
+}

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/altair/AltairAutoConfiguration.java

@@ -17,7 +17,10 @@ public class AltairAutoConfiguration {
 
   @Bean
   @ConditionalOnProperty(value = "graphql.altair.enabled", havingValue = "true")
-  AltairController altairController() {
-    return new AltairController();
+  AltairController altairController(
+      AltairProperties altairProperties,
+      AltairOptions altairOptions,
+      AltairResources altairResources) {
+    return new AltairController(altairProperties, altairOptions, altairResources);
   }
 }

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/altair/AltairController.java

@@ -13,12 +13,12 @@
 import java.util.Map;
 import javax.annotation.PostConstruct;
 import javax.servlet.http.HttpServletResponse;
+import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import lombok.val;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.text.StringSubstitutor;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.stereotype.Controller;
 import org.springframework.util.StreamUtils;
@@ -27,14 +27,15 @@
 /** @author Moncef AOUDIA */
 @Slf4j
 @Controller
+@RequiredArgsConstructor
 public class AltairController {
 
   private static final String CDN_JSDELIVR_NET_NPM = "//cdn.jsdelivr.net/npm/";
   private static final String ALTAIR = "altair-static";
   private final ObjectMapper objectMapper = new ObjectMapper();
-  @Autowired private AltairProperties altairProperties;
-  @Autowired private AltairOptions altairOptions;
-  @Autowired private AltairResources altairResources;
+  private final AltairProperties altairProperties;
+  private final AltairOptions altairOptions;
+  private final AltairResources altairResources;
 
   private String template;
 

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/voyager/ReactiveVoyagerAutoConfiguration.java

@@ -1,5 +1,6 @@
 package graphql.kickstart.autoconfigure.editor.voyager;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/voyager/ReactiveVoyagerController.java

@@ -1,5 +1,7 @@
 package graphql.kickstart.autoconfigure.editor.voyager;
 
+import static graphql.kickstart.autoconfigure.editor.EditorConstants.CSRF_ATTRIBUTE_NAME;
+
 import java.io.IOException;
 import java.util.Map;
 import lombok.RequiredArgsConstructor;
@@ -9,6 +11,7 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestAttribute;
 
 /** @author Max David Günther */
 @Controller
@@ -18,10 +21,12 @@ public class ReactiveVoyagerController {
   @Autowired private VoyagerIndexHtmlTemplate indexTemplate;
 
   @GetMapping(path = "${graphql.voyager.mapping:/voyager}")
-  public ResponseEntity<String> voyager(@PathVariable Map<String, String> params)
+  public ResponseEntity<String> voyager(
+      final @RequestAttribute(value = CSRF_ATTRIBUTE_NAME, required = false) Object csrf,
+      @PathVariable Map<String, String> params)
       throws IOException {
     // no context path in spring-webflux
-    String indexHtmlContent = indexTemplate.fillIndexTemplate("", params);
+    String indexHtmlContent = indexTemplate.fillIndexTemplate("", csrf, params);
     return ResponseEntity.ok()
         .contentType(MediaType.valueOf("text/html; charset=UTF-8"))
         .body(indexHtmlContent);

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/voyager/VoyagerAutoConfiguration.java

@@ -1,5 +1,6 @@
 package graphql.kickstart.autoconfigure.editor.voyager;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -17,8 +18,8 @@
 public class VoyagerAutoConfiguration {
 
   @Bean
-  VoyagerController voyagerController() {
-    return new VoyagerController();
+  VoyagerController voyagerController(VoyagerIndexHtmlTemplate voyagerIndexHtmlTemplate) {
+    return new VoyagerController(voyagerIndexHtmlTemplate);
   }
 
   @Bean

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/voyager/VoyagerController.java

@@ -1,26 +1,34 @@
 package graphql.kickstart.autoconfigure.editor.voyager;
 
+import static graphql.kickstart.autoconfigure.editor.EditorConstants.CSRF_ATTRIBUTE_NAME;
+
 import java.io.IOException;
 import java.util.Map;
 import javax.servlet.http.HttpServletRequest;
+import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestAttribute;
 
 /** @author Max David Günther */
 @Controller
+@RequiredArgsConstructor
 public class VoyagerController {
 
-  @Autowired private VoyagerIndexHtmlTemplate indexTemplate;
+  private final VoyagerIndexHtmlTemplate indexTemplate;
 
   @GetMapping(value = "${graphql.voyager.mapping:/voyager}")
   public ResponseEntity<String> voyager(
-      HttpServletRequest request, @PathVariable Map<String, String> params) throws IOException {
+      HttpServletRequest request,
+      final @RequestAttribute(value = CSRF_ATTRIBUTE_NAME, required = false) Object csrf,
+      @PathVariable Map<String, String> params)
+      throws IOException {
     String contextPath = request.getContextPath();
-    String indexHtmlContent = indexTemplate.fillIndexTemplate(contextPath, params);
+    String indexHtmlContent = indexTemplate.fillIndexTemplate(contextPath, csrf, params);
     return ResponseEntity.ok()
         .contentType(MediaType.valueOf("text/html; charset=UTF-8"))
         .body(indexHtmlContent);

graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/voyager/VoyagerIndexHtmlTemplate.java

@@ -1,5 +1,8 @@
 package graphql.kickstart.autoconfigure.editor.voyager;
 
+import static graphql.kickstart.autoconfigure.editor.EditorConstants.CSRF_ATTRIBUTE_NAME;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.util.HashMap;
@@ -21,9 +24,10 @@ public class VoyagerIndexHtmlTemplate {
   private static final String FAVICON_APIS_GURU =
       "//apis.guru/graphql-voyager/icons/favicon-16x16.png";
 
+  private final ObjectMapper objectMapper = new ObjectMapper();
   private final VoyagerPropertiesConfiguration voyagerConfiguration;
 
-  public String fillIndexTemplate(String contextPath, Map<String, String> params)
+  public String fillIndexTemplate(String contextPath, Object csrf, Map<String, String> params)
       throws IOException {
     String template =
         StreamUtils.copyToString(
@@ -34,6 +38,11 @@ public String fillIndexTemplate(String contextPath, Map<String, String> params)
     String voyagerCdnVersion = voyagerConfiguration.getCdn().getVersion();
 
     Map<String, String> replacements = new HashMap<>();
+    if (csrf != null) {
+      replacements.put(CSRF_ATTRIBUTE_NAME, objectMapper.writeValueAsString(csrf));
+    } else {
+      replacements.put(CSRF_ATTRIBUTE_NAME, "null");
+    }
     replacements.put("graphqlEndpoint", constructGraphQlEndpoint(contextPath, params));
     replacements.put("pageTitle", voyagerConfiguration.getPageTitle());
     replacements.put("pageFavicon", getResourceUrl(basePath, "favicon.ico", FAVICON_APIS_GURU));