(GH-100) Refactor Extension logging to an interface

In order to support common code between the Extension and an out-of-process
debug adapter, the logging facility was moved to an interface and a series
of concrete implementations.  The Debug Adapter is not able to import the vscode
namespace as it does not exist inside the editor.  This commit;
- Creates a ILogger interface which is passed between objects instead of the
  concrete implementation of Logger
- Changes the current Logger object to be an OutputChannel Logger
- Add a file, null and stdout logging implementation which cna be used by the
  Debug Adapter or during debugging the extenion itself
- Update all of the references to Logger to ILogger in the extension

Author: glennsarti

client/src/commands/pdk/pdkNewClassCommand.ts

@@ -3,15 +3,15 @@
 import * as vscode from 'vscode';
 import * as cp from 'child_process';
 import ChildProcess = cp.ChildProcess;
-import { Logger } from '../../logging';
+import { ILogger } from '../../logging';
 import { reporter } from '../../telemetry/telemetry';
 import * as messages from '../../messages';
 
 export class pdkNewClassCommand {
-  private logger: Logger = undefined;
+  private logger: ILogger = undefined;
   private terminal: vscode.Terminal = undefined;
 
-  constructor(logger: Logger, terminal: vscode.Terminal) {
+  constructor(logger: ILogger, terminal: vscode.Terminal) {
     this.logger = logger;
     this.terminal = terminal;
   }

client/src/commands/pdk/pdkNewModuleCommand.ts

@@ -1,15 +1,15 @@
 'use strict';
 
 import * as vscode from 'vscode';
-import { Logger } from '../../logging';
+import { ILogger } from '../../logging';
 import { reporter } from '../../telemetry/telemetry';
 import * as messages from '../../messages';
 
 export class pdkNewModuleCommand {
-  private logger: Logger = undefined;
+  private logger: ILogger = undefined;
   private terminal: vscode.Terminal = undefined;
 
-  constructor(logger: Logger, terminal: vscode.Terminal) {
+  constructor(logger: ILogger, terminal: vscode.Terminal) {
     this.logger = logger;
     this.terminal = terminal;
   }

client/src/commands/pdk/pdkTestCommand.ts

@@ -3,15 +3,15 @@
 import * as vscode from 'vscode';
 import * as cp from 'child_process';
 import ChildProcess = cp.ChildProcess;
-import { Logger } from '../../logging';
+import { ILogger } from '../../logging';
 import { reporter } from '../../telemetry/telemetry';
 import * as messages from '../../messages';
 
 export class pdkTestUnitCommand {
-  private logger: Logger = undefined;
+  private logger: ILogger = undefined;
   private terminal: vscode.Terminal = undefined;
 
-  constructor(logger: Logger, terminal: vscode.Terminal) {
+  constructor(logger: ILogger, terminal: vscode.Terminal) {
     this.logger = logger;
     this.terminal = terminal;
   }

client/src/commands/pdk/pdkValidateCommand.ts

@@ -3,15 +3,15 @@
 import * as vscode from 'vscode';
 import * as cp from 'child_process';
 import ChildProcess = cp.ChildProcess;
-import { Logger } from '../../logging';
+import { ILogger } from '../../logging';
 import { reporter } from '../../telemetry/telemetry';
 import * as messages from '../../messages';
 
 export class pdkValidateCommand {
-  private logger: Logger = undefined;
+  private logger: ILogger = undefined;
   private terminal: vscode.Terminal = undefined;
 
-  constructor(logger: Logger, terminal: vscode.Terminal) {
+  constructor(logger: ILogger, terminal: vscode.Terminal) {
     this.logger = logger;
     this.terminal = terminal;
   }

client/src/commands/pdkcommands.ts

@@ -1,14 +1,14 @@
 import * as vscode from 'vscode';
 import * as messages from '../../src/messages';
 import { IConnectionManager } from '../../src/connection';
-import { Logger } from '../../src/logging';
+import { ILogger } from '../../src/logging';
 import { pdkNewModuleCommand } from './pdk/pdkNewModuleCommand';
 import { pdkNewClassCommand } from './pdk/pdkNewClassCommand';
 import { pdkNewTaskCommand } from './pdk/pdkNewTaskCommand';
 import { pdkValidateCommand } from './pdk/pdkValidateCommand';
 import { pdkTestUnitCommand } from './pdk/pdkTestCommand';
 
-export function setupPDKCommands(langID: string, connManager: IConnectionManager, ctx: vscode.ExtensionContext, logger: Logger, terminal: vscode.Terminal) {
+export function setupPDKCommands(langID: string, connManager: IConnectionManager, ctx: vscode.ExtensionContext, logger: ILogger, terminal: vscode.Terminal) {
   let newModuleCommand = new pdkNewModuleCommand(logger, terminal);
   ctx.subscriptions.push(newModuleCommand);
   ctx.subscriptions.push(vscode.commands.registerCommand(messages.PDKCommandStrings.PdkNewModuleCommandId, () => {

client/src/commands/puppet/puppetResourceCommand.ts

@@ -2,7 +2,7 @@
 
 import * as vscode from 'vscode';
 import { IConnectionManager, ConnectionStatus } from '../../connection';
-import { Logger } from '../../logging';
+import { ILogger } from '../../logging';
 import { reporter } from '../../telemetry/telemetry';
 import * as messages from '../../messages';
 
@@ -13,9 +13,9 @@ class RequestParams implements messages.PuppetResourceRequestParams {
 
 export class puppetResourceCommand {
   private _connectionManager: IConnectionManager = undefined;
-  private logger: Logger = undefined;
+  private logger: ILogger = undefined;
 
-  constructor(connMgr: IConnectionManager, logger: Logger) {
+  constructor(connMgr: IConnectionManager, logger: ILogger) {
     this._connectionManager = connMgr;
     this.logger = logger;
   }

client/src/commands/puppetcommands.ts

@@ -1,14 +1,14 @@
 import * as vscode from 'vscode';
 import * as messages from '../../src/messages';
 import { IConnectionManager } from '../../src/connection';
-import { Logger } from '../../src/logging';
+import { ILogger } from '../../src/logging';
 import {
   PuppetNodeGraphContentProvider, isNodeGraphFile,
   getNodeGraphUri, showNodeGraph
 } from '../../src/providers/previewNodeGraphProvider';
 import { puppetResourceCommand } from '../commands/puppet/puppetResourceCommand';
 
-export function setupPuppetCommands(langID:string, connManager:IConnectionManager, ctx:vscode.ExtensionContext, logger: Logger){
+export function setupPuppetCommands(langID:string, connManager:IConnectionManager, ctx:vscode.ExtensionContext, logger: ILogger){
 
   let resourceCommand = new puppetResourceCommand(connManager, logger);
   ctx.subscriptions.push(resourceCommand);

client/src/connection.ts

@@ -2,7 +2,7 @@ import net = require('net');
 import path = require('path');
 import vscode = require('vscode');
 import cp = require('child_process');
-import { Logger } from '../src/logging';
+import { ILogger } from '../src/logging';
 import { LanguageClient, LanguageClientOptions, ServerOptions } from 'vscode-languageclient';
 import { ConnectionConfiguration } from './configuration';
 import { setupPuppetCommands } from '../src/commands/puppetcommands';
@@ -53,7 +53,7 @@ export class ConnectionManager implements IConnectionManager {
   private languageServerProcess = undefined;
   private extensionContext = undefined;
   private commandsRegistered = false;
-  private logger: Logger = undefined;
+  private logger: ILogger = undefined;
   private terminal: vscode.Terminal = undefined
 
   public get status() : ConnectionStatus {
@@ -66,7 +66,7 @@ export class ConnectionManager implements IConnectionManager {
     this.logger.show()
   }
 
-  constructor(context: vscode.ExtensionContext, logger: Logger) {
+  constructor(context: vscode.ExtensionContext, logger: ILogger) {
     this.logger = logger;
     this.extensionContext = context;
   }

client/src/extension.ts

@@ -5,7 +5,8 @@ import * as path from 'path';
 
 import { ConnectionManager, IConnectionConfiguration, ConnectionType } from './connection';
 import { ConnectionConfiguration } from './configuration';
-import { Logger } from './logging';
+import { ILogger } from './logging';
+import { OutputChannelLogger } from './logging/outputchannel';
 import { Reporter } from './telemetry/telemetry';
 
 const langID = 'puppet'; // don't change this
@@ -21,7 +22,7 @@ export function activate(context: vscode.ExtensionContext) {
   notifyOnNewExtensionVersion(context, puppetExtensionVersion)
 
   context.subscriptions.push(new Reporter(context));
-  var logger = new Logger();
+  var logger = new OutputChannelLogger();
   connManager = new ConnectionManager(context, logger);
 
   var configSettings = new ConnectionConfiguration(context);

client/src/logging.ts

@@ -3,87 +3,18 @@
 import * as vscode from 'vscode';
 
 export enum LogLevel {
-    Verbose,
-    Debug,
-    Normal,
-    Warning,
-    Error
+  Verbose,
+  Debug,
+  Normal,
+  Warning,
+  Error
 }
 
-export class Logger {
-
-  private logChannel: vscode.OutputChannel;
-
-  // Minimum log level that is shown to users on logChannel
-  private minimumUserLogLevel: LogLevel = undefined;
-
-  constructor() {
-    this.logChannel = vscode.window.createOutputChannel("Puppet");
-
-    let config = vscode.workspace.getConfiguration('puppet');
-    let logLevelName = config['languageclient']['minimumUserLogLevel'];
-    let logLevel = this.logLevelFromString(logLevelName);
-
-    if(logLevel == undefined) {
-      this.minimumUserLogLevel = LogLevel.Normal;
-      this.error("Logger could not interpret " + logLevelName + " as a log level setting");
-    } else {
-      this.minimumUserLogLevel = logLevel;
-    }
-  }
-
-  public show(){
-    this.logChannel.show();
-  }
-
-  public verbose(message: string) {
-    this.logWithLevel(LogLevel.Verbose, message);
-  }
-
-  public debug(message: string) {
-    this.logWithLevel(LogLevel.Debug, message);
-  }
-
-  public normal(message: string) {
-    this.logWithLevel(LogLevel.Normal, message);
-  }
-
-  public warning(message: string) {
-    this.logWithLevel(LogLevel.Warning, message);
-  }
-
-  public error(message: string) {
-    this.logWithLevel(LogLevel.Error, message);
-  }
-
-  private logWithLevel(level: LogLevel, message) {
-    let logMessage = this.logLevelPrefixAsString(level) + (new Date().toISOString()) + ' ' + message
-
-    console.log(logMessage);
-    if (level >= this.minimumUserLogLevel) {
-      this.logChannel.appendLine(logMessage);
-    }
-  }
-
-  private logLevelFromString(logLevelName: String): LogLevel {
-    switch (logLevelName.toLowerCase()) {
-      case "verbose": return LogLevel.Verbose;
-      case "debug": return LogLevel.Debug;
-      case "normal": return LogLevel.Normal;
-      case "warning": return LogLevel.Warning;
-      case "error": return LogLevel.Error;
-      default:  return undefined;
-    }
-  }
-
-  private logLevelPrefixAsString(level: LogLevel): String {
-    switch (level) {
-      case LogLevel.Verbose: return "VERBOSE: ";
-      case LogLevel.Debug: return "DEBUG: ";
-      case LogLevel.Warning: return "WARNING: ";
-      case LogLevel.Error: return "ERROR: ";
-      default: return "";
-    }
-  }
+export interface ILogger {
+  show();
+  verbose(message: string);
+  debug(message: string);
+  normal(message: string);
+  warning(message: string);
+  error(message: string);
 }
-