Merge pull request #169 from Karm/issue-163

Karm · web-flow · commit 5b664b04cde1 · 2019-07-01T14:52:48.000+02:00
Adds /supportMatrix and /supportMatrix/servers resources to REST API
diff --git a/src/main/java/org/eclipse/microprofile/starter/rest/APIEndpointLatest.java b/src/main/java/org/eclipse/microprofile/starter/rest/APIEndpointLatest.java
@@ -62,14 +62,27 @@ public Response listMPVersions() {
         return api.listMPVersions();
     }
 
+    @Path("/supportMatrix")
+    @GET
+    @Produces({"application/json"})
+    public Response supportMatrix(@HeaderParam(HttpHeaders.IF_NONE_MATCH) String ifNoneMatch) {
+        return api.supportMatrix(ifNoneMatch);
+    }
+
+    @Path("/supportMatrix/servers")
+    @GET
+    @Produces({"application/json"})
+    public Response supportMatrixServers(@HeaderParam(HttpHeaders.IF_NONE_MATCH) String ifNoneMatch) {
+        return api.supportMatrixServers(ifNoneMatch);
+    }
+
     @Path("/mpVersion/{mpVersion}")
     @GET
     @Produces({"application/json"})
     public Response listOptions(@NotNull @PathParam("mpVersion") MicroProfileVersion mpVersion) {
         return api.listOptions(mpVersion);
     }
 
-
     @Path("/project")
     @GET
     @Produces({"application/zip", "application/json"})
diff --git a/src/main/java/org/eclipse/microprofile/starter/rest/APIService.java b/src/main/java/org/eclipse/microprofile/starter/rest/APIService.java
@@ -48,7 +48,10 @@
 import javax.ws.rs.core.EntityTag;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Scanner;
