PowerShell / PowerShell/PowerShellEditorServices

Script Content Triggers unhandled Newtonsoft.Json.JsonSerializationException

Open
#2,165 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Bug Needs: Triage
Dominant language
C#
Stars
767
Forks
266
Avg merge
3d 16h
Merged PRs (30d)
1

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 PowerShell Editor Services itself and does not reproduce in a standalone PowerShell instance, and is not an issue with my editor.
  • I have verified that I am using the latest version of PowerShell Editor Services.
  • If this is a security issue, I have read the security issue reporting guidance.
Summary

When the following code snippet is encountered in a user created PowerShell script, and the script's path is in the environment path variable, PowerShellEditorServices fails. This appears to be caused by a Newtonsoft.Json.JsonSerializationException (For additional details, see the included PowerShellEditorServices-14896.log file included below).

Because the PowerShellEditorServices is used by the PowerShell Extension for Visual Studio Code, both the extension's Command Explorer and Intellisense stop working when this exception occurs. Ideally, I feel the PowerShellEditorServices should gracefully handle and report the exception and continue running.

param ( [Parameter(Mandatory=$false)] [ValidateScript({ if ($_ -is [int] -and $_ -ge 0) { $true } else { throw "The input argument be a positive integer or zero." } })] [int]$DaysBack = 0 # Default value is 0 )

PowerShell Version
PS ~> $PSVersionTable    

Name                           Value
----                           -----
PSVersion                      7.4.3
PSEdition                      Core
GitCommitId                    7.4.3
OS                             Microsoft Windows 10.0.22631
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0
Editor Version
Installed PowerShell Extension for Visual Studio Code.
PowerShell Editor Services Version
N/A
Steps to Reproduce

In Windows 11:

  1. Insert aforementioned code snippet into any user defined PowerShell script.
  2. Make sure the script can be found by the PowerShellEditorServices by including its fully qualified path (not file name) in the path environment variable.
  3. Open Visual Studio Code (with the PowerShell for VS Code extension (by Microsoft) installed.
  4. Click on the PowerShell icon in the left panel, to show the Command Explorer. (You may need to enable this extension's setting: PowerShell>SideBar: Command Explorer Visibility
  5. The Command Explorer will fail to enumerate and Intellisense will stop working for PowerShell scripts.
Visuals

No response

Logs

PowerShellEditorServices-14896.log
StartEditorServices-14896.log
vscode-powershell.log

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 by reproducing the failure with the provided PowerShell snippet and review PowerShellEditorServices-14896.log, StartEditorServices-14896.log, and vscode-powershell.log. Trace the unhandled serialization failure in PowerShell Editor Services; done means the exception is handled and Command Explorer enumeration and IntelliSense continue working.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell, vscode
Domain
developer-experience, 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.