Unit tests for RazorProjectInfoEndpointPublisher (#10281)

* Unit tests for RazorProjectInfoEndpointPublisher

* Removing unnessary using directive

* Minor formatting/rename cleanup

* 'using' cleanup

* Use test accessors per CR suggestion

* Misc renames per CR suggestions

* Change test accessor to follow reference doc in Roslyn

Author: alexgav

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

@@ -30,15 +30,8 @@ public ProjectInfoEndpoint(ProjectConfigurationStateManager projectConfiguration
 
     public Task HandleNotificationAsync(ProjectInfoParams request, RazorRequestContext requestContext, CancellationToken cancellationToken)
     {
-        RazorProjectInfo? razorProjectInfo = null;
-
-        // ProjectInfo will be null if project is being deleted and should be removed
-        if (request.ProjectInfo is string projectInfoBase64)
-        {
-            var projectInfoBytes = Convert.FromBase64String(projectInfoBase64);
-            using var stream = new MemoryStream(projectInfoBytes);
-            razorProjectInfo = RazorProjectInfoDeserializer.Instance.DeserializeFromStream(stream);
-        }
+        var razorProjectInfo =
+            RazorProjectInfoDeserializer.Instance.DeserializeFromString(request.ProjectInfo);
 
         var projectKey = ProjectKey.FromString(request.ProjectKeyId);
 

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Serialization/IRazorProjectInfoDeserializer.cs

@@ -8,6 +8,7 @@ namespace Microsoft.AspNetCore.Razor.LanguageServer.Serialization;
 
 internal interface IRazorProjectInfoDeserializer
 {
+    RazorProjectInfo? DeserializeFromString(string? base64String);
     RazorProjectInfo? DeserializeFromFile(string filePath);
     RazorProjectInfo? DeserializeFromStream(Stream stream);
 }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Serialization/RazorProjectInfoDeserializer.cs

@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
+using System;
 using System.IO;
 using Microsoft.AspNetCore.Razor.ProjectSystem;
 
@@ -14,6 +15,21 @@ private RazorProjectInfoDeserializer()
     {
     }
 
+    public RazorProjectInfo? DeserializeFromString(string? base64String)
+    {
+        RazorProjectInfo? razorProjectInfo = null;
+
+        // ProjectInfo will be null if project is being deleted and should be removed
+        if (base64String is not null)
+        {
+            var projectInfoBytes = Convert.FromBase64String(base64String);
+            using var stream = new MemoryStream(projectInfoBytes);
+            razorProjectInfo = DeserializeFromStream(stream);
+        }
+
+        return razorProjectInfo;
+    }
+
     public RazorProjectInfo? DeserializeFromFile(string filePath)
     {
         using var stream = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite | FileShare.Delete);

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/ProjectSystem/IProjectSnapshotExtensions.cs

@@ -1,8 +1,10 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
+using System;
 using System.Collections.Immutable;
 using System.Diagnostics;
+using System.IO;
 using System.Threading;
 using Microsoft.AspNetCore.Razor.Language;
 using Microsoft.AspNetCore.Razor.PooledObjects;
@@ -37,6 +39,17 @@ public static RazorProjectInfo ToRazorProjectInfo(this IProjectSnapshot project,
             documents: documents.DrainToImmutable());
     }
 
+    public static string ToBase64EncodedProjectInfo(this IProjectSnapshot project, string serializedFilePath)
+    {
+        var projectInfo = project.ToRazorProjectInfo(serializedFilePath);
+
+        using var stream = new MemoryStream();
+        projectInfo.SerializeTo(stream);
+        var base64ProjectInfo = Convert.ToBase64String(stream.ToArray());
+
+        return base64ProjectInfo;
+    }
+
     public static ImmutableArray<TagHelperDescriptor> GetTagHelpersSynchronously(this IProjectSnapshot projectSnapshot)
     {
         var canResolveTagHelpersSynchronously = projectSnapshot is ProjectSnapshot ||

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/LanguageClient/ProjectSystem/RazorProjectInfoEndpointPublisher.TestAccessor.cs

@@ -0,0 +1,34 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.Razor.ProjectSystem;
+
+namespace Microsoft.VisualStudio.Razor.LanguageClient.ProjectSystem;
+
+internal partial class RazorProjectInfoEndpointPublisher
+{
+    internal TestAccessor GetTestAccessor()
+        => new(this);
+
+    internal sealed class TestAccessor(RazorProjectInfoEndpointPublisher instance)
+    {
+        /// <summary>
+        /// Allows unit tests to imitate ProjectManager.Changed event firing
+        /// </summary>
+        public void ProjectManager_Changed(object sender, ProjectChangeEventArgs args)
+            => instance.ProjectManager_Changed(sender, args);
+
+        /// <summary>
+        /// Allows unit tests to enqueue project update directly.
+        /// </summary>
+        public void EnqueuePublish(IProjectSnapshot projectSnapshot)
+             => instance.EnqueuePublish(projectSnapshot);
+
+        /// <summary>
+        /// Allows unit tests to wait for all work queue items to be processed.
+        /// </summary>
+        public Task WaitUntilCurrentBatchCompletesAsync()
+            => instance._workQueue.WaitUntilCurrentBatchCompletesAsync();
+    }
+}

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/LanguageClient/ProjectSystem/RazorProjectInfoEndpointPublisher.cs

@@ -5,7 +5,6 @@
 using System.Collections.Immutable;
 using System.ComponentModel.Composition;
 using System.Diagnostics;
-using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor;
@@ -158,17 +157,12 @@ private ValueTask ProcessBatchAsync(ImmutableArray<(IProjectSnapshot Project, bo
 
     private void RemovePublishingData(IProjectSnapshot projectSnapshot, CancellationToken cancellationToken)
     {
-        // This should never get called if we are inactive, so don't check _active flag
         ImmediatePublish(projectSnapshot.Key, encodedProjectInfo: null, cancellationToken);
     }
 
     private void ImmediatePublish(IProjectSnapshot projectSnapshot, CancellationToken cancellationToken)
     {
-        using var stream = new MemoryStream();
-
-        var projectInfo = projectSnapshot.ToRazorProjectInfo(projectSnapshot.IntermediateOutputPath);
-        projectInfo.SerializeTo(stream);
-        var base64ProjectInfo = Convert.ToBase64String(stream.ToArray());
+        var base64ProjectInfo = projectSnapshot.ToBase64EncodedProjectInfo(projectSnapshot.IntermediateOutputPath);
 
         ImmediatePublish(projectSnapshot.Key, base64ProjectInfo, cancellationToken);
     }