Write client log to file if option set

And add a new log level: Debug

Author: jneira

src/extension.ts

@@ -108,7 +108,7 @@ function findManualExecutable(logger: Logger, uri: Uri, folder?: WorkspaceFolder
   }
   logger.info(`Trying to find the server executable in: ${exePath}`);
   exePath = resolvePathPlaceHolders(exePath, folder);
-  logger.info(`Location after path variables substitution: ${exePath}`);
+  logger.log(`Location after path variables substitution: ${exePath}`);
 
   if (!executableExists(exePath)) {
     let msg = `serverExecutablePath is set to ${exePath}`;
@@ -164,6 +164,8 @@ async function activateServerForFolder(context: ExtensionContext, uri: Uri, fold
     return;
   }
 
+  const currentWorkingDir = folder ? folder.uri.fsPath : path.dirname(uri.fsPath);
+
   // Set the key to null to prevent multiple servers being launched at once
   clients.set(clientsKey, null);
 
@@ -173,11 +175,14 @@ async function activateServerForFolder(context: ExtensionContext, uri: Uri, fold
 
   const outputChannel: OutputChannel = window.createOutputChannel(langName);
 
-  const logger: Logger = new ExtensionLogger('client', clientLogLevel, outputChannel);
-
-  logger.info('Environment variables:');
+  const logFilePath = logFile ? path.resolve(currentWorkingDir, logFile) : undefined;
+  const logger: Logger = new ExtensionLogger('client', clientLogLevel, outputChannel, logFilePath);
+  if (logFilePath) {
+    logger.info(`Writing client log to file ${logFilePath}`);
+  }
+  logger.log('Environment variables:');
   Object.entries(process.env).forEach(([key, value]: [string, string | undefined]) => {
-    logger.info(`  ${key}: ${value}`);
+    logger.log(`  ${key}: ${value}`);
   });
 
   let serverExecutable;
@@ -217,11 +222,13 @@ async function activateServerForFolder(context: ExtensionContext, uri: Uri, fold
   // If we're operating on a standalone file (i.e. not in a folder) then we need
   // to launch the server in a reasonable current directory. Otherwise the cradle
   // guessing logic in hie-bios will be wrong!
+  let cwdMsg = `Activating the language server in working dir: ${currentWorkingDir}`;
   if (folder) {
-    logger.info(`Activating the language server in the workspace folder: ${folder?.uri.fsPath}`);
+    cwdMsg += ' (the workspace folder)';
   } else {
-    logger.info(`Activating the language server in the parent dir of the file: ${uri.fsPath}`);
+    cwdMsg += ` (parent dir of loaded file ${uri.fsPath})`;
   }
+  logger.info(cwdMsg);
 
   const serverEnvironment: IEnvVars = workspace.getConfiguration('haskell', uri).serverEnvironment;
   const exeOptions: ExecutableOptions = {
@@ -252,7 +259,7 @@ async function activateServerForFolder(context: ExtensionContext, uri: Uri, fold
   }
 
   const pat = folder ? `${folder.uri.fsPath}/**/*` : '**/*';
-  logger.info(`document selector patten: ${pat}`);
+  logger.log(`document selector patten: ${pat}`);
   const clientOptions: LanguageClientOptions = {
     // Use the document selector to only notify the LSP on files inside the folder
     // path for the specific workspace.

src/utils.ts

@@ -18,16 +18,19 @@ enum LogLevel {
   Error,
   Warn,
   Info,
+  Debug
 }
 export class ExtensionLogger implements Logger {
   public readonly name: string;
   public readonly level: LogLevel;
   public readonly channel: OutputChannel;
+  public readonly logFile: string | undefined;
 
-  constructor(name: string, level: string, channel: OutputChannel) {
+  constructor(name: string, level: string, channel: OutputChannel, logFile: string | undefined) {
     this.name = name;
     this.level = this.getLogLevel(level);
     this.channel = channel;
+    this.logFile = logFile;
   }
   public warn(message: string): void {
     this.logLevel(LogLevel.Warn, message);
@@ -41,13 +44,25 @@ export class ExtensionLogger implements Logger {
     this.logLevel(LogLevel.Error, message);
   }
 
-  public log(msg: string) {
-    this.channel.appendLine(msg);
+  public log(message: string) {
+    this.logLevel(LogLevel.Debug, message);
+  }
+
+  private write(msg: string) {
+    let now = new Date();
+    // Ugly hack to make js date iso format similar to hls one
+    const offset = now.getTimezoneOffset();
+    now = new Date(now.getTime() - (offset * 60 * 1000));
+    const timedMsg = `${new Date().toISOString().replace('T', ' ').replace('Z', '0000')} ${msg}`;
+    this.channel.appendLine(timedMsg);
+    if (this.logFile) {
+      fs.appendFileSync(this.logFile, timedMsg + '\n');
+    }
   }
 
   private logLevel(level: LogLevel, msg: string) {
     if (level <= this.level) {
-      this.log(`[${this.name}][${LogLevel[level].toUpperCase()}] ${msg}`);
+      this.write(`[${this.name}] ${LogLevel[level].toUpperCase()} ${msg}`);
     }
   }
 
@@ -57,6 +72,8 @@ export class ExtensionLogger implements Logger {
         return LogLevel.Off;
       case 'error':
         return LogLevel.Error;
+      case 'debug':
+        return LogLevel.Debug;
       default:
         return LogLevel.Info;
     }