@@ -66,6 +69,10 @@ public class APIService {
     private static final Logger LOG = Logger.getLogger(APIService.class.getName());
 
     private Map<MicroProfileVersion, MPOptionsAvailable> mpvToOptions;
+    private EntityTag mpvToOptionsEtag;
+
+    private Map<SupportedServer, Map<MicroProfileVersion, List<MicroprofileSpec>>> serversToOptions;
+    private EntityTag serversToOptionsEtag;
 
     private String readme;
     private EntityTag readmeEtag;
@@ -78,18 +85,26 @@ public class APIService {
 
     @PostConstruct
     public void init() {
-        mpvToOptions =
-                new HashMap<MicroProfileVersion, MPOptionsAvailable>(MicroProfileVersion.values().length) {
-                    {
-                        Stream.of(MicroProfileVersion.values()).forEach(mpv -> put(mpv, new MPOptionsAvailable(
-                                Stream.of(SupportedServer.values())
-                                        .filter(v -> v.getMpVersions().contains(mpv)).collect(Collectors.toList()),
-                                Stream.of(MicroprofileSpec.values())
-                                        .filter(v -> v.getMpVersions().contains(mpv)).collect(Collectors.toList()))));
-
-                    }
-
-                };
+        // Keys are MP versions and values are servers and specs
+        mpvToOptions = new HashMap<>(MicroProfileVersion.values().length);
+        Stream.of(MicroProfileVersion.values()).filter(mpv -> mpv != MicroProfileVersion.NONE).forEach(mpv -> {
+            List<SupportedServer> supportedServers = Stream.of(SupportedServer.values())
+                    .filter(v -> v.getMpVersions().contains(mpv)).collect(Collectors.toList());
+            List<MicroprofileSpec> specs = Stream.of(MicroprofileSpec.values())
+                    .filter(v -> v.getMpVersions().contains(mpv)).collect(Collectors.toList());
+            mpvToOptions.put(mpv, new MPOptionsAvailable(supportedServers, specs));
+        });
+        mpvToOptionsEtag = new EntityTag(Integer.toHexString(31 * version.getGit().hashCode() + mpvToOptions.hashCode()));
+        // Keys are servers and values are MP versions and specs
+        serversToOptions = new HashMap<>(SupportedServer.values().length);
+        for (SupportedServer s : SupportedServer.values()) {
+            Map<MicroProfileVersion, List<MicroprofileSpec>> mpvToSpec = new HashMap<>(s.getMpVersions().size());
+            s.getMpVersions().forEach(mpv -> mpvToSpec.put(
+                    mpv,
+                    Stream.of(MicroprofileSpec.values()).filter(v -> v.getMpVersions().contains(mpv)).collect(Collectors.toList())));
+            serversToOptions.put(s, mpvToSpec);
+        }
+        serversToOptionsEtag = new EntityTag(Integer.toHexString(31 * version.getGit().hashCode() + serversToOptions.hashCode()));
         try (Scanner s = new Scanner(FilesLocator.class.getClassLoader()
                 .getResourceAsStream("/REST-README.md")).useDelimiter("\\A")) {
             readme = (s.hasNext() ? s.next() : "") + "\n" + version.getGit() + "\n";
@@ -130,7 +145,7 @@ public Response readme(String ifNoneMatch) {
                 return Response.notModified().build();
             }
         }
-        return Response.ok(readme).build();
+        return Response.ok(readme).tag(readmeEtag).build();
     }
 
     public Response listMPVersions() {
@@ -142,6 +157,30 @@ public Response listMPVersions() {
         ).build();
     }
 
+    public Response supportMatrix(String ifNoneMatch) {
+        if (ifNoneMatch != null) {
+            if (mpvToOptionsEtag.toString().equals(ifNoneMatch)) {
+                return Response.notModified().build();
+            }
+        }
+        return Response.ok(mpvToOptions, MediaType.APPLICATION_JSON_TYPE).tag(mpvToOptionsEtag).build();
+    }
+
+    public Response supportMatrixServers(String ifNoneMatch) {
+        if (ifNoneMatch != null) {
+            if (serversToOptionsEtag.toString().equals(ifNoneMatch)) {
+                return Response.notModified().build();
+            }
+        }
+        List<SupportedServer> servers = new ArrayList<>(serversToOptions.keySet());
+        Collections.shuffle(servers);
+        Map<SupportedServer, Map<MicroProfileVersion, List<MicroprofileSpec>>> rndServersToOptions = new LinkedHashMap<>(servers.size());
+        for (SupportedServer s : servers) {
+            rndServersToOptions.put(s, serversToOptions.get(s));
+        }
+        return Response.ok(rndServersToOptions, MediaType.APPLICATION_JSON_TYPE).tag(serversToOptionsEtag).build();
+    }
+
     public Response listOptions(MicroProfileVersion mpVersion) {
         return Response.ok(mpvToOptions.get(mpVersion)).build();
     }
diff --git a/src/main/resources/REST-README.md b/src/main/resources/REST-README.md
@@ -244,3 +244,153 @@ PS C:\> $headers = @{
 >> }
 PS C:\> Invoke-WebRequest -InFile ./all.json -OutFile project.zip -Method Post -Uri "https://start.microprofile.io/api/1/project" -Headers $headers
 ```
+
+# Integration with IDEs
+
+If it is preferred to acquire all valid options in a one request the ```supportMatrix``` call is recommended.
+The integration code [SHOULD](https://tools.ietf.org/html/rfc2119) use [Etag](https://tools.ietf.org/html/rfc7232#section-2.3) response header
+and [If-None-Match](https://tools.ietf.org/html/rfc7232#section-3.2) request header so as to avoid unnecessary deserialization of identical responses.
+
+## MicroProfile versions as keys
+
+```
+$ curl -i https://start.microprofile.io/api/1/supportMatrix
+...
+ETag: "44730639"
+...
+{
+  "MP12": {
+    "supportedServers": [
+      "WILDFLY_SWARM",
+      "PAYARA_MICRO",
+      "THORNTAIL_V2",
+      "TOMEE",
+      "LIBERTY",
+      "KUMULUZEE",
+      "HELIDON"
+    ],
+    "specs": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS"
+    ]
+  },
+  "MP21": {
+    "supportedServers": [
+      "KUMULUZEE",
+      "THORNTAIL_V2",
+      "LIBERTY",
+      "PAYARA_MICRO"
+    ],
+    "specs": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS",
+      "OPEN_API",
+      "OPEN_TRACING",
+      "REST_CLIENT"
+    ]
+  },
+  ...removed for brevity...
+}
+```
+
+Using value from ETag in If-None-Match:
+
+```
+$ curl '-HIf-None-Match: "44730639"' -i https://start.microprofile.io/api/1/supportMatrix
+...
+HTTP/1.1 304 Not Modified
+```
+
+## Server implementations as keys
+
+```
+$ curl -i https://start.microprofile.io/api/1/supportMatrix/servers
+...
+ETag: "7b99230f"
+...
+{
+  "HELIDON": {
+    "MP12": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS"
+    ]
+  },
+  "PAYARA_MICRO": {
+    "MP20": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS",
+      "OPEN_API",
+      "OPEN_TRACING",
+      "REST_CLIENT"
+    ],
+    "MP13": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS",
+      "OPEN_API",
+      "OPEN_TRACING",
+      "REST_CLIENT"
+    ],
+    "MP22": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS",
+      "OPEN_API",
+      "OPEN_TRACING",
+      "REST_CLIENT"
+    ],
+    "MP12": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS"
+    ],
+    "MP14": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS",
+      "OPEN_API",
+      "OPEN_TRACING",
+      "REST_CLIENT"
+    ],
+    "MP21": [
+      "CONFIG",
+      "FAULT_TOLERANCE",
+      "JWT_AUTH",
+      "METRICS",
+      "HEALTH_CHECKS",
+      "OPEN_API",
+      "OPEN_TRACING",
+      "REST_CLIENT"
+    ]
+  }
+  ...removed for brevity...
+}
+```
+
+Using value from ETag in If-None-Match:
+
+```
+$ curl '-HIf-None-Match: "7b99230f"' -i https://start.microprofile.io/api/1/supportMatrix/servers
+...
+HTTP/1.1 304 Not Modified
+```
