Publish on document change if the config file doesn't exist (#9634)

Author: Andrew Hall

src/Razor/src/Microsoft.VisualStudio.LanguageServerClient.Razor/RazorProjectInfoPublisher.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
@@ -171,6 +172,19 @@ internal void ProjectSnapshotManager_Changed(object sender, ProjectChangeEventAr
                 }
 
                 break;
+            case ProjectChangeKind.DocumentChanged:
+                // DocumentChanged normally isn't a great trigger for publishing, given that it happens while a user types
+                // but for a brand new project, its possible this DocumentChanged actually represents a DocumentOpen, and
+                // it could be the first one, so its important to publish if there is no project configuration file present
+                if (ProjectWorkspacePublishable(args) &&
+                    _projectConfigurationFilePathStore.TryGet(args.ProjectKey, out var configurationFilePath) &&
+                    !FileExists(configurationFilePath))
+                {
+                    ImmediatePublish(args.Newer!);
+                }
+
+                break;
+
             case ProjectChangeKind.DocumentRemoved:
             case ProjectChangeKind.DocumentAdded:
 
@@ -195,6 +209,10 @@ internal void ProjectSnapshotManager_Changed(object sender, ProjectChangeEventAr
             case ProjectChangeKind.ProjectRemoved:
                 RemovePublishingData(args.Older!);
                 break;
+
+            default:
+                Debug.Fail("A new ProjectChangeKind has been added that the RazorProjectInfoPublisher doesn't know how to deal with");
+                break;
         }
 
         static bool ProjectWorkspacePublishable(ProjectChangeEventArgs args)

src/Razor/test/Microsoft.VisualStudio.LanguageServerClient.Razor.Test/RazorProjectInfoPublisherTest.cs

@@ -158,6 +158,44 @@ await RunOnDispatcherThreadAsync(() =>
         Assert.True(serializationSuccessful);
     }
 
+    [Fact]
+    public async Task ProjectManager_Changed_DocumentOpened_InitializedProject_NoFile_Active_Publishes()
+    {
+        // Arrange
+        var serializationSuccessful = false;
+        var hostProject = new HostProject(@"C:\path\to\project.csproj", @"C:\path\to\obj", RazorConfiguration.Default, rootNamespace: "TestRootNamespace");
+        var hostDocument = new HostDocument(@"C:\path\to\file.razor", "file.razor");
+        _projectSnapshotManager.ProjectAdded(hostProject);
+        _projectSnapshotManager.ProjectWorkspaceStateChanged(hostProject.Key, ProjectWorkspaceState.Default);
+        _projectSnapshotManager.DocumentAdded(hostProject.Key, hostDocument, new EmptyTextLoader(hostDocument.FilePath));
+        var projectSnapshot = _projectSnapshotManager.GetProjects()[0];
+        var expectedConfigurationFilePath = @"C:\path\to\obj\bin\Debug\project.razor.bin";
+        _projectConfigurationFilePathStore.Set(projectSnapshot.Key, expectedConfigurationFilePath);
+        var publisher = new TestRazorProjectInfoPublisher(
+            _projectConfigurationFilePathStore,
+            onSerializeToFile: (snapshot, configurationFilePath) =>
+            {
+                Assert.Equal(expectedConfigurationFilePath, configurationFilePath);
+                serializationSuccessful = true;
+            },
+            configurationFileExists: false)
+        {
+            EnqueueDelay = 10,
+            _active = true
+        };
+        publisher.Initialize(_projectSnapshotManager);
+
+        // Act
+        await RunOnDispatcherThreadAsync(() =>
+        {
+            _projectSnapshotManager.DocumentOpened(hostProject.Key, hostDocument.FilePath, SourceText.From(string.Empty));
+        });
+
+        // Assert
+        Assert.Empty(publisher.DeferredPublishTasks);
+        Assert.True(serializationSuccessful);
+    }
+
     [Theory]
     [InlineData(ProjectChangeKind.DocumentAdded)]
     [InlineData(ProjectChangeKind.DocumentRemoved)]
@@ -586,6 +624,7 @@ private class TestRazorProjectInfoPublisher : RazorProjectInfoPublisher
 
         private readonly bool _shouldSerialize;
         private readonly bool _useRealShouldSerialize;
+        private readonly bool _configurationFileExists;
 
         static TestRazorProjectInfoPublisher()
         {
@@ -598,17 +637,19 @@ public TestRazorProjectInfoPublisher(
             ProjectConfigurationFilePathStore projectStatePublishFilePathStore,
             Action<IProjectSnapshot, string> onSerializeToFile = null,
             bool shouldSerialize = true,
-            bool useRealShouldSerialize = false)
+            bool useRealShouldSerialize = false,
+            bool configurationFileExists = true)
             : base(s_lspEditorFeatureDetector.Object, projectStatePublishFilePathStore, TestRazorLogger.Instance)
         {
             _onSerializeToFile = onSerializeToFile ?? ((_1, _2) => throw new XunitException("SerializeToFile should not have been called."));
             _shouldSerialize = shouldSerialize;
             _useRealShouldSerialize = useRealShouldSerialize;
+            _configurationFileExists = configurationFileExists;
         }
 
         protected override bool FileExists(string file)
         {
-            return true;
+            return _configurationFileExists;
         }
 
         protected override void SerializeToFile(IProjectSnapshot projectSnapshot, string configurationFilePath) => _onSerializeToFile?.Invoke(projectSnapshot, configurationFilePath);