Added a -UseHostReadKey switch to instruct LegacyReadLine to use the ReadKey provided by the host instead of Console.ReadKey

Author: dkattan

module/PowerShellEditorServices/Start-EditorServices.ps1

@@ -52,17 +52,20 @@ param(
     [ValidateSet("Diagnostic", "Verbose", "Normal", "Warning", "Error")]
     $LogLevel,
 
-	[Parameter(Mandatory=$true)]
-	[ValidateNotNullOrEmpty()]
-	[string]
-	$SessionDetailsPath,
+    [Parameter(Mandatory=$true)]
+    [ValidateNotNullOrEmpty()]
+    [string]
+    $SessionDetailsPath,
 
     [switch]
     $EnableConsoleRepl,
 
     [switch]
     $UseLegacyReadLine,
 
+    [switch]
+    $UseHostReadKey,
+
     [switch]
     $DebugServiceOnly,
 

src/PowerShellEditorServices.Hosting/Commands/StartEditorServicesCommand.cs

@@ -176,6 +176,12 @@ public StartEditorServicesCommand()
         [Parameter]
         public SwitchParameter UseLegacyReadLine { get; set; }
 
+        /// <summary>
+        /// When set and the console is enabled and legacy readline
+        /// is enabled, console operations will use PSHostreadline implementation will be used instead of PSReadLine.
+        /// </summary>
+        [Parameter]
+        public SwitchParameter UseHostReadKey { get; set; }
         /// <summary>
         /// When set, do not enable LSP service, only the debug adapter.
         /// </summary>
@@ -359,8 +365,9 @@ private EditorServicesConfig CreateConfigObject()
                 hostInfo,
                 Host,
                 SessionDetailsPath,
-                bundledModulesPath,
-                LogPath)
+                bundledModulesPath,                
+                LogPath,
+                UseHostReadKey)
             {
                 FeatureFlags = FeatureFlags,
                 LogLevel = LogLevel,

src/PowerShellEditorServices.Hosting/Configuration/EditorServicesConfig.cs

@@ -17,7 +17,7 @@ public enum ConsoleReplKind
         /// <summary>Use a REPL with the legacy readline implementation. This is generally used when PSReadLine is unavailable.</summary>
         LegacyReadLine = 1,
         /// <summary>Use a REPL with the PSReadLine module for console interaction.</summary>
-        PSReadLine = 2,
+        PSReadLine = 2
     }
 
     /// <summary>
@@ -39,13 +39,15 @@ public EditorServicesConfig(
             PSHost psHost,
             string sessionDetailsPath,
             string bundledModulePath,
-            string logPath)
+            string logPath,
+            bool useHostReadKey)
         {
             HostInfo = hostInfo;
             PSHost = psHost;
             SessionDetailsPath = sessionDetailsPath;
             BundledModulePath = bundledModulePath;
             LogPath = logPath;
+            UseHostReadKey = useHostReadKey;
         }
 
         /// <summary>
@@ -72,6 +74,7 @@ public EditorServicesConfig(
         /// The path to use for logging for Editor Services.
         /// </summary>
         public string LogPath { get; }
+        public bool UseHostReadKey { get; }
 
         /// <summary>
         /// Names of or paths to any additional modules to load on startup.
@@ -88,7 +91,7 @@ public EditorServicesConfig(
         /// (including none to disable the integrated console).
         /// </summary>
         public ConsoleReplKind ConsoleRepl { get; set; } = ConsoleReplKind.None;
-
+        
         /// <summary>
         /// The minimum log level to log events with.
         /// </summary>

src/PowerShellEditorServices.Hosting/EditorServicesLoader.cs

@@ -103,12 +103,12 @@ public static EditorServicesLoader Create(
                 // We only want the Editor Services DLL; the new ALC will lazily load its dependencies automatically
                 if (!string.Equals(asmName.Name, "Microsoft.PowerShell.EditorServices", StringComparison.Ordinal))
                 {
-                    return null;
+                    //return null;
                 }
 
                 string asmPath = Path.Combine(s_psesDependencyDirPath, $"{asmName.Name}.dll");
 
-                logger.Log(PsesLogLevel.Verbose, "Loading PSES DLL using new assembly load context");
+                logger.Log(PsesLogLevel.Verbose, $"Loading {asmName.Name}.dll using new assembly load context");
 
                 return psesLoadContext.LoadFromAssemblyPath(asmPath);
             };

src/PowerShellEditorServices.Hosting/Internal/EditorServicesRunner.cs

@@ -290,6 +290,7 @@ private HostStartupInfo CreateHostStartupInfo()
                 (int)_config.LogLevel,
                 consoleReplEnabled: _config.ConsoleRepl != ConsoleReplKind.None,
                 usesLegacyReadLine: _config.ConsoleRepl == ConsoleReplKind.LegacyReadLine,
+                useHostReadKey: _config.UseHostReadKey,
                 bundledModulePath: _config.BundledModulePath);
         }
 

