Enhance RenameHandler to handle null capabilities gracefully and add tests for registration options

Author: mgreenegit

src/PowerShellEditorServices/Services/TextDocument/Handlers/RenameHandler.cs

@@ -20,7 +20,7 @@ internal class PrepareRenameHandler
     RenameService renameService
 ) : IPrepareRenameHandler
 {
-    public RenameRegistrationOptions GetRegistrationOptions(RenameCapability capability, ClientCapabilities clientCapabilities) => capability.PrepareSupport ? new() { PrepareProvider = true } : new();
+    public RenameRegistrationOptions GetRegistrationOptions(RenameCapability capability, ClientCapabilities clientCapabilities) => capability?.PrepareSupport == true ? new() { PrepareProvider = true } : new();
 
     public async Task<RangeOrPlaceholderRange?> Handle(PrepareRenameParams request, CancellationToken cancellationToken)
         => await renameService.PrepareRenameSymbol(request, cancellationToken).ConfigureAwait(false);
@@ -34,7 +34,9 @@ RenameService renameService
 ) : IRenameHandler
 {
     // RenameOptions may only be specified if the client states that it supports prepareSupport in its initial initialize request.
-    public RenameRegistrationOptions GetRegistrationOptions(RenameCapability capability, ClientCapabilities clientCapabilities) => capability.PrepareSupport ? new() { PrepareProvider = true } : new();
+    // Passes a null capability when the client omits textDocument.rename from its advertised capabilities (e.g. a completion-only client).
+    // Use the null-conditional operator so we don't throw NullReferenceException during initialize.
+    public RenameRegistrationOptions GetRegistrationOptions(RenameCapability capability, ClientCapabilities clientCapabilities) => capability?.PrepareSupport == true ? new() { PrepareProvider = true } : new();
 
     public async Task<WorkspaceEdit?> Handle(RenameParams request, CancellationToken cancellationToken)
         => await renameService.RenameSymbol(request, cancellationToken).ConfigureAwait(false);

test/PowerShellEditorServices.Test/Refactoring/RenameHandlerTests.cs

@@ -7,6 +7,7 @@
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using Microsoft.PowerShell.EditorServices.Test.Shared;
 using OmniSharp.Extensions.LanguageServer.Protocol;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using static PowerShellEditorServices.Test.Refactoring.RefactorUtilities;
 using System.Linq;
@@ -24,25 +25,25 @@ public class RenameHandlerTests
     private readonly WorkspaceService workspace = new(NullLoggerFactory.Instance);
 
     private readonly RenameHandler testHandler;
+    private readonly PrepareRenameHandler testPrepareHandler;
     public RenameHandlerTests()
     {
         workspace.WorkspaceFolders.Add(new WorkspaceFolder
         {
             Uri = DocumentUri.FromFileSystemPath(TestUtilities.GetSharedPath("Refactoring"))
         });
 
-        testHandler = new
+        RenameService renameService = new
         (
-            new RenameService
-            (
-                workspace,
-                new FakeLspSendMessageRequestFacade("I Accept"),
-                new EmptyConfiguration()
-            )
-            {
-                DisclaimerAcceptedForSession = true //Disables UI prompts
-            }
-        );
+            workspace,
+            new FakeLspSendMessageRequestFacade("I Accept"),
+            new EmptyConfiguration()
+        )
+        {
+            DisclaimerAcceptedForSession = true //Disables UI prompts
+        };
+        testHandler = new(renameService);
+        testPrepareHandler = new(renameService);
     }
 
     // Decided to keep this DAMP instead of DRY due to memberdata boundaries, duplicates with PrepareRenameHandler
@@ -125,4 +126,50 @@ public async Task RenamedVariable(RenameTestTarget s)
 
         Assert.Equal(expected, actual);
     }
+
+    [Fact]
+    public void GetRegistrationOptionsDoesNotThrowWhenCapabilityIsNull()
+    {
+        // Acts: framework hands us null when client omits the capability.
+        RenameRegistrationOptions opts = testHandler.GetRegistrationOptions(
+            capability: null,
+            clientCapabilities: new ClientCapabilities());
+
+        Assert.NotNull(opts);
+        // Without PrepareSupport advertised, PrepareProvider should be false.
+        Assert.False(opts.PrepareProvider);
+    }
+
+    [Fact]
+    public void GetRegistrationOptionsHonorsPrepareSupportWhenCapabilityProvided()
+    {
+        RenameRegistrationOptions opts = testHandler.GetRegistrationOptions(
+            capability: new RenameCapability { PrepareSupport = true },
+            clientCapabilities: new ClientCapabilities());
+
+        Assert.NotNull(opts);
+        Assert.True(opts.PrepareProvider);
+    }
+
+    [Fact]
+    public void PrepareGetRegistrationOptionsDoesNotThrowWhenCapabilityIsNull()
+    {
+        RenameRegistrationOptions opts = testPrepareHandler.GetRegistrationOptions(
+            capability: null,
+            clientCapabilities: new ClientCapabilities());
+
+        Assert.NotNull(opts);
+        Assert.False(opts.PrepareProvider);
+    }
+
+    [Fact]
+    public void PrepareGetRegistrationOptionsHonorsPrepareSupportWhenCapabilityProvided()
+    {
+        RenameRegistrationOptions opts = testPrepareHandler.GetRegistrationOptions(
+            capability: new RenameCapability { PrepareSupport = true },
+            clientCapabilities: new ClientCapabilities());
+
+        Assert.NotNull(opts);
+        Assert.True(opts.PrepareProvider);
+    }
 }