Move DocumentKey and clean up a bit

- Move DocumentKey to Microsoft.AspNetCore.Razor.ProjectEngineHost project alongside ProjectKey.
- Move DocumentKey to the Microsoft.AspNetCore.Razor.ProjectSystem namespace
- Rename DocumentFilePath to FilePath. ("Document" is a bit redundant in a "DocumentKey").
- Implement IComparable<ProjectKey> on ProjectKey.
- Implement IComparable<DocumentKey> on DocumentKey.

Author: DustinCampbell

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

@@ -180,7 +180,7 @@ private void ProjectManager_Changed(object? sender, ProjectChangeEventArgs args)
                     {
                         if (_publishedCSharpData.Remove(key))
                         {
-                            _logger.LogDebug($"Removing previous C# publish data for {key.ProjectKey}/{key.DocumentFilePath}");
+                            _logger.LogDebug($"Removing previous C# publish data for {key.ProjectKey}/{key.FilePath}");
                         }
                     }
 
@@ -208,15 +208,15 @@ private void ProjectManager_Changed(object? sender, ProjectChangeEventArgs args)
                     {
                         if (_publishedCSharpData.Remove(documentKey))
                         {
-                            _logger.LogDebug($"Removing previous C# publish data for {documentKey.ProjectKey}/{documentKey.DocumentFilePath}");
+                            _logger.LogDebug($"Removing previous C# publish data for {documentKey.ProjectKey}/{documentKey.FilePath}");
                         }
                     }
 
                     lock (_publishedHtmlData)
                     {
                         if (_publishedHtmlData.Remove(documentFilePath))
                         {
-                            _logger.LogDebug($"Removing previous Html publish data for {documentKey.ProjectKey}/{documentKey.DocumentFilePath}");
+                            _logger.LogDebug($"Removing previous Html publish data for {documentKey.ProjectKey}/{documentKey.FilePath}");
                         }
                     }
                 }
@@ -249,7 +249,7 @@ private void ProjectManager_Changed(object? sender, ProjectChangeEventArgs args)
                         {
                             if (_publishedCSharpData.Remove(key))
                             {
-                                _logger.LogDebug($"Removing previous C# publish data for {key.ProjectKey}/{key.DocumentFilePath}");
+                                _logger.LogDebug($"Removing previous C# publish data for {key.ProjectKey}/{key.FilePath}");
                             }
                         }
                     }

src/Razor/src/Microsoft.AspNetCore.Razor.ProjectEngineHost/ProjectSystem/DocumentKey.cs

@@ -0,0 +1,44 @@
+// 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 Microsoft.CodeAnalysis.Razor;
+using Microsoft.Extensions.Internal;
+
+namespace Microsoft.AspNetCore.Razor.ProjectSystem;
+
+internal readonly record struct DocumentKey : IComparable<DocumentKey>
+{
+    public ProjectKey ProjectKey { get; }
+    public string FilePath { get; }
+
+    public DocumentKey(ProjectKey projectKey, string filePath)
+    {
+        ProjectKey = projectKey;
+        FilePath = filePath;
+    }
+
+    public bool Equals(DocumentKey other)
+        => ProjectKey.Equals(other.ProjectKey) &&
+           FilePathComparer.Instance.Equals(FilePath, other.FilePath);
+
+    public override int GetHashCode()
+    {
+        var hash = HashCodeCombiner.Start();
+        hash.Add(ProjectKey);
+        hash.Add(FilePath, FilePathComparer.Instance);
+
+        return hash;
+    }
+
+    public int CompareTo(DocumentKey other)
+    {
+        var comparison = ProjectKey.CompareTo(other.ProjectKey);
+        if (comparison != 0)
+        {
+            return comparison;
+        }
+
+        return FilePathComparer.Instance.Compare(FilePath, other.FilePath);
+    }
+}

src/Razor/src/Microsoft.AspNetCore.Razor.ProjectEngineHost/ProjectSystem/ProjectKey.cs

@@ -14,7 +14,7 @@ namespace Microsoft.AspNetCore.Razor.ProjectSystem;
 /// identifier for a project.
 /// </summary>
 [DebuggerDisplay("id: {Id}")]
-internal readonly record struct ProjectKey
+internal readonly record struct ProjectKey : IComparable<ProjectKey>
 {
     public static ProjectKey Unknown { get; } = default;
 
@@ -38,4 +38,19 @@ public override int GetHashCode()
 
     public override string ToString()
         => IsUnknown ? "<Unknown Project>" : Id;
+
+    public int CompareTo(ProjectKey other)
+    {
+        // Sort "unknown" project keys after other project keys.
+        if (IsUnknown)
+        {
+            return other.IsUnknown ? 0 : 1;
+        }
+        else if (other.IsUnknown)
+        {
+            return -1;
+        }
+
+        return FilePathComparer.Instance.Compare(Id, other.Id);
+    }
 }

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/DocumentKey.cs

@@ -96,15 +96,15 @@ public EditorDocument GetOrCreateDocument(
             }
 
             // Check if the document is already open and initialized, and associate a buffer if possible.
