Allow rename to (optionally) process source generated documents

src/EditorFeatures/Core/InlineRename/AbstractEditorInlineRenameService.cs

@@ -24,7 +24,7 @@ protected AbstractEditorInlineRenameService(IEnumerable<IRefactorNotifyService>
 
     public async Task<IInlineRenameInfo> GetRenameInfoAsync(Document document, int position, CancellationToken cancellationToken)
     {
-        var symbolicInfo = await SymbolicRenameInfo.GetRenameInfoAsync(document, position, cancellationToken).ConfigureAwait(false);
+        var symbolicInfo = await SymbolicRenameInfo.GetRenameInfoAsync(document, position, includeSourceGenerated: false, cancellationToken).ConfigureAwait(false);
         if (symbolicInfo.LocalizedErrorMessage != null)
             return new FailureInlineRenameInfo(symbolicInfo.LocalizedErrorMessage);
 

src/Features/Core/Portable/Rename/SymbolicRenameInfo.cs

@@ -111,13 +111,13 @@ public string GetFinalSymbolName(string replacementText)
     }
 
     public static async Task<SymbolicRenameInfo> GetRenameInfoAsync(
-        Document document, int position, CancellationToken cancellationToken)
+        Document document, int position, bool includeSourceGenerated, CancellationToken cancellationToken)
     {
         var triggerToken = await GetTriggerTokenAsync(document, position, cancellationToken).ConfigureAwait(false);
         if (triggerToken == default)
             return new SymbolicRenameInfo(FeaturesResources.You_must_rename_an_identifier);
 
-        return await GetRenameInfoAsync(document, triggerToken, cancellationToken).ConfigureAwait(false);
+        return await GetRenameInfoAsync(document, triggerToken, includeSourceGenerated, cancellationToken).ConfigureAwait(false);
     }
 
     private static async Task<SyntaxToken> GetTriggerTokenAsync(Document document, int position, CancellationToken cancellationToken)
