feat: move playground into main starter

Author: oliemansm

example-webflux/build.gradle

@@ -21,8 +21,6 @@ apply plugin: "org.springframework.boot"
 
 dependencies {
     implementation(project(":graphql-spring-boot-starter"))
-    implementation(project(":voyager-spring-boot-starter"))
-    implementation(project(":playground-spring-boot-starter"))
 
     implementation("org.springframework.boot:spring-boot-starter-webflux:$LIB_SPRING_BOOT_VER")
     implementation("org.springframework.boot:spring-boot-starter-actuator:$LIB_SPRING_BOOT_VER")

graphql-spring-boot-autoconfigure/build.gradle

@@ -55,8 +55,11 @@ dependencies {
     testImplementation "org.springframework.boot:spring-boot-starter-web"
     testImplementation "org.springframework.boot:spring-boot-starter-actuator"
     testImplementation "org.springframework.boot:spring-boot-starter-webflux"
+    testImplementation "org.springframework.boot:spring-boot-starter-security"
+    testImplementation "org.springframework.security:spring-security-test"
     testImplementation "io.projectreactor:reactor-core"
     testImplementation "io.reactivex.rxjava2:rxjava"
+    testImplementation "org.jsoup:jsoup:$LIB_JSOUP_VER"
 }
 
 compileJava.dependsOn(processResources)

playground-spring-boot-autoconfigure/src/main/java/graphql/kickstart/playground/boot/PlaygroundAutoConfiguration.java renamed to graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/playground/PlaygroundAutoConfiguration.java

@@ -1,6 +1,7 @@
-package graphql.kickstart.playground.boot;
+package graphql.kickstart.autoconfigure.editor.playground;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import graphql.kickstart.autoconfigure.editor.playground.properties.PlaygroundProperties;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -9,17 +10,16 @@
 
 @Configuration
 @ConditionalOnWebApplication
-@EnableConfigurationProperties(PlaygroundPropertiesConfiguration.class)
+@EnableConfigurationProperties(PlaygroundProperties.class)
 public class PlaygroundAutoConfiguration {
 
   @Bean
   @ConditionalOnProperty(
       value = "graphql.playground.enabled",
-      havingValue = "true",
-      matchIfMissing = true)
+      havingValue = "true")
   public PlaygroundController playgroundController(
-      final PlaygroundPropertiesConfiguration playgroundPropertiesConfiguration,
+      final PlaygroundProperties playgroundProperties,
       final ObjectMapper objectMapper) {
-    return new PlaygroundController(playgroundPropertiesConfiguration, objectMapper);
+    return new PlaygroundController(playgroundProperties, objectMapper);
   }
 }

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

@@ -0,0 +1,89 @@
+package graphql.kickstart.autoconfigure.editor.playground;
+
+import static java.util.Objects.nonNull;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import graphql.kickstart.autoconfigure.editor.playground.properties.PlaygroundProperties;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.file.Paths;
+import java.util.HashMap;
+import java.util.Map;
+import lombok.RequiredArgsConstructor;
+import org.apache.commons.text.StringSubstitutor;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.util.StreamUtils;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestAttribute;
+
+@Controller
+@RequiredArgsConstructor
+public class PlaygroundController {
+
+  private static final String CDN_ROOT = "https://cdn.jsdelivr.net/npm/graphql-playground-react";
+  private static final String CSS_PATH = "static/css/index.css";
+  private static final String FAVICON_PATH = "favicon.png";
+  private static final String SCRIPT_PATH = "static/js/middleware.js";
+  private static final String LOGO_PATH = "logo.png";
+
+  private static final String CSS_URL_ATTRIBUTE_NAME = "cssUrl";
+  private static final String FAVICON_URL_ATTRIBUTE_NAME = "faviconUrl";
+  private static final String SCRIPT_URL_ATTRIBUTE_NAME = "scriptUrl";
+  private static final String LOGO_URL_ATTRIBUTE_NAME = "logoUrl";
+  private static final String CSRF = "_csrf";
+
+  private final PlaygroundProperties properties;
+
+  private final ObjectMapper objectMapper;
+
+  @GetMapping("${graphql.playground.mapping:/playground}")
+  public String playground(
+      final Model model, final @RequestAttribute(value = CSRF, required = false) Object csrf)
+      throws IOException {
+    String template =
+        StreamUtils.copyToString(
+            new ClassPathResource("templates/playground.html").getInputStream(), Charset.defaultCharset());
+    Map<String, String> replacements = new HashMap<>();
+    if (properties.getCdn().isEnabled()) {
+      addCdnUrls(replacements);
+    } else {
+      addLocalAssetUrls(replacements);
+    }
+    replacements.put("pageTitle", properties.getPageTitle());
+    replacements.put("properties", objectMapper.writeValueAsString(properties));
+    if (nonNull(csrf)) {
+      replacements.put(CSRF, objectMapper.writeValueAsString(csrf));
+    } else {
+      replacements.put(CSRF, null);
+    }
+    return StringSubstitutor.replace(template, replacements);
+  }
+
+  private String getCdnUrl(final String assetPath) {
+    return String.format(
+        "%s@%s/build/%s",
+        CDN_ROOT, properties.getCdn().getVersion(), assetPath);
+  }
+
+  private String getLocalUrl(final String assetPath) {
+    return Paths.get(properties.getStaticPath().getBase(), assetPath)
+        .toString()
+        .replace('\\', '/');
+  }
+
+  private void addCdnUrls(final Map<String, String> replacements) {
+    replacements.put(CSS_URL_ATTRIBUTE_NAME, getCdnUrl(CSS_PATH));
+    replacements.put(FAVICON_URL_ATTRIBUTE_NAME, getCdnUrl(FAVICON_PATH));
+    replacements.put(SCRIPT_URL_ATTRIBUTE_NAME, getCdnUrl(SCRIPT_PATH));
+    replacements.put(LOGO_URL_ATTRIBUTE_NAME, getCdnUrl(LOGO_PATH));
+  }
+
+  private void addLocalAssetUrls(final Map<String, String> replacements) {
+    replacements.put(CSS_URL_ATTRIBUTE_NAME, getLocalUrl(CSS_PATH));
+    replacements.put(FAVICON_URL_ATTRIBUTE_NAME, getLocalUrl(FAVICON_PATH));
+    replacements.put(SCRIPT_URL_ATTRIBUTE_NAME, getLocalUrl(SCRIPT_PATH));
+    replacements.put(LOGO_URL_ATTRIBUTE_NAME, getLocalUrl(LOGO_PATH));
+  }
+}