src/PowerShellEditorServices/Hosting/HostStartupInfo.cs

@@ -80,7 +80,11 @@ public sealed class HostStartupInfo
         /// If the console REPL is not enabled, this setting will be ignored.
         /// </summary>
         public bool UsesLegacyReadLine { get; }
-
+        /// <summary>
+        /// If true, the legacy PSES readline implementation but calls ReadKey in the provided host
+        /// If the console REPL is not enabled, this setting will be ignored.
+        /// </summary>
+        public bool UseHostReadKey { get; }
         /// <summary>
         /// The PowerShell host to use with Editor Services.
         /// </summary>
@@ -154,6 +158,7 @@ public HostStartupInfo(
             int logLevel,
             bool consoleReplEnabled,
             bool usesLegacyReadLine,
+            bool useHostReadKey,
             string bundledModulePath)
         {
             Name = name ?? DefaultHostName;
@@ -168,6 +173,7 @@ public HostStartupInfo(
             LogLevel = logLevel;
             ConsoleReplEnabled = consoleReplEnabled;
             UsesLegacyReadLine = usesLegacyReadLine;
+            UseHostReadKey = useHostReadKey;
             BundledModulePath = bundledModulePath;
         }
 

src/PowerShellEditorServices/Services/PowerShell/Console/ConsoleProxy.cs

@@ -12,22 +12,10 @@ namespace Microsoft.PowerShell.EditorServices.Services.PowerShell.Console
     /// Provides asynchronous implementations of the <see cref="Console" /> API's as well as
     /// synchronous implementations that work around platform specific issues.
     /// </summary>
-    internal static class ConsoleProxy
+    internal static class ConsoleProxy 
     {
         private static readonly IConsoleOperations s_consoleProxy;
 
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1810:Initialize reference type static fields inline", Justification = "Platform specific initialization")]
-        static ConsoleProxy()
-        {
-            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
-            {
-                s_consoleProxy = new WindowsConsoleOperations();
-                return;
-            }
-
-            s_consoleProxy = new UnixConsoleOperations();
-        }
-
         /// <summary>
         /// Obtains the next character or function key pressed by the user asynchronously.
         /// Does not block when other console API's are called.
@@ -161,39 +149,6 @@ public static Task<int> GetCursorTopAsync() =>
         public static Task<int> GetCursorTopAsync(CancellationToken cancellationToken) =>
             s_consoleProxy.GetCursorTopAsync(cancellationToken);
 
-        /// <summary>
-        /// This method is sent to PSReadLine as a workaround for issues with the System.Console
-        /// implementation. Functionally it is the same as System.Console.ReadKey,
-        /// with the exception that it will not lock the standard input stream.
-        /// </summary>
-        /// <param name="intercept">
-        /// Determines whether to display the pressed key in the console window.
-        /// true to not display the pressed key; otherwise, false.
-        /// </param>
-        /// <param name="cancellationToken">
-        /// The <see cref="CancellationToken" /> that can be used to cancel the request.
-        /// </param>
-        /// <returns>
-        /// An object that describes the ConsoleKey constant and Unicode character, if any,
-        /// that correspond to the pressed console key. The ConsoleKeyInfo object also describes,
-        /// in a bitwise combination of ConsoleModifiers values, whether one or more Shift, Alt,
-        /// or Ctrl modifier keys was pressed simultaneously with the console key.
-        /// </returns>
-        internal static ConsoleKeyInfo SafeReadKey(bool intercept, CancellationToken cancellationToken)
-        {
-            try
-            {
-                return s_consoleProxy.ReadKey(intercept, cancellationToken);
-            }
-            catch (OperationCanceledException)
-            {
-                return new ConsoleKeyInfo(
-                    keyChar: ' ',
-                    ConsoleKey.DownArrow,
-                    shift: false,
-                    alt: false,
-                    control: false);
-            }
-        }
+        
     }
 }

src/PowerShellEditorServices/Services/PowerShell/Console/LegacyReadLine.cs

@@ -25,15 +25,19 @@ internal class LegacyReadLine : TerminalReadLine
 
         private readonly Action<CancellationToken> _onIdleAction;
 
