feat(#212): GraphQL Playground settings are now configurable

Author: BlasiusSecundus

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

@@ -1,20 +1,25 @@
 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;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.DispatcherServlet;
 
 @Configuration
 @ConditionalOnWebApplication
 @ConditionalOnClass(DispatcherServlet.class)
+@EnableConfigurationProperties(PlaygroundSettingsProperties.class)
 public class PlaygroundAutoConfiguration {
 
     @Bean
     @ConditionalOnProperty(value = "playground.enabled", havingValue = "true", matchIfMissing = true)
-    PlaygroundController altairController() {
-        return new PlaygroundController();
+    PlaygroundController playgroundController(final PlaygroundSettingsProperties playgroundSettingsProperties,
+            final ObjectMapper objectMapper) {
+        return new PlaygroundController(playgroundSettingsProperties, objectMapper);
     }
 }

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

@@ -1,11 +1,15 @@
 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;
 
 @Controller
+@RequiredArgsConstructor
 public class PlaygroundController {
 
     private static final String CDN_ROOT = "https://cdn.jsdelivr.net/npm/graphql-playground-react";
@@ -39,6 +43,10 @@ public class PlaygroundController {
     @Value("${playground.pageTitle:Playground}")
     private String pageTitle;
 
+    private final PlaygroundSettingsProperties settingsProperties;
+
+    private final ObjectMapper objectMapper;
+
     @GetMapping("${playground.mapping:/playground}")
     public String playground(final Model model) {
         if (cdnEnabled) {
@@ -49,6 +57,7 @@ public String playground(final Model model) {
         model.addAttribute("graphqlEndpoint", graphqlEndpoint);
         model.addAttribute("subscriptionsEndpoint", subscriptionsEndpoint);
         model.addAttribute("pageTitle", pageTitle);
+        model.addAttribute("settings", objectMapper.valueToTree(settingsProperties));
         return "playground";
     }
 

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

@@ -0,0 +1,12 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public enum PlaygroundEditorCursorShape {
+    @JsonProperty("line")
+    LINE,
+    @JsonProperty("block")
+    BLOCK,
+    @JsonProperty("underline")
+    UNDERLINE
+}

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

@@ -0,0 +1,15 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.Data;
+
+@Data
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PlaygroundEditorSettings {
+
+    private PlaygroundEditorCursorShape cursorShape;
+    private String fontFamily;
+    private Integer fontSize;
+    private PlaygroundEditorTheme theme;
+    private Boolean reuseHeaders;
+}

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

@@ -0,0 +1,10 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public enum PlaygroundEditorTheme {
+    @JsonProperty("light")
+    LIGHT,
+    @JsonProperty("dark")
+    DARK
+}

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

@@ -0,0 +1,13 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.Data;
+
+@Data
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PlaygroundPrettierSettings {
+
+    private Integer printWidth;
+    private Integer tabWidth;
+    private Boolean useTabs;
+}

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

@@ -0,0 +1,12 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public enum PlaygroundRequestIncludeCredentials {
+    @JsonProperty("omit")
+    OMIT,
+    @JsonProperty("include")
+    INCLUDE,
+    @JsonProperty("same-origin")
+    SAME_ORIGIN
+}

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

@@ -0,0 +1,11 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.Data;
+
+@Data
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PlaygroundRequestSettings {
+
+    private PlaygroundRequestIncludeCredentials credentials;
+}

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

@@ -0,0 +1,13 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.Data;
+
+@Data
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PlaygroundSchemaPollingSettings {
+
+    private Boolean enable;
+    private String endpointFilter;
+    private Integer interval;
+}

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

@@ -0,0 +1,15 @@
+package com.oembedler.moon.playground.boot.settings;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonUnwrapped;
+import lombok.Data;
+
+@Data
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PlaygroundSchemaSettings {
+
+    private Boolean disableComments;
+
+    @JsonUnwrapped(prefix = "polling.")
+    private PlaygroundSchemaPollingSettings polling;
+}