Merge pull request #137 from glennsarti/make-client-langserver-better

jpogran · web-flow · commit 67a80a0e64a7 · 2017-09-20T10:27:16.000-04:00
(GH-136)(GH-61) Make client langserver better
diff --git a/client/package.json b/client/package.json
@@ -38,6 +38,9 @@
   ],
   "activationEvents": [
     "onLanguage:puppet",
+    "onCommand:extension.puppetRestartSession",
+    "onCommand:extension.puppetShowConnectionLogs",
+    "onCommand:extension.puppetShowConnectionMenu",
     "onCommand:extension.puppetLint",
     "onCommand:extension.puppetParserValidate",
     "onCommand:extension.puppetShowNodeGraphToSide",
@@ -87,6 +90,16 @@
       }
     ],
     "commands": [
+      {
+        "command": "extension.puppetRestartSession",
+        "category": "Puppet",
+        "title": "Restart Current Session"
+      },
+      {
+        "command": "extension.puppetShowConnectionLogs",
+        "category": "Puppet",
+        "title": "Show Connection Logs"
+      },
       {
         "command": "extension.pdkNewModule",
         "category": "Puppet",
@@ -128,6 +141,12 @@
     ],
     "menus": {
       "commandPalette": [
+        {
+          "command": "extension.puppetRestartSession"
+        },
+        {
+          "command": "extension.puppetShowConnectionLogs"
+        },
         {
           "command": "extension.pdkNewModule"
         },
@@ -255,7 +274,8 @@
         "puppet.languageclient.minimumUserLogLevel": {
           "type": "string",
           "default": "normal",
-          "description": "Set the minimum log level that the user will see on the Puppet OutputChannel (Allowed values: verbose, debug, normal, warning, error)"
+          "description": "Set the minimum log level that the user will see on the Puppet connection logs",
+          "enum": ["verbose", "debug", "normal", "warning", "error" ]
         },
         "puppet.puppetAgentDir": {
           "type": "string",
diff --git a/client/src/commands/puppetcommands.ts b/client/src/commands/puppetcommands.ts
@@ -19,7 +19,19 @@ export function setupPuppetCommands(langID:string, connManager:IConnectionManage
   ctx.subscriptions.push(vscode.commands.registerCommand(messages.PuppetCommandStrings.PuppetNodeGraphToTheSideCommandId,
     uri => showNodeGraph(uri, true))
   );
-  
+
+  ctx.subscriptions.push(vscode.commands.registerCommand(messages.PuppetCommandStrings.PuppetShowConnectionMenuCommandId,
+    () => { connManager.showConnectionMenu(); }
+  ));
+
+  ctx.subscriptions.push(vscode.commands.registerCommand(messages.PuppetCommandStrings.PuppetShowConnectionLogsCommandId,
+    () => { connManager.showLogger(); }
+  ));
+
+  ctx.subscriptions.push(vscode.commands.registerCommand(messages.PuppetCommandStrings.PuppetRestartSessionCommandId,
+    () => { connManager.restartConnection(); }
+  ));
+
   const contentProvider = new PuppetNodeGraphContentProvider(ctx, connManager);
   const contentProviderRegistration = vscode.workspace.registerTextDocumentContentProvider(langID, contentProvider);
 
diff --git a/client/src/configuration.ts b/client/src/configuration.ts
@@ -0,0 +1,27 @@
+'use strict';
+
+import * as vscode from 'vscode';
+
+import { ConnectionManager, IConnectionConfiguration, ConnectionType } from './connection';
+
+export class ConnectionConfiguration implements IConnectionConfiguration {
+  public type: ConnectionType = ConnectionType.Unknown; 
+  public host: string = undefined;
+  public port: number = undefined;
+  public timeout: number = undefined;
+  public preLoadPuppet: boolean = undefined;
+  public debugFilePath: string = undefined;
+  public puppetAgentDir: string = undefined;
+
+  constructor(context: vscode.ExtensionContext) {
+    let config = vscode.workspace.getConfiguration('puppet');
+
+    this.host          = config['languageserver']['address'];
+    this.port          = config['languageserver']['port'];
+    this.timeout       = config['languageserver']['timeout'];
+    this.preLoadPuppet = config['languageserver']['preLoadPuppet'];
+    this.debugFilePath = config['languageserver']['debugFilePath'];
+    
+    this.puppetAgentDir = config['puppetAgentDir'];
+  }
+}
diff --git a/client/src/connection.ts b/client/src/connection.ts
@@ -4,6 +4,7 @@ import vscode = require('vscode');
 import cp = require('child_process');
 import { Logger } from '../src/logging';
 import { LanguageClient, LanguageClientOptions, ServerOptions } from 'vscode-languageclient';
+import { ConnectionConfiguration } from './configuration';
 import { setupPuppetCommands } from '../src/commands/puppetcommands';
 import { setupPDKCommands } from '../src/commands/pdkcommands';
 import { reporter } from './telemetry/telemetry';
@@ -39,6 +40,9 @@ export interface IConnectionConfiguration {
 export interface IConnectionManager {
   status: ConnectionStatus;
   languageClient: LanguageClient;
+  showConnectionMenu();
+  showLogger();
+  restartConnection(connectionConfig?: IConnectionConfiguration);
 }
 
 export class ConnectionManager implements IConnectionManager {
@@ -58,6 +62,9 @@ export class ConnectionManager implements IConnectionManager {
   public get languageClient() : LanguageClient {
     return this.languageServerClient;
   }
+  public showLogger() {
+    this.logger.show()
+  }
 
   constructor(context: vscode.ExtensionContext, logger: Logger) {
     this.logger = logger;
@@ -78,7 +85,7 @@ export class ConnectionManager implements IConnectionManager {
       this.terminal = vscode.window.createTerminal('Puppet PDK');
       this.terminal.processId.then(
         pid => {
-          console.log("pdk shell started, pid: " + pid);
+          this.logger.debug("pdk shell started, pid: " + pid);
         });
       setupPDKCommands(langID, this, this.extensionContext, this.logger, this.terminal);
       this.extensionContext.subscriptions.push(this.terminal);
@@ -325,9 +332,11 @@ export class ConnectionManager implements IConnectionManager {
     var languageServerClient = new LanguageClient(title, serverOptions, clientOptions)
     languageServerClient.onReady().then(() => {
       langClient.logger.debug('Language server client started, setting puppet version')
-      languageServerClient.sendRequest(messages.PuppetVersionRequest.type).then((versionDetails) => {
-        this.setConnectionStatus(versionDetails.puppetVersion, ConnectionStatus.Running);
-        if (reporter) {
+      this.setConnectionStatus("Loading Puppet", ConnectionStatus.Starting);
+      this.queryLanguageServerStatus();
+      // Send telemetry
+      if (reporter) {
+        languageServerClient.sendRequest(messages.PuppetVersionRequest.type).then((versionDetails) => {
           reporter.sendTelemetryEvent('puppetVersion' +versionDetails.puppetVersion);
           reporter.sendTelemetryEvent('facterVersion' + versionDetails.facterVersion);
           reporter.sendTelemetryEvent('languageServerVersion' + versionDetails.languageServerVersion);
@@ -336,26 +345,66 @@ export class ConnectionManager implements IConnectionManager {
             facterVersion: versionDetails.facterVersion,
             languageServerVersion: versionDetails.languageServerVersion,
           });
-        }
-      });
+        });
+      }
     }, (reason) => {
       this.setSessionFailure("Could not start language service: ", reason);
     });
 
     return languageServerClient;
   }
 
-  private restartConnection(connectionConfig?: IConnectionConfiguration) {
-      this.stop();
-      this.start(connectionConfig);
+  private queryLanguageServerStatus() {
+    let connectionManager = this;
+
+    return new Promise((resolve, reject) => {
+      let count = 0;
+      let lastVersionResponse = null;
+      let handle = setInterval(() => {
+        count++;
+
+        // After 30 seonds timeout the progress
+        if (count >= 30 || connectionManager.languageClient == undefined) {
+          clearInterval(handle);
+          connectionManager.setConnectionStatus(lastVersionResponse.puppetVersion, ConnectionStatus.Running);
+          resolve();
+        }
+
+        connectionManager.languageClient.sendRequest(messages.PuppetVersionRequest.type).then((versionDetails) => {
+          lastVersionResponse = versionDetails
+          if (versionDetails.factsLoaded && versionDetails.functionsLoaded && versionDetails.typesLoaded) {
+            clearInterval(handle);
+            connectionManager.setConnectionStatus(lastVersionResponse.puppetVersion, ConnectionStatus.Running);
+            resolve();
+          } else {
+            let progress = 0;
+
+            if (versionDetails.factsLoaded) { progress++; }
+            if (versionDetails.functionsLoaded) { progress++; }
+            if (versionDetails.typesLoaded) { progress++; }
+            progress = Math.round(progress / 3.0 * 100);
+
+            this.setConnectionStatus("Loading Puppet (" + progress.toString() + "%)", ConnectionStatus.Starting);
+          }
+        });
+
+      }, 1000);
+    });
+  }
+
+  public restartConnection(connectionConfig?: IConnectionConfiguration) {
+    if (connectionConfig == undefined) {
+      connectionConfig = new ConnectionConfiguration(this.extensionContext);
+    }
+    this.stop();
+    this.start(connectionConfig);
   }
 
   private createStatusBarItem() {
     if (this.statusBarItem === undefined) {
       this.statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 1);
 
-      // TODO: Add a command here to show the connection menu
-      // this.statusBarItem.command = this.ShowConnectionMenuCommandName;
+      this.statusBarItem.command = messages.PuppetCommandStrings.PuppetShowConnectionMenuCommandId;
       this.statusBarItem.show();
       vscode.window.onDidChangeActiveTextEditor(textEditor => {
         if (textEditor === undefined || textEditor.document.languageId !== "puppet") {
@@ -368,6 +417,27 @@ export class ConnectionManager implements IConnectionManager {
     }
   }
 
+  public showConnectionMenu() {
+    var menuItems: ConnectionMenuItem[] = [];
+
+    menuItems.push(
+      new ConnectionMenuItem(
+        "Restart Current Puppet Session",
+        () => { vscode.commands.executeCommand(messages.PuppetCommandStrings.PuppetRestartSessionCommandId); }),
+    )
+
+    menuItems.push(
+      new ConnectionMenuItem(
+        "Show Puppet Session Logs",
+        () => { vscode.commands.executeCommand(messages.PuppetCommandStrings.PuppetShowConnectionLogsCommandId); }),
+    )
+
+    vscode
+      .window
+      .showQuickPick<ConnectionMenuItem>(menuItems)
+      .then((selectedItem) => { selectedItem.callback(); });
+  }
+
   private setConnectionStatus(statusText: string, status: ConnectionStatus): void {
     // Set color and icon for 'Running' by default
     var statusIconText = "$(terminal) ";
@@ -391,3 +461,11 @@ export class ConnectionManager implements IConnectionManager {
     this.setConnectionStatus("Starting Error", ConnectionStatus.Failed);
   }
 }
+
+class ConnectionMenuItem implements vscode.QuickPickItem {
+  public description: string;
+
+  constructor(public readonly label: string, public readonly callback: () => void = () => { })
+  {
+  }
+}
diff --git a/client/src/extension.ts b/client/src/extension.ts
@@ -4,6 +4,7 @@ import * as vscode from 'vscode';
 import * as path from 'path';
 
 import { ConnectionManager, IConnectionConfiguration, ConnectionType } from './connection';
+import { ConnectionConfiguration } from './configuration';
 import { Logger } from './logging';
 import { Reporter } from './telemetry/telemetry';
 
@@ -13,28 +14,6 @@ var serverProc;
 
 var connManager: ConnectionManager = undefined;
 
-export class ConnectionConfiguration implements IConnectionConfiguration {
-  public type: ConnectionType = ConnectionType.Unknown; 
-  public host: string = undefined;
-  public port: number = undefined;
-  public timeout: number = undefined;
-  public preLoadPuppet: boolean = undefined;
-  public debugFilePath: string = undefined;
-  public puppetAgentDir: string = undefined;
-
-  constructor(context: vscode.ExtensionContext) {
-    let config = vscode.workspace.getConfiguration('puppet');
-
-    this.host          = config['languageserver']['address'];
-    this.port          = config['languageserver']['port'];
-    this.timeout       = config['languageserver']['timeout'];
-    this.preLoadPuppet = config['languageserver']['preLoadPuppet'];
-    this.debugFilePath = config['languageserver']['debugFilePath'];
-    
-    this.puppetAgentDir = config['puppetAgentDir'];
-  }
-}
-
 export function activate(context: vscode.ExtensionContext) {
   const puppetExtension = vscode.extensions.getExtension('jpogran.puppet-vscode')!;
   const puppetExtensionVersion = puppetExtension.packageJSON.version;
diff --git a/client/src/logging.ts b/client/src/logging.ts
@@ -19,7 +19,6 @@ export class Logger {
 
   constructor() {
     this.logChannel = vscode.window.createOutputChannel("Puppet");
-    this.logChannel.show();
 
     let config = vscode.workspace.getConfiguration('puppet');
     let logLevelName = config['languageclient']['minimumUserLogLevel'];
@@ -33,6 +32,10 @@ export class Logger {
     }
   }
 
+  public show(){
+    this.logChannel.show();
+  }
+
   public verbose(message: string) {
     this.logWithLevel(LogLevel.Verbose, message);
   }
@@ -54,7 +57,7 @@ export class Logger {
   }
 
   private logWithLevel(level: LogLevel, message) {
-    let logMessage = this.logLevelPrefixAsString(level) + message
+    let logMessage = this.logLevelPrefixAsString(level) + (new Date().toISOString()) + ' ' + message
 
     console.log(logMessage);
     if (level >= this.minimumUserLogLevel) {
diff --git a/client/src/messages.ts b/client/src/messages.ts
@@ -8,6 +8,9 @@ export interface PuppetVersionDetails {
   puppetVersion: string;
   facterVersion: string;
   languageServerVersion: string;
+  factsLoaded: boolean;
+  functionsLoaded: boolean;
+  typesLoaded: boolean;
 }
 
 export interface PuppetResourceRequestParams {
@@ -37,6 +40,9 @@ export interface CompileNodeGraphResponse {
 export class PuppetCommandStrings{
   static PuppetResourceCommandId:string = 'extension.puppetResource';
   static PuppetNodeGraphToTheSideCommandId = 'extension.puppetShowNodeGraphToSide';
+  static PuppetShowConnectionMenuCommandId = 'extension.puppetShowConnectionMenu';
+  static PuppetShowConnectionLogsCommandId = 'extension.puppetShowConnectionLogs';
+  static PuppetRestartSessionCommandId = 'extension.puppetRestartSession';
 }
 
 export class PDKCommandStrings {
diff --git a/server/lib/languageserver/puppet_version.rb b/server/lib/languageserver/puppet_version.rb
@@ -1,9 +1,12 @@
 module LanguageServer
   module PuppetVersion
     # export interface PuppetVersionDetails {
-    #     puppetVersion:         string;
-    #     facterVersion:         string;
-    #     languageServerVersion: string;
+    #   puppetVersion: string;
+    #   facterVersion: string;
+    #   languageServerVersion: string;
+    #   factsLoaded: boolean;
+    #   functionsLoaded: boolean;
+    #   typesLoaded: boolean;
     # }
 
     def self.create(options)
@@ -13,6 +16,11 @@ def self.create(options)
 
       result['puppetVersion'] = options['puppetVersion']
       result['facterVersion'] = options['facterVersion']
+
+      result['factsLoaded']     = options['factsLoaded'] unless options['factsLoaded'].nil?
+      result['functionsLoaded'] = options['functionsLoaded'] unless options['functionsLoaded'].nil?
+      result['typesLoaded']     = options['typesLoaded'] unless options['typesLoaded'].nil?
+
       result['languageServerVersion'] = PuppetLanguageServer.version
 
       result
diff --git a/server/lib/puppet-languageserver/facter_helper.rb b/server/lib/puppet-languageserver/facter_helper.rb
diff --git a/server/lib/puppet-languageserver/message_router.rb b/server/lib/puppet-languageserver/message_router.rb
diff --git a/server/lib/puppet-languageserver/puppet_helper.rb b/server/lib/puppet-languageserver/puppet_helper.rb
diff --git a/server/spec/unit/puppet-languageserver/message_router_spec.rb b/server/spec/unit/puppet-languageserver/message_router_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ export class Logger {`
`19`	`19`
`20`	`20`	`constructor() {`
`21`	`21`	`this.logChannel = vscode.window.createOutputChannel("Puppet");`
`22`		`- this.logChannel.show();`
`23`	`22`
`24`	`23`	`let config = vscode.workspace.getConfiguration('puppet');`
`25`	`24`	`let logLevelName = config['languageclient']['minimumUserLogLevel'];`
`@@ -33,6 +32,10 @@ export class Logger {`
`33`	`32`	`}`
`34`	`33`	`}`
`35`	`34`
	`35`	`+ public show(){`
	`36`	`+ this.logChannel.show();`
	`37`	`+ }`
	`38`	`+`
`36`	`39`	`public verbose(message: string) {`
`37`	`40`	`this.logWithLevel(LogLevel.Verbose, message);`
`38`	`41`	`}`
`@@ -54,7 +57,7 @@ export class Logger {`
`54`	`57`	`}`
`55`	`58`
`56`	`59`	`private logWithLevel(level: LogLevel, message) {`
`57`		`- let logMessage = this.logLevelPrefixAsString(level) + message`
	`60`	`+ let logMessage = this.logLevelPrefixAsString(level) + (new Date().toISOString()) + ' ' + message`
`58`	`61`
`59`	`62`	`console.log(logMessage);`
`60`	`63`	`if (level >= this.minimumUserLogLevel) {`