Improve PowerShell session management, status reporting, and logging

This change introduces a pretty large refactoring of the existing
extension code to improve the overall user experience.  Here is a summary
of the changes:

- The PowerShell session is now restartable at any time while VS Code is
  running without restarting the whole VS Code window.  This is exposed
  through the "Restart PowerShell Session" command.
- A new status indicator has been added to the status bar which lets the
  user know when the language server is starting, running, or in an error
  state.
- Logs for the extension are now written to an output channel in the UI
  allowing the user to show them at any time with the "Show PowerShell
  Extension Logs" command.
- Any failure to load the PowerShell session will show an error message to
  the user and give them the opportunity to show the extension logs.
- If the PowerShell process ends unexpectedly at any time, the user will
  be shown a prompt to restart the session.
- Logs for each session are now written out to individual log folders
  instead of creating them all in the same folder.

Resolves #281.

Author: daviwil

.gitignore

@@ -5,7 +5,9 @@ out/
 node_modules/
 logs/
 modules/*
+sessions/*
 !modules/README.md
 vscode-powershell.zip
 vscps-preview.zip
-*.vsix
+*.vsix
+npm-debug.log

.vscodeignore

@@ -8,4 +8,4 @@ bin/EditorServices.log
 bin/DebugAdapter.log
 bin/*.vshost.*
 logs/**
-
+sessions/**

examples/.vscode/launch.json

@@ -10,4 +10,4 @@
             "cwd": "${file}"
         }
     ]
-}
+}

package.json

@@ -5,7 +5,7 @@
     "publisher": "ms-vscode",
     "description": "Develop PowerShell scripts in Visual Studio Code!",
     "engines": {
-        "vscode": "1.x.x"
+        "vscode": "^1.7.0"
     },
     "license": "SEE LICENSE IN LICENSE.txt",
     "homepage": "https://github.com/PowerShell/vscode-powershell/blob/master/README.md",
@@ -89,6 +89,21 @@
                 "title": "Run selection",
                 "category": "PowerShell"
             },
+            {
+                "command": "PowerShell.RestartSession",
+                "title": "Restart PowerShell Session",
+                "category": "PowerShell"
+            },
+            {
+                "command": "PowerShell.ShowLogs",
+                "title": "Show PowerShell Extension Logs",
+                "category": "PowerShell"
+            },
+            {
+                "command": "PowerShell.OpenLogFolder",
+                "title": "Open PowerShell Extension Logs Folder",
+                "category": "PowerShell"
+            },
             {
                 "command": "PowerShell.OpenInISE",
                 "title": "Open current file in PowerShell ISE",

scripts/Start-EditorServices.ps1

@@ -57,6 +57,12 @@ param(
 # Are we running in PowerShell 5 or later?
 $isPS5orLater = $PSVersionTable.PSVersion.Major -ge 5
 
+# If PSReadline is present in the session, remove it so that runspace
+# management is easier
+if ((Get-Module PSReadline).Count -ne 0) {
+    Remove-Module PSReadline
+}
+
 # This variable will be assigned later to contain information about
 # what happened while attempting to launch the PowerShell Editor
 # Services host
@@ -161,6 +167,7 @@ else {
 $languageServicePort = Get-AvailablePort
 $debugServicePort = Get-AvailablePort
 
+# Create the Editor Services host
 $editorServicesHost =
     Start-EditorServicesHost `
         -HostName $HostName `

src/debugAdapter.ts

@@ -1,8 +1,12 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
 import fs = require('fs');
 import path = require('path');
 import net = require('net');
 import utils = require('./utils');
-import logging = require('./logging');
+import { Logger } from './logging';
 
 // NOTE: The purpose of this file is to serve as a bridge between
 // VS Code's debug adapter client (which communicates via stdio) and
@@ -11,13 +15,12 @@ import logging = require('./logging');
 // relay between the two transports.
 
 var logBasePath = path.resolve(__dirname, "../logs");
-utils.ensurePathExists(logBasePath);
 
 var debugAdapterLogWriter =
     fs.createWriteStream(
         path.resolve(
             logBasePath,
-            logging.getLogName("DebugAdapterClient")));
+            "DebugAdapter.log"));
 
 // Pause the stdin buffer until we're connected to the
 // debug server

src/feature.ts

@@ -0,0 +1,12 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+import vscode = require('vscode');
+import { LanguageClient } from 'vscode-languageclient';
+export { LanguageClient } from 'vscode-languageclient';
+
+export interface IFeature extends vscode.Disposable {
+    setLanguageClient(languageclient: LanguageClient);
+    dispose();
+}

src/features/Console.ts

@@ -1,4 +1,9 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
 import vscode = require('vscode');
+import { IFeature } from '../feature';
 import { LanguageClient, RequestType, NotificationType } from 'vscode-languageclient';
 
 export namespace EvaluateRequest {
@@ -138,44 +143,66 @@ function onInputEntered(responseText: string): ShowInputPromptResponseBody {
     }
 }
 
-export function registerConsoleCommands(client: LanguageClient): void {
+export class ConsoleFeature implements IFeature {
+    private command: vscode.Disposable;
+    private languageClient: LanguageClient;
+    private consoleChannel: vscode.OutputChannel;
+
+    constructor() {
+        this.command =
+            vscode.commands.registerCommand('PowerShell.RunSelection', () => {
+                if (this.languageClient === undefined) {
+                    // TODO: Log error message
+                    return;
+                }
+
+                var editor = vscode.window.activeTextEditor;
+                var selectionRange: vscode.Range = undefined;
+
+                if (!editor.selection.isEmpty) {
+                    selectionRange =
+                        new vscode.Range(
+                            editor.selection.start,
+                            editor.selection.end);
+                }
+                else {
+                    selectionRange = editor.document.lineAt(editor.selection.start.line).range;
+                }
+
+                this.languageClient.sendRequest(EvaluateRequest.type, {
+                    expression: editor.document.getText(selectionRange)
+                });
+            });
+
+        this.consoleChannel = vscode.window.createOutputChannel("PowerShell Output");
+    }
 
-    vscode.commands.registerCommand('PowerShell.RunSelection', () => {
-        var editor = vscode.window.activeTextEditor;
-        var selectionRange: vscode.Range = undefined;
+    public setLanguageClient(languageClient: LanguageClient) {
+        this.languageClient = languageClient;
 
-        if (!editor.selection.isEmpty) {
-            selectionRange =
-                new vscode.Range(
-                    editor.selection.start,
-                    editor.selection.end);
-        }
-        else {
-            selectionRange = editor.document.lineAt(editor.selection.start.line).range;
-        }
+        this.languageClient.onRequest(
+            ShowChoicePromptRequest.type,
+            promptDetails => showChoicePrompt(promptDetails, this.languageClient));
 
-        client.sendRequest(EvaluateRequest.type, {
-            expression: editor.document.getText(selectionRange)
-        });
-    });
+        this.languageClient.onRequest(
+            ShowInputPromptRequest.type,
+            promptDetails => showInputPrompt(promptDetails, this.languageClient));
 
-    var consoleChannel = vscode.window.createOutputChannel("PowerShell Output");
-    client.onNotification(OutputNotification.type, (output) => {
-        var outputEditorExist = vscode.window.visibleTextEditors.some((editor) => {
-	           return editor.document.languageId == 'Log'
-        });
-        if (!outputEditorExist)
-            consoleChannel.show(vscode.ViewColumn.Three);
-        consoleChannel.append(output.output);
-    });
+        this.languageClient.onNotification(OutputNotification.type, (output) => {
+            var outputEditorExist = vscode.window.visibleTextEditors.some((editor) => {
+                return editor.document.languageId == 'Log'
+            });
 
-    var t: Thenable<ShowChoicePromptResponseBody>;
+            if (!outputEditorExist) {
+                this.consoleChannel.show(vscode.ViewColumn.Three);
+            }
 
-    client.onRequest(
-        ShowChoicePromptRequest.type,
-        promptDetails => showChoicePrompt(promptDetails, client));
+            this.consoleChannel.append(output.output);
+        });
+    }
 
-    client.onRequest(
-        ShowInputPromptRequest.type,
-        promptDetails => showInputPrompt(promptDetails, client));
+    public dispose() {
+        this.command.dispose();
+        this.consoleChannel.dispose();
+    }
 }

src/features/ExpandAlias.ts

@@ -1,37 +1,59 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
 import vscode = require('vscode');
-import { LanguageClient, RequestType, NotificationType } from 'vscode-languageclient';
 import Window = vscode.window;
+import { IFeature } from '../feature';
+import { LanguageClient, RequestType, NotificationType } from 'vscode-languageclient';
 
 export namespace ExpandAliasRequest {
     export const type: RequestType<string, any, void> = { get method() { return 'powerShell/expandAlias'; } };
 }
 
-export function registerExpandAliasCommand(client: LanguageClient): void {
-    var disposable = vscode.commands.registerCommand('PowerShell.ExpandAlias', () => {
-
-        var editor = Window.activeTextEditor;
-        var document = editor.document;
-        var selection = editor.selection;
-        var text, range;
-
-        var sls = selection.start;
-        var sle = selection.end;
-
-        if (
-            (sls.character === sle.character) &&
-            (sls.line === sle.line)
-        ) {
-            text = document.getText();
-            range = new vscode.Range(0, 0, document.lineCount, text.length);
-        } else {
-            text = document.getText(selection);
-            range = new vscode.Range(sls.line, sls.character, sle.line, sle.character);
-        }
-
-        client.sendRequest(ExpandAliasRequest.type, text).then((result) => {
-            editor.edit((editBuilder) => {
-                editBuilder.replace(range, result);
+export class ExpandAliasFeature implements IFeature {
+    private command: vscode.Disposable;
+    private languageClient: LanguageClient;
+
+    constructor() {
+        this.command = vscode.commands.registerCommand('PowerShell.ExpandAlias', () => {
+            if (this.languageClient === undefined) {
+                // TODO: Log error message
+                return;
+            }
+
+            var editor = Window.activeTextEditor;
+            var document = editor.document;
+            var selection = editor.selection;
+            var text, range;
+
+            var sls = selection.start;
+            var sle = selection.end;
+
+            if (
+                (sls.character === sle.character) &&
+                (sls.line === sle.line)
+            ) {
+                text = document.getText();
+                range = new vscode.Range(0, 0, document.lineCount, text.length);
+            } else {
+                text = document.getText(selection);
+                range = new vscode.Range(sls.line, sls.character, sle.line, sle.character);
+            }
+
+            this.languageClient.sendRequest(ExpandAliasRequest.type, text).then((result) => {
+                editor.edit((editBuilder) => {
+                    editBuilder.replace(range, result);
+                });
             });
         });
-    });
+    }
+
+    public setLanguageClient(languageclient: LanguageClient) {
+        this.languageClient = languageclient;
+    }
+
+    public dispose() {
+        this.command.dispose();
+    }
 }