Skip to content

Re-workaround uncancellable Console.ReadKey #1751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 12, 2022
Merged

Re-workaround uncancellable Console.ReadKey #1751

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7b429a3
Remove `UnixConsoleEcho` now that PS6 is unsupported
andyleejordan Apr 4, 2022
174fc77
Remove check for PS6 in startup sequence
andyleejordan Apr 4, 2022
3667e80
Remove now-unused async console operations
andyleejordan Apr 4, 2022
39ced5f
"Cancel" `Console.ReadKey()` via `sendKeyPress()` notification to client
andyleejordan Apr 7, 2022
9fa13a2
Delete deprecated console operations
andyleejordan Apr 7, 2022
7c97b9a
Delete `ConsoleProxy.cs` and further simplify `ReadKey` logic
andyleejordan Apr 12, 2022
7bc13d0
Sort completion results to fix flaky test
andyleejordan Apr 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .vsts-ci/templates/release-general.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ steps:
**/Newtonsoft.Json.dll
**/OmniSharp*.dll
**/Serilog*.dll
**/UnixConsoleEcho.dll

# The SBOM generation requires our original sources with the `dotnet restore`
# produced `project.assets.json` files.
Expand Down
15 changes: 0 additions & 15 deletions Third Party Notices.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,6 @@ This file is based on or incorporates material from the projects listed below (T

---

UnixConsoleEcho

Copyright (c) 2017 Patrick Meinecke
Provided for Informational Purposes Only

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

Serilog

Copyright 2013-2015 Serilog Contributors
Expand Down
21 changes: 1 addition & 20 deletions src/PowerShellEditorServices.Hosting/Commands/StartEditorServicesCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@
using System.Management.Automation.Runspaces;
using Microsoft.PowerShell.EditorServices.Hosting;
using System.Globalization;
using System.Collections;

// TODO: Remove this when we drop support for PS6.
#if CoreCLR
using System.Runtime.InteropServices;
#endif

#if DEBUG
using System.Diagnostics;
Expand All @@ -35,14 +29,6 @@ namespace Microsoft.PowerShell.EditorServices.Commands
[Cmdlet(VerbsLifecycle.Start, "EditorServices", DefaultParameterSetName = "NamedPipe")]
public sealed class StartEditorServicesCommand : PSCmdlet
{
// TODO: Remove this when we drop support for PS6.
private static readonly bool s_isWindows =
#if CoreCLR
RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
#else
true;
#endif

private readonly List<IDisposable> _disposableResources;

private readonly List<IDisposable> _loggerUnsubscribers;
Expand Down Expand Up @@ -420,12 +406,7 @@ private ConsoleReplKind GetReplKind()
return ConsoleReplKind.None;
}

// TODO: Remove this when we drop support for PS6.
Hashtable psVersionTable = (Hashtable)SessionState.PSVariable.GetValue("PSVersionTable");
dynamic version = psVersionTable["PSVersion"];
int majorVersion = (int)version.Major;

if (UseLegacyReadLine || (!s_isWindows && majorVersion == 6))
if (UseLegacyReadLine)
{
_logger.Log(PsesLogLevel.Diagnostic, "REPL configured as Legacy");
return ConsoleReplKind.LegacyReadLine;
Expand Down
1 change: 0 additions & 1 deletion src/PowerShellEditorServices/PowerShellEditorServices.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
<PackageReference Include="System.IO.Pipes.AccessControl" Version="5.0.0" />
<PackageReference Include="System.Security.Principal" Version="4.3.0" />
<PackageReference Include="System.Security.Principal.Windows" Version="5.0.0" />
<PackageReference Include="UnixConsoleEcho" Version="0.1.0" />
</ItemGroup>

<ItemGroup>
Expand Down
170 changes: 9 additions & 161 deletions src/PowerShellEditorServices/Services/PowerShell/Console/ConsoleProxy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,164 +2,23 @@
// Licensed under the MIT License.

using System;
using System.Runtime.InteropServices;
using System.Threading;
using System.Threading.Tasks;

namespace Microsoft.PowerShell.EditorServices.Services.PowerShell.Console
{
/// <summary>
/// Provides asynchronous implementations of the <see cref="Console" /> API's as well as
/// synchronous implementations that work around platform specific issues.
/// NOTE: We're missing GetCursorPosition.
/// </summary>
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.
/// </summary>
/// <param name="intercept">
/// Determines whether to display the pressed key in the console window. <see langword="true" />
/// to not display the pressed key; otherwise, <see langword="false" />.
/// </param>
/// <param name="cancellationToken">The CancellationToken to observe.</param>
/// <returns>
/// An object that describes the <see cref="ConsoleKey" /> constant and Unicode character, if any,
/// that correspond to the pressed console key. The <see cref="ConsoleKeyInfo" /> object also
/// describes, in a bitwise combination of <see cref="ConsoleModifiers" /> values, whether
/// one or more Shift, Alt, or Ctrl modifier keys was pressed simultaneously with the console key.
/// </returns>
public static ConsoleKeyInfo ReadKey(bool intercept, CancellationToken cancellationToken) =>
s_consoleProxy.ReadKey(intercept, cancellationToken);

/// <summary>
/// Obtains the next character or function key pressed by the user asynchronously.
/// Does not block when other console API's are called.
/// </summary>
/// <param name="intercept">
/// Determines whether to display the pressed key in the console window. <see langword="true" />
/// to not display the pressed key; otherwise, <see langword="false" />.
/// </param>
/// <param name="cancellationToken">The CancellationToken to observe.</param>
/// <returns>
/// A task that will complete with a result of the key pressed by the user.
/// </returns>
public static Task<ConsoleKeyInfo> ReadKeyAsync(bool intercept, CancellationToken cancellationToken) =>
s_consoleProxy.ReadKeyAsync(intercept, cancellationToken);

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <returns>The horizontal position of the console cursor.</returns>
public static int GetCursorLeft() =>
s_consoleProxy.GetCursorLeft();

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>The horizontal position of the console cursor.</returns>
public static int GetCursorLeft(CancellationToken cancellationToken) =>
s_consoleProxy.GetCursorLeft(cancellationToken);

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the horizontal position
/// of the console cursor.
/// </returns>
public static Task<int> GetCursorLeftAsync() =>
s_consoleProxy.GetCursorLeftAsync();

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the horizontal position
/// of the console cursor.
/// </returns>
public static Task<int> GetCursorLeftAsync(CancellationToken cancellationToken) =>
s_consoleProxy.GetCursorLeftAsync(cancellationToken);

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <returns>The vertical position of the console cursor.</returns>
public static int GetCursorTop() =>
s_consoleProxy.GetCursorTop();

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>The vertical position of the console cursor.</returns>
public static int GetCursorTop(CancellationToken cancellationToken) =>
s_consoleProxy.GetCursorTop(cancellationToken);

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the vertical position
/// of the console cursor.
/// </returns>
public static Task<int> GetCursorTopAsync() =>
s_consoleProxy.GetCursorTopAsync();

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="IConsoleOperations.ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the vertical position
/// of the console cursor.
/// </returns>
public static Task<int> GetCursorTopAsync(CancellationToken cancellationToken) =>
s_consoleProxy.GetCursorTopAsync(cancellationToken);
internal static readonly ConsoleKeyInfo s_nullKeyInfo = new(
keyChar: ' ',
ConsoleKey.DownArrow,
shift: false,
alt: false,
control: false);

/// <summary>
/// This method is sent to PSReadLine as a workaround for issues with the System.Console
Expand All @@ -181,19 +40,8 @@ public static Task<int> GetCursorTopAsync(CancellationToken cancellationToken) =
/// </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);
}
ConsoleKeyInfo key = System.Console.ReadKey(intercept);
return cancellationToken.IsCancellationRequested ? s_nullKeyInfo : key;
}
}
}
89 changes: 4 additions & 85 deletions src/PowerShellEditorServices/Services/PowerShell/Console/IConsoleOperations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

