Do not parse URIs during LSP serialization/deserialization (#76691)

Resolves dotnet/vscode-csharp#7638
Resolves microsoft/vscode-dotnettools#1932

Related to dotnet/runtime#64707

## Problem

`System.Uri` will throw attempting to parse URIs that have `sub-delims`
in the host name. This is because it does additional host name
validation beyond what is defined in the URI RFC spec. See above linked
issues for specific examples.

When we get passed these URIs from VSCode, the server crashes because we
cannot successfully deserialize the LSP URI string into a `System.Uri`.
We are unable to easily recover from these as it happens before we get
to the queue processing.

## Solution

The approach I took in this PR is to stop parsing URIs during LSP
message deserialization and remove usages of `System.Uri` from LSP
directly. Instead, I created a wrapper type `DocumentUri` which
initially stores just the string representation of the URI (exactly how
[LSP defines
URIs](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#uri)).
The `System.Uri` can be optionally retrieved from this (which will parse
it). Only places which need to extract information from the URI should
retrieve the `System.Uri` and must handle failures.
 
This allows URI parsing to be delayed until much later (for example
looking at the scheme or file path to find a matching document in the
workspace). While we still cannot parse the URI, we can handle the error
and provide a misc document instead of crashing the server. These aren't
normal files anyway (they don't conform to the `file:///<path>` format)
and would go to misc regardless of if we succeed in parsing it or not.

If at some point the runtime adds a new parsing mode, or we switch to
our own URI parser (similar to O#), this still provides value.
Deserialization of the URI string and parsing the URI string are two
separate logical operations and should not be tied together.
Additionally, any runtime improvements here would only be available in
.NET 10.

## Key areas to look at
1.  `DocumentUri`
2.  `DocumentUriConverter`
3.  `LspWorkspaceManager`
4.  `ProtocolConversions`

Razor PR - https://github.com/dotnet/razor/pull/11390/files

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,
+            DocumentUri = new(typeScriptIdentifier.Value.Uri),
         };
 
         if (typeScriptIdentifier.Value.ProjectId != null)

src/EditorFeatures/Test/LanguageServer/VSTypeScriptHandlerTests.cs

@@ -22,6 +22,7 @@
 using StreamJsonRpc;
 using Xunit;
 using Xunit.Abstractions;
+using System.Text.Json.Serialization;
 
 namespace Microsoft.CodeAnalysis.Editor.UnitTests.LanguageServer;
 
@@ -138,7 +139,7 @@ public static async Task<VSTypeScriptTestLspServer> CreateAsync(LspTestWorkspace
         }
     }
 
-    internal sealed record TSRequest(Uri Document, string Project);
+    internal sealed record TSRequest([property: JsonConverter(typeof(DocumentUriConverter))] DocumentUri Document, string Project);
 
     [ExportTypeScriptLspServiceFactory(typeof(TypeScriptHandler)), PartNotDiscoverable, Shared]
     internal sealed class TypeScriptHandlerFactory : AbstractVSTypeScriptRequestHandlerFactory
@@ -168,7 +169,7 @@ internal sealed class TypeScriptHandler : AbstractVSTypeScriptRequestHandler<TSR
 
         protected override TypeScriptTextDocumentIdentifier? GetTypeSciptTextDocumentIdentifier(TSRequest request)
         {
-            return new TypeScriptTextDocumentIdentifier(request.Document, request.Project);
+            return new TypeScriptTextDocumentIdentifier(request.Document.GetRequiredParsedUri(), request.Project);
         }
 
         protected override Task<int> HandleRequestAsync(TSRequest request, TypeScriptRequestContext context, CancellationToken cancellationToken)

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/Generator/Graph/LsifDocument.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
+using Roslyn.LanguageServer.Protocol;
 
 namespace Microsoft.CodeAnalysis.LanguageServerIndexFormat.Generator.Graph;
 

src/Features/Lsif/Generator/Graph/LsifProject.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
+using Roslyn.LanguageServer.Protocol;
 
 namespace Microsoft.CodeAnalysis.LanguageServerIndexFormat.Generator.Graph;
 

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() { DocumentUri = new(GetTextDocumentIdentifier(request)) };
     Task<TResponse> IRequestHandler<TRequest, TResponse, LspRequestContext>.HandleRequestAsync(TRequest request, LspRequestContext context, CancellationToken cancellationToken)
         => HandleRequestAsync(request, new RequestContext(context), cancellationToken);
 }

src/LanguageServer/ExternalAccess/Copilot/Handler/AbstractCopilotLspServiceDocumentRequestHandler.cs

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

src/LanguageServer/ExternalAccess/VisualDiagnostics/Internal/HotReloadDiagnosticSource.cs

@@ -24,7 +24,7 @@ public async Task<ImmutableArray<DiagnosticData>> GetDiagnosticsAsync(RequestCon
         return result;
     }
 
-    public TextDocumentIdentifier? GetDocumentIdentifier() => new() { Uri = textDocument.GetURI() };
+    public TextDocumentIdentifier? GetDocumentIdentifier() => new() { DocumentUri = textDocument.GetURI() };
     public ProjectOrDocumentId GetId() => new(textDocument.Id);
     public Project GetProject() => textDocument.Project;
     public bool IsLiveSource() => true;

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