@@ -131,6 +131,7 @@ private static async Task<SyntaxToken> GetTriggerTokenAsync(Document document, i
     private static async Task<SymbolicRenameInfo> GetRenameInfoAsync(
         Document document,
         SyntaxToken triggerToken,
+        bool includeSourceGenerated,
         CancellationToken cancellationToken)
     {
         var syntaxFacts = document.GetRequiredLanguageService<ISyntaxFactsService>();
@@ -221,7 +222,7 @@ private static async Task<SymbolicRenameInfo> GetRenameInfoAsync(
                 var solution = document.Project.Solution;
                 var sourceDocument = solution.GetRequiredDocument(location.SourceTree);
 
-                if (sourceDocument is SourceGeneratedDocument)
+                if (!includeSourceGenerated && sourceDocument is SourceGeneratedDocument)
                 {
                     // The file is generated so doesn't count towards valid spans 
                     // we can edit.

src/LanguageServer/Protocol/Extensions/ProtocolConversions.cs

@@ -20,6 +20,7 @@
 using Microsoft.CodeAnalysis.LanguageServer.Handler;
 using Microsoft.CodeAnalysis.NavigateTo;
 using Microsoft.CodeAnalysis.PooledObjects;
+using Microsoft.CodeAnalysis.Shared.Extensions;
 using Microsoft.CodeAnalysis.SpellCheck;
 using Microsoft.CodeAnalysis.Tags;
 using Microsoft.CodeAnalysis.Text;
@@ -388,15 +389,15 @@ public static LSP.Range TextSpanToRange(TextSpan textSpan, SourceText text)
     /// Compute all the <see cref="LSP.TextDocumentEdit"/> for the input list of changed documents.
     /// Additionally maps the locations of the changed documents if necessary.
     /// </summary>
-    public static async Task<LSP.TextDocumentEdit[]> ChangedDocumentsToTextDocumentEditsAsync<T>(IEnumerable<DocumentId> changedDocuments, Func<DocumentId, T> getNewDocumentFunc,
-            Func<DocumentId, T> getOldDocumentFunc, IDocumentTextDifferencingService? textDiffService, CancellationToken cancellationToken) where T : TextDocument
+    public static async Task<LSP.TextDocumentEdit[]> ChangedDocumentsToTextDocumentEditsAsync(IEnumerable<DocumentId> changedDocuments, Solution newSolution,
+            Solution oldSolution, IDocumentTextDifferencingService? textDiffService, CancellationToken cancellationToken)
     {
         using var _ = ArrayBuilder<(DocumentUri Uri, LSP.TextEdit TextEdit)>.GetInstance(out var uriToTextEdits);
 
         foreach (var docId in changedDocuments)
         {
-            var newDocument = getNewDocumentFunc(docId);
-            var oldDocument = getOldDocumentFunc(docId);
+            var newDocument = await newSolution.GetRequiredDocumentAsync(docId, includeSourceGenerated: true, cancellationToken).ConfigureAwait(false);
+            var oldDocument = await oldSolution.GetRequiredDocumentAsync(docId, includeSourceGenerated: true, cancellationToken).ConfigureAwait(false);
 
             var oldText = await oldDocument.GetValueTextAsync(cancellationToken).ConfigureAwait(false);
 

src/LanguageServer/Protocol/Handler/Rename/PrepareRenameHandler.cs

@@ -33,7 +33,7 @@ public LSP.TextDocumentIdentifier GetTextDocumentIdentifier(LSP.PrepareRenamePar
         var position = await document.GetPositionFromLinePositionAsync(linePosition, cancellationToken).ConfigureAwait(false);
 
         var symbolicRenameInfo = await SymbolicRenameInfo.GetRenameInfoAsync(
-            document, position, cancellationToken).ConfigureAwait(false);
+            document, position, includeSourceGenerated: false, cancellationToken).ConfigureAwait(false);
         if (symbolicRenameInfo.IsError)
             return null;
 

src/LanguageServer/Protocol/Handler/Rename/RenameHandler.cs

@@ -28,23 +28,24 @@ internal sealed class RenameHandler() : ILspServiceDocumentRequestHandler<LSP.Re
     public TextDocumentIdentifier GetTextDocumentIdentifier(RenameParams request) => request.TextDocument;
 
     public Task<WorkspaceEdit?> HandleRequestAsync(RenameParams request, RequestContext context, CancellationToken cancellationToken)
-        => GetRenameEditAsync(context.GetRequiredDocument(), ProtocolConversions.PositionToLinePosition(request.Position), request.NewName, cancellationToken);
+        => GetRenameEditAsync(context.GetRequiredDocument(), ProtocolConversions.PositionToLinePosition(request.Position), request.NewName, includeSourceGenerated: false, cancellationToken);
 
-    internal static async Task<WorkspaceEdit?> GetRenameEditAsync(Document document, LinePosition linePosition, string newName, CancellationToken cancellationToken)
+    internal static async Task<WorkspaceEdit?> GetRenameEditAsync(Document document, LinePosition linePosition, string newName, bool includeSourceGenerated, CancellationToken cancellationToken)
     {
         var oldSolution = document.Project.Solution;
         var position = await document.GetPositionFromLinePositionAsync(linePosition, cancellationToken).ConfigureAwait(false);
 
         var symbolicRenameInfo = await SymbolicRenameInfo.GetRenameInfoAsync(
-            document, position, cancellationToken).ConfigureAwait(false);
+            document, position, includeSourceGenerated, cancellationToken).ConfigureAwait(false);
         if (symbolicRenameInfo.IsError)
             return null;
 
         var options = new SymbolRenameOptions(
-            RenameOverloads: false,
-            RenameInStrings: false,
-            RenameInComments: false,
-            RenameFile: false);
+            renameOverloads: false,
+            renameInStrings: false,
+            renameInComments: false,
+            renameFile: false,
+            renameInSourceGeneratedDocuments: includeSourceGenerated);
 
         var renameLocationSet = await Renamer.FindRenameLocationsAsync(
             oldSolution,
@@ -70,14 +71,18 @@ internal sealed class RenameHandler() : ILspServiceDocumentRequestHandler<LSP.Re
         // Then we can just take the text changes from the first document to avoid returning duplicate edits.
         renamedSolution = await renamedSolution.WithMergedLinkedFileChangesAsync(oldSolution, solutionChanges, cancellationToken: cancellationToken).ConfigureAwait(false);
         solutionChanges = renamedSolution.GetChanges(oldSolution);
+
+        Contract.ThrowIfTrue(!includeSourceGenerated && !renamedSolution.CompilationState.FrozenSourceGeneratedDocumentStates.IsEmpty, "Renaming in generated documents is not allowed, but there are changes in source generated documents.");
+
         var changedDocuments = solutionChanges
             .GetProjectChanges()
             .SelectMany(p => p.GetChangedDocuments(onlyGetDocumentsWithTextChanges: true))
-            .GroupBy(docId => renamedSolution.GetRequiredDocument(docId).FilePath, StringComparer.OrdinalIgnoreCase).Select(group => group.First());
+            .GroupBy(docId => renamedSolution.GetRequiredDocument(docId).FilePath, StringComparer.OrdinalIgnoreCase).Select(group => group.First())
+            .Concat(solutionChanges.GetExplicitlyChangedSourceGeneratedDocuments());
 
         var textDiffService = renamedSolution.Services.GetRequiredService<IDocumentTextDifferencingService>();
 
-        var documentEdits = await ProtocolConversions.ChangedDocumentsToTextDocumentEditsAsync(changedDocuments, renamedSolution.GetRequiredDocument, oldSolution.GetRequiredDocument,
+        var documentEdits = await ProtocolConversions.ChangedDocumentsToTextDocumentEditsAsync(changedDocuments, renamedSolution, oldSolution,
             textDiffService, cancellationToken).ConfigureAwait(false);
 
         return new WorkspaceEdit { DocumentChanges = documentEdits };