feat(#212): ability to set custom static folder for Playground resources

Author: BlasiusSecundus

README.md

@@ -18,6 +18,7 @@
 - [Enable GraphQL Playground](#enable-graphql-playground)
   - [Basic settings](#basic-settings)
   - [CDN](#cdn)
+  - [Custom static resources](#custom-static-resources)
   - [Customizing GraphQL Playground](#customizing-graphql-playground)
   - [Tabs](#tabs)
 - [Supported GraphQL-Java Libraries](#supported-graphql-java-libraries)
@@ -273,6 +274,7 @@ graphql.playground:
     mapping: /playground
     endpoint: /graphql
     subscriptionsEndpoint: /subscriptions
+    staticFolder.basePath: my-playground-resources-folder
     enabled: true
     pageTitle: Playground
     cdn:
@@ -328,6 +330,18 @@ The CDN option uses `jsDelivr` CDN, if enabled. By default, it will load the lat
 Available CDN versions can be found on the project's 
 [jsDelivr page](https://www.jsdelivr.com/package/npm/graphql-playground-react). The CDN option is disabled by default.
 
+## Custom static resources
+
+You can also specify a custom local version of Playground by setting the base path for `Playground` resources in
+the `staticPath.base` property. Under this directory, you have to provide the following files:
+   
+* `static/css/index.css`
+* `static/js/middleware.js`
+* `favicon.png`
+* `logo.png`
+
+This is identical to the directory structure of the CDN under the `build` subfolder (where these files can be found).
+
 ## Customizing GraphQL Playground
 
 Further GraphQL Playground settings can be specified under the `settings` group, which are documented in the official 

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

@@ -7,21 +7,18 @@
 import org.springframework.web.bind.annotation.GetMapping;
 
 import javax.servlet.http.HttpServletRequest;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 
 @Controller
 @RequiredArgsConstructor
 public class PlaygroundController {
 
     private static final String CDN_ROOT = "https://cdn.jsdelivr.net/npm/graphql-playground-react";
-    private static final String CDN_CSS = "build/static/css/index.css";
-    private static final String CDN_FAVICON =  "build/favicon.png";
-    private static final String CDN_SCRIPT = "build/static/js/middleware.js";
-    private static final String CDN_LOGO = "build/logo.png";
-
-    private static final String LOCAL_CSS = "/vendor/playground/playground.css";
-    private static final String LOCAL_FAVICON = "/vendor/playground/favicon.png";
-    private static final String LOCAL_SCRIPT = "/vendor/playground/playground.js";
-    private static final String LOCAL_LOGO = "/vendor/playground/assets/logo.png";
+    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";
@@ -46,21 +43,25 @@ public String playground(final Model model, final HttpServletRequest request) {
     }
 
     private String getCdnUrl(final String assetUrl) {
-        return String.format("%s@%s/%s", CDN_ROOT, propertiesConfiguration.getPlayground().getCdn().getVersion(),
+        return String.format("%s@%s/build/%s", CDN_ROOT, propertiesConfiguration.getPlayground().getCdn().getVersion(),
                 assetUrl);
     }
 
+    private Path getLocalUrl(final String cssPath) {
+        return Paths.get(propertiesConfiguration.getPlayground().getStaticPath().getBase(), cssPath);
+    }
+
     private void setCdnUrls(final Model model) {
-        model.addAttribute(CSS_URL_ATTRIBUTE_NAME, getCdnUrl(CDN_CSS));
-        model.addAttribute(FAVICON_URL_ATTRIBUTE_NAME, getCdnUrl(CDN_FAVICON));
-        model.addAttribute(SCRIPT_URL_ATTRIBUTE_NAME, getCdnUrl(CDN_SCRIPT));
-        model.addAttribute(LOGO_URL_ATTRIBUTE_NAME, getCdnUrl(CDN_LOGO));
+        model.addAttribute(CSS_URL_ATTRIBUTE_NAME, getCdnUrl(CSS_PATH));
+        model.addAttribute(FAVICON_URL_ATTRIBUTE_NAME, getCdnUrl(FAVICON_PATH));
+        model.addAttribute(SCRIPT_URL_ATTRIBUTE_NAME, getCdnUrl(SCRIPT_PATH));
+        model.addAttribute(LOGO_URL_ATTRIBUTE_NAME, getCdnUrl(LOGO_PATH));
     }
 
     private void setLocalAssetUrls(final Model model) {
-        model.addAttribute(CSS_URL_ATTRIBUTE_NAME, LOCAL_CSS);
-        model.addAttribute(FAVICON_URL_ATTRIBUTE_NAME, LOCAL_FAVICON);
-        model.addAttribute(SCRIPT_URL_ATTRIBUTE_NAME, LOCAL_SCRIPT);
-        model.addAttribute(LOGO_URL_ATTRIBUTE_NAME, LOCAL_LOGO);
+        model.addAttribute(CSS_URL_ATTRIBUTE_NAME, getLocalUrl(CSS_PATH));
+        model.addAttribute(FAVICON_URL_ATTRIBUTE_NAME, getLocalUrl(FAVICON_PATH));
+        model.addAttribute(SCRIPT_URL_ATTRIBUTE_NAME, getLocalUrl(SCRIPT_PATH));
+        model.addAttribute(LOGO_URL_ATTRIBUTE_NAME, getLocalUrl(LOGO_PATH));
     }
 }

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

@@ -2,12 +2,12 @@
 
 import lombok.Data;
 
-import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotBlank;
 
 @Data
 public class PlaygroundCdn {
 
     private boolean enabled;
-    @NotEmpty
+    @NotBlank
     private String version = "latest";
 }

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

@@ -5,7 +5,7 @@
 import lombok.Data;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
-import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotBlank;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -14,16 +14,20 @@
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class PlaygroundProperties {
 
-    @NotEmpty
+    @NotBlank
     private String endpoint = "/graphql";
 
-    @NotEmpty
+    @NotBlank
     private String subscriptionEndpoint = "/subscriptions";
 
     @NestedConfigurationProperty
     @JsonIgnore
     private PlaygroundCdn cdn = new PlaygroundCdn();
 
+    @NestedConfigurationProperty
+    @JsonIgnore
+    private PlaygroundStaticPathSettings staticPath = new PlaygroundStaticPathSettings();
+
     @JsonIgnore
     private String pageTitle = "Playground";
 

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

@@ -0,0 +1,12 @@
+package com.oembedler.moon.playground.boot.properties;
+
+import lombok.Data;
+
+import javax.validation.constraints.NotBlank;
+
+@Data
+public class PlaygroundStaticPathSettings {
+
+    @NotBlank
+    private String base = "/vendor/playground";
+}