VSCode extension now sets executable permissions for the language server prior to launch

Author: fwcd

BUILDING.md

@@ -24,7 +24,7 @@ Contains the commands require to build this project. Note that you might need to
 
 ## Running/Debugging the VSCode extension
 * Open the debug tab in VSCode
-* Run the `Extension (kotlin-language-server)` launch configuration
+* Run the `Extension` launch configuration
 
 ## Packaging the VSCode extension
 * `vsce package -o build.vsix`

vscode-extension-src/extension.ts

@@ -4,12 +4,15 @@
 import * as vscode from 'vscode';
 import * as path from "path";
 import * as fs from "fs";
-import {LanguageClient, LanguageClientOptions, ServerOptions} from "vscode-languageclient";
+import * as child_process from "child_process";
+import { LanguageClient, LanguageClientOptions, ServerOptions } from "vscode-languageclient";
+import { isOSUnixoid } from './osUtils';
+import { LOG } from './logger';
 
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
 export function activate(context: vscode.ExtensionContext) {
-    console.log('Activating Kotlin language server...');
+    LOG.info('Activating Kotlin language server...');
 
     let javaExecutablePath = findJavaExecutable('java');
 
@@ -42,14 +45,20 @@ export function activate(context: vscode.ExtensionContext) {
     }
     let startScriptPath = path.resolve(context.extensionPath, "build", "install", "kotlin-language-server", "bin", correctScriptName("kotlin-language-server"))
     let args = [];
+    
+    // Ensure that start script can be executed
+    if (isOSUnixoid()) {
+        child_process.exec("chmod +x " + startScriptPath)
+    }
+    
     // Start the child java process
     let serverOptions: ServerOptions = {
         command: startScriptPath,
         args: args,
         options: { cwd: vscode.workspace.rootPath }
     }
 
-    console.log(startScriptPath + ' ' + args.join(' '));
+    LOG.info("Launching {} with args {}", startScriptPath, args.join(' '));
 
     // Create the language client and start the client.
     let languageClient = new LanguageClient('kotlin', 'Kotlin Language Server', serverOptions, clientOptions);
@@ -64,14 +73,14 @@ export function activate(context: vscode.ExtensionContext) {
 export function deactivate() {
 }
 
-function findJavaExecutable(binname: string) {
-	binname = correctBinname(binname);
+function findJavaExecutable(rawBinname: string) {
+	let binname = correctBinname(rawBinname);
 
 	// First search java.home setting
     let userJavaHome = vscode.workspace.getConfiguration('java').get('home') as string;
 
 	if (userJavaHome != null) {
-        console.log('Looking for java in settings java.home ' + userJavaHome + '...');
+        LOG.debug("Looking for Java in java.home (settings): {}", userJavaHome);
 
         let candidate = findJavaExecutableInJavaHome(userJavaHome, binname);
 
@@ -83,7 +92,7 @@ function findJavaExecutable(binname: string) {
     let envJavaHome = process.env['JAVA_HOME'];
 
 	if (envJavaHome) {
-        console.log('Looking for java in environment variable JAVA_HOME ' + envJavaHome + '...');
+        LOG.debug("Looking for Java in JAVA_HOME (environment variable): {}", envJavaHome);
 
         let candidate = findJavaExecutableInJavaHome(envJavaHome, binname);
 
@@ -93,7 +102,7 @@ function findJavaExecutable(binname: string) {
 
 	// Then search PATH parts
 	if (process.env['PATH']) {
-        console.log('Looking for java in PATH');
+        LOG.debug("Looking for Java in PATH");
 
 		let pathparts = process.env['PATH'].split(path.delimiter);
 		for (let i = 0; i < pathparts.length; i++) {
@@ -104,8 +113,9 @@ function findJavaExecutable(binname: string) {
 		}
 	}
 
-	// Else return the binary name directly (this will likely always fail downstream)
-	return null;
+    // Else return the binary name directly (this will likely always fail downstream)
+    LOG.debug("Could not find Java, will try using binary name directly");
+	return binname;
 }
 
 function correctBinname(binname: string) {
@@ -131,4 +141,4 @@ function findJavaExecutableInJavaHome(javaHome: string, binname: string) {
         if (fs.existsSync(binpath))
             return binpath;
     }
-}
+}

vscode-extension-src/logger.ts

@@ -0,0 +1,56 @@
+export enum LogLevel {
+	NONE = 100,
+	ERROR = 2,
+	WARN = 1,
+	INFO = 0,
+	DEBUG = -1,
+	TRACE = -2,
+	DEEP_TRACE = -3
+}
+
+export class Logger {
+	level: LogLevel;
+	
+	public constructor(level: LogLevel) {
+		this.level = level;
+	}
+	
+	private format(msg: String, placeholders: any[]): string {
+		let result = "";
+		let i = 0;
+		let placeholderIndex = 0;
+		while (i < msg.length) {
+			let c = msg.charAt(i);
+			let next = msg.charAt(i + 1);
+			if (c === '{' && next === '}') {
+				result += placeholders[placeholderIndex];
+				placeholderIndex++;
+				i += 2;
+			} else {
+				result += c;
+				i++;
+			}
+		}
+		return result;
+	}
+	
+	private log(prefix: String, level: LogLevel, msg: String, placeholders: any[]): void {
+		if (level >= this.level) {
+			console.log(prefix + this.format(msg, placeholders));
+		}
+	}
+	
+	public error(msg: String, ...placeholders: any[]): void { this.log("Extension: [ERROR]  ", LogLevel.ERROR, msg, placeholders); }
+	
+	public warn(msg: String, ...placeholders: any[]): void { this.log("Extension: [WARN]   ", LogLevel.WARN, msg, placeholders); }
+	
+	public info(msg: String, ...placeholders: any[]): void { this.log("Extension: [INFO]   ", LogLevel.INFO, msg, placeholders); }
+	
+	public debug(msg: String, ...placeholders: any[]): void { this.log("Extension: [DEBUG]  ", LogLevel.DEBUG, msg, placeholders); }
+	
+	public trace(msg: String, ...placeholders: any[]): void { this.log("Extension: [TRACE]  ", LogLevel.TRACE, msg, placeholders); }
+	
+	public deepTrace(msg: String, ...placeholders: any[]): void { this.log("Extension: [D_TRACE]", LogLevel.DEEP_TRACE, msg, placeholders); }
+}
+
+export const LOG = new Logger(LogLevel.INFO);

vscode-extension-src/osUtils.ts

@@ -0,0 +1,11 @@
+export function isOSWindows(): boolean {
+	return process.platform === "win32";
+}
+
+export function isOSUnixoid(): boolean {
+	let platform = process.platform;
+	return platform === "linux"
+		|| platform === "darwin"
+		|| platform === "freebsd"
+		|| platform === "openbsd";
+}