+        private IConsoleOperations _consoleOperations;
+
         public LegacyReadLine(
             PsesInternalHost psesHost,
             Func<bool, ConsoleKeyInfo> readKeyFunc,
-            Action<CancellationToken> onIdleAction)
+            Action<CancellationToken> onIdleAction,
+            IConsoleOperations consoleOperations)
         {
             _psesHost = psesHost;
             _readKeyTasks = new Task[2];
             _readKeyFunc = readKeyFunc;
             _onIdleAction = onIdleAction;
+            _consoleOperations = consoleOperations;
         }
 
         public override string ReadLine(CancellationToken cancellationToken)
@@ -47,12 +51,12 @@ public override string ReadLine(CancellationToken cancellationToken)
 
             StringBuilder inputLine = new();
 
-            int initialCursorCol = ConsoleProxy.GetCursorLeft(cancellationToken);
-            int initialCursorRow = ConsoleProxy.GetCursorTop(cancellationToken);
+            int initialCursorCol = _consoleOperations?.GetCursorLeft(cancellationToken) ?? _psesHost.UI.RawUI.CursorPosition.X;
+            int initialCursorRow = _consoleOperations?.GetCursorTop(cancellationToken) ?? _psesHost.UI.RawUI.CursorPosition.Y; ;
 
             int currentCursorIndex = 0;
-
-            Console.TreatControlCAsInput = true;
+            if(_consoleOperations != null)
+                Console.TreatControlCAsInput = true;
 
             try
             {
@@ -64,7 +68,8 @@ public override string ReadLine(CancellationToken cancellationToken)
                     // because the window could have been resized before then
                     int promptStartCol = initialCursorCol;
                     int promptStartRow = initialCursorRow;
-                    int consoleWidth = Console.WindowWidth;
+
+                    int consoleWidth = _consoleOperations is not null ? Console.WindowWidth : _psesHost.UI.RawUI.WindowSize.Width;
 
                     switch (keyInfo.Key)
                     {

src/PowerShellEditorServices/Services/PowerShell/Console/PsrlReadLine.cs

@@ -17,6 +17,7 @@ internal class PsrlReadLine : TerminalReadLine
         private readonly PsesInternalHost _psesHost;
 
         private readonly EngineIntrinsics _engineIntrinsics;
+        private IConsoleOperations _consoleOperations;
 
         #region Constructors
 
@@ -25,13 +26,15 @@ public PsrlReadLine(
             PsesInternalHost psesHost,
             EngineIntrinsics engineIntrinsics,
             Func<bool, ConsoleKeyInfo> readKeyFunc,
-            Action<CancellationToken> onIdleAction)
+            Action<CancellationToken> onIdleAction,
+            IConsoleOperations consoleOperations)
         {
             _psrlProxy = psrlProxy;
             _psesHost = psesHost;
             _engineIntrinsics = engineIntrinsics;
             _psrlProxy.OverrideReadKey(readKeyFunc);
             _psrlProxy.OverrideIdleHandler(onIdleAction);
+            _consoleOperations = consoleOperations;
         }
 
         #endregion
@@ -40,7 +43,10 @@ public PsrlReadLine(
 
         public override string ReadLine(CancellationToken cancellationToken) => _psesHost.InvokeDelegate(representation: "ReadLine", new ExecutionOptions { MustRunInForeground = true }, InvokePSReadLine, cancellationToken);
 
-        protected override ConsoleKeyInfo ReadKey(CancellationToken cancellationToken) => ConsoleProxy.ReadKey(intercept: true, cancellationToken);
+        protected override ConsoleKeyInfo ReadKey(CancellationToken cancellationToken)
+        {
+            return _consoleOperations.ReadKey(intercept: true, cancellationToken);
+        }
 
         #endregion
 

src/PowerShellEditorServices/Services/PowerShell/Console/TerminalReadLine.cs

@@ -12,6 +12,8 @@ namespace Microsoft.PowerShell.EditorServices.Services.PowerShell.Console
 
     internal abstract class TerminalReadLine : IReadLine
     {
+        private IConsoleOperations _consoleOperations;
+
         public abstract string ReadLine(CancellationToken cancellationToken);
 
         protected abstract ConsoleKeyInfo ReadKey(CancellationToken cancellationToken);
@@ -69,8 +71,8 @@ public SecureString ReadSecureLine(CancellationToken cancellationToken)
                     }
                     else if (previousInputLength > 0 && currentInputLength < previousInputLength)
                     {
-                        int row = ConsoleProxy.GetCursorTop(cancellationToken);
-                        int col = ConsoleProxy.GetCursorLeft(cancellationToken);
+                        int row = _consoleOperations.GetCursorTop(cancellationToken);
+                        int col = _consoleOperations.GetCursorLeft(cancellationToken);
 
                         // Back up the cursor before clearing the character
                         col--;