Add APIs to get classpaths and settings (#1212)

Signed-off-by: Sheng Chen <sheche@microsoft.com>

Author: jdneo

src/commands.ts

@@ -172,4 +172,16 @@ export namespace Commands {
      * Show server task status
      */
     export const SHOW_SERVER_TASK_STATUS = 'java.show.server.task.status';
+    /**
+     * Get the project settings
+     */
+    export const GET_PROJECT_SETTINGS = 'java.project.getSettings';
+    /**
+     * Get the classpaths and modulepaths
+     */
+    export const GET_CLASSPATHS = 'java.project.getClasspaths';
+    /**
+     * Check the input file is a test file or not
+     */
+    export const IS_TEST_FILE = 'java.project.isTestFile';
 }

src/extension.api.ts

@@ -1,17 +1,80 @@
 import { getDocumentSymbolsCommand } from './documentSymbols';
 import { RequirementsData } from './requirements';
 import { TextDocumentPositionParams } from 'vscode-languageclient';
-import { CancellationToken, Command, ProviderResult } from 'vscode';
+import { CancellationToken, Command, ProviderResult, Uri, Event } from 'vscode';
 
 export type provideHoverCommandFn = (params: TextDocumentPositionParams, token: CancellationToken) => ProviderResult<Command[] | undefined>;
 export type registerHoverCommand = (callback: provideHoverCommandFn) => void;
 
-export const ExtensionApiVersion = '0.3';
+/**
+ * Gets the project settings.
+ * @param uri Uri of the source/class file that needs to be queried.
+ * @param OptionKeys the settings we want to query, for example: ["org.eclipse.jdt.core.compiler.compliance", "org.eclipse.jdt.core.compiler.source"]
+ * @returns An object with all the optionKeys.
+ * @throws Will throw errors if the Uri does not belong to any project.
+ */
+
+export type getProjectSettingsCommand = (uri: string, SettingKeys: string[]) => Promise<Object>;
+
+/**
+ * Gets the classpaths and modulepaths.
+ * @param uri Uri of the source/class file that needs to be queried.
+ * @param options Query options.
+ * @returns ClasspathResult containing both classpaths and modulepaths.
+ * @throws Will throw errors if the Uri does not belong to any project.
+ */
+
+export type getClasspathsCommand = (uri: string, options: ClasspathQueryOptions) => Promise<ClasspathResult>;
+export type ClasspathQueryOptions = {
+	/**
+	 * Determines the scope of the classpath. Valid scopes are "runtime" and "test".
+	 * If the given scope is not supported, "runtime" will be used.
+	 */
+	scope: string;
+};
+
+export type ClasspathResult = {
+	/**
+	 * Uri string of the project root path.
+	 */
+	projectRoot: string;
+	/**
+	 * File path array for the classpaths.
+	 */
+	classpaths: string[];
+	/**
+	 * File path array for the modulepaths.
+	 */
+	modulepaths: string[];
+};
+
+/**
+ * Checks if the input uri is a test source file or not.
+ * @param uri Uri of the source file that needs to be queried.
+ * @returns `true` if the input uri is a test file in its belonging project, otherwise returns false.
+ * @throws Will throw errors if the Uri does not belong to any project.
+ */
+export type isTestFileCommand = (uri: string) => Promise<boolean>;
+
+export const ExtensionApiVersion = '0.4';
 
 export interface ExtensionAPI {
-    readonly apiVersion: string;
+	readonly apiVersion: string;
 	readonly javaRequirement: RequirementsData;
 	readonly status: "Started" | "Error";
 	readonly registerHoverCommand: registerHoverCommand;
 	readonly getDocumentSymbols: getDocumentSymbolsCommand;
+	readonly getProjectSettings: getProjectSettingsCommand;
+	readonly getClasspaths: getClasspathsCommand;
+	readonly isTestFile: isTestFileCommand;
+	/**
+	 * An event which fires on classpath update.
+	 *
+	 * Note:
+	 *   1. This event will only fire for Maven/Gradle projects.
+	 *   2. This event will fire when the project's configuration file (e.g. pom.xml for Maven) get changed,
+	 *      but the classpaths might still be the same as before.
+	 *   3. The Uri points to the project root path.
+	 */
+	readonly onDidClasspathUpdate: Event<Uri>;
 }

src/extension.ts

@@ -4,7 +4,7 @@ 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, languages, IndentAction, ProgressLocation, InputBoxOptions, Selection, Position, EventEmitter, OutputChannel, TextDocument, RelativePattern } from 'vscode';
-import { ExecuteCommandParams, ExecuteCommandRequest, LanguageClient, LanguageClientOptions, RevealOutputChannelOn, Position as LSPosition, Location as LSLocation, StreamInfo, ErrorHandler, Message, ErrorAction, CloseAction, DidChangeConfigurationNotification } from 'vscode-languageclient';
+import { ExecuteCommandParams, ExecuteCommandRequest, LanguageClient, LanguageClientOptions, RevealOutputChannelOn, Position as LSPosition, Location as LSLocation, StreamInfo, ErrorHandler, Message, ErrorAction, CloseAction, DidChangeConfigurationNotification, Emitter } from 'vscode-languageclient';
 import { onExtensionChange, collectJavaExtensions } from './plugin';
 import { prepareExecutable, awaitServerConnection } from './javaServerStarter';
 import { getDocumentSymbolsCommand, getDocumentSymbolsProvider } from './documentSymbols';