playground-spring-boot-autoconfigure/src/main/java/graphql/kickstart/playground/boot/PlaygroundPropertiesConfiguration.java renamed to graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/playground/PlaygroundPropertiesConfiguration.java

@@ -1,13 +1,13 @@
-package graphql.kickstart.playground.boot;
+package graphql.kickstart.autoconfigure.editor.playground;
 
-import graphql.kickstart.playground.boot.properties.PlaygroundProperties;
+import graphql.kickstart.autoconfigure.editor.playground.properties.PlaygroundProperties;
 import lombok.Data;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.validation.annotation.Validated;
 
 @Data
-@ConfigurationProperties(prefix = "graphql")
+
 @Validated
 public class PlaygroundPropertiesConfiguration {
 

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

@@ -0,0 +1,27 @@
+package graphql.kickstart.autoconfigure.editor.playground;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.web.reactive.config.WebFluxConfigurer;
+import org.springframework.web.reactive.function.server.RouterFunction;
+import org.springframework.web.reactive.function.server.RouterFunctions;
+import org.springframework.web.reactive.function.server.ServerResponse;
+
+@Configuration
+@Import(PlaygroundWebFluxControllerAdvice.class)
+@ConditionalOnClass(WebFluxConfigurer.class)
+@ConditionalOnProperty(value = "graphql.playground.enabled", havingValue = "true")
+@RequiredArgsConstructor
+public class PlaygroundWebFluxAutoConfiguration implements WebFluxConfigurer {
+
+  @Bean
+  public RouterFunction<ServerResponse> playgroundStaticFilesRouter() {
+    return RouterFunctions.resources(
+        "/vendor/playground/**", new ClassPathResource("static/vendor/playground/"));
+  }
+}

playground-spring-boot-autoconfigure/src/main/java/graphql/kickstart/playground/boot/PlaygroundWebFluxControllerAdvice.java renamed to graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/playground/PlaygroundWebFluxControllerAdvice.java

@@ -1,4 +1,4 @@
-package graphql.kickstart.playground.boot;
+package graphql.kickstart.autoconfigure.editor.playground;
 
 import lombok.NoArgsConstructor;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;

playground-spring-boot-autoconfigure/src/main/java/graphql/kickstart/playground/boot/ResourceSerializer.java renamed to graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/playground/ResourceSerializer.java

@@ -1,4 +1,4 @@
-package graphql.kickstart.playground.boot;
+package graphql.kickstart.autoconfigure.editor.playground;
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.JsonSerializer;

playground-spring-boot-autoconfigure/src/main/java/graphql/kickstart/playground/boot/properties/PlaygroundCdn.java renamed to graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/playground/properties/PlaygroundCdn.java

@@ -1,4 +1,4 @@
-package graphql.kickstart.playground.boot.properties;
+package graphql.kickstart.autoconfigure.editor.playground.properties;
 
 import javax.validation.constraints.NotBlank;
 import lombok.Data;

playground-spring-boot-autoconfigure/src/main/java/graphql/kickstart/playground/boot/properties/PlaygroundProperties.java renamed to graphql-spring-boot-autoconfigure/src/main/java/graphql/kickstart/autoconfigure/editor/playground/properties/PlaygroundProperties.java

@@ -1,4 +1,4 @@
-package graphql.kickstart.playground.boot.properties;
+package graphql.kickstart.autoconfigure.editor.playground.properties;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -7,10 +7,14 @@
 import java.util.Map;
 import javax.validation.constraints.NotBlank;
 import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
+import org.springframework.validation.annotation.Validated;
 
 @Data
+@Validated
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
+@ConfigurationProperties(prefix = "graphql.playground")
 public class PlaygroundProperties {
 
   @NotBlank private String endpoint = "/graphql";