Reload prompt when extension bundle changed. (#822)

Signed-off-by: Yaohai Zheng <[email protected]>

Author: yaohaizh

.gitignore

@@ -8,3 +8,6 @@ undefined
 target
 dist
 bin/
+.settings
+.classpath
+.project

package-lock.json

@@ -10,7 +10,7 @@
   "bugs": "https://github.com/redhat-developer/vscode-java/issues",
   "preview": true,
   "engines": {
-    "vscode": "^1.30.0"
+    "vscode": "^1.31.0"
   },
   "repository": {
     "type": "git",

package.json

@@ -5,7 +5,7 @@ import * as os from 'os';
 import * as fs from 'fs';
 import { workspace, extensions, ExtensionContext, window, StatusBarAlignment, commands, ViewColumn, Uri, CancellationToken, TextDocumentContentProvider, TextEditor, WorkspaceConfiguration, languages, IndentAction, ProgressLocation, InputBoxOptions, Selection, Position, EventEmitter } from 'vscode';
 import { ExecuteCommandParams, ExecuteCommandRequest, LanguageClient, LanguageClientOptions, RevealOutputChannelOn, Position as LSPosition, Location as LSLocation, StreamInfo, VersionedTextDocumentIdentifier } from 'vscode-languageclient';
-import { collectionJavaExtensions } from './plugin';
+import { onExtensionChange, collectJavaExtensions } from './plugin';
 import { prepareExecutable, awaitServerConnection } from './javaServerStarter';
 import * as requirements from './requirements';
 import { Commands } from './commands';
@@ -68,7 +68,7 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 						],
 					},
 					initializationOptions: {
-						bundles: collectionJavaExtensions(extensions.all),
+						bundles: collectJavaExtensions(extensions.all),
 						workspaceFolders: workspace.workspaceFolders ? workspace.workspaceFolders.map(f => f.uri.toString()) : null,
 						settings: { java: getJavaConfiguration() },
 						extendedClientCapabilities:{
@@ -304,6 +304,9 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 						}
 					};
 					context.subscriptions.push(workspace.registerTextDocumentContentProvider('jdt', provider));
+					extensions.onDidChange(() => {
+						onExtensionChange(extensions.all);
+					});
 					excludeProjectSettingsFiles();
 				});
 

src/extension.ts

@@ -1,10 +1,13 @@
 'use strict';
 
-import { Extension } from 'vscode';
+import * as vscode from 'vscode';
 import * as path from 'path';
+import { Commands } from './commands';
 
-export function collectionJavaExtensions(extensions: Extension<any>[]): string[] {
-	let result = [];
+let existingExtensions: Array<string>;
+
+export function collectJavaExtensions(extensions: vscode.Extension<any>[]): string[] {
+	const result = [];
 	if (extensions && extensions.length) {
 		for (let extension of extensions) {
 			let contributesSection = extension.packageJSON['contributes'];
@@ -18,5 +21,35 @@ export function collectionJavaExtensions(extensions: Extension<any>[]): string[]
 			}
 		}
 	}
+	// Make a copy of extensions:
+	existingExtensions = result.slice();
 	return result;
 }
+
+export function onExtensionChange(extensions: vscode.Extension<any>[]) {
+	if (!existingExtensions) {
+		return;
+	}
+	const oldExtensions = new Set(existingExtensions.slice());
+	const newExtensions = collectJavaExtensions(extensions);
+	let hasChanged = ( oldExtensions.size != newExtensions.length);
+	if (!hasChanged) {
+		for (const newExtension of newExtensions) {
+			if (!oldExtensions.has(newExtension)) {
+				hasChanged = true;
+				break;
+			}
+		}
+	}
+
+	if (hasChanged) {
+		const msg = 'Extensions to the Java Language Server changed, reloading Visual Studio Code is required for the changes to take effect.';
+		const action = 'Reload';
+		const restartId = Commands.RELOAD_WINDOW;
+		vscode.window.showWarningMessage(msg, action).then((selection) => {
+			if (action === selection) {
+				vscode.commands.executeCommand(restartId);
+			}
+		});
+	}
+}

src/plugin.ts

@@ -88,7 +88,7 @@ suite('Java Language Extension', () => {
 		};
 
 		const extensions = [fakedExtension];
-		const result = plugin.collectionJavaExtensions(extensions);
+		const result = plugin.collectJavaExtensions(extensions);
 		assert(result.length === 1);
 		assert(result[0].endsWith(path.normalize('./bin/java.extend.jar')));
 	});