Ensure we regenerate C# code when documents move from misc files to regular projects (or vice versa) while open

Author: davidwengier

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/OpenDocumentGenerator.cs

@@ -6,6 +6,7 @@
 using System.Collections.Immutable;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.Razor.Logging;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Utilities;
 using Microsoft.CodeAnalysis.Razor.Workspaces;
@@ -29,14 +30,16 @@ internal partial class OpenDocumentGenerator : IRazorStartupService, IDisposable
     private readonly ImmutableArray<IDocumentProcessedListener> _listeners;
     private readonly IProjectSnapshotManager _projectManager;
     private readonly LanguageServerFeatureOptions _options;
+    private readonly ILogger _logger;
 
     private readonly AsyncBatchingWorkQueue<IDocumentSnapshot> _workQueue;
     private readonly CancellationTokenSource _disposeTokenSource;
 
     public OpenDocumentGenerator(
         IEnumerable<IDocumentProcessedListener> listeners,
         IProjectSnapshotManager projectManager,
-        LanguageServerFeatureOptions options)
+        LanguageServerFeatureOptions options,
+        ILoggerFactory loggerFactory)
     {
         _listeners = listeners.ToImmutableArray();
         _projectManager = projectManager;
@@ -49,6 +52,7 @@ public OpenDocumentGenerator(
             _disposeTokenSource.Token);
 
         _projectManager.Changed += ProjectManager_Changed;
+        _logger = loggerFactory.GetOrCreateLogger<OpenDocumentGenerator>();
     }
 
     public void Dispose()
@@ -88,6 +92,8 @@ private void ProjectManager_Changed(object? sender, ProjectChangeEventArgs args)
             return;
         }
 
+        _logger.LogDebug($"Got a project change of type {args.Kind} for {args.ProjectKey.Id}");
+
         switch (args.Kind)
         {
             case ProjectChangeKind.ProjectChanged:
@@ -106,25 +112,11 @@ private void ProjectManager_Changed(object? sender, ProjectChangeEventArgs args)
                 }
 
             case ProjectChangeKind.DocumentAdded:
-                {
-                    var newProject = args.Newer.AssumeNotNull();
-                    var documentFilePath = args.DocumentFilePath.AssumeNotNull();
-
-                    if (newProject.TryGetDocument(documentFilePath, out var document))
-                    {
-                        // We don't enqueue the current document because added documents are initially closed.
-
-                        foreach (var relatedDocument in newProject.GetRelatedDocuments(document))
-                        {
-                            EnqueueIfNecessary(relatedDocument);
-                        }
-                    }
-
-                    break;
-                }
-
             case ProjectChangeKind.DocumentChanged:
                 {
+                    // Most of the time Add will be called on closed files, but when migrating files to/from the misc files
+                    // project they could already be open, but with a different generated C# path
+
                     var newProject = args.Newer.AssumeNotNull();
                     var documentFilePath = args.DocumentFilePath.AssumeNotNull();
 
@@ -178,6 +170,8 @@ void EnqueueIfNecessary(IDocumentSnapshot document)
                 return;
             }
 
+            _logger.LogDebug($"Enqueuing generation of {document.FilePath} in {document.Project.Key.Id}");
+
             _workQueue.AddWork(document);
         }
     }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/RazorProjectService.cs

@@ -454,7 +454,18 @@ private void MoveDocument(
         var currentHostDocument = documentSnapshot.State.HostDocument;
 
         var textLoader = new DocumentSnapshotTextLoader(documentSnapshot);
-        var newHostDocument = new HostDocument(documentSnapshot.FilePath, documentSnapshot.TargetPath, documentSnapshot.FileKind);
+
+        // If we're moving from the misc files project to a real project, then target path will be the full path to the file
+        // and the next update to the project will update it to be a relative path. To save a bunch of busy work if that is
+        // the only change necessary, we can proactively do that work here.
+        var projectDirectory = FilePathNormalizer.GetNormalizedDirectoryName(toProject.FilePath);
+        var newTargetPath = documentSnapshot.TargetPath;
+        if (FilePathNormalizer.Normalize(newTargetPath).StartsWith(projectDirectory))
+        {
+            newTargetPath = newTargetPath[projectDirectory.Length..];
+        }
+
+        var newHostDocument = new HostDocument(documentSnapshot.FilePath, newTargetPath, documentSnapshot.FileKind);
 
         _logger.LogInformation($"Moving '{documentFilePath}' from the '{fromProject.Key}' project to '{toProject.Key}' project.");