Handle exception if ConsoleHost tries to set cursor out of bounds because screen buffer changed#15380
Merged
Merged
Conversation
…ause screen buffer changed
iSazonov
reviewed
May 12, 2021
iSazonov
reviewed
May 12, 2021
c13b117 to
be29403
Compare
Collaborator
|
Iwonder that tests fail.
|
Member
Author
|
@iSazonov it appears that the difference in the .NET code and the previous PS code is that PS is only using the stdout handle while .NET is checking stdin, stdout, and stderr and if any of them fail, an exception is thrown. In this case, I suspect stdin is not a valid handle on CI. Given that the .NET code is working differently here, I think we should revert the GetCursorPosition code back. |
iSazonov
approved these changes
May 14, 2021
|
🎉 Handy links: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
There's a race condition between the call to set the console cursor position and the screen buffer size has changed that puts the coordinates outside of the screen buffer area and causes pwsh to crash with an unhandled exception. Also, it seems that the console host is calling Win32 APIs instead of the .NET APIs and I don't see any specific reason to do that other than consistency with other native APIs that need to be used.
Fix is to switch to using Console.SetCursorPosition and remove all use of the Win32 API. Catch the ArgumentOutOfRangeException and ignore it. There is really no way to avoid the race condition here as any validation of the screen buffer size can be wrong by the time we set the cursor position. The user may have resized the window or when tabs show up on Windows Terminal, the screen buffer size automatically shrinks so that the window size doesn't change.
PR Context
Fix #15254
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.(which runs in a different PS Host).