Display Java runtime entries (#173)

* Display Java runtime entries

Signed-off-by: Rome Li <[email protected]>

* Resolve review comments

Signed-off-by: Rome Li <[email protected]>

Author: akaroml

package-lock.json

@@ -69,8 +69,11 @@
     "@types/bytes": "^3.0.0",
     "@types/expand-tilde": "^2.0.0",
     "@types/jquery": "^3.3.29",
+    "@types/lodash": "^4.14.137",
     "@types/node": "^8.10.46",
     "@types/path-exists": "^3.0.0",
+    "@types/react": "^16.9.2",
+    "@types/react-dom": "^16.9.0",
     "@types/request": "^2.48.1",
     "@types/request-promise-native": "^1.0.16",
     "@types/semver": "^5.5.0",
@@ -84,10 +87,13 @@
     "html-webpack-inline-source-plugin": "0.0.10",
     "html-webpack-plugin": "^3.2.0",
     "jquery": "^3.4.0",
+    "lodash": "^4.17.15",
     "node-sass": "^4.11.0",
     "path-exists": "^3.0.0",
     "popper.js": "^1.15.0",
     "postcss-loader": "^2.1.5",
+    "react": "^16.9.0",
+    "react-dom": "^16.9.0",
     "request": "^2.88.0",
     "request-promise-native": "^1.0.7",
     "sass-loader": "^7.0.1",

package.json

@@ -20,11 +20,15 @@ <h1>Configure Java Runtime</h1>
             <div class="card-body">
               <h4 class="alert-heading">Java Development Kit Required</h4>
               <p>
-                Java Development Kit (JDK) 8 or later is required for developing Java applications.
+                Java Development Kit (JDK) 8 or later is required for developing Java applications. The path to the JDK is searched in the following order:
               </p>
-              <p>
+              <div id="javaRuntimeEntryPanel"></div>
+              <p class="d-none">
                 ⚠️ No JDK installation was detected. Please follow the links below to download and install JDK:
               </p>
+              <p class="d-none">
+                <a href="#">Install extra JDKs</a>
+              </p>
               <ul class="nav nav-tabs mb-3" id="jdkSourceTab" role="tablist">
                 <li class="nav-item">
                   <a class="nav-link active" id="adoptOpenJdkTab" data-toggle="tab" href="#adoptOpenJdkPanel" role="tab" aria-controls="adoptOpenJdkPanel" aria-selected="true" title="Reliable source of OpenJDK binaries for all platforms">AdoptOpenJDK</a>

src/java-runtime/assets/index.html

@@ -5,15 +5,22 @@ import $ = require("jquery");
 import "../../assets/vscode.scss";
 import "bootstrap/js/src/tab";
 import bytes = require("bytes");
+import { JavaRuntimeEntryPanel } from "./java.runtime.entries";
+import * as ReactDOM from "react-dom";
+import { JavaRuntimeEntry } from "../types";
 
 window.addEventListener("message", event => {
-  if (event.data.command === "showJavaRuntimePanel") {
-    $("#javaRuntimePanel").removeClass("d-none");
-  } else if (event.data.command === "applyJdkInfo") {
+  if (event.data.command === "applyJdkInfo") {
     applyJdkInfo(event.data.jdkInfo);
+  } else if (event.data.command === "showJavaRuntimeEntries") {
+    showJavaRuntimeEntries(event.data.entries);
   }
 });
 
+function showJavaRuntimeEntries(entries: JavaRuntimeEntry[]) {
+  ReactDOM.render(JavaRuntimeEntryPanel(entries), document.getElementById("javaRuntimeEntryPanel"));
+}
+
 function applyJdkInfo(jdkInfo: any) {
   let binary = jdkInfo.binaries[0];
   let downloadLink = binary.installer_link || binary.binary_link;

src/java-runtime/assets/index.ts

@@ -0,0 +1,43 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+import * as React from "react";
+import { JavaRuntimeEntry } from "../types";
+
+export const JavaRuntimeEntryPanel = (props: JavaRuntimeEntry[]) => {
+  const current = props.findIndex(entry => entry.isValid || false);
+  const entries = props.map((entry, index) =>
+    <tr>
+      <th scope="row">{index + 1}</th>
+      <td>
+        {!entry.path && <em>*Empty*</em>}
+        {entry.path}
+        {index === current && <span className="badge badge-pill badge-primary">Current</span>}
+        {entry.path && !entry.isValid && <span className="badge badge-pill badge-secondary" title={entry.hint}>Invalid</span>}
+      </td>
+      <td>
+        {entry.name}
+      </td>
+      <td>
+        {!entry.actionUri && entry.type}
+        {entry.actionUri && <a href={entry.actionUri}>{entry.type}</a>}
+      </td>
+    </tr>
+  );
+
+  return (
+    <table className="table table-borderless table-hover table-sm">
+      <thead>
+        <tr>
+          <th scope="col">Order</th>
+          <th scope="col">Path</th>
+          <th scope="col">Source</th>
+          <th scope="col">Type</th>
+        </tr>
+      </thead>
+      <tbody>
+        {entries}
+      </tbody>
+    </table>
+  );
+};

src/java-runtime/assets/java.runtime.entries.tsx

@@ -10,6 +10,10 @@ import * as request from "request-promise-native";
 import findJavaHome = require("find-java-home");
 import architecture = require("arch");
 import { loadTextFromFile, getExtensionContext } from "../utils";
+import { JavaRuntimeEntry, JavaRuntimeEntryTypes } from "./types";
+import * as _ from "lodash";
+
+const MIN_JDK_VERSION: number = 8;
 
 let javaRuntimeView: vscode.WebviewPanel | undefined;
 
@@ -54,8 +58,18 @@ async function initializeJavaRuntimeView(context: vscode.ExtensionContext, webvi
     });
   }
 
+  function showJavaRuntimeEntries(entries: JavaRuntimeEntry[]) {
+    webviewPanel.webview.postMessage({
+      command: "showJavaRuntimeEntries",
+      entries: entries
+    });
+  }
+
   let jdkInfo = await suggestOpenJdk();
   applyJdkInfo(jdkInfo);
+
+  let entries = await findJavaRuntimeEntries();
+  showJavaRuntimeEntries(entries);
 }
 
 export class JavaRuntimeViewSerializer implements vscode.WebviewPanelSerializer {
@@ -111,26 +125,38 @@ async function getJavaVersion(javaHome: string | undefined): Promise<number> {
   });
 }
 
