Explicitly Show Unsaved Files as currently unsupported. It's probably doable but will take work

Also add convenience HandlerErrorException as RPCErrorException is super obtuse.

Author: JustinGrote

src/PowerShellEditorServices/Services/PowerShell/Handlers/PrepareRenameSymbol.cs

@@ -7,7 +7,6 @@
 using System.Management.Automation.Language;
 using OmniSharp.Extensions.JsonRpc;
 using Microsoft.PowerShell.EditorServices.Services;
-using Microsoft.Extensions.Logging;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using Microsoft.PowerShell.EditorServices.Refactoring;
 using Microsoft.PowerShell.EditorServices.Services.Symbols;
@@ -31,21 +30,16 @@ internal class PrepareRenameSymbolResult
 
     internal class PrepareRenameSymbolHandler : IPrepareRenameSymbolHandler
     {
-        private readonly ILogger _logger;
         private readonly WorkspaceService _workspaceService;
 
-        public PrepareRenameSymbolHandler(ILoggerFactory loggerFactory, WorkspaceService workspaceService)
-        {
-            _logger = loggerFactory.CreateLogger<RenameSymbolHandler>();
-            _workspaceService = workspaceService;
-        }
+        public PrepareRenameSymbolHandler(WorkspaceService workspaceService) => _workspaceService = workspaceService;
 
         public async Task<PrepareRenameSymbolResult> Handle(PrepareRenameSymbolParams request, CancellationToken cancellationToken)
         {
             if (!_workspaceService.TryGetFile(request.FileName, out ScriptFile scriptFile))
             {
-                _logger.LogDebug("Failed to open file!");
-                return await Task.FromResult<PrepareRenameSymbolResult>(null).ConfigureAwait(false);
+                // TODO: Unsaved file support. We need to find the unsaved file in the text documents synced to the LSP and use that as our Ast Base.
+                throw new HandlerErrorException($"File {request.FileName} not found in workspace. Unsaved files currently do not support the rename symbol feature.");
             }
             return await Task.Run(() =>
             {

src/PowerShellEditorServices/Services/PowerShell/Handlers/RenameSymbol.cs

@@ -8,15 +8,16 @@
 using System.Management.Automation.Language;
 using OmniSharp.Extensions.JsonRpc;
 using Microsoft.PowerShell.EditorServices.Services;
-using Microsoft.Extensions.Logging;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using Microsoft.PowerShell.EditorServices.Refactoring;
+using System;
 namespace Microsoft.PowerShell.EditorServices.Handlers
 {
     [Serial, Method("powerShell/renameSymbol")]
     internal interface IRenameSymbolHandler : IJsonRpcRequestHandler<RenameSymbolParams, RenameSymbolResult> { }
 
-    public class RenameSymbolOptions {
+    public class RenameSymbolOptions
+    {
         public bool CreateAlias { get; set; }
     }
 
@@ -68,14 +69,10 @@ public class RenameSymbolResult
 
     internal class RenameSymbolHandler : IRenameSymbolHandler
     {
-        private readonly ILogger _logger;
         private readonly WorkspaceService _workspaceService;
 
-        public RenameSymbolHandler(ILoggerFactory loggerFactory, WorkspaceService workspaceService)
-        {
-            _logger = loggerFactory.CreateLogger<RenameSymbolHandler>();
-            _workspaceService = workspaceService;
-        }
+        public RenameSymbolHandler(WorkspaceService workspaceService) => _workspaceService = workspaceService;
+
         internal static ModifiedFileResponse RenameFunction(Ast token, Ast scriptAst, RenameSymbolParams request)
         {
             string tokenName = "";
@@ -98,20 +95,20 @@ internal static ModifiedFileResponse RenameFunction(Ast token, Ast scriptAst, Re
                 Changes = visitor.Modifications
             };
             return FileModifications;
-
-
-
         }
+
         internal static ModifiedFileResponse RenameVariable(Ast symbol, Ast scriptAst, RenameSymbolParams request)
         {
             if (symbol is VariableExpressionAst or ParameterAst or CommandParameterAst or StringConstantExpressionAst)
             {
 
-                IterativeVariableRename visitor = new(request.RenameTo,
-                                            symbol.Extent.StartLineNumber,
-                                            symbol.Extent.StartColumnNumber,
-                                            scriptAst,
-                                            request.Options ?? null);
+                IterativeVariableRename visitor = new(
+                    request.RenameTo,
+                    symbol.Extent.StartLineNumber,
+                    symbol.Extent.StartColumnNumber,
+                    scriptAst,
+                    request.Options ?? null
+                );
                 visitor.Visit(scriptAst);
                 ModifiedFileResponse FileModifications = new(request.FileName)
                 {
@@ -121,21 +118,18 @@ internal static ModifiedFileResponse RenameVariable(Ast symbol, Ast scriptAst, R
 
             }
             return null;
-
         }
+
         public async Task<RenameSymbolResult> Handle(RenameSymbolParams request, CancellationToken cancellationToken)
         {
             if (!_workspaceService.TryGetFile(request.FileName, out ScriptFile scriptFile))
             {
-                _logger.LogDebug("Failed to open file!");
-                return await Task.FromResult<RenameSymbolResult>(null).ConfigureAwait(false);
+                throw new InvalidOperationException("This should not happen as PrepareRename should have already checked for viability. File an issue if you see this.");
             }
 
             return await Task.Run(() =>
             {
-
                 Ast token = Utilities.GetAst(request.Line + 1, request.Column + 1, scriptFile.ScriptAst);
-
                 if (token == null) { return null; }
 
                 ModifiedFileResponse FileModifications = (token is FunctionDefinitionAst || token.Parent is CommandAst)

src/PowerShellEditorServices/Utility/HandlerErrorException.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using OmniSharp.Extensions.JsonRpc;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+
+namespace Microsoft.PowerShell.EditorServices.Handlers;
+
+/// <summary>
+/// A convenience exception for handlers to throw when a request fails for a normal reason,
+/// and to communicate that reason to the user without a full internal stacktrace.
+/// </summary>
+/// <param name="message">The message describing the reason for the request failure.</param>
+/// <param name="logDetails">Additional details to be logged regarding the failure. It should be serializable to JSON.</param>
+/// <param name="severity">The severity level of the message. This is only shown in internal logging.</param>
+public class HandlerErrorException
+(
+    string message,
+    object logDetails = null,
+    MessageType severity = MessageType.Error
+) : RpcErrorException((int)severity, logDetails!, message)
+{ }