Check Gradle compatibility when importing fails (#2245)

Signed-off-by: Shi Chen <[email protected]>

Author: CsCherrYY

src/protocol.ts

@@ -58,6 +58,7 @@ export enum FeatureStatus {
 export enum EventType {
     ClasspathUpdated = 100,
     ProjectsImported = 200,
+    IncompatibleGradleJdkIssue = 300,
 }
 
 export enum CompileWorkspaceStatus {
@@ -406,3 +407,10 @@ export interface RenameFilesParams {
 export namespace WillRenameFiles {
     export const type = new RequestType<RenameFilesParams, WorkspaceEdit, void>('workspace/willRenameFiles');
 }
+
+export interface GradleCompatibilityInfo {
+    projectUri: string;
+    message: string;
+    highestJavaVersion: string;
+    recommendedGradleVersion: string;
+}

src/requirements.ts

@@ -147,7 +147,7 @@ async function findDefaultRuntimeFromSettings(): Promise<string | undefined> {
     return undefined;
 }
 
-function sortJdksBySource(jdks: IJavaRuntime[]) {
+export 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()) {
@@ -164,7 +164,7 @@ function sortJdksBySource(jdks: IJavaRuntime[]) {
 /**
  * Sort by major version in descend order.
  */
-function sortJdksByVersion(jdks: IJavaRuntime[]) {
+export function sortJdksByVersion(jdks: IJavaRuntime[]) {
     jdks.sort((a, b) => (b.version?.major ?? 0) - (a.version?.major ?? 0));
 }
 
@@ -196,7 +196,7 @@ function openJDKDownload(reject, cause) {
     });
 }
 
-function getJdkUrl() {
+export function getJdkUrl() {
     let jdkUrl = 'https://developers.redhat.com/products/openjdk/download/?sc_cid=701f2000000RWTnAAO';
     if (process.platform === 'darwin') {
         jdkUrl = 'https://adoptopenjdk.net/';

src/standardLanguageClient.ts

@@ -1,17 +1,17 @@
 'use strict';
 
-import { ExtensionContext, window, workspace, commands, Uri, ProgressLocation, ViewColumn, EventEmitter, extensions, Location, languages, CodeActionKind, TextEditor, CancellationToken } from "vscode";
+import { ExtensionContext, window, workspace, commands, Uri, ProgressLocation, ViewColumn, EventEmitter, extensions, Location, languages, CodeActionKind, TextEditor, CancellationToken, ConfigurationTarget, Range, Position } from "vscode";
 import { Commands } from "./commands";
 import { serverStatus, ServerStatusKind } from "./serverStatus";
 import { prepareExecutable, awaitServerConnection } from "./javaServerStarter";
 import { getJavaConfig, applyWorkspaceEdit } from "./extension";
 import { LanguageClientOptions, Position as LSPosition, Location as LSLocation, MessageType, TextDocumentPositionParams, ConfigurationRequest, ConfigurationParams } from "vscode-languageclient";
 import { LanguageClient, StreamInfo } from "vscode-languageclient/node";
-import { CompileWorkspaceRequest, CompileWorkspaceStatus, SourceAttachmentRequest, SourceAttachmentResult, SourceAttachmentAttribute, ProjectConfigurationUpdateRequest, FeatureStatus, StatusNotification, ProgressReportNotification, ActionableNotification, ExecuteClientCommandRequest, ServerNotification, EventNotification, EventType, LinkLocation, FindLinks } from "./protocol";
+import { CompileWorkspaceRequest, CompileWorkspaceStatus, SourceAttachmentRequest, SourceAttachmentResult, SourceAttachmentAttribute, ProjectConfigurationUpdateRequest, FeatureStatus, StatusNotification, ProgressReportNotification, ActionableNotification, ExecuteClientCommandRequest, ServerNotification, EventNotification, EventType, LinkLocation, FindLinks, GradleCompatibilityInfo } from "./protocol";
 import { setGradleWrapperChecksum, excludeProjectSettingsFiles, ServerMode } from "./settings";
 import { onExtensionChange, collectBuildFilePattern } from "./plugin";
 import { activationProgressNotification, serverTaskPresenter } from "./serverTaskPresenter";
-import { RequirementsData } from "./requirements";
+import { getJdkUrl, RequirementsData, sortJdksBySource, sortJdksByVersion } from "./requirements";
 import * as net from 'net';
 import * as fse from 'fs-extra';
 import * as path from 'path';
@@ -32,9 +32,15 @@ import { typeHierarchyTree } from "./typeHierarchy/typeHierarchyTree";
 import { TypeHierarchyDirection, TypeHierarchyItem } from "./typeHierarchy/protocol";
 import { buildFilePatterns } from './plugin';
 import { pomCodeActionMetadata, PomCodeActionProvider } from "./pom/pomCodeActionProvider";
+import { findRuntimes, IJavaRuntime } from "jdk-utils";
 
 const extensionName = 'Language Support for Java';
 const GRADLE_CHECKSUM = "gradle/checksum/prompt";
+const GET_JDK = "Get the Java Development Kit";
+const USE_JAVA = "Use Java ";
+const AS_GRADLE_JVM = " as Gradle JVM";
+const UPGRADE_GRADLE = "Upgrade Gradle to ";
+const GRADLE_IMPORT_JVM = "java.import.gradle.java.home";
 
 export class StandardLanguageClient {
 
@@ -141,7 +147,7 @@ export class StandardLanguageClient {
 				serverTasks.updateServerTask(progress);
 			});
 
-			this.languageClient.onNotification(EventNotification.type, (notification) => {
+			this.languageClient.onNotification(EventNotification.type, async (notification) => {
 				switch (notification.eventType) {
 					case EventType.ClasspathUpdated:
 						apiManager.fireDidClasspathUpdate(Uri.parse(notification.data));
@@ -157,6 +163,23 @@ export class StandardLanguageClient {
 							apiManager.fireDidProjectsImport(projectUris);
 						}
 						break;
+					case EventType.IncompatibleGradleJdkIssue:
+						const options: string[] = [];
+						const info = notification.data as GradleCompatibilityInfo;
+						const highestJavaVersion = Number(info.highestJavaVersion);
+						let runtimes = await findRuntimes({checkJavac: true, withVersion: true, withTags: true});
+						runtimes = runtimes.filter(runtime => {
+							return runtime.version.major <= highestJavaVersion;
+						});
+						sortJdksByVersion(runtimes);
+						sortJdksBySource(runtimes);
+						options.push(UPGRADE_GRADLE + info.recommendedGradleVersion);
+						if (!runtimes.length) {
+							options.push(GET_JDK);
+						} else {
+							options.push(USE_JAVA + runtimes[0].version.major + AS_GRADLE_JVM);
+						}
+						this.showGradleCompatibilityIssueNotification(info.message, options, info.projectUri, runtimes[0]?.homedir);
 					default:
 						break;
 				}
@@ -230,6 +253,44 @@ export class StandardLanguageClient {
 		this.status = ClientStatus.Initialized;
 	}
 
+	private showGradleCompatibilityIssueNotification(message: string, options: string[], projectUri: string, newJavaHome: string) {
+		window.showErrorMessage(message + " [Learn More](https://docs.gradle.org/current/userguide/compatibility.html)", ...options).then(async (choice) => {
+			if (choice === GET_JDK) {
+				commands.executeCommand(Commands.OPEN_BROWSER, Uri.parse(getJdkUrl()));
+			} else if (choice.startsWith(USE_JAVA)) {
+				await workspace.getConfiguration().update(GRADLE_IMPORT_JVM, newJavaHome, ConfigurationTarget.Global);
+				commands.executeCommand("workbench.action.openSettings", GRADLE_IMPORT_JVM);
+				commands.executeCommand(Commands.IMPORT_PROJECTS);
+			} else if (choice.startsWith(UPGRADE_GRADLE)) {
+				const useWrapper = workspace.getConfiguration().get<boolean>("java.import.gradle.wrapper.enabled");
+				if (!useWrapper) {
+					await workspace.getConfiguration().update("java.import.gradle.wrapper.enabled", true, ConfigurationTarget.Workspace);
+				}
+				const result = await window.withProgress({
+					location: ProgressLocation.Notification,
+					title: "Upgrading Gradle wrapper...",
+					cancellable: true,
+				}, (_progress, token) => {
+					return commands.executeCommand(Commands.EXECUTE_WORKSPACE_COMMAND, "java.project.upgradeGradle", projectUri, token);
+				});
+				if (result) {
+					const propertiesFile = path.join(Uri.parse(projectUri).fsPath, "gradle", "wrapper", "gradle-wrapper.properties");
+					if (fse.pathExists(propertiesFile)) {
+						const content = await fse.readFile(propertiesFile);
+						const offset = content.toString().indexOf("distributionUrl");
+						if (offset >= 0) {
+							const document = await workspace.openTextDocument(propertiesFile);
+							const position = document.positionAt(offset);
+							const distributionUrlRange = document.getWordRangeAtPosition(position);
+							window.showTextDocument(document, {selection: new Range(distributionUrlRange.start, new Position(distributionUrlRange.start.line + 1, 0))});
+						}
+					}
+					commands.executeCommand(Commands.IMPORT_PROJECTS);
+				}
+			}
+		});
+	}
+
 	private registerCommandsForStandardServer(context: ExtensionContext, jdtEventEmitter: EventEmitter<Uri>): void {
 		context.subscriptions.push(commands.registerCommand(Commands.IMPORT_PROJECTS, async () => {
 			return await commands.executeCommand<void>(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.IMPORT_PROJECTS);