Establish new host interface abstraction model, remove ConsoleService

This change is a fairly large refactoring of our PSHost implementation
to remove the ConsoleService and IConsoleHost types and instead use two
different PSHostUserInterface implementations.  Here's a detailed
breakdown of the changes:

- Centralized host UI behavior in EditorServicesPSHostUserInterface
  abstract class.  This class now exposes overridable abstract methods
  that simplify PSHostUserInterface implementations that will be used
  with the EditorServicesPSHost.

- Removed the ConsoleService class and put its behavior and abstractions
  into EditorServicesPSHostUserInterface.

- Created TerminalPSHostUserInterface for the integrated terminal host
  experience.

- Created ProtocolPSHostUserInterface for the protocol-based host
  experience.

- Removed the concept of a "prompt handler context" because each host
  implementation will have a single way to deal with input and choice
  prompts.

- Lifted direct management of the console interface out of the
  LanguageServer and DebugAdapter classes, now managed in the
  EditorServicesHost.

- Disabled the ConsoleServiceTests until we decide how to test for
  this behavior at the level of the EditorServicesPSHostUserInterface.

Author: daviwil

src/PowerShellEditorServices.Host/EditorServicesHost.cs

@@ -1,4 +1,4 @@
-//
+//
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
@@ -195,6 +195,8 @@ private async void OnLanguageServiceClientConnect(
                 CreateSession(
                     this.hostDetails,
                     this.profilePaths,
+                    protocolEndpoint,
+                    messageDispatcher,
                     this.enableConsoleRepl);
 
             this.languageServer =
@@ -264,7 +266,10 @@ private void OnDebugServiceClientConnect(object sender, TcpSocketServerChannel s
                     this.CreateDebugSession(
                         this.hostDetails,
                         profilePaths,
-                        this.languageServer?.EditorOperations);
+                        protocolEndpoint,
+                        messageDispatcher,
+                        this.languageServer?.EditorOperations,
+                        false);
 
                 this.debugAdapter =
                     new DebugAdapter(
@@ -318,47 +323,61 @@ public void WaitForCompletion()
         private EditorSession CreateSession(
             HostDetails hostDetails,
             ProfilePaths profilePaths,
+            IMessageSender messageSender,
+            IMessageHandlers messageHandlers,
             bool enableConsoleRepl)
         {
             EditorSession editorSession = new EditorSession(this.logger);
             PowerShellContext powerShellContext = new PowerShellContext(this.logger);
 
-            ConsoleServicePSHost psHost =
-                new ConsoleServicePSHost(
+            EditorServicesPSHostUserInterface hostUserInterface =
+                enableConsoleRepl
+                    ? (EditorServicesPSHostUserInterface) new TerminalPSHostUserInterface(powerShellContext, this.logger)
+                    : new ProtocolPSHostUserInterface(powerShellContext, messageSender, messageHandlers, this.logger);
+
+            EditorServicesPSHost psHost =
+                new EditorServicesPSHost(
                     powerShellContext,
                     hostDetails,
-                    enableConsoleRepl);
+                    hostUserInterface,
+                    this.logger);
 
             Runspace initialRunspace = PowerShellContext.CreateRunspace(psHost);
-            powerShellContext.Initialize(profilePaths, initialRunspace, true, psHost.ConsoleService);
+            powerShellContext.Initialize(profilePaths, initialRunspace, true, hostUserInterface);
 
-            editorSession.StartSession(
-                powerShellContext,
-                psHost.ConsoleService);
+            editorSession.StartSession(powerShellContext, hostUserInterface);
 
             return editorSession;
         }
 
         private EditorSession CreateDebugSession(
             HostDetails hostDetails,
             ProfilePaths profilePaths,
-            IEditorOperations editorOperations)
+            IMessageSender messageSender,
+            IMessageHandlers messageHandlers,
+            IEditorOperations editorOperations,
+            bool enableConsoleRepl)
         {
             EditorSession editorSession = new EditorSession(this.logger);
             PowerShellContext powerShellContext = new PowerShellContext(this.logger);
 
-            ConsoleServicePSHost psHost =
-                new ConsoleServicePSHost(
+            EditorServicesPSHostUserInterface hostUserInterface =
+                enableConsoleRepl
+                    ? (EditorServicesPSHostUserInterface) new TerminalPSHostUserInterface(powerShellContext, this.logger)
+                    : new ProtocolPSHostUserInterface(powerShellContext, messageSender, messageHandlers, this.logger);
+
+            EditorServicesPSHost psHost =
+                new EditorServicesPSHost(
                     powerShellContext,
                     hostDetails,
-                    enableConsoleRepl);
+                    hostUserInterface,
+                    this.logger);
 
             Runspace initialRunspace = PowerShellContext.CreateRunspace(psHost);
-            powerShellContext.Initialize(profilePaths, initialRunspace, true, psHost.ConsoleService);
+            powerShellContext.Initialize(profilePaths, initialRunspace, true, hostUserInterface);
 
             editorSession.StartDebugSession(
                 powerShellContext,
-                psHost.ConsoleService,
                 editorOperations);
 
             return editorSession;

src/PowerShellEditorServices.Protocol/Server/PromptHandlers.cs renamed to src/PowerShellEditorServices.Host/PSHost/PromptHandlers.cs

@@ -12,51 +12,24 @@
 using System.Threading;
 using System.Security;
 
-namespace Microsoft.PowerShell.EditorServices.Protocol.Server
+namespace Microsoft.PowerShell.EditorServices.Host
 {
-    internal class ProtocolPromptHandlerContext : IPromptHandlerContext
-    {
-        private IMessageSender messageSender;
-        private ConsoleService consoleService;
-
-        public ProtocolPromptHandlerContext(
-            IMessageSender messageSender,
-            ConsoleService consoleService)
-        {
-            this.messageSender = messageSender;
-            this.consoleService = consoleService;
-        }
-
-        public ChoicePromptHandler GetChoicePromptHandler()
-        {
-            return new ProtocolChoicePromptHandler(
-                this.messageSender,
-                this.consoleService,
-                Logger.CurrentLogger);
-        }
-
-        public InputPromptHandler GetInputPromptHandler()
-        {
-            return new ProtocolInputPromptHandler(
-                this.messageSender,
-                this.consoleService);
-        }
-    }
-
     internal class ProtocolChoicePromptHandler : ConsoleChoicePromptHandler
     {
+        private IHostInput hostInput;
         private IMessageSender messageSender;
-        private ConsoleService consoleService;
         private TaskCompletionSource<string> readLineTask;
 
         public ProtocolChoicePromptHandler(
             IMessageSender messageSender,
-            ConsoleService consoleService,
+            IHostInput hostInput,
+            IHostOutput hostOutput,
             ILogger logger)
-                : base(consoleService, logger)
+                : base(hostOutput, logger)
         {
+            this.hostInput = hostInput;
+            this.hostOutput = hostOutput;
             this.messageSender = messageSender;
-            this.consoleService = consoleService;
         }
 
         protected override void ShowPrompt(PromptStyle promptStyle)
@@ -93,7 +66,7 @@ private void HandlePromptResponse(
 
                 if (!response.PromptCancelled)
                 {
-                    this.consoleService.WriteOutput(
+                    this.hostOutput.WriteOutput(
                         response.ResponseText,
                         OutputType.Normal);
 
@@ -102,7 +75,7 @@ private void HandlePromptResponse(
                 else
                 {
                     // Cancel the current prompt
-                    this.consoleService.SendControlC();
+                    this.hostInput.SendControlC();
                 }
             }
             else
@@ -117,7 +90,7 @@ private void HandlePromptResponse(
                 }
 
                 // Cancel the current prompt
-                this.consoleService.SendControlC();
+                this.hostInput.SendControlC();
             }
 
             this.readLineTask = null;
@@ -126,37 +99,24 @@ private void HandlePromptResponse(
 
     internal class ProtocolInputPromptHandler : ConsoleInputPromptHandler
     {
+        private IHostInput hostInput;
         private IMessageSender messageSender;
-        private ConsoleService consoleService;
         private TaskCompletionSource<string> readLineTask;
 
         public ProtocolInputPromptHandler(
             IMessageSender messageSender,
-            ConsoleService consoleService)
-                : base(
-                    consoleService,
-                    Microsoft.PowerShell.EditorServices.Utility.Logger.CurrentLogger)
+            IHostInput hostInput,
+            IHostOutput hostOutput,
+            ILogger logger)
+                : base(hostOutput, logger)
         {
+            this.hostInput = hostInput;
+            this.hostOutput = hostOutput;
             this.messageSender = messageSender;
-            this.consoleService = consoleService;
-        }
-
-        protected override void ShowErrorMessage(Exception e)
-        {
-            // Use default behavior for writing the error message
-            base.ShowErrorMessage(e);
-        }
-
-        protected override void ShowPromptMessage(string caption, string message)
-        {
-            // Use default behavior for writing the prompt message
-            base.ShowPromptMessage(caption, message);
         }
 
         protected override void ShowFieldPrompt(FieldDetails fieldDetails)
         {
-            // Write the prompt to the console first so that there's a record
-            // of it occurring
             base.ShowFieldPrompt(fieldDetails);
 
             messageSender
@@ -186,7 +146,7 @@ private void HandlePromptResponse(
 
                 if (!response.PromptCancelled)
                 {
-                    this.consoleService.WriteOutput(
+                    this.hostOutput.WriteOutput(
                         response.ResponseText,
                         OutputType.Normal);
 
@@ -195,7 +155,7 @@ private void HandlePromptResponse(
                 else
                 {
                     // Cancel the current prompt
-                    this.consoleService.SendControlC();
+                    this.hostInput.SendControlC();
                 }
             }
             else
@@ -210,11 +170,16 @@ private void HandlePromptResponse(
                 }
 
                 // Cancel the current prompt
-                this.consoleService.SendControlC();
+                this.hostInput.SendControlC();
             }
 
             this.readLineTask = null;
         }
+
+        protected override Task<SecureString> ReadSecureString(CancellationToken cancellationToken)
+        {
+            // TODO: Write a message to the console
+            throw new NotImplementedException();
+        }
     }
 }
-