Do not parse URIs during LSP serialization/deserialization

Author: dibarbet

src/EditorFeatures/Core/ExternalAccess/VSTypeScript/Api/AbstractVSTypeScriptRequestHandler.cs

@@ -31,7 +31,7 @@ internal abstract class AbstractVSTypeScriptRequestHandler<TRequestType, TRespon
 
         var textDocumentIdentifier = new VSTextDocumentIdentifier
         {
-            Uri = typeScriptIdentifier.Value.Uri,
+            Uri = DocumentUri.FromUri(typeScriptIdentifier.Value.Uri),
         };
 
         if (typeScriptIdentifier.Value.ProjectId != null)

src/EditorFeatures/TestUtilities/LanguageServer/AbstractLanguageServerProtocolTests.cs

@@ -31,6 +31,7 @@
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.CommonLanguageServerProtocol.Framework;
 using Nerdbank.Streams;
+using Roslyn.LanguageServer.Protocol;
 using Roslyn.Utilities;
 using StreamJsonRpc;
 using Xunit;
@@ -74,7 +75,7 @@ internal class TestSpanMapper : ISpanMappingService
             internal static readonly LSP.Location MappedFileLocation = new LSP.Location
             {
                 Range = ProtocolConversions.LinePositionToRange(s_mappedLinePosition),
-                Uri = ProtocolConversions.CreateAbsoluteUri(s_mappedFilePath)
+                Uri = ProtocolConversions.CreateAbsoluteDocumentUri(s_mappedFilePath)
             };
 
             /// <summary>
@@ -159,7 +160,7 @@ private protected static int CompareLocations(LSP.Location? l1, LSP.Location? l2
             if (l2 is null)
                 return 1;
 
-            var compareDocument = l1.Uri.AbsoluteUri.CompareTo(l2.Uri.AbsoluteUri);
+            var compareDocument = l1.Uri.UriString.CompareTo(l2.Uri.UriString);
             var compareRange = CompareRange(l1.Range, l2.Range);
             return compareDocument != 0 ? compareDocument : compareRange;
         }
@@ -206,7 +207,7 @@ internal static LSP.SymbolInformation CreateSymbolInformation(LSP.SymbolKind kin
             return info;
         }
 
