Fix #2297: guard PrepareRenameHandler against null rename capability

[manderse21]

Drafted PR -- PSES PrepareRename/Rename null RenameCapability guard (#2297)

Status: PR-READY, NOT SUBMITTED. The fix branch is pushed to Mike's fork:

• Fork branch: manderse21/PowerShellEditorServices @ fix/2297-prepare-rename-null-capability
• Base: PowerShell/PowerShellEditorServices @ main (which is v4.6.0, commit d2112c21)
• Commit: Fix #2297: guard null RenameCapability in rename handlers

Opening the PR (fork branch -> upstream main) is Mike's explicit action. Nothing
has been submitted, commented, or posted upstream.

---

PR title

Fix #2297: guard null RenameCapability in rename handlers

PR body (draft)

Summary

PrepareRenameHandler and RenameHandler both read capability.PrepareSupport in
GetRegistrationOptions. The language-server framework passes a null
RenameCapability when the client's initialize omits textDocument.rename, so the
dereference throws a NullReferenceException during capability registration. The
exception leaves the initialize request unanswered, so the handshake hangs for
any client that legitimately omits the optional rename capability (#2297).

The rename provider is new in v4.6.0 (#2292), so this affects v4.6.0.

Fix

Guard both handlers with a property pattern, so an absent capability is treated as
"no prepare support" instead of dereferenced:

// before
public RenameRegistrationOptions GetRegistrationOptions(RenameCapability capability, ClientCapabilities clientCapabilities)
    => capability.PrepareSupport ? new() { PrepareProvider = true } : new();

// after
public RenameRegistrationOptions GetRegistrationOptions(RenameCapability capability, ClientCapabilities clientCapabilities)
    => capability is { PrepareSupport: true } ? new() { PrepareProvider = true } : new();

Tests

Adds a regression test to each handler's test class asserting
GetRegistrationOptions(null, ...) does not throw and reports no prepare provider.

Validation (performed locally before submission)

• dotnet build -c Release is clean (the Release configuration's documentation/analyzer
  gate passes).
• The rename test category is green: 102 tests including the two new regression tests
  (Category=PrepareRename|Category=RenameHandlerFunction, net8.0 Release).
• Adversarial control: reverting only the guard makes both new tests fail with the
  exact NRE -- RenameHandler.GetRegistrationOptions (RenameHandler.cs:37) and
  PrepareRenameHandler.GetRegistrationOptions (RenameHandler.cs:23) -- and they pass
  again with the guard restored, confirming the tests guard the regression and the fix
  is the cause.
• End-to-end: an initialize that omits rename, sent over -Stdio, never returns
  an initialize response against a stock v4.6.0 bundle (hang reproduced); the same
  probe against a bundle in which only Microsoft.PowerShell.EditorServices.dll is
  rebuilt from this branch returns the initialize response and completes the handshake.
• The full PowerShellEditorServices.Test unit project runs 315/320 green on net8.0
  Release. The 5 failures are pre-existing environment dependencies unrelated to this
  change -- CanLoadPSReadLine, CanLoadPSScriptAnalyzerAsync, and three PSSA-dependent
  tests (parse-error / script-marker / built-in command help) -- which need PSReadLine and
  PSScriptAnalyzer provisioned (this local sandbox does not install them; the project's CI
  does). No rename test fails.

Closes #2297.

[microsoft-github-policy-service]

@manderse21 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a regression guard for omitted textDocument.rename capabilities during LSP initialize so GetRegistrationOptions no longer throws (and hangs the handshake) when RenameCapability is null.

Changes:

• Harden GetRegistrationOptions in both rename handlers to tolerate null RenameCapability.
• Add regression tests covering the omitted rename capability scenario for both handlers.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
test/PowerShellEditorServices.Test/Refactoring/RenameHandlerTests.cs	Adds regression test ensuring registration options don’t throw when rename capability is omitted.
test/PowerShellEditorServices.Test/Refactoring/PrepareRenameHandlerTests.cs	Adds regression test ensuring prepare-rename registration options don’t throw when rename capability is omitted.
src/PowerShellEditorServices/Services/TextDocument/Handlers/RenameHandler.cs	Guards against null RenameCapability when computing registration options.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.