Add context menu to update source attachment for the binary classfile (#699)

Signed-off-by: Jinbo Wang <jinbwan@microsoft.com>

Author: testforstephen

package.json

@@ -291,6 +291,11 @@
         "command": "java.clean.workspace",
         "title": "Clean the Java language server workspace",
         "category": "Java"
+      },
+      {
+        "command": "java.project.updateSourceAttachment",
+        "title": "Attach Source",
+        "category": "Java"
       }
     ],
     "keybindings": [
@@ -323,6 +328,11 @@
           "when": "editorLangId == java",
           "group": "1_javaactions"
         },
+        {
+          "command": "java.project.updateSourceAttachment",
+          "when": "editorReadonly && editorLangId == java",
+          "group": "1_javaactions"
+        },
         {
           "command": "java.projectConfiguration.update",
           "when": "resourceFilename =~ /(.*\\.gradle)|(pom.xml)$/",
@@ -333,6 +343,10 @@
         {
           "command": "java.edit.organizeImports",
           "when": "!editorReadonly && editorLangId == java"
+        },
+        {
+          "command": "java.project.updateSourceAttachment",
+          "when": "false"
         }
       ]
     }

src/commands.ts

@@ -86,4 +86,12 @@ export namespace Commands {
      * Clean the Java language server workspace
      */
     export const CLEAN_WORKSPACE = 'java.clean.workspace';
+    /**
+     * Update the source attachment for the selected class file
+     */
+    export const UPDATE_SOURCE_ATTACHMENT = 'java.project.updateSourceAttachment';
+    /**
+     * Resolve the source attachment information for the selected class file
+     */
+    export const RESOLVE_SOURCE_ATTACHMENT = 'java.project.resolveSourceAttachment';
 }

src/extension.ts

@@ -3,19 +3,21 @@
 import * as path from 'path';
 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 } from 'vscode';
-import { ExecuteCommandParams, ExecuteCommandRequest, LanguageClient, LanguageClientOptions, RevealOutputChannelOn, ServerOptions, Position as LSPosition, Location as LSLocation, StreamInfo } from 'vscode-languageclient';
+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, ServerOptions, Position as LSPosition, Location as LSLocation, StreamInfo, VersionedTextDocumentIdentifier } from 'vscode-languageclient';
 import { collectionJavaExtensions } from './plugin';
 import { prepareExecutable, awaitServerConnection } from './javaServerStarter';
 import * as requirements from './requirements';
 import { Commands } from './commands';
-import { StatusNotification, ClassFileContentsRequest, ProjectConfigurationUpdateRequest, MessageType, ActionableNotification, FeatureStatus, ActionableMessage, CompileWorkspaceRequest, CompileWorkspaceStatus, ProgressReportNotification, ExecuteClientCommandRequest, SendNotificationRequest } from './protocol';
+import { StatusNotification, ClassFileContentsRequest, ProjectConfigurationUpdateRequest, MessageType, ActionableNotification, FeatureStatus, ActionableMessage, CompileWorkspaceRequest, CompileWorkspaceStatus, ProgressReportNotification, ExecuteClientCommandRequest, SendNotificationRequest,
+SourceAttachmentRequest, SourceAttachmentResult, SourceAttachmentAttribute } from './protocol';
 import { ExtensionAPI } from './extension.api';
 import * as net from 'net';
 
 let oldConfig;
 let lastStatus;
 let languageClient: LanguageClient;
+let jdtEventEmitter = new EventEmitter<Uri>();
 const cleanWorkspaceFileName = '.cleanWorkspace';
 
 export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
@@ -251,12 +253,55 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 						});
 					});
 
+					commands.registerCommand(Commands.UPDATE_SOURCE_ATTACHMENT, async (classFileUri: Uri): Promise<boolean> => {
+						const resolveRequest: SourceAttachmentRequest = {
+							classFileUri: classFileUri.toString(),
+						};
+						const resolveResult: SourceAttachmentResult = await <SourceAttachmentResult>commands.executeCommand(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.RESOLVE_SOURCE_ATTACHMENT, JSON.stringify(resolveRequest));
+						if (resolveResult.errorMessage) {
+							window.showErrorMessage(resolveResult.errorMessage);
+							return false;
+						}
+
+						const attributes: SourceAttachmentAttribute = resolveResult.attributes || {};
+						const defaultPath = attributes.sourceAttachmentPath || attributes.jarPath;
+						const sourceFileUris: Uri[] = await window.showOpenDialog({
+							defaultUri: defaultPath ? Uri.file(defaultPath) : null,
+							openLabel: "Select Source File",
+							canSelectFiles: true,
+							canSelectFolders: false,
+							canSelectMany: false,
+							filters: {
+								"Source files": ["jar", "zip"]
+							},
+						});
+
+						if (sourceFileUris && sourceFileUris.length) {
+							const updateRequest: SourceAttachmentRequest = {
+								classFileUri: classFileUri.toString(),
+								attributes: {
+									...attributes, 
+									sourceAttachmentPath: sourceFileUris[0].fsPath
+								},
+							};
+							const updateResult: SourceAttachmentResult = await <SourceAttachmentResult>commands.executeCommand(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.UPDATE_SOURCE_ATTACHMENT, JSON.stringify(updateRequest));
+							if (updateResult.errorMessage) {
+								window.showErrorMessage(updateResult.errorMessage);
+								return false;
+							}
+
+							// Notify jdt content provider to rerender the classfile contents.
+							jdtEventEmitter.fire(classFileUri);
+							return true;
+						}
+					});
+
 					window.onDidChangeActiveTextEditor((editor) => {
 						toggleItem(editor, item);
 					});
 
 					let provider: TextDocumentContentProvider = <TextDocumentContentProvider>{
-						onDidChange: null,
+						onDidChange: jdtEventEmitter.event,
 						provideTextDocumentContent: (uri: Uri, token: CancellationToken): Thenable<string> => {
 							return languageClient.sendRequest(ClassFileContentsRequest.type, { uri: uri.toString() }, token).then((v: string): string => {
 								return v || '';

src/protocol.ts

@@ -103,4 +103,21 @@ export namespace ExecuteClientCommandRequest {
 
 export namespace SendNotificationRequest {
     export const type = new RequestType<ExecuteCommandParams, any, void, void>('workspace/notify');
+}
+
+export interface SourceAttachmentRequest {
+    classFileUri: string;
+    attributes?: SourceAttachmentAttribute;
+}
+
+export interface SourceAttachmentResult {
+    errorMessage?: string;
+    attributes?: SourceAttachmentAttribute;
+}
+
+export interface SourceAttachmentAttribute {
+    jarPath?: string;
+    sourceAttachmentPath?: string;
+    sourceAttachmentEncoding?: string;
+    canEditEncoding?: boolean;
 }

test/extension.test.ts

@@ -37,7 +37,8 @@ suite('Java Language Extension', () => {
 				Commands.COMPILE_WORKSPACE,
 				Commands.EDIT_ORGANIZE_IMPORTS,
 				Commands.OPEN_FORMATTER,
-				Commands.CLEAN_WORKSPACE
+				Commands.CLEAN_WORKSPACE,
+				Commands.UPDATE_SOURCE_ATTACHMENT
 			];
 			let foundJavaCommands = commands.filter(function(value){
 				return JAVA_COMMANDS.indexOf(value)>=0 || value.startsWith('java.');