@@ -14,7 +14,7 @@ import {
 	StatusNotification, ClassFileContentsRequest, ProjectConfigurationUpdateRequest, MessageType, ActionableNotification, FeatureStatus, CompileWorkspaceRequest, CompileWorkspaceStatus, ProgressReportNotification, ExecuteClientCommandRequest, SendNotificationRequest,
 	SourceAttachmentRequest, SourceAttachmentResult, SourceAttachmentAttribute
 } from './protocol';
-import { ExtensionAPI, ExtensionApiVersion } from './extension.api';
+import { ExtensionAPI, ExtensionApiVersion, ClasspathQueryOptions, ClasspathResult } from './extension.api';
 import * as buildpath from './buildpath';
 import * as hoverAction from './hoverAction';
 import * as sourceAction from './sourceAction';
@@ -242,6 +242,21 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 			const snippetProvider: SnippetCompletionProvider = new SnippetCompletionProvider();
 			context.subscriptions.push(languages.registerCompletionItemProvider({ scheme: 'file', language: 'java' }, snippetProvider));
 
+			const getProjectSettings = async (uri: string, SettingKeys: string[]) => {
+				return await commands.executeCommand<Object>(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.GET_PROJECT_SETTINGS, uri, SettingKeys);
+			};
+
+			const getClasspaths = async (uri: string, options: ClasspathQueryOptions) => {
+				return await commands.executeCommand<ClasspathResult>(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.GET_CLASSPATHS, uri, JSON.stringify(options));
+			};
+
+			const isTestFile = async (uri: string) => {
+				return await commands.executeCommand<boolean>(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.IS_TEST_FILE, uri);
+			};
+
+			const _onDidClasspathUpdate = new Emitter<Uri>();
+			const onDidClasspathUpdate = _onDidClasspathUpdate.event;
+
 			languageClient.onReady().then(() => {
 				languageClient.onNotification(StatusNotification.type, (report) => {
 					switch (report.type) {
@@ -253,7 +268,11 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 								javaRequirement: requirements,
 								status: report.type,
 								registerHoverCommand,
-								getDocumentSymbols
+								getDocumentSymbols,
+								getProjectSettings,
+								getClasspaths,
+								isTestFile,
+								onDidClasspathUpdate
 							});
 							snippetProvider.setActivation(false);
 							break;
@@ -264,7 +283,11 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 								javaRequirement: requirements,
 								status: report.type,
 								registerHoverCommand,
-								getDocumentSymbols
+								getDocumentSymbols,
+								getProjectSettings,
+								getClasspaths,
+								isTestFile,
+								onDidClasspathUpdate
 							});
 							break;
 						case 'Starting':
@@ -278,6 +301,10 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 					serverTasks.updateServerTask(progress);
 				});
 				languageClient.onNotification(ActionableNotification.type, (notification) => {
+					if (notification.message === "__CLASSPATH_UPDATED__") {
+						_onDidClasspathUpdate.fire(Uri.parse(notification.data));
+						return;
+					}
 					let show = null;
 					switch (notification.severity) {
 						case MessageType.Log: