Merge release/dev17.9 to main (#9640)

This is an automatically generated pull request from release/dev17.9
into main.


Once all conflicts are resolved and all the tests pass, you are free to
merge the pull request. 🐯

## Troubleshooting conflicts

### Identify authors of changes which introduced merge conflicts
Scroll to the bottom, then for each file containing conflicts copy its
path into the following searches:
- https://github.com/dotnet/razor/find/release/dev17.9
- https://github.com/dotnet/razor/find/main

Usually the most recent change to a file between the two branches is
considered to have introduced the conflicts, but sometimes it will be
necessary to look for the conflicting lines and check the blame in each
branch. Generally the author whose change introduced the conflicts
should pull down this PR, fix the conflicts locally, then push up a
commit resolving the conflicts.

### Resolve merge conflicts using your local repo
Sometimes merge conflicts may be present on GitHub but merging locally
will work without conflicts. This is due to differences between the
merge algorithm used in local git versus the one used by GitHub.
``` bash
git fetch --all
git checkout -t upstream/merges/release/dev17.9-to-main
git reset --hard upstream/main
git merge upstream/release/dev17.9
# Fix merge conflicts
git commit
git push upstream merges/release/dev17.9-to-main --force
```

Author: dotnet-bot

azure-pipelines.yml

@@ -83,10 +83,10 @@ stages:
           pool:
             ${{ if eq(variables['System.TeamProject'], 'public') }}:
               name: $(DncEngPublicBuildPool)
-              demands: ImageOverride -equals windows.vs2022preview.scout.amd64.open
+              demands: ImageOverride -equals windows.vs2022preview.amd64.open
             ${{ if ne(variables['System.TeamProject'], 'public') }}:
               name: $(DncEngInternalBuildPool)
-              demands: ImageOverride -equals windows.vs2022preview.scout.amd64
+              demands: ImageOverride -equals windows.vs2022preview.amd64
           steps:
           - task: NuGetCommand@2
             displayName: 'Clear NuGet caches'
@@ -127,10 +127,10 @@ stages:
         pool:
           ${{ if eq(variables['System.TeamProject'], 'public') }}:
             name: $(DncEngPublicBuildPool)
-            demands: ImageOverride -equals windows.vs2022preview.scout.amd64.open
+            demands: ImageOverride -equals windows.vs2022preview.amd64.open
           ${{ if ne(variables['System.TeamProject'], 'public') }}:
             name: $(DncEngInternalBuildPool)
-            demands: ImageOverride -equals windows.vs2022preview.scout.amd64
+            demands: ImageOverride -equals windows.vs2022preview.amd64
         strategy:
           matrix:
             ${{ if eq(variables['System.TeamProject'], 'public') }}:

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);