-
Notifications
You must be signed in to change notification settings - Fork 162
Expand file tree
/
Copy pathupstreamApi.ts
More file actions
197 lines (176 loc) · 8.18 KB
/
Copy pathupstreamApi.ts
File metadata and controls
197 lines (176 loc) · 8.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
// based on https://github.com/redhat-developer/vscode-java/blob/c4cdbed1190fc705c364179dab525645acf03898/src/requirements.ts
import * as fse from "fs-extra";
import { findRuntimes, getRuntime, getSources, IJavaRuntime, JAVAC_FILENAME, JAVA_FILENAME } from 'jdk-utils';
import * as path from "path";
import * as vscode from "vscode";
import { env, workspace } from 'vscode';
const expandHomeDir = require("expand-home-dir");
export const REQUIRED_JDK_VERSION = 17;
export async function resolveRequirements(): Promise<{
tooling_jre: string | undefined; // Used to launch Java extension.
tooling_jre_version: number;
java_home: string | undefined; // Used as default project JDK.
java_version: number;
}> {
const javaExtPath: string | undefined = vscode.extensions.getExtension("redhat.java")?.extensionPath
let toolingJre: string | undefined = await findEmbeddedJRE(javaExtPath);
let toolingJreVersion: number = await getMajorVersion(toolingJre);
return new Promise(async (resolve, reject) => {
let source: string;
const javaPreferences = checkJavaPreferences();
let preferenceName = javaPreferences.preference;
let javaVersion: number = 0;
let javaHome = javaPreferences.javaHome;
if (javaHome) { // java.jdt.ls.java.home or java.home setting has highest priority.
source = `java.home variable defined in ${env.appName} settings`;
javaHome = expandHomeDir(javaHome);
if (!await fse.pathExists(javaHome!)) {
invalidJavaHome(reject, `The ${source} points to a missing or inaccessible folder (${javaHome})`);
} else if (!await fse.pathExists(path.resolve(javaHome!, 'bin', JAVAC_FILENAME))) {
let msg: string;
if (await fse.pathExists(path.resolve(javaHome!, JAVAC_FILENAME))) {
msg = `'bin' should be removed from the ${source} (${javaHome})`;
} else {
msg = `The ${source} (${javaHome}) does not point to a JDK.`;
}
invalidJavaHome(reject, msg);
}
javaVersion = await getMajorVersion(javaHome);
if (preferenceName === "java.jdt.ls.java.home" || !toolingJre) {
toolingJre = javaHome;
toolingJreVersion = javaVersion;
}
}
// java.home not specified, search valid JDKs from env.JAVA_HOME, env.PATH, SDKMAN, jEnv, jabba, Common directories
const javaRuntimes = await findRuntimes({checkJavac: true, withVersion: true, withTags: true});
if (!toolingJre) { // universal version
// as latest version as possible.
sortJdksByVersion(javaRuntimes);
const validJdks = javaRuntimes.filter(r => r.version && r.version.major >= REQUIRED_JDK_VERSION);
if (validJdks.length > 0) {
sortJdksBySource(validJdks);
javaHome = validJdks[0].homedir;
javaVersion = validJdks[0].version?.major ?? 0;
toolingJre = javaHome;
toolingJreVersion = javaVersion;
}
} else { // pick a default project JDK/JRE
/**
* For legacy users, we implicitly following the order below to
* set a default project JDK during initialization:
* java.home > env.JDK_HOME > env.JAVA_HOME > env.PATH
*
* We'll keep it for compatibility.
*/
if (javaHome && (await getRuntime(javaHome) !== undefined)) {
const runtime = await getRuntime(javaHome, {withVersion: true});
if (runtime) {
javaHome = runtime.homedir;
javaVersion = runtime.version?.major ?? 0;
}
} else if (javaRuntimes.length) {
sortJdksBySource(javaRuntimes);
javaHome = javaRuntimes[0].homedir;
javaVersion = javaRuntimes[0].version?.major ?? 0;
} else if (javaHome = (await findDefaultRuntimeFromSettings() ?? "")) {
javaVersion = await getMajorVersion(javaHome);
} else {
/**
* Originally it was:
* invalidJavaHome(reject, "Please download and install a JDK to compile your project. You can configure your projects with different JDKs by the setting ['java.configuration.runtimes'](https://github.com/redhat-developer/vscode-java/wiki/JDK-Requirements#java.configuration.runtimes)");
*
* here we focus on tooling jre, so we swallow the error.
*
*/
}
}
if (!toolingJre || toolingJreVersion < REQUIRED_JDK_VERSION) {
// For universal version, we still require users to install a qualified JDK to run Java extension.
invalidJavaHome(reject, `Java ${REQUIRED_JDK_VERSION} or more recent is required to run the Java extension. Please download and install a recent JDK. You can still compile your projects with older JDKs by configuring ['java.configuration.runtimes'](https://github.com/redhat-developer/vscode-java/wiki/JDK-Requirements#java.configuration.runtimes)`);
}
resolve({
tooling_jre: toolingJre, // Used to launch Java extension.
tooling_jre_version: toolingJreVersion,
java_home: javaHome, // Used as default project JDK.
java_version: javaVersion,
});
});
}
async function findEmbeddedJRE(javaExtPath?: string): Promise<string | undefined> {
if (!javaExtPath) {
return undefined;
}
const jreHome = path.join(javaExtPath, "jre");
if (fse.existsSync(jreHome) && fse.statSync(jreHome).isDirectory()) {
const candidates = fse.readdirSync(jreHome);
for (const candidate of candidates) {
if (fse.existsSync(path.join(jreHome, candidate, "bin", JAVA_FILENAME))) {
return path.join(jreHome, candidate);
}
}
}
return;
}
async function findDefaultRuntimeFromSettings(): Promise<string | undefined> {
const runtimes = workspace.getConfiguration().get("java.configuration.runtimes");
if (Array.isArray(runtimes) && runtimes.length) {
let candidate: string | undefined;
for (const runtime of runtimes) {
if (!runtime || typeof runtime !== 'object' || !runtime.path) {
continue;
}
const jr = await getRuntime(runtime.path);
if (jr) {
candidate = jr.homedir;
}
if (runtime.default) {
break;
}
}
return candidate;
}
return undefined;
}
function sortJdksBySource(jdks: IJavaRuntime[]) {
const rankedJdks = jdks as Array<IJavaRuntime & { rank: number }>;
const sources = ["JDK_HOME", "JAVA_HOME", "PATH"];
for (const [index, source] of sources.entries()) {
for (const jdk of rankedJdks) {
if (jdk.rank === undefined && getSources(jdk).includes(source)) {
jdk.rank = index;
}
}
}
rankedJdks.filter(jdk => jdk.rank === undefined).forEach(jdk => jdk.rank = sources.length);
rankedJdks.sort((a, b) => a.rank - b.rank);
}
/**
* Sort by major version in descend order.
*/
function sortJdksByVersion(jdks: IJavaRuntime[]) {
jdks.sort((a, b) => (b.version?.major ?? 0) - (a.version?.major ?? 0));
}
function checkJavaPreferences(){
let preference: string = 'java.jdt.ls.java.home';
let javaHome = workspace.getConfiguration().get<string>('java.jdt.ls.java.home');
if (!javaHome) { // Read java.home from the deprecated "java.home" setting.
preference = 'java.home';
javaHome = workspace.getConfiguration().get<string>('java.home');
}
return {
javaHome,
preference
};
}
function invalidJavaHome(reject: any, reason: string) {
reject(new Error(reason));
}
async function getMajorVersion(javaHome?: string): Promise<number> {
if (!javaHome) {
return 0;
}
const runtime = await getRuntime(javaHome, { withVersion: true });
return runtime?.version?.major || 0;
}