Add a private field to indicate if PSReadLine is initialized and ready #4706
Conversation
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
StevenBucher98
approved these changes
Apr 15, 2025
StevenBucher98
approved these changes
Apr 16, 2025
daxian-dbw
added a commit
to PowerShell/AIShell
that referenced
this pull request
Apr 16, 2025
This PR fixes the following scenarios on macOS 1. Running `/code post` from the `AIShell` pane to post code to the `PowerShell` pane 2. Running `Invoke-AIShell -PostCode` from the `PowerShell` to request code to be posted from the `AIShell` pane. **[NOTE]** Now the `AIShell` module depends on the **v2.4.2-beta2** PSReadLine, because a private field was added in PSReadLine to accurately indicate if PSReadLine is initialized and ready to render (PowerShell/PSReadLine#4706). The `AIShell` module starts to depend on that field to be more deterministic about if PSReadLine is running and ready. Before this change, we relied on `Console.TreatControlCAsInput` which is not accurate and may cause race condition: `Console.TreatControlCAsInput` is set to true, but `Initialize(...)` is not called yet. Rendering the posted code before initialization could result in corrupted state -- posted code may be rendered on wrong position or even cause exception.
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
When posting code from
AIShellto PowerShell, we need to know if PSReadLine has finished the initialization that is required for each call toPSConsoleReadLine.ReadLine(...).This is especially needed when one is calling
Invoke-AIShell -PostCodefrom PowerShell to request the generated code to be posted from theAIShellside:PSReadLinehasn't finishes the initialization, the posted code may be rendered at the wrong row/position (because the new cursor position hasn't been set to_initialXand_initialY) or even cause exception due to race condition.The fix is to add a private field to indicate if the initialization per call is done. This doesn't introduce any behavior changes to PSReadLine. Making it a private field means it's not an officially supported scenario, even though a tool like
AIShellcan utilize it.PR Checklist
Microsoft Reviewers: Open in CodeFlow