Improve debugger's variable population mechanism #1630
Merged
Conversation
This file contains 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
andyleejordan
force-pushed
the
andschwa/debugger
branch
from
df3665a to
e73dbc0
Compare
Thanks to PowerShell idiosyncracies around scopes, it is impossible for the debug service to get the "local variables" for each stack frame. The prior behavior used an assumption that from the 0 index, each increment to the stack frame corresponded 1-to-1 to an increment in scope, and that at each of those frames we could get local variables. This does not work because that 1-to-1 assumption does not hold, as evidenced by crashes exhibited in the preview extension because there are often more stack frames than there are scopes. Since this was but a guess, it was decided that it is worse to provide inaccurate information than a "best guess" and so each stack frame now only gets auto variables. In the process of fixing this, the variable detection mechanism was improved to rely on the raw results of `Get-PSCallStack` when available locally, and only pass it through a serialization and deserialization process when necessary for remote debugging. Finally, the `StackFrameDetails.Create` method had an ancient TODO from 2019 that we decided to drop the skeleton support for, namely passing the workspace root path and processing the invoation information. Co-authored-by: Andy Schwartzmeyer <andrew@schwartzmeyer.com> Co-authored-by: Patrick Meinecke <SeeminglyScience@users.noreply.github.com>
While it would be nice to only present `$PSItem` to encourage people to use it, that may confuse people who still use `$_` and don't know that they are the same. Co-authored-by: Patrick Meinecke <SeeminglyScience@users.noreply.github.com>
Co-authored-by: Patrick Meinecke <SeeminglyScience@users.noreply.github.com> Co-authored-by: Andy Schwartzmeyer <andrew@schwartzmeyer.com>
andyleejordan
force-pushed
the
andschwa/debugger
branch
2 times, most recently
from
b38b1c1 to
491cd9d
Compare
Mostly so we can use const interpolated strings.
andyleejordan
force-pushed
the
andschwa/debugger
branch
from
491cd9d to
26f978c
Compare
JustinGrote
approved these changes
Nov 19, 2021
src/PowerShellEditorServices/Services/DebugAdapter/DebugService.cs
Outdated
Show resolved
Hide resolved
|
@andschwa please merge these changes, I feel pretty good about this change set. See Discord for details. |
Literally just got to the top of the conversation starting 11/19, reading through! |
We want this container to hold everything that is most likely contextually relevant to the user while debugging. It is specifically NOT analagous to PowerShell's automatic variables, but to Visual Studio's "auto" view of a debugger's variables. This means that for the top of the callstack, we merge the local scope's variables with those in the frame and filter to our own curated list. We also cleaned up our variable property rehydration path.
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.
This is take two on #1620, with it rebased and commits somewhat split apart, as well as additional fixes.
Fixes PowerShell/vscode-powershell#3667
Fixes PowerShell/vscode-powershell#3673