using System;
using System.Threading;
using System.Threading.Tasks;

namespace Microsoft.PowerShell.EditorServices.Services.PowerShell.Console
{
Expand All @@ -30,109 +29,29 @@ internal interface IConsoleOperations
ConsoleKeyInfo ReadKey(bool intercept, CancellationToken cancellationToken);

/// <summary>
/// Obtains the next character or function key pressed by the user asynchronously.
/// Does not block when other console API's are called.
/// </summary>
/// <param name="intercept">
/// Determines whether to display the pressed key in the console window. <see langword="true" />
/// to not display the pressed key; otherwise, <see langword="false" />.
/// </param>
/// <param name="cancellationToken">The CancellationToken to observe.</param>
/// <returns>
/// A task that will complete with a result of the key pressed by the user.
/// </returns>
Task<ConsoleKeyInfo> ReadKeyAsync(bool intercept, CancellationToken cancellationToken);

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// Obtains the horizontal position of the console cursor.
/// </summary>
/// <returns>The horizontal position of the console cursor.</returns>
int GetCursorLeft();

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// Obtains the horizontal position of the console cursor. TODO: Is this still necessary?
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>The horizontal position of the console cursor.</returns>
int GetCursorLeft(CancellationToken cancellationToken);

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the horizontal position
/// of the console cursor.
/// </returns>
Task<int> GetCursorLeftAsync();

/// <summary>
/// Obtains the horizontal position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorLeft" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the horizontal position
/// of the console cursor.
/// </returns>
Task<int> GetCursorLeftAsync(CancellationToken cancellationToken);

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// Obtains the vertical position of the console cursor. TODO: Is this still necessary?
/// </summary>
/// <returns>The vertical position of the console cursor.</returns>
int GetCursorTop();

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// Obtains the vertical position of the console cursor. TODO: Is this still necessary?
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>The vertical position of the console cursor.</returns>
int GetCursorTop(CancellationToken cancellationToken);

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the vertical position
/// of the console cursor.
/// </returns>
Task<int> GetCursorTopAsync();

/// <summary>
/// Obtains the vertical position of the console cursor. Use this method
/// instead of <see cref="System.Console.CursorTop" /> to avoid triggering
/// pending calls to <see cref="ReadKeyAsync(bool, CancellationToken)" />
/// on Unix platforms.
/// </summary>
/// <param name="cancellationToken">The <see cref="CancellationToken" /> to observe.</param>
/// <returns>
/// A <see cref="Task{T}" /> representing the asynchronous operation. The
/// <see cref="Task{T}.Result" /> property will return the vertical position
/// of the console cursor.
/// </returns>
Task<int> GetCursorTopAsync(CancellationToken cancellationToken);
}
}
Loading