-            var textBuffer = GetTextBufferForOpenDocument(key.DocumentFilePath);
+            var textBuffer = GetTextBufferForOpenDocument(key.FilePath);
             document = new EditorDocument(
                 this,
                 JoinableTaskContext,
                 projectFilePath,
-                key.DocumentFilePath,
+                key.FilePath,
                 projectKey,
-                new FileTextLoader(key.DocumentFilePath, defaultEncoding: null),
-                _fileChangeTrackerFactory.Create(key.DocumentFilePath),
+                new FileTextLoader(key.FilePath, defaultEncoding: null),
+                _fileChangeTrackerFactory.Create(key.FilePath),
                 textBuffer,
                 changedOnDisk,
                 changedInEditor,
@@ -113,10 +113,10 @@ public EditorDocument GetOrCreateDocument(
 
             _documents.Add(key, document);
 
-            if (!_documentsByFilePath.TryGetValue(key.DocumentFilePath, out var documents))
+            if (!_documentsByFilePath.TryGetValue(key.FilePath, out var documents))
             {
                 documents = new List<DocumentKey>();
-                _documentsByFilePath.Add(key.DocumentFilePath, documents);
+                _documentsByFilePath.Add(key.FilePath, documents);
             }
 
             if (!documents.Contains(key))

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/Documents/EditorDocumentManager.cs

@@ -12,7 +12,6 @@
 using Microsoft.AspNetCore.Razor.ProjectSystem;
 using Microsoft.AspNetCore.Razor.Telemetry;
 using Microsoft.AspNetCore.Razor.Utilities;
-using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Workspaces;
 using Microsoft.VisualStudio.Razor.ProjectSystem;

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/Documents/EditorDocumentManagerListener.cs

@@ -4,7 +4,6 @@
 using System;
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.AspNetCore.Razor.ProjectSystem;
-using Microsoft.CodeAnalysis.Razor;
 
 namespace Microsoft.VisualStudio.Razor.Documents;
 

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/Documents/IEditorDocumentManager.cs

@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using Microsoft.AspNetCore.Razor;
+using Microsoft.AspNetCore.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor;
 using Microsoft.VisualStudio.Editor;
 using Microsoft.VisualStudio.Razor.Extensions;
@@ -180,7 +181,7 @@ public void DocumentClosed(uint cookie, string? exceptFilePath = null)
             // We have to deal with some complications here due to renames and event ordering and such.
             // We we might see multiple documents open for a cookie (due to linked files), but only one of them
             // has been renamed. In that case, we just process the change that we know about.
-            var filePaths = new HashSet<string>(documents.Select(d => d.DocumentFilePath));
+            var filePaths = new HashSet<string>(documents.Select(d => d.FilePath));
 
             // `Remove` can correctly handle the case when the incoming value is null without any exceptions.
             // The method is just not properly annotated for it,

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/Documents/VisualStudioEditorDocumentManager.cs

@@ -2,7 +2,7 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using System.Collections.Generic;
-using Microsoft.CodeAnalysis.Razor;
+using Microsoft.AspNetCore.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 
 namespace Microsoft.VisualStudio.Razor.DynamicFiles;

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/DynamicFiles/BackgroundDocumentGenerator.Comparer.cs

@@ -14,7 +14,6 @@
 using Microsoft.AspNetCore.Razor.Test.Common;
 using Microsoft.AspNetCore.Razor.Test.Common.VisualStudio;
 using Microsoft.CodeAnalysis;
-using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Razor.Logging;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Text;
@@ -254,7 +253,7 @@ await projectManager.UpdateAsync(updater =>
         // Wait for the work to complete.
         await generator.WaitUntilCurrentBatchCompletesAsync();
 
-        Assert.Collection(generator.CompletedWork.OrderBy(key => key.DocumentFilePath),
+        Assert.Collection(generator.CompletedWork.OrderBy(key => key.FilePath),
             key => Assert.Equal(documentKey1, key),
             key => Assert.Equal(documentKey2, key));
     }
@@ -295,7 +294,7 @@ await projectManager.UpdateAsync(updater =>
 
         Assert.True(generator.HasPendingWork);
 
-        Assert.Collection(generator.PendingWork.OrderBy(key => key.DocumentFilePath),
+        Assert.Collection(generator.PendingWork.OrderBy(key => key.FilePath),
             key => Assert.Equal(new(s_hostProject1.Key, documents[0].FilePath), key),
             key => Assert.Equal(new(s_hostProject1.Key, documents[1].FilePath), key));
 
@@ -306,7 +305,7 @@ await projectManager.UpdateAsync(updater =>
 
         Assert.False(generator.HasPendingWork);
 
-        Assert.Collection(generator.CompletedWork.OrderBy(key => key.DocumentFilePath),
+        Assert.Collection(generator.CompletedWork.OrderBy(key => key.FilePath),
             key => Assert.Equal(new(s_hostProject1.Key, documents[0].FilePath), key),
             key => Assert.Equal(new(s_hostProject1.Key, documents[1].FilePath), key));
     }