Add commands to view Java Language Server debug and error logs

- Open log files in same view column, outside preview-mode for better
  visibility

Resolves #2367

Signed-off-by: Karl von Randow <[email protected]>

Author: karlvr

package.json

@@ -924,13 +924,19 @@
       },
       {
         "command": "java.open.serverLog",
-        "title": "%java.open.serverLog%",
-        "category": "Java"
+        "when": "false"
+      },
+      {
+        "command": "java.open.serverStdoutLog",
+        "when": "false"
+      },
+      {
+        "command": "java.open.serverStderrLog",
+        "when": "false"
       },
       {
         "command": "java.open.clientLog",
-        "title": "%java.open.clientLog%",
-        "category": "Java"
+        "when": "false"
       },
       {
         "command": "java.open.logs",

package.nls.json

@@ -2,8 +2,6 @@
 	"java.server.mode.switch": "Switch to Standard Mode",
 	"java.projectConfiguration.update": "Update Project",
 	"java.project.import": "Import Java Projects into Workspace",
-	"java.open.serverLog": "Open Java Language Server Log File",
-	"java.open.clientLog": "Open Java Extension Log File",
 	"java.open.logs": "Open All Log Files",
 	"java.workspace.compile": "Force Java Compilation",
 	"java.open.formatter.settings": "Open Java Formatter Settings",

package.nls.zh.json

@@ -2,8 +2,6 @@
 	"java.server.mode.switch": "切换到标准模式",
 	"java.projectConfiguration.update": "更新项目",
 	"java.project.import": "将 Java 项目导入工作区",
-	"java.open.serverLog": "打开 Java 语言服务器日志文件",
-	"java.open.clientLog": "打开 Java 插件日志文件",
 	"java.open.logs": "打开所有日志文件",
 	"java.workspace.compile": "强制编译",
 	"java.open.formatter.settings": "打开 Java 格式设置",

src/commands.ts

@@ -84,6 +84,16 @@ export namespace Commands {
     */
     export const OPEN_SERVER_LOG = 'java.open.serverLog';
 
+    /**
+    * Open Java Language Service Output Log file
+    */
+    export const OPEN_SERVER_STDOUT_LOG = 'java.open.serverStdoutLog';
+
+    /**
+    * Open Java Language Server Error Log file
+    */
+    export const OPEN_SERVER_STDERR_LOG = 'java.open.serverStderrLog';
+
     /**
     * Open Java client Log file
     */

src/extension.ts

@@ -369,6 +369,8 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 
 			// Register commands here to make it available even when the language client fails
 			context.subscriptions.push(commands.registerCommand(Commands.OPEN_SERVER_LOG, (column: ViewColumn) => openServerLogFile(workspacePath, column)));
+			context.subscriptions.push(commands.registerCommand(Commands.OPEN_SERVER_STDOUT_LOG, (column: ViewColumn) => openRollingServerLogFile(workspacePath, '.out-jdt.ls', column)));
+			context.subscriptions.push(commands.registerCommand(Commands.OPEN_SERVER_STDERR_LOG, (column: ViewColumn) => openRollingServerLogFile(workspacePath, '.error-jdt.ls', column)));
 
 			context.subscriptions.push(commands.registerCommand(Commands.OPEN_CLIENT_LOG, (column: ViewColumn) => openClientLogFile(clientLogFile, column)));
 
@@ -734,6 +736,25 @@ function openServerLogFile(workspacePath, column: ViewColumn = ViewColumn.Active
 	return openLogFile(serverLogFile, 'Could not open Java Language Server log file', column);
 }
 
+function openRollingServerLogFile(workspacePath, filename, column: ViewColumn = ViewColumn.Active): Thenable<boolean> {
+	return new Promise((resolve) => {
+		const dirname = path.join(workspacePath, '.metadata');
+
+		// find out the newest one
+		glob(filename + '-*', { cwd: dirname }, (err, files) => {
+			if (!err && files.length > 0) {
+				files.sort();
+
+				const logFile = path.join(dirname, files[files.length - 1]);
+				openLogFile(logFile, `Could not open Java Language Server log file ${filename}`, column).then((result) => resolve(result));
+			} else {
+				window.showWarningMessage(`Could not find Java Language Server log file ${filename} in ${dirname}`);
+				resolve(false);
+			}
+		});
+	});
+}
+
 function openClientLogFile(logFile: string, column: ViewColumn = ViewColumn.Active): Thenable<boolean> {
 	return new Promise((resolve) => {
 		const filename = path.basename(logFile);
@@ -765,7 +786,9 @@ function openClientLogFile(logFile: string, column: ViewColumn = ViewColumn.Acti
 
 async function openLogs() {
 	await commands.executeCommand(Commands.OPEN_CLIENT_LOG, ViewColumn.One);
-	await commands.executeCommand(Commands.OPEN_SERVER_LOG, ViewColumn.Two);
+	await commands.executeCommand(Commands.OPEN_SERVER_LOG, ViewColumn.One);
+	await commands.executeCommand(Commands.OPEN_SERVER_STDOUT_LOG, ViewColumn.One);
+	await commands.executeCommand(Commands.OPEN_SERVER_STDERR_LOG, ViewColumn.One);
 }
 
 function openLogFile(logFile, openingFailureWarning: string, column: ViewColumn = ViewColumn.Active): Thenable<boolean> {
@@ -778,7 +801,7 @@ function openLogFile(logFile, openingFailureWarning: string, column: ViewColumn
 			if (!doc) {
 				return false;
 			}
-			return window.showTextDocument(doc, column)
+			return window.showTextDocument(doc, {viewColumn: column, preview: false})
 				.then(editor => !!editor);
 		}, () => false)
 		.then(didOpen => {

test/lightweight-mode-suite/extension.test.ts

@@ -16,6 +16,8 @@ suite('Java Language Extension - LightWeight', () => {
 			const JAVA_COMMANDS = [
 				Commands.EXECUTE_WORKSPACE_COMMAND,
 				Commands.OPEN_SERVER_LOG,
+				Commands.OPEN_SERVER_STDOUT_LOG,
+				Commands.OPEN_SERVER_STDERR_LOG,
 				Commands.OPEN_CLIENT_LOG,
 				Commands.OPEN_LOGS,
 				Commands.OPEN_FORMATTER,

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

@@ -55,6 +55,8 @@ suite('Java Language Extension - Standard', () => {
 				Commands.OPEN_LOGS,
 				Commands.OPEN_OUTPUT,
 				Commands.OPEN_SERVER_LOG,
+				Commands.OPEN_SERVER_STDOUT_LOG,
+				Commands.OPEN_SERVER_STDERR_LOG,
 				Commands.ORGANIZE_IMPORTS,
 				Commands.OVERRIDE_METHODS_PROMPT,
 				Commands.PROJECT_CONFIGURATION_STATUS,