-async function findPossibleJdkInstallations(): Promise<{[location : string] : string | undefined}> {
-  return new Promise<{[location : string] : string | undefined}>((resolve, reject) => {
-    const javaHomeEntries: {[location : string] : string | undefined} = {
-      "java.home": vscode.workspace.getConfiguration().get("java.home", undefined),
-      "JDK_HOME": process.env["JDK_HOME"],
-      "JAVA_HOME": process.env["JAVA_HOME"],
-      "java.other": undefined
-    };
-
-    findJavaHome({allowJre: false}, (err, home) => {
+async function findPossibleJdkInstallations(): Promise<JavaRuntimeEntry[]> {
+  return new Promise<JavaRuntimeEntry[]>(resolve => {
+    const entries: JavaRuntimeEntry[] = [{
+      name: "java.home",
+      path: vscode.workspace.getConfiguration().get("java.home", undefined),
+      type: JavaRuntimeEntryTypes.UserSetting,
+      actionUri: "command:workbench.action.openSettings?%22java.home%22"
+    }, {
+      name: "JDK_HOME",
+      path: process.env["JDK_HOME"],
+      type: JavaRuntimeEntryTypes.EnvironmentVariable
+    }, {
+      name: "JAVA_HOME",
+      path: process.env["JAVA_HOME"],
+      type: JavaRuntimeEntryTypes.EnvironmentVariable
+    }];
+
+    findJavaHome((err, home: string) => {
       if (!err) {
-        javaHomeEntries.other = home;
+        entries.push({
+          name: "Other",
+          path: home,
+          type: JavaRuntimeEntryTypes.Other
+        });
       }
 
-      resolve(javaHomeEntries);
+      resolve(entries);
     });
   });
 }
 
-async function validateJdkInstallation(javaHome: string | undefined) {
+async function checkJdkInstallation(javaHome: string | undefined) {
   if (!javaHome) {
     return false;
   }
@@ -140,17 +166,29 @@ async function validateJdkInstallation(javaHome: string | undefined) {
 }
 
 export async function validateJavaRuntime() {
-  const jdkEntries = await findPossibleJdkInstallations();
-  for (const key in jdkEntries) {
-    if (jdkEntries.hasOwnProperty(key)) {
-      const entry = jdkEntries[key];
-      if (await validateJdkInstallation(entry) && await getJavaVersion(entry) >= 8) {
-        return true;
-      }
+  const entries = await findJavaRuntimeEntries();
+  return _.some(entries, entry => entry.isValid);
+}
+
+export async function findJavaRuntimeEntries(): Promise<JavaRuntimeEntry[]> {
+  const entries = await findPossibleJdkInstallations();
+  return Promise.all(_.map(entries, async entry => {
+    if (!await checkJdkInstallation(entry.path)) {
+      entry.isValid = false;
+      entry.hint = "This path does not point to a JDK.";
+      return entry;
     }
-  }
 
-  return false;
+    const version = await getJavaVersion(entry.path);
+    if (version < MIN_JDK_VERSION) {
+      entry.isValid = false;
+      entry.hint = `JDK 8+ is required while the path points to ${version}`;
+      return entry;
+    }
+
+    entry.isValid = true;
+    return entry;
+  }));
 }
 
 export async function suggestOpenJdk(jdkVersion: string = "openjdk11", impl: string = "hotspot") {