Merge pull request #206 from Sparow199/feature/altair-starter

feat(Altair starter): Add Altair client starter

Author: oliemansm

README.md

@@ -7,13 +7,16 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
-- [Intro](#intro)
+- [GraphQL and Graph*i*QL Spring Framework Boot Starters](#graphql-and-graphiql-spring-framework-boot-starters)
+  - [WARNING: NoClassDefFoundError when using GraphQL Java Tools > 5.4.x](#warning-noclassdeffounderror-when-using-graphql-java-tools--54x)
+    - [Using Gradle](#using-gradle)
+    - [Using Maven](#using-maven)
+- [Documentation](#documentation)
 - [Requirements and Downloads](#requirements-and-downloads)
 - [Enable GraphQL Servlet](#enable-graphql-servlet)
-- [Enable GraphiQL](#enable-graphiql)
+- [Enable Graph*i*QL](#enable-graphiql)
 - [Supported GraphQL-Java Libraries](#supported-graphql-java-libraries)
-    - [GraphQL Java Tools](#graphql-java-tools) - [https://github.com/graphql-java-kickstart/graphql-java-tools](https://github.com/graphql-java-kickstart/graphql-java-tools)
-    - [GraphQL Spring Common](#graphql-spring-common) - [https://github.com/oembedler/spring-graphql-common](https://github.com/oembedler/spring-graphql-common)
+  - [GraphQL Java Tools](#graphql-java-tools)
 - [Contributions](#contributions)
 - [Licenses](#licenses)
 
@@ -49,7 +52,9 @@ See our new [Documentation](https://www.graphql-java-kickstart.com/spring-boot/)
 Repository contains:
 
 * `graphql-spring-boot-starter` to turn your boot application into GraphQL server (see [graphql-java-servlet](https://github.com/graphql-java-kickstart/graphql-java-servlet))
+* `altair-spring-boot-starter`to embed `Altair` tool for schema introspection and query debugging (see [altair](https://github.com/imolorhe/altair))
 * `graphiql-spring-boot-starter`to embed `GraphiQL` tool for schema introspection and query debugging (see [graphiql](https://github.com/graphql/graphiql))
+* `voyager-spring-boot-starter`to embed `Voyager` tool for visually explore GraphQL APIs as an interactive graph (see [voyger](https://github.com/APIs-guru/graphql-voyager))
 
 # Requirements and Downloads
 
@@ -68,6 +73,9 @@ repositories {
 dependencies {
   compile 'com.graphql-java-kickstart:graphql-spring-boot-starter:5.6.1'
   
+  // to embed Altair tool
+  compile 'com.altair-java-kickstart:graphiql-spring-boot-starter:5.6.1'
+
   // to embed GraphiQL tool
   compile 'com.graphql-java-kickstart:graphiql-spring-boot-starter:5.6.1'
 
@@ -87,6 +95,13 @@ Maven:
     <version>5.6.1</version>
 </dependency>
 
+<!-- to embed Altair tool -->
+<dependency>
+    <groupId>com.graphql-java-kickstart</groupId>
+    <artifactId>altair-spring-boot-starter</artifactId>
+    <version>5.6.1</version>
+</dependency>
+
 <!-- to embed GraphiQL tool -->
 <dependency>
     <groupId>com.graphql-java-kickstart</groupId>
@@ -163,13 +178,16 @@ graphiql:
     endpoint:
       graphql: /graphql
       subscriptions: /subscriptions
+    subscriptions:
+      timeout: 30
+      reconnect: false
     static:
       basePath: /
     enabled: true
     pageTitle: GraphiQL
     cdn:
         enabled: false
-        version: 0.11.11
+        version: 0.13.0
     props:
         resources:
             query: query.graphql
@@ -220,7 +238,7 @@ Contributions are welcome.  Please respect the [Code of Conduct](http://contribu
 
 # Licenses
 
-`graphql-spring-boot-starter` and `graphiql-spring-boot-starter` are licensed under the MIT License. See [LICENSE](LICENSE.md) for details.
+`graphql-spring-boot-starter`, `altair-spring-boot-starter`, `graphiql-spring-boot-starter`and `voyager-spring-boot-starter` are licensed under the MIT License. See [LICENSE](LICENSE.md) for details.
 
 [graphql-java License](https://github.com/andimarek/graphql-java/blob/master/LICENSE.md)
 

altair-spring-boot-autoconfigure/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oembedler Inc. and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

altair-spring-boot-autoconfigure/build.gradle

@@ -0,0 +1,30 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 oEmbedler Inc. and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ *  documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ *  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ *  persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+dependencies{
+    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor:$LIB_SPRING_BOOT_VER"
+    
+    compile "org.springframework.boot:spring-boot-autoconfigure:$LIB_SPRING_BOOT_VER"
+    compile "org.apache.commons:commons-text:1.1"
+    compileOnly "org.springframework.boot:spring-boot-starter-web:$LIB_SPRING_BOOT_VER"
+
+    testCompile "org.springframework.boot:spring-boot-starter-web:$LIB_SPRING_BOOT_VER"
+    testCompile "org.springframework.boot:spring-boot-starter-test:$LIB_SPRING_BOOT_VER"
+}
+
+compileJava.dependsOn(processResources)

altair-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/altair/boot/AltairAutoConfiguration.java

@@ -0,0 +1,22 @@
+package com.oembedler.moon.altair.boot;
+
+        import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+        import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+        import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+        import org.springframework.context.annotation.Bean;
+        import org.springframework.context.annotation.Configuration;
+        import org.springframework.web.servlet.DispatcherServlet;
+
+/**
+ * @author Moncef AOUDIA
+ */
+@Configuration
+@ConditionalOnWebApplication
+@ConditionalOnClass(DispatcherServlet.class)
+public class AltairAutoConfiguration {
+    @Bean
+    @ConditionalOnProperty(value = "altair.enabled", havingValue = "true", matchIfMissing = true)
+    AltairController altairController() {
+        return new AltairController();
+    }
+}

altair-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/altair/boot/AltairController.java

@@ -0,0 +1,135 @@
+package com.oembedler.moon.altair.boot;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.text.StrSubstitutor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.core.env.Environment;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.http.MediaType;
+import org.springframework.stereotype.Controller;
+import org.springframework.util.StreamUtils;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import javax.annotation.PostConstruct;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
+
+/**
+ * @author Moncef AOUDIA
+ */
+@Controller
+public class AltairController {
+
+    private static final String CDN_UNPKG = "//unpkg.com/";
+    private static final String ALTAIR = "altair-static";
+
+    @Value("${altair.endpoint.graphql:/graphql}")
+    private String graphqlEndpoint;
+
+    @Value("${altair.endpoint.subscriptions:/subscriptions}")
+    private String subscriptionsEndpoint;
+
+    @Value("${altair.static.basePath:/}")
+    private String staticBasePath;
+
+    @Value("${altair.pageTitle:Altair}")
+    private String pageTitle;
+
+    @Value("${altair.cdn.enabled:false}")
+    private Boolean altairCdnEnabled;
+
+    @Value("${altair.cdn.version:2.1.1}")
+    private String altairCdnVersion;
+
+    @Autowired
+    private Environment environment;
+
+    private String template;
+    private String props;
+
+    @PostConstruct
+    public void onceConstructed() throws IOException {
+        loadTemplate();
+        loadProps();
+    }
+
+    private void loadTemplate() throws IOException {
+        try (InputStream inputStream = new ClassPathResource("altair.html").getInputStream()) {
+            template = StreamUtils.copyToString(inputStream, Charset.defaultCharset());
+        }
+    }
+
+    private void loadProps() throws IOException {
+        props = new PropsLoader(environment).load();
+    }
+
+    private void addIfAbsent(Properties headerProperties, String header) {
+        if (!headerProperties.containsKey(header)) {
+            headerProperties.setProperty(header, MediaType.APPLICATION_JSON_VALUE);
+        }
+    }
+
+    @RequestMapping(value = "${altair.mapping:/altair}")
+    public void altair(HttpServletRequest request, HttpServletResponse response, @PathVariable Map<String, String> params) throws IOException {
+        response.setContentType("text/html; charset=UTF-8");
+
+        Map<String, String> replacements = getReplacements(
+                constructGraphQlEndpoint(request, params),
+                request.getContextPath() + subscriptionsEndpoint
+        );
+
+        String populatedTemplate = StrSubstitutor.replace(template, replacements);
+        response.getOutputStream().write(populatedTemplate.getBytes(Charset.defaultCharset()));
+    }
+
+    private Map<String, String> getReplacements(String graphqlEndpoint, String subscriptionsEndpoint) {
+        Map<String, String> replacements = new HashMap<>();
+        replacements.put("graphqlEndpoint", graphqlEndpoint);
+        replacements.put("subscriptionsEndpoint", subscriptionsEndpoint);
+        replacements.put("pageTitle", pageTitle);
+        replacements.put("pageFavicon", getResourceUrl("favicon.ico", "favicon.ico"));
+        replacements.put("altairBaseUrl", getResourceUrl("/vendor/altair/",
+                joinJsUnpkgPath(ALTAIR, altairCdnVersion, "build/dist/")));
+        replacements.put("altairLogoUrl", getResourceUrl("assets/img/logo_350.svg", "assets/img/logo_350.svg"));
+        replacements.put("altairCssUrl", getResourceUrl("styles.css", "styles.css"));
+        replacements.put("altairMainJsUrl", getResourceUrl("main.js", "main.js"));
+        replacements.put("altairPolyfillsJsUrl", getResourceUrl("polyfills.js", "polyfills.js"));
+        replacements.put("altairRuntimeJsUrl", getResourceUrl("runtime.js", "runtime.js"));
+        replacements.put("props", props);
+        return replacements;
+    }
+
+    private String getResourceUrl(String staticFileName, String cdnUrl) {
+        if (altairCdnEnabled && StringUtils.isNotBlank(cdnUrl)) {
+            return cdnUrl;
+        }
+        return staticFileName;
+    }
+
+    private String joinJsUnpkgPath(String library, String cdnVersion, String cdnFileName) {
+        return CDN_UNPKG + library + "@" + cdnVersion + "/" + cdnFileName;
+    }
+
+    private String constructGraphQlEndpoint(HttpServletRequest request, @RequestParam Map<String, String> params) {
+        String endpoint = graphqlEndpoint;
+        for (Map.Entry<String, String> param : params.entrySet()) {
+            endpoint = endpoint.replaceAll("\\{" + param.getKey() + "}", param.getValue());
+        }
+        if (StringUtils.isNotBlank(request.getContextPath()) && !endpoint.startsWith(request.getContextPath())) {
+            return request.getContextPath() + endpoint;
+        }
+        return endpoint;
+    }
+
+}

altair-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/altair/boot/PropertyGroupReader.java

@@ -0,0 +1,62 @@
+package com.oembedler.moon.altair.boot;
+
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.EnumerablePropertySource;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.PropertySource;
+
+import java.util.*;
+import java.util.stream.Stream;
+import java.util.stream.StreamSupport;
+
+class PropertyGroupReader {
+
+    private Environment environment;
+    private String prefix;
+    private Properties props;
+
+    PropertyGroupReader(Environment environment, String prefix) {
+        this.environment = Objects.requireNonNull(environment);
+        this.prefix = Optional.ofNullable(prefix).orElse("");
+    }
+
+    Properties load() {
+        if (props == null) {
+            props = new Properties();
+            loadProps();
+        }
+        return props;
+    }
+
+    private void loadProps() {
+        streamOfPropertySources().forEach(propertySource ->
+                Arrays.stream(propertySource.getPropertyNames())
+                        .filter(this::isWanted)
+                        .forEach(key -> add(propertySource, key)));
+    }
+
+    private Stream<EnumerablePropertySource> streamOfPropertySources() {
+        if (environment instanceof ConfigurableEnvironment) {
+            Iterator<PropertySource<?>> iterator = ((ConfigurableEnvironment) environment).getPropertySources().iterator();
+            Iterable<PropertySource<?>> iterable = () -> iterator;
+            return StreamSupport.stream(iterable.spliterator(), false)
+                    .filter(EnumerablePropertySource.class::isInstance)
+                    .map(EnumerablePropertySource.class::cast);
+        }
+        return Stream.empty();
+    }
+
+    private String withoutPrefix(String key) {
+        return key.replace(prefix, "");
+    }
+
+    private boolean isWanted(String key) {
+        return key.startsWith(prefix);
+    }
+
+    private Object add(EnumerablePropertySource propertySource, String key) {
+        return props.put(withoutPrefix(key), propertySource.getProperty(key));
+    }
+
+}
+