Provide reload project code action on demand (#2575)

- The reload project code actions will be provided for the related
  diagnostics.

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

Author: jdneo

src/gradle/gradleCodeActionProvider.ts

@@ -4,7 +4,7 @@ import * as fse from "fs-extra";
 import * as path from "path";
 import { CancellationToken, CodeAction, CodeActionContext, CodeActionKind, CodeActionProvider, CodeActionProviderMetadata, Command, commands, Diagnostic, DiagnosticRelatedInformation, ExtensionContext, ProviderResult, Range, Selection, TextDocument, Uri } from "vscode";
 import { Commands } from "../commands";
-import { upgradeGradle } from "../standardLanguageClient";
+import { upgradeGradle } from "../standardLanguageClientUtils";
 
 export class GradleCodeActionProvider implements CodeActionProvider<CodeAction> {
 
@@ -29,6 +29,17 @@ export class GradleCodeActionProvider implements CodeActionProvider<CodeAction>
 	private async provideGradleCodeActions(document: TextDocument, diagnostics: readonly Diagnostic[]): Promise<CodeAction[]> {
 		const codeActions = [];
 		for (const diagnostic of diagnostics) {
+			if (diagnostic.message?.startsWith("The build file has been changed")) {
+				const reloadProjectAction = new CodeAction("Reload project", CodeActionKind.QuickFix);
+				reloadProjectAction.command = {
+					title: "Reload Project",
+					command: Commands.CONFIGURATION_UPDATE,
+					arguments: [document.uri],
+				};
+				codeActions.push(reloadProjectAction);
+				continue;
+			}
+
 			const documentUri = document.uri.toString();
 			if (documentUri.endsWith(GradleCodeActionProvider.WRAPPER_PROPERTIES_DESCRIPTOR) && diagnostic.code === GradleCodeActionProvider.GRADLE_INVALID_TYPE_CODE_ID.toString()) {
 				const projectPath = path.resolve(Uri.parse(documentUri).fsPath, "..", "..", "..").normalize();

src/pom/pomCodeActionProvider.ts

@@ -14,13 +14,13 @@ export class PomCodeActionProvider implements CodeActionProvider<CodeAction> {
 
 	provideCodeActions(document: TextDocument, range: Range | Selection, context: CodeActionContext, token: CancellationToken): ProviderResult<(Command | CodeAction)[]> {
 		if (context?.diagnostics?.length && context.diagnostics[0].source === "Java") {
-			return this.collectCodeActionsForNotCoveredExecutions(document, context.diagnostics);
+			return this.collectCodeActions(document, context.diagnostics);
 		}
 
 		return undefined;
 	}
 
-	private collectCodeActionsForNotCoveredExecutions(document: TextDocument, diagnostics: readonly Diagnostic[]): CodeAction[] {
+	private collectCodeActions(document: TextDocument, diagnostics: readonly Diagnostic[]): CodeAction[] {
 		const codeActions: CodeAction[] = [];
 		for (const diagnostic of diagnostics) {
 			if (diagnostic.message?.startsWith("Plugin execution not covered by lifecycle configuration")) {
@@ -48,6 +48,14 @@ export class PomCodeActionProvider implements CodeActionProvider<CodeAction> {
 				action3.edit.insert(document.uri, diagnostic.range.end, indentation + "<?m2e ignore?>");
 				action3.command = saveAndUpdateConfigCommand;
 				codeActions.push(action3);
+			} else if (diagnostic.message?.startsWith("The build file has been changed")) {
+				const reloadProjectAction = new CodeAction("Reload project", CodeActionKind.QuickFix);
+				reloadProjectAction.command = {
+					title: "Reload Project",
+					command: Commands.CONFIGURATION_UPDATE,
+					arguments: [document.uri],
+				};
+				codeActions.push(reloadProjectAction);
 			}
 		}
 

src/standardLanguageClient.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-import { ExtensionContext, window, workspace, commands, Uri, ProgressLocation, ViewColumn, EventEmitter, extensions, Location, languages, CodeActionKind, TextEditor, CancellationToken, ConfigurationTarget, Range, Position } from "vscode";
+import { ExtensionContext, window, workspace, commands, Uri, ProgressLocation, ViewColumn, EventEmitter, extensions, Location, languages, CodeActionKind, TextEditor, CancellationToken, ConfigurationTarget } from "vscode";
 import { Commands } from "./commands";
 import { serverStatus, ServerStatusKind } from "./serverStatus";
 import { prepareExecutable, awaitServerConnection } from "./javaServerStarter";
@@ -36,7 +36,7 @@ import { snippetCompletionProvider } from "./snippetCompletionProvider";
 import { JavaInlayHintsProvider } from "./inlayHintsProvider";
 import { gradleCodeActionMetadata, GradleCodeActionProvider } from "./gradle/gradleCodeActionProvider";
 import { checkLombokDependency } from "./lombokSupport";
-import { askForProjects, projectConfigurationUpdate } from "./standardLanguageClientUtils";
+import { askForProjects, projectConfigurationUpdate, upgradeGradle } from "./standardLanguageClientUtils";
 
 const extensionName = 'Language Support for Java';
 const GRADLE_CHECKSUM = "gradle/checksum/prompt";
@@ -559,7 +559,7 @@ export class StandardLanguageClient {
 
 			languages.registerCodeActionsProvider({
 				scheme: "file",
-				pattern: "**/gradle/wrapper/gradle-wrapper.properties"
+				pattern: "**/{gradle/wrapper/gradle-wrapper.properties,build.gradle,build.gradle.kts,settings.gradle,settings.gradle.kts}"
 			}, new GradleCodeActionProvider(context), gradleCodeActionMetadata);
 
 			if (languages.registerInlayHintsProvider) {
@@ -674,31 +674,3 @@ export function showNoLocationFound(message: string): void {
 		message
 	);
 }
-
-export async function upgradeGradle(projectUri: string, version?: string): Promise<void> {
-	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, version, 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_CMD);
-	}
-}

src/standardLanguageClientUtils.ts

@@ -1,7 +1,8 @@
 'use strict';
 
-import { commands, QuickPickItem, Uri, window } from "vscode";
+import { commands, ConfigurationTarget, Position, ProgressLocation, QuickPickItem, Range, Uri, window, workspace } from "vscode";
 import * as path from "path";
+import * as fse from "fs-extra";
 import { TextDocumentIdentifier } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
 import { buildFilePatterns } from "./plugin";
@@ -120,3 +121,31 @@ async function generateProjectPicks(activeFileUri: Uri | undefined): Promise<Qui
 
 	return projectPicks;
 }
+
+export async function upgradeGradle(projectUri: string, version?: string): Promise<void> {
+	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, version, 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_CMD);
+	}
+}

test/standard-mode-suite/codeActionProvider.test.ts

@@ -0,0 +1,60 @@
+'use strict';
+
+import * as assert from 'assert';
+import * as path from 'path';
+import { CodeAction, CodeActionContext, CodeActionKind, CodeActionTriggerKind, DiagnosticSeverity, ExtensionContext, Position, Range, Uri, window } from "vscode";
+import { Commands } from '../../src/commands';
+import { GradleCodeActionProvider } from '../../src/gradle/gradleCodeActionProvider';
+import { PomCodeActionProvider } from "../../src/pom/pomCodeActionProvider";
+
+// tslint:disable: only-arrow-functions
+const mavenProjectFsPath: string = path.join(__dirname, '..', '..', '..', 'test', 'resources', 'projects', 'maven', 'salut');
+const gradleProjectFsPath: string = path.join(__dirname, '..', '..', '..', 'test', 'resources', 'projects', 'gradle', 'simple-gradle');
+
+suite('Code Action Provider Test', () => {
+
+	test('Provide reload project action on demand for pom file', async function () {
+		const contextMock = {
+			subscriptions: []
+		};
+		const provider = new PomCodeActionProvider(contextMock as ExtensionContext);
+
+		const codeActionContext: CodeActionContext = {
+			triggerKind: CodeActionTriggerKind.Invoke,
+			diagnostics: [{
+				range: new Range(new Position(0, 0), new Position(0, 0)),
+				message: 'The build file has been changed and may need reload to make it effective.',
+				severity: DiagnosticSeverity.Information,
+				source: 'Java'
+			}],
+			only: CodeActionKind.QuickFix
+		};
+		const editor = await window.showTextDocument(Uri.file(path.join(mavenProjectFsPath, 'pom.xml')));
+		const codeActions = provider.provideCodeActions(editor.document, null, codeActionContext, null) as CodeAction[];
+		assert.equal(codeActions.length, 1);
+		assert.equal(codeActions[0].command.command, Commands.CONFIGURATION_UPDATE);
+	});
+
+	test('Provide reload project action on demand for gradle file', async function () {
+		const contextMock = {
+			subscriptions: []
+		};
+		const provider = new GradleCodeActionProvider(contextMock as ExtensionContext);
+
+		const codeActionContext: CodeActionContext = {
+			triggerKind: CodeActionTriggerKind.Invoke,
+			diagnostics: [{
+				range: new Range(new Position(0, 0), new Position(0, 0)),
+				message: 'The build file has been changed and may need reload to make it effective.',
+				severity: DiagnosticSeverity.Information,
+				source: 'Java'
+			}],
+			only: CodeActionKind.QuickFix
+		};
+		const editor = await window.showTextDocument(Uri.file(path.join(gradleProjectFsPath, 'build.gradle')));
+		const codeActions = (await provider.provideCodeActions(editor.document, null, codeActionContext, null)) as CodeAction[];
+		assert.equal(codeActions.length, 1);
+		assert.equal(codeActions[0].command.command, Commands.CONFIGURATION_UPDATE);
+	});
+
+});