-        private protected static LSP.TextDocumentIdentifier CreateTextDocumentIdentifier(Uri uri, ProjectId? projectContext = null)
+        private protected static LSP.TextDocumentIdentifier CreateTextDocumentIdentifier(DocumentUri uri, ProjectId? projectContext = null)
         {
             var documentIdentifier = new LSP.VSTextDocumentIdentifier { Uri = uri };
 
@@ -474,7 +475,7 @@ protected static async Task RemoveGeneratorAsync(AnalyzerReference reference, Ed
 
             return locations;
 
-            static LSP.Location ConvertTextSpanWithTextToLocation(TextSpan span, SourceText text, Uri documentUri)
+            static LSP.Location ConvertTextSpanWithTextToLocation(TextSpan span, SourceText text, DocumentUri documentUri)
             {
                 var location = new LSP.Location
                 {
@@ -500,7 +501,7 @@ private static string GetDocumentFilePathFromName(string documentName)
             => "C:\\" + documentName;
 
         private static LSP.DidChangeTextDocumentParams CreateDidChangeTextDocumentParams(
-            Uri documentUri,
+            DocumentUri documentUri,
             ImmutableArray<(LSP.Range Range, string Text)> changes)
         {
             var changeEvents = changes.Select(change => new LSP.TextDocumentContentChangeEvent
@@ -519,7 +520,7 @@ private static LSP.DidChangeTextDocumentParams CreateDidChangeTextDocumentParams
             };
         }
 
-        private static LSP.DidOpenTextDocumentParams CreateDidOpenTextDocumentParams(Uri uri, string source, string languageId = "")
+        private static LSP.DidOpenTextDocumentParams CreateDidOpenTextDocumentParams(DocumentUri uri, string source, string languageId = "")
             => new LSP.DidOpenTextDocumentParams
             {
                 TextDocument = new LSP.TextDocumentItem
@@ -530,7 +531,7 @@ private static LSP.DidOpenTextDocumentParams CreateDidOpenTextDocumentParams(Uri
                 }
             };
 
-        private static LSP.DidCloseTextDocumentParams CreateDidCloseTextDocumentParams(Uri uri)
+        private static LSP.DidCloseTextDocumentParams CreateDidCloseTextDocumentParams(DocumentUri uri)
            => new LSP.DidCloseTextDocumentParams()
            {
                TextDocument = new LSP.TextDocumentIdentifier
@@ -650,14 +651,14 @@ private static RoslynLanguageServer CreateLanguageServer(Stream inputStream, Str
                 return languageServer;
             }
 
-            public async Task<Document> GetDocumentAsync(Uri uri)
+            public async Task<Document> GetDocumentAsync(DocumentUri uri)
             {
                 var document = await GetCurrentSolution().GetDocumentAsync(new LSP.TextDocumentIdentifier { Uri = uri }, CancellationToken.None).ConfigureAwait(false);
                 Contract.ThrowIfNull(document, $"Unable to find document with {uri} in solution");
                 return document;
             }
 
-            public async Task<SourceText> GetDocumentTextAsync(Uri uri)
+            public async Task<SourceText> GetDocumentTextAsync(DocumentUri uri)
             {
                 var document = await GetDocumentAsync(uri).ConfigureAwait(false);
                 return await document.GetTextAsync(CancellationToken.None).ConfigureAwait(false);
@@ -692,7 +693,7 @@ public Task ExecutePreSerializedRequestAsync(string methodName, JsonDocument ser
                 return _clientRpc.InvokeWithParameterObjectAsync(methodName, serializedRequest);
             }
 
-            public async Task OpenDocumentAsync(Uri documentUri, string? text = null, string languageId = "")
+            public async Task OpenDocumentAsync(DocumentUri documentUri, string? text = null, string languageId = "")
             {
                 if (text == null)
                 {
@@ -706,15 +707,15 @@ public async Task OpenDocumentAsync(Uri documentUri, string? text = null, string
                 await ExecuteRequestAsync<LSP.DidOpenTextDocumentParams, object>(LSP.Methods.TextDocumentDidOpenName, didOpenParams, CancellationToken.None);
             }
 
-            public Task ReplaceTextAsync(Uri documentUri, params (LSP.Range Range, string Text)[] changes)
+            public Task ReplaceTextAsync(DocumentUri documentUri, params (LSP.Range Range, string Text)[] changes)
             {
                 var didChangeParams = CreateDidChangeTextDocumentParams(
                     documentUri,
                     [.. changes]);
                 return ExecuteRequestAsync<LSP.DidChangeTextDocumentParams, object>(LSP.Methods.TextDocumentDidChangeName, didChangeParams, CancellationToken.None);
             }
 
-            public Task InsertTextAsync(Uri documentUri, params (int Line, int Column, string Text)[] changes)
+            public Task InsertTextAsync(DocumentUri documentUri, params (int Line, int Column, string Text)[] changes)
             {
                 return ReplaceTextAsync(documentUri, [.. changes.Select(change => (new LSP.Range
                 {
@@ -723,7 +724,7 @@ public Task InsertTextAsync(Uri documentUri, params (int Line, int Column, strin
                 }, change.Text))]);
             }
 
-            public Task DeleteTextAsync(Uri documentUri, params (int StartLine, int StartColumn, int EndLine, int EndColumn)[] changes)
+            public Task DeleteTextAsync(DocumentUri documentUri, params (int StartLine, int StartColumn, int EndLine, int EndColumn)[] changes)
             {
                 return ReplaceTextAsync(documentUri, [.. changes.Select(change => (new LSP.Range
                 {
@@ -732,7 +733,7 @@ public Task DeleteTextAsync(Uri documentUri, params (int StartLine, int StartCol
                 }, string.Empty))]);
             }
 
-            public Task CloseDocumentAsync(Uri documentUri)
+            public Task CloseDocumentAsync(DocumentUri documentUri)
             {
                 var didCloseParams = CreateDidCloseTextDocumentParams(documentUri);
                 return ExecuteRequestAsync<LSP.DidCloseTextDocumentParams, object>(LSP.Methods.TextDocumentDidCloseName, didCloseParams, CancellationToken.None);
@@ -790,7 +791,7 @@ internal async Task WaitForDiagnosticsAsync()
 
             internal T GetRequiredLspService<T>() where T : class, ILspService => LanguageServer.GetTestAccessor().GetRequiredLspService<T>();
 
-            internal ImmutableArray<SourceText> GetTrackedTexts() => [.. GetManager().GetTrackedLspText().Values.Select(v => v.Text)];
+            internal ImmutableArray<SourceText> GetTrackedTexts() => [.. GetManager().GetTrackedLspText().Values.Select(v => v.SourceText)];
 
             internal Task RunCodeAnalysisAsync(ProjectId? projectId)
                 => _codeAnalysisService.RunAnalysisAsync(GetCurrentSolution(), projectId, onAfterProjectAnalyzed: _ => { }, CancellationToken.None);

src/Features/Lsif/Generator/Generator.cs

@@ -212,7 +212,7 @@ public async Task GenerateForProjectAsync(
 
             var contentBase64Encoded = await GetBase64EncodedContentAsync(document, cancellationToken);
 
-            var documentVertex = new Graph.LsifDocument(document.GetURI(), GetLanguageKind(semanticModel.Language), contentBase64Encoded, idFactory);
+            var documentVertex = new Graph.LsifDocument(document.GetURI().GetRequiredParsedUri(), GetLanguageKind(semanticModel.Language), contentBase64Encoded, idFactory);
             lsifJsonWriter.Write(documentVertex);
             lsifJsonWriter.Write(new Event(Event.EventKind.Begin, documentVertex.GetId(), idFactory));
 

src/Features/Lsif/GeneratorTest/ProjectStructureTests.vb

@@ -76,7 +76,7 @@ Namespace Microsoft.CodeAnalysis.LanguageServerIndexFormat.Generator.UnitTests
             Await TestLsifOutput.GenerateForWorkspaceAsync(workspace, New LineModeLsifJsonWriter(stringWriter))
 
             Dim generatedDocument = Assert.Single(Await workspace.CurrentSolution.Projects.Single().GetSourceGeneratedDocumentsAsync())
-            Dim uri = SourceGeneratedDocumentUri.Create(generatedDocument.Identity)
+            Dim uri = SourceGeneratedDocumentUri.Create(generatedDocument.Identity).GetRequiredParsedUri()
             Dim outputText = stringWriter.ToString()
             Assert.Contains(uri.AbsoluteUri, outputText)
         End Function

src/LanguageServer/ExternalAccess/CompilerDeveloperSDK/Handler/AbstractCompilerDeveloperSdkLspServiceDocumentRequestHandler.cs

@@ -22,7 +22,7 @@ internal abstract class AbstractCompilerDeveloperSdkLspServiceDocumentRequestHan
     bool ISolutionRequiredHandler.RequiresLSPSolution => RequiresLSPSolution;
 
     TextDocumentIdentifier ITextDocumentIdentifierHandler<TRequest, TextDocumentIdentifier>.GetTextDocumentIdentifier(TRequest request)
-        => new() { Uri = GetTextDocumentIdentifier(request) };
+        => new() { Uri = DocumentUri.FromUri(GetTextDocumentIdentifier(request)) };
     Task<TResponse> IRequestHandler<TRequest, TResponse, LspRequestContext>.HandleRequestAsync(TRequest request, LspRequestContext context, CancellationToken cancellationToken)
         => HandleRequestAsync(request, new RequestContext(context), cancellationToken);
 }

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer.UnitTests/LspFileChangeWatcherTests.cs

@@ -62,7 +62,7 @@ public async Task CreatingDirectoryWatchRequestsDirectoryWatch()
 
         var watcher = GetSingleFileWatcher(dynamicCapabilitiesRpcTarget);
 
-        Assert.Equal(tempDirectory.Path, watcher.GlobPattern.Second.BaseUri.Second.LocalPath);
+        Assert.Equal(tempDirectory.Path, watcher.GlobPattern.Second.BaseUri.Second.GetRequiredParsedUri().LocalPath);
         Assert.Equal("**/*", watcher.GlobPattern.Second.Pattern);
 
         // Get rid of the registration and it should be gone again
@@ -93,7 +93,7 @@ public async Task CreatingFileWatchRequestsFileWatch()
 
         var watcher = GetSingleFileWatcher(dynamicCapabilitiesRpcTarget);
 
-        Assert.Equal("Z:\\", watcher.GlobPattern.Second.BaseUri.Second.LocalPath);
+        Assert.Equal("Z:\\", watcher.GlobPattern.Second.BaseUri.Second.GetRequiredParsedUri().LocalPath);
         Assert.Equal("SingleFile.txt", watcher.GlobPattern.Second.Pattern);
 
         // Get rid of the registration and it should be gone again

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer.UnitTests/ServerInitializationTests.cs

@@ -18,7 +18,7 @@ public ServerInitializationTests(ITestOutputHelper testOutputHelper) : base(test
     public async Task TestServerHandlesTextSyncRequestsAsync()
     {
         await using var server = await CreateLanguageServerAsync();
-        var document = new VersionedTextDocumentIdentifier { Uri = ProtocolConversions.CreateAbsoluteUri("C:\\\ue25b\ud86d\udeac.cs") };
+        var document = new VersionedTextDocumentIdentifier { Uri = ProtocolConversions.CreateAbsoluteDocumentUri("C:\\\ue25b\ud86d\udeac.cs") };
         var response = await server.ExecuteRequestAsync<DidOpenTextDocumentParams, object>(Methods.TextDocumentDidOpenName, new DidOpenTextDocumentParams
         {
             TextDocument = new TextDocumentItem

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/FileWatching/LspFileChangeWatcher.cs

@@ -104,7 +104,7 @@ private void WatchedFilesHandler_OnNotificationRaised(object? sender, DidChangeW
         {
             foreach (var changedFile in e.Changes)
             {
-                var filePath = changedFile.Uri.LocalPath;
+                var filePath = changedFile.Uri.GetRequiredParsedUri().LocalPath;
 
                 // Unfortunately the LSP protocol doesn't give us any hint of which of the file watches we might have sent to the client
                 // was the one that registered for this change, so we have to check paths to see if this one we should respond to.
@@ -152,7 +152,7 @@ public IWatchedFile EnqueueWatchingFile(string filePath)
                 // TODO: figure out how I just can do an absolute path watch
                 GlobPattern = new RelativePattern
                 {
-                    BaseUri = ProtocolConversions.CreateAbsoluteUri(Path.GetDirectoryName(filePath)!),
+                    BaseUri = ProtocolConversions.CreateAbsoluteDocumentUri(Path.GetDirectoryName(filePath)!),
                     Pattern = Path.GetFileName(filePath)
                 }
             };

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/Razor/RazorDynamicFileChangedHandler.cs

@@ -5,6 +5,7 @@
 using System.Composition;
 using Microsoft.CodeAnalysis.Host.Mef;
 using Microsoft.CodeAnalysis.LanguageServer.Handler;
+using Roslyn.LanguageServer.Protocol;
 
 namespace Microsoft.CodeAnalysis.LanguageServer.HostWorkspace.Razor;
 
@@ -27,7 +28,8 @@ public RazorDynamicFileChangedHandler(RazorDynamicFileInfoProvider razorDynamicF
 
     public Task HandleNotificationAsync(RazorDynamicFileChangedParams request, RequestContext requestContext, CancellationToken cancellationToken)
     {
-        var filePath = ProtocolConversions.GetDocumentFilePathFromUri(request.RazorDocument.Uri);
+        var parsedUri = request.RazorDocument.Uri.GetRequiredParsedUri();
+        var filePath = ProtocolConversions.GetDocumentFilePathFromUri(parsedUri);
         _razorDynamicFileInfoProvider.Update(filePath);
         return Task.CompletedTask;
     }

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/Razor/RazorDynamicFileInfoProvider.TextChangesTextLoader.cs

@@ -6,6 +6,7 @@
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.LanguageServer.LanguageServer;
 using Microsoft.CodeAnalysis.Text;
+using Roslyn.LanguageServer.Protocol;
 using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.LanguageServer.HostWorkspace.Razor;
@@ -18,14 +19,14 @@ private sealed class TextChangesTextLoader(
         byte[] checksum,
         SourceHashAlgorithm checksumAlgorithm,
         int? codePage,
-        Uri razorUri) : TextLoader
+        DocumentUri razorUri) : TextLoader
     {
         private readonly TextDocument? _document = document;
         private readonly IEnumerable<RazorDynamicFileUpdate> _updates = updates;
         private readonly byte[] _checksum = checksum;
         private readonly SourceHashAlgorithm _checksumAlgorithm = checksumAlgorithm;
         private readonly int? _codePage = codePage;
-        private readonly Uri _razorUri = razorUri;
+        private readonly DocumentUri _razorUri = razorUri;
 
         private readonly Lazy<SourceText> _emptySourceText = new Lazy<SourceText>(() =>
         {