PowerShell / PowerShell/vscode-powershell

Issue with the Variable inspector in VSCode's debug viewer for PowerShell

Open
#4,604 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Debugging Issue-Bug
Dominant language
TypeScript
Stars
1.9k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

Prerequisites
  • I have written a descriptive issue title.
  • I have searched all open and closed issues to ensure it has not already been reported.
  • I have read the troubleshooting guide.
  • I am sure this issue is with the extension itself and does not reproduce in a standalone PowerShell instance.
  • I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.
  • If this is a security issue, I have read the security issue reporting guidance.
Summary

There is an issue in the Variable inspector in VSCode's debug viewer for PowerShell.
It appears that when an object has a custom format definition for displaying data, and if there is $null data for one of the object's default display properties, then the Variable inspector cannot display the data, but displays an error instead.
This is evident with the CosmosDb module, when using the Get-CosmosDbDocument cmdlet. If the Cosmos query uses a custom SELECT statement and does not return the _rid, _self, _attachments, and the _etag properties in the results, then the Variable inspector displays an error (see attachment).

PowerShell Version
Name                           Value
----                           -----
PSVersion                      5.1.19041.2673
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.19041.2673
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
Visual Studio Code Version
1.78.2
b3e4e68a0bc097f0ae7907b217c1119af9e03435
x64
Extension Version
ms-vscode.powershell@2023.5.0
Steps to Reproduce

It appears that when an object has a custom format definition for displaying data, and if there is $null data for one of the object's default display properties, then the Variable inspector cannot display the data, but displays an error instead.
This is evident with the CosmosDb module, when using the Get-CosmosDbDocument cmdlet. If the Cosmos query uses a custom SELECT statement and does not return the _rid, _self, _attachments, and the _etag properties in the results, then the Variable inspector displays an error (see attachment).

Visuals

No response

Logs

[errors]

`Internal Error-System Management Automation Extended TypeSystemExceptionThe member_rid" is not present at System Management Automation PSAliasProperty LookupMember(String nameHashSet 1 visitedAliasesPSMemberinfo& returned Member
Boolean& hasCycle) at System Management Automation PSAliasProperty.LookupMember(String name) at System.Management Automation PSAliasProperty.get_Value()

] Internal Error
at Microsoft PowerShell EditorServices Services DebugAdapter.VariableDetails SafeGetValue(PSPropertyInfo psProperty)
at Microsoft PowerShell EditorServices Services DebugAdapter VariableDetails.<>c.b_14_2(PSPropertyinfo at System.Linq.Enumerable WhereSelectEnumerablelterator 2 MoveNext(
p)
5] Internal Error -
at System.Collections.Generic.List 1.InsertRange(int32 index, IEnumerable 1 collection) at Microsoft.PowerShell.EditorServicesServices.DebugAdapter.VariableDetails.GetChildren(Object obj, ILogger logger) at Microsoft PowerShell.EditorServices Services DebugAdapter.VariableDetails....`

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the logged stack trace in Microsoft.PowerShell.EditorServices, especially DebugAdapter.VariableDetails.SafeGetValue and GetChildren. Reproduce the failure with Get-CosmosDbDocument results that omit the listed properties and include null values or custom formatting. Done means the VSCode Variable inspector displays the object instead of returning the reported internal error.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, typescript, vscode
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.