Merge pull request #592 from SeeminglyScience/unix-stepping-fix

Fix debugger step through on Unix platforms

Author: TylerLeonhardt

PowerShellEditorServices.build.ps1

@@ -129,6 +129,10 @@ task TestPowerShellApi -If { !$script:IsUnix } {
 task Build {
     exec { & $script:dotnetExe build -c $Configuration .\src\PowerShellEditorServices.Host\PowerShellEditorServices.Host.csproj $script:TargetFrameworksParam }
     exec { & $script:dotnetExe build -c $Configuration .\src\PowerShellEditorServices.VSCode\PowerShellEditorServices.VSCode.csproj $script:TargetFrameworksParam }
+    exec { & $script:dotnetExe publish -c $Configuration .\src\PowerShellEditorServices\PowerShellEditorServices.csproj -f netstandard1.6 }
+    Copy-Item $PSScriptRoot\src\PowerShellEditorServices\bin\$Configuration\netstandard1.6\publish\UnixConsoleEcho.dll -Destination $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6
+    Copy-Item $PSScriptRoot\src\PowerShellEditorServices\bin\$Configuration\netstandard1.6\publish\runtimes\osx-64\native\libdisablekeyecho.dylib -Destination $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6
+    Copy-Item $PSScriptRoot\src\PowerShellEditorServices\bin\$Configuration\netstandard1.6\publish\runtimes\linux-64\native\libdisablekeyecho.so -Destination $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6
 }
 
 function UploadTestLogs {
@@ -185,9 +189,12 @@ task LayoutModule -After Build {
     New-Item -Force $PSScriptRoot\module\PowerShellEditorServices\bin\Core -Type Directory | Out-Null
 
     Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6\* -Filter Microsoft.PowerShell.EditorServices*.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
+    Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6\UnixConsoleEcho.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
+    Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6\libdisablekeyecho.* -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
     if (!$script:IsUnix) {
         Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\net451\* -Filter Microsoft.PowerShell.EditorServices*.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop\
         Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\net451\Newtonsoft.Json.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop\
+        Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\net451\UnixConsoleEcho.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop\
     }
 
     # Lay out the PowerShellEditorServices.VSCode module's binaries

src/PowerShellEditorServices/Console/ConsoleReadLine.cs

@@ -8,6 +8,7 @@
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using UnixConsoleEcho;
 
 namespace Microsoft.PowerShell.EditorServices.Console
 {
@@ -20,8 +21,6 @@ internal class ConsoleReadLine
     {
         #region Private Field
 
-        private object readKeyLock = new object();
-        private ConsoleKeyInfo? bufferedKey;
         private PowerShellContext powerShellContext;
 
         #endregion
@@ -61,7 +60,7 @@ public async Task<SecureString> ReadSecureLine(CancellationToken cancellationTok
             {
                 while (!cancellationToken.IsCancellationRequested)
                 {
-                    ConsoleKeyInfo keyInfo = await this.ReadKeyAsync(cancellationToken);
+                    ConsoleKeyInfo keyInfo = await ReadKeyAsync(cancellationToken);
 
                     if ((int)keyInfo.Key == 3 ||
                         keyInfo.Key == ConsoleKey.C && keyInfo.Modifiers.HasFlag(ConsoleModifiers.Control))
@@ -129,6 +128,28 @@ public async Task<SecureString> ReadSecureLine(CancellationToken cancellationTok
 
         #region Private Methods
 
+        private static async Task<ConsoleKeyInfo> ReadKeyAsync(CancellationToken cancellationToken)
+        {
+            await WaitForKeyAvailableAsync(cancellationToken);
+            return Console.ReadKey(true);
+        }
+
+        private static async Task WaitForKeyAvailableAsync(CancellationToken cancellationToken)
+        {
+            InputEcho.Disable();
+            try
+            {
+                while (!Console.KeyAvailable)
+                {
+                    await Task.Delay(50, cancellationToken);
+                }
+            }
+            finally
+            {
+                InputEcho.Enable();
+            }
+        }
+
         private async Task<string> ReadLine(bool isCommandLine, CancellationToken cancellationToken)
         {
             string inputBeforeCompletion = null;
@@ -154,7 +175,7 @@ private async Task<string> ReadLine(bool isCommandLine, CancellationToken cancel
             {
                 while (!cancellationToken.IsCancellationRequested)
                 {
-                    ConsoleKeyInfo keyInfo = await this.ReadKeyAsync(cancellationToken);
+                    ConsoleKeyInfo keyInfo = await ReadKeyAsync(cancellationToken);
 
                     // Do final position calculation after the key has been pressed
                     // because the window could have been resized before then
@@ -466,41 +487,6 @@ await this.powerShellContext.ExecuteCommand<PSObject>(
             return null;
         }
 
-        private async Task<ConsoleKeyInfo> ReadKeyAsync(CancellationToken cancellationToken)
-        {
-            return await
-                Task.Factory.StartNew(
-                    () =>
-                    {
-                        ConsoleKeyInfo keyInfo;
-
-                        lock (this.readKeyLock)
-                        {
-                            if (cancellationToken.IsCancellationRequested)
-                            {
-                                throw new TaskCanceledException();
-                            }
-                            else if (this.bufferedKey.HasValue)
-                            {
-                                keyInfo = this.bufferedKey.Value;
-                                this.bufferedKey = null;
-                            }
-                            else
-                            {
-                                keyInfo = Console.ReadKey(true);
-
-                                if (cancellationToken.IsCancellationRequested)
-                                {
-                                    this.bufferedKey = keyInfo;
-                                    throw new TaskCanceledException();
-                                }
-                            }
-                        }
-
-                        return keyInfo;
-                    });
-        }
-
         private int CalculateIndexFromCursor(
             int promptStartCol,
             int promptStartRow,

src/PowerShellEditorServices/PowerShellEditorServices.csproj

@@ -59,6 +59,10 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="UnixConsoleEcho" Version="0.1.0" />
+  </ItemGroup>
+
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard1.6' ">
     <DefineConstants>$(DefineConstants);CoreCLR</DefineConstants>
   </PropertyGroup>