PowerShell / PowerShell/PowerShellEditorServices

CodeLens related commands cause exception to be thrown

Open
#2,172 2 comments 0 reactions 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

In the repository below, I have forked @TylerLeonhardt's old Monaco + PSES example, upgraded to the (almost) latest version of all packages, and wrote up how to reproduce the issue in the README.md.

https://github.com/mhintzke/monaco-powershell

Basically, regardless of OS (Windows or Unix) when the editor detects that the contents contains a basic function, e.g.

function Verb-Noun {

}

Then Monaco Client sends some commands such as textDocument/codeLens and codeLens/resolve. Both of which cause an exception to be thrown here

https://github.com/PowerShell/PowerShellEditorServices/blob/41fce39f491d5d351b4ac5864e89857ec070e107/src/PowerShellEditorServices/Services/Workspace/WorkspaceService.cs#L144

This is all using very basic configuration of the Monaco Editor and a model URI of inmemory://model.ps1. Basically when these commands are handled by PSES, they attempt to open the file at the uri above, but somehow along the way to the function above, gets translated into an "empty" string.

Because we are working with inmemory models here, I feel like we should just not even attempt to perform a File System read at all. I'm not 100% what the intended function of these commands are, but they might be not applicable in the scenario where we use inmemory models. Please correct me if I am wrong.

PowerShell Version
❯ $PSVersionTable
                                                                                                                        Name                           Value
----                           -----
PSVersion                      7.4.4
PSEdition                      Core
GitCommitId                    7.4.4
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
Monaco v7.0.7
PowerShell Editor Services Version
v3.20.1


(Invoke-RestMethod https://api.github.com/repos/PowerShell/PowerShellEditorServices/releases/latest).tag_name // v3.20.1
Steps to Reproduce

See forked repository README.md

Visuals

No response

Logs

No response

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

Reproduce the issue using the monaco-powershell fork and its README.md, with an inmemory://model.ps1 URI and a basic PowerShell function. Start at src/PowerShellEditorServices/Services/Workspace/WorkspaceService.cs around line 144 and trace the textDocument/codeLens and codeLens/resolve requests. Done means these requests no longer throw an exception for in-memory models.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
api, backend
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.