feat(#212): Reworked Playground configuration

Author: BlasiusSecundus

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/PlaygroundAutoConfiguration.java

@@ -1,7 +1,6 @@
 package com.oembedler.moon.playground.boot;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.oembedler.moon.playground.boot.settings.PlaygroundSettingsProperties;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
@@ -13,13 +12,13 @@
 @Configuration
 @ConditionalOnWebApplication
 @ConditionalOnClass(DispatcherServlet.class)
-@EnableConfigurationProperties(PlaygroundSettingsProperties.class)
+@EnableConfigurationProperties(PlaygroundPropertiesConfiguration.class)
 public class PlaygroundAutoConfiguration {
 
     @Bean
-    @ConditionalOnProperty(value = "playground.enabled", havingValue = "true", matchIfMissing = true)
-    PlaygroundController playgroundController(final PlaygroundSettingsProperties playgroundSettingsProperties,
+    @ConditionalOnProperty(value = "graphql.playground.enabled", havingValue = "true", matchIfMissing = true)
+    PlaygroundController playgroundController(final PlaygroundPropertiesConfiguration playgroundPropertiesConfiguration,
             final ObjectMapper objectMapper) {
-        return new PlaygroundController(playgroundSettingsProperties, objectMapper);
+        return new PlaygroundController(playgroundPropertiesConfiguration, objectMapper);
     }
 }

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/PlaygroundController.java

@@ -1,9 +1,7 @@
 package com.oembedler.moon.playground.boot;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.oembedler.moon.playground.boot.settings.PlaygroundSettingsProperties;
 import lombok.RequiredArgsConstructor;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.Model;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -28,41 +26,24 @@ public class PlaygroundController {
     private static final String SCRIPT_URL_ATTRIBUTE_NAME = "scriptUrl";
     private static final String LOGO_URL_ATTRIBUTE_NAME = "logoUrl";
 
-    @Value("${playground.endpoint.graphql:/graphql}")
-    private String graphqlEndpoint;
-
-    @Value("${playground.endpoint.subscriptions:/subscriptions}")
-    private String subscriptionsEndpoint;
-
-    @Value("${playground.cdn.enabled:false}")
-    private Boolean cdnEnabled;
-
-    @Value("${playground.cdn.version:latest}")
-    private String cdnVersion;
-
-    @Value("${playground.pageTitle:Playground}")
-    private String pageTitle;
-
-    private final PlaygroundSettingsProperties settingsProperties;
+    private final PlaygroundPropertiesConfiguration propertiesConfiguration;
 
     private final ObjectMapper objectMapper;
 
-    @GetMapping("${playground.mapping:/playground}")
+    @GetMapping("${graphql.playground.mapping:/playground}")
     public String playground(final Model model) {
-        if (cdnEnabled) {
+        if (propertiesConfiguration.getPlayground().isCdnEnabled()) {
             setCdnUrls(model);
         } else {
             setLocalAssetUrls(model);
         }
-        model.addAttribute("graphqlEndpoint", graphqlEndpoint);
-        model.addAttribute("subscriptionsEndpoint", subscriptionsEndpoint);
-        model.addAttribute("pageTitle", pageTitle);
-        model.addAttribute("settings", objectMapper.valueToTree(settingsProperties));
+        model.addAttribute("pageTitle", propertiesConfiguration.getPlayground().getPageTitle());
+        model.addAttribute("properties", objectMapper.valueToTree(propertiesConfiguration.getPlayground()));
         return "playground";
     }
 
     private String getCdnUrl(final String assetUrl) {
-        return String.format("%s@%s/%s", CDN_ROOT, cdnVersion, assetUrl);
+        return String.format("%s@%s/%s", CDN_ROOT, propertiesConfiguration.getPlayground().getCdnVersion(), assetUrl);
     }
 
     private void setCdnUrls(final Model model) {

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/PlaygroundProperties.java

@@ -0,0 +1,34 @@
+package com.oembedler.moon.playground.boot;
+
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.oembedler.moon.playground.boot.settings.PlaygroundSettings;
+import lombok.Data;
+
+import javax.validation.constraints.NotEmpty;
+
+@Data
+@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, getterVisibility = JsonAutoDetect.Visibility.NONE,
+        isGetterVisibility = JsonAutoDetect.Visibility.NONE)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PlaygroundProperties {
+
+    @NotEmpty
+    @JsonProperty
+    private String endpoint = "/graphql";
+
+    @NotEmpty
+    @JsonProperty
+    private String subscriptionEndpoint = "/subscriptions";
+
+    private boolean cdnEnabled;
+
+    @NotEmpty
+    private String cdnVersion = "latest";
+
+    private String pageTitle = "Playground";
+
+    @JsonProperty
+    private PlaygroundSettings settings;
+}

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/PlaygroundPropertiesConfiguration.java

@@ -0,0 +1,13 @@
+package com.oembedler.moon.playground.boot;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.validation.annotation.Validated;
+
+@Data
+@ConfigurationProperties(prefix = "graphql")
+@Validated
+public class PlaygroundPropertiesConfiguration {
+
+    private PlaygroundProperties playground = new PlaygroundProperties();
+}

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/settings/PlaygroundPrettierSettings.java

@@ -3,11 +3,15 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.Data;
 
+import javax.validation.constraints.Min;
+
 @Data
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class PlaygroundPrettierSettings {
 
+    @Min(1)
     private Integer printWidth;
+    @Min(1)
     private Integer tabWidth;
     private Boolean useTabs;
 }

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/settings/PlaygroundSchemaPollingSettings.java

@@ -3,11 +3,14 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.Data;
 
+import javax.validation.constraints.Min;
+
 @Data
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class PlaygroundSchemaPollingSettings {
 
     private Boolean enable;
     private String endpointFilter;
+    @Min(1)
     private Integer interval;
 }

playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/settings/PlaygroundSettingsProperties.java renamed to playground-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/playground/boot/settings/PlaygroundSettings.java

@@ -1,37 +1,25 @@
 package com.oembedler.moon.playground.boot.settings;
 
-import com.fasterxml.jackson.annotation.JsonAutoDetect;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonUnwrapped;
 import lombok.Data;
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.context.annotation.Configuration;
 
-@Configuration
 @Data
-@ConfigurationProperties(prefix = "playground.settings")
-@JsonAutoDetect(fieldVisibility =  JsonAutoDetect.Visibility.NONE, getterVisibility = JsonAutoDetect.Visibility.NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class PlaygroundSettingsProperties {
+public class PlaygroundSettings {
 
-    @JsonProperty
     @JsonUnwrapped(prefix = "editor.")
     private PlaygroundEditorSettings editor;
 
-    @JsonProperty
     @JsonUnwrapped(prefix = "prettier.")
     private PlaygroundPrettierSettings prettier;
 
-    @JsonProperty
     @JsonUnwrapped(prefix = "request.")
     private PlaygroundRequestSettings request;
 
-    @JsonProperty
     @JsonUnwrapped(prefix = "schema.")
     private PlaygroundSchemaSettings schema;
 
-    @JsonProperty
     @JsonUnwrapped(prefix = "tracing.")
     private PlaygroundTracingSettings tracing;
 }

playground-spring-boot-autoconfigure/src/main/resources/templates/playground.html

@@ -19,19 +19,12 @@
 </div>
 
 <script th:inline="javascript">
-    let graphqlEndpoint = /*[[${graphqlEndpoint}]]*/ "";
-    let subscriptionsEndpoint = /*[[${subscriptionsEndpoint}]]*/ "";
-    let settings = /*[[${settings}]]*/ null;
+    let properties = /*[[${properties}]]*/ {};
+    properties.setTitle = false;
+    window.addEventListener('load', function (event) {
+      GraphQLPlayground.init(document.getElementById('root'), properties)
+    });
 </script>
-
-<script>window.addEventListener('load', function (event) {
-      GraphQLPlayground.init(document.getElementById('root'), {
-        endpoint: graphqlEndpoint,
-        subscriptionEndpoint: subscriptionsEndpoint,
-        setTitle: false,
-        settings: settings
-      })
-    })</script>
 </body>
 
 </html>

playground-spring-boot-autoconfigure/src/test/java/com/oembedler/moon/playground/boot/PlaygroundDisabledTest.java

@@ -1,5 +1,6 @@
 package com.oembedler.moon.playground.boot;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
@@ -9,7 +10,8 @@
 import org.springframework.test.context.junit4.SpringRunner;
 
 @RunWith(SpringRunner.class)
-@SpringBootTest(classes = PlaygroundAutoConfiguration.class, properties = "playground.enabled=false")
+@SpringBootTest(classes = {PlaygroundAutoConfiguration.class, ObjectMapper.class},
+        properties = "graphql.playground.enabled=false")
 public class PlaygroundDisabledTest {
 
     @Autowired

playground-spring-boot-autoconfigure/src/test/java/com/oembedler/moon/playground/boot/PlaygroundEnabledTest.java

@@ -12,7 +12,7 @@
 
 @RunWith(SpringRunner.class)
 @SpringBootTest(classes = {PlaygroundAutoConfiguration.class, ObjectMapper.class},
-        properties = "playground.enabled=true")
+        properties = "graphql.playground.enabled=true")
 public class PlaygroundEnabledTest {
 
     @Autowired