Encoding DocumentUri.Path when converting DocumentUri to Uri (#…

…11574) This is a workaround for OmniSharp/csharp-language-server-protocol#1005. Fixes #9466. ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/11574)
Azure · Aug 29, 2023 · e0ce74d · e0ce74d
1 parent d4a130b
commit e0ce74d
Show file tree

Hide file tree

Showing 42 changed files with 188 additions and 134 deletions.
diff --git a/src/BannedSymbols.txt b/src/BannedSymbols.txt
@@ -37,3 +37,5 @@ M:System.Console.WriteLine(System.Decimal);Don't use Console.WriteLine for loggi
 
 M:Moq.Mock`1.#ctor();Don't use the default Mock constructor. Set Strict mode explicitly or use a MockRepository set to strict mode.
 M:Moq.Mock`1.#ctor(System.Object[]);Don't use the default Mock constructor. Set Strict mode explicitly or use a MockRepository set to strict mode.
+
+M:OmniSharp.Extensions.LanguageServer.Protocol.DocumentUri.ToUri();Use DocumentUri.ToUriEncoded() instead.
diff --git a/src/Bicep.Core.IntegrationTests/Semantics/SemanticModelTests.cs b/src/Bicep.Core.IntegrationTests/Semantics/SemanticModelTests.cs
@@ -197,7 +197,7 @@ public void GetAllDiagnostics_VerifyDisableNextLineDiagnosticsDirectiveDoesNotSu
 resource test";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var files = new Dictionary<Uri, string>
             {
@@ -243,7 +243,7 @@ public void GetAllDiagnostics_VerifyDisableNextLineDiagnosticsDirectiveSupportsC
 }";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var files = new Dictionary<Uri, string>
             {
@@ -262,7 +262,7 @@ public void GetAllDiagnostics_VerifyDisableNextLineDiagnosticsDirectiveSupportsL
 param storageAccount string = 'testStorageAccount'";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var files = new Dictionary<Uri, string>
             {
@@ -282,7 +282,7 @@ public void GetAllDiagnostics_WithNoDisableNextLineDiagnosticsDirectiveInPreviou
 param storageAccount string = 'testStorageAccount'";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var files = new Dictionary<Uri, string>
             {

diff --git a/src/Bicep.Core.UnitTests/Registry/OciModuleRegistryTests.cs b/src/Bicep.Core.UnitTests/Registry/OciModuleRegistryTests.cs
@@ -519,7 +519,7 @@ public async Task GetDescription_WithValidDescriptionAndDocumentationUriInManife
         {
             string testOutputPath = FileHelper.GetUniqueTestOutputPath(TestContext);
             var bicepPath = FileHelper.SaveResultFile(TestContext, "input.bicep", bicepFileContents, testOutputPath);
-            var parentModuleUri = DocumentUri.FromFileSystemPath(bicepPath).ToUri();
+            var parentModuleUri = DocumentUri.FromFileSystemPath(bicepPath).ToUriEncoded();
 
             var ociArtifactModuleReference = OciArtifactModuleReferenceHelper.GetModuleReferenceAndSaveManifestFile(
                 TestContext,

diff --git a/src/Bicep.LangServer.IntegrationTests/BicepConfigTests.cs b/src/Bicep.LangServer.IntegrationTests/BicepConfigTests.cs
@@ -495,7 +495,7 @@ public async Task WithMultipleConfigFiles_ShouldUseConfigSettingsFromRelevantDir
 
             string bicepFileContents = @"param storageAccountName string = 'test'";
             var documentUriOfFileInChildDirectory = SaveFile("main.bicep", bicepFileContents, childDirectoryPath);
-            var uriOfFileInChildDirectory = documentUriOfFileInChildDirectory.ToUri();
+            var uriOfFileInChildDirectory = documentUriOfFileInChildDirectory.ToUriEncoded();
 
             // open the main document and verify diagnostics
             {
@@ -511,7 +511,7 @@ await VerifyDiagnosticsAsync(diagsListener, uriOfFileInChildDirectory, (@"Parame
             // add bicepconfig.json to parent directory and verify diagnostics
             {
                 var documentUriOfFileInParentDirectory = SaveFile("main.bicep", bicepFileContents, parentDirectoryPath);
-                var uriOfFileInParentDirectory = documentUriOfFileInParentDirectory.ToUri();
+                var uriOfFileInParentDirectory = documentUriOfFileInParentDirectory.ToUriEncoded();
 
                 bicepConfigFileContents = @"{
   ""analyzers"": {

diff --git a/src/Bicep.LangServer.IntegrationTests/CodeActionTests.cs b/src/Bicep.LangServer.IntegrationTests/CodeActionTests.cs
@@ -230,14 +230,14 @@ private async Task VerifyCodeActionIsAvailableToSuppressLinterDiagnostics(string
             var bicepFileContents = @"param storageAccount string = 'testStorageAccount'";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents, testOutputPath);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var fileSystemDict = new Dictionary<Uri, string>();
             fileSystemDict[uri] = bicepFileContents;
 
             string bicepConfigFilePath = FileHelper.SaveResultFile(TestContext, "bicepconfig.json", bicepConfigFileContents, testOutputPath);
             var bicepConfigUri = DocumentUri.FromFileSystemPath(bicepConfigFilePath);
-            fileSystemDict[bicepConfigUri.ToUri()] = bicepConfigFileContents;
+            fileSystemDict[bicepConfigUri.ToUriEncoded()] = bicepConfigFileContents;
 
             var compilation = Services.BuildCompilation(fileSystemDict, uri);
             var diagnostics = compilation.GetEntrypointSemanticModel().GetAllDiagnostics();
@@ -271,7 +271,7 @@ public async Task VerifyCodeActionIsNotAvailableToSuppressCoreCompilerError()
 resource test";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var files = new Dictionary<Uri, string>
             {
@@ -333,7 +333,7 @@ public async Task VerifyCodeActionIsAvailableToSuppressCoreCompilerWarning()
 }";
             var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
             var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
-            var uri = documentUri.ToUri();
+            var uri = documentUri.ToUriEncoded();
 
             var files = new Dictionary<Uri, string>
             {

diff --git a/src/Bicep.LangServer.IntegrationTests/CompletionTests.cs b/src/Bicep.LangServer.IntegrationTests/CompletionTests.cs
@@ -219,7 +219,7 @@ public async Task ValidateSnippetCompletionAfterPlaceholderReplacements(Completi
         private async Task<string> RequestSnippetCompletion(string bicepFileName, CompletionData completionData, string placeholderFile, int cursor)
         {
             var documentUri = DocumentUri.FromFileSystemPath(bicepFileName);
-            var bicepFile = SourceFileFactory.CreateBicepFile(documentUri.ToUri(), placeholderFile);
+            var bicepFile = SourceFileFactory.CreateBicepFile(documentUri.ToUriEncoded(), placeholderFile);
 
             var helper = await ServerWithNamespaceProvider.GetAsync();
             await helper.OpenFileOnceAsync(this.TestContext, placeholderFile, documentUri);
@@ -3850,7 +3850,7 @@ public async Task ModuleRegistryReferenceCompletions_GetCompletionsAfterBrSchema
                 .AddSingleton<ISettingsProvider>(settingsProvider.Object)
                 .WithFileResolver(new FileResolver(new IOFileSystem())));
 
-            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUri(), text);
+            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUriEncoded(), text);
             var completions = await file.RequestCompletion(cursor);
 
             completions.Count().Should().Be(3);
@@ -3879,7 +3879,7 @@ public async Task ModuleRegistryReferenceCompletions_GetCompletionsForFolderInsi
                 .AddSingleton<ISettingsProvider>(settingsProvider.Object)
                 .WithFileResolver(new FileResolver(new IOFileSystem())));
 
-            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUri(), text);
+            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUriEncoded(), text);
             var completions = await file.RequestCompletion(cursor);
 
             completions.Count().Should().Be(2);
@@ -3915,7 +3915,7 @@ public async Task ModuleRegistryReferenceCompletions_GetPathCompletions(string i
                 .AddSingleton<ISettingsProvider>(settingsProvider.Object)
                 .WithFileResolver(new FileResolver(new IOFileSystem())));
 
-            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUri(), text);
+            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUriEncoded(), text);
             var completions = await file.RequestCompletion(cursor);
 
             completions.Count().Should().Be(2);
@@ -3949,7 +3949,7 @@ public async Task ModuleRegistryReferenceCompletions_GetVersionCompletions(strin
                 .AddSingleton<ISettingsProvider>(settingsProvider.Object)
                 .WithFileResolver(new FileResolver(new IOFileSystem())));
 
-            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUri(), text);
+            var file = await new ServerRequestHelper(TestContext, helper).OpenFile(mainUri.ToUriEncoded(), text);
             var completions = await file.RequestCompletion(cursor);
 
             completions.Count().Should().Be(2);

diff --git a/src/Bicep.LangServer.IntegrationTests/DeploymentGraphTests.cs b/src/Bicep.LangServer.IntegrationTests/DeploymentGraphTests.cs
@@ -34,7 +34,7 @@ public async Task RequestDeploymentGraphShouldReturnDeploymentGraph()
             var fileSystemDict = new Dictionary<Uri, string>();
 
             var mainUri = DocumentUri.FromFileSystemPath("/main.bicep");
-            fileSystemDict[mainUri.ToUri()] = @"
+            fileSystemDict[mainUri.ToUriEncoded()] = @"
 resource res1 'Test.Rp/basicTests@2020-01-01' = {
   name: 'res1'
 }
@@ -62,7 +62,7 @@ public async Task RequestDeploymentGraphShouldReturnDeploymentGraph()
 ";
 
             var module1Uri = DocumentUri.FromFileSystemPath("/modules/module1.bicep");
-            fileSystemDict[module1Uri.ToUri()] = @"
+            fileSystemDict[module1Uri.ToUriEncoded()] = @"
 resource res3 'Test.Rp/basicTests@2020-01-01' = {
   name: 'res3'
 }
@@ -71,7 +71,7 @@ public async Task RequestDeploymentGraphShouldReturnDeploymentGraph()
 ";
 
             var module2Uri = DocumentUri.FromFileSystemPath("/modules/module2.bicep");
-            fileSystemDict[module2Uri.ToUri()] = @"
+            fileSystemDict[module2Uri.ToUriEncoded()] = @"
 resource res4 'Test.Rp/basicTests@2020-01-01' = {
   name: 'res4'
 }
@@ -85,7 +85,7 @@ public async Task RequestDeploymentGraphShouldReturnDeploymentGraph()
 ";
 
             var nestedModuleUri = DocumentUri.FromFileSystemPath("/modules/nestedModules/nestedModule.bicep");
-            fileSystemDict[nestedModuleUri.ToUri()] = @"
+            fileSystemDict[nestedModuleUri.ToUriEncoded()] = @"
 resource res5 'Test.Rp/basicTests@2020-01-01' = {
   name: 'res5'
 }
@@ -97,7 +97,7 @@ public async Task RequestDeploymentGraphShouldReturnDeploymentGraph()
                 services => services.WithNamespaceProvider(BuiltInTestTypes.Create()).WithFileResolver(new InMemoryFileResolver(fileSystemDict)));
             var client = helper.Client;
 
-            client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
+            client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUriEncoded()], 1));
             await diagnosticsListener.WaitNext();
 
             var deploymentGraph = await client.SendRequest(new BicepDeploymentGraphParams(new TextDocumentIdentifier(mainUri)), default);

diff --git a/src/Bicep.LangServer.IntegrationTests/FileWatcherTests.cs b/src/Bicep.LangServer.IntegrationTests/FileWatcherTests.cs
@@ -51,7 +51,7 @@ public async Task Module_file_change_should_trigger_a_recompilation()
             var diagsListener = new MultipleMessageListener<PublishDiagnosticsParams>();
 
             var mainUri = DocumentUri.FromFileSystemPath("/path/to/main.bicep");
-            fileSystemDict[mainUri.ToUri()] = @"
+            fileSystemDict[mainUri.ToUriEncoded()] = @"
 module myMod '../toOther/module.bicep' = {
   name: 'myMod'
   params: {
@@ -61,7 +61,7 @@ public async Task Module_file_change_should_trigger_a_recompilation()
 ";
 
             var moduleUri = DocumentUri.FromFileSystemPath("/path/toOther/module.bicep");
-            fileSystemDict[moduleUri.ToUri()] = @"
+            fileSystemDict[moduleUri.ToUriEncoded()] = @"
 // mis-spelling!
 param requiredIpnut string
 ";
@@ -73,7 +73,7 @@ param requiredIpnut string
 
             // open the main document
             {
-                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
+                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUriEncoded()], 1));
 
                 var diagsParams = await diagsListener.WaitNext();
                 diagsParams.Uri.Should().Be(mainUri);
@@ -82,7 +82,7 @@ param requiredIpnut string
 
             // open the module document. this should trigger diagnostics for both the module and the main doc which references it.
             {
-                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(moduleUri, fileSystemDict[moduleUri.ToUri()], 1));
+                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(moduleUri, fileSystemDict[moduleUri.ToUriEncoded()], 1));
 
                 var diagsParams = await diagsListener.WaitNext();
                 diagsParams.Uri.Should().Be(moduleUri);
@@ -129,7 +129,7 @@ public async Task Background_file_deletion_should_trigger_a_recompilation()
             var diagsListener = new MultipleMessageListener<PublishDiagnosticsParams>();
 
             var mainUri = DocumentUri.FromFileSystemPath("/path/to/main.bicep");
-            fileSystemDict[mainUri.ToUri()] = @"
+            fileSystemDict[mainUri.ToUriEncoded()] = @"
 module myMod '../toOther/module.bicep' = {
   name: 'myMod'
   params: {
@@ -139,7 +139,7 @@ public async Task Background_file_deletion_should_trigger_a_recompilation()
 ";
 
             var moduleUri = DocumentUri.FromFileSystemPath("/path/toOther/module.bicep");
-            fileSystemDict[moduleUri.ToUri()] = @"
+            fileSystemDict[moduleUri.ToUriEncoded()] = @"
 // mis-spelling!
 param requiredIpnut string
 ";
@@ -153,7 +153,7 @@ param requiredIpnut string
 
             // open the main document
             {
-                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
+                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUriEncoded()], 1));
 
                 var diagsParams = await diagsListener.WaitNext();
                 diagsParams.Uri.Should().Be(mainUri);
@@ -196,7 +196,7 @@ public async Task Background_folder_deletion_should_trigger_a_recompilation()
             var diagsListener = new MultipleMessageListener<PublishDiagnosticsParams>();
 
             var mainUri = DocumentUri.FromFileSystemPath("/path/to/main.bicep");
-            fileSystemDict[mainUri.ToUri()] = @"
+            fileSystemDict[mainUri.ToUriEncoded()] = @"
 module myMod '../toOther/module.bicep' = {
   name: 'myMod'
   params: {
@@ -206,7 +206,7 @@ public async Task Background_folder_deletion_should_trigger_a_recompilation()
 ";
 
             var moduleUri = DocumentUri.FromFileSystemPath("/path/toOther/module.bicep");
-            fileSystemDict[moduleUri.ToUri()] = @"
+            fileSystemDict[moduleUri.ToUriEncoded()] = @"
 // mis-spelling!
 param requiredIpnut string
 ";
@@ -220,7 +220,7 @@ param requiredIpnut string
 
             // open the main document
             {
-                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
+                client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUriEncoded()], 1));
 
                 var diagsParams = await diagsListener.WaitNext();
                 diagsParams.Uri.Should().Be(mainUri);

diff --git a/src/Bicep.LangServer.IntegrationTests/Helpers/LanguageServerHelper.cs b/src/Bicep.LangServer.IntegrationTests/Helpers/LanguageServerHelper.cs
@@ -73,7 +73,7 @@ public static async Task<LanguageServerHelper> StartServer(TestContext testConte
         /// No further file opening is possible.
         /// </summary>
         public static Task<LanguageServerHelper> StartServerWithText(TestContext testContext, string text, DocumentUri documentUri, Action<IServiceCollection>? onRegisterServices = null)
-            => StartServerWithText(testContext, new Dictionary<Uri, string> { [documentUri.ToUri()] = text }, documentUri.ToUri(), onRegisterServices);
+            => StartServerWithText(testContext, new Dictionary<Uri, string> { [documentUri.ToUriEncoded()] = text }, documentUri.ToUriEncoded(), onRegisterServices);
 
         /// <summary>
         /// Starts a language client/server pair that will load the specified Bicep text and wait for the diagnostics to be published.

diff --git a/src/Bicep.LangServer.IntegrationTests/Helpers/TextDocumentParamHelper.cs b/src/Bicep.LangServer.IntegrationTests/Helpers/TextDocumentParamHelper.cs
@@ -16,8 +16,8 @@ public static DidOpenTextDocumentParams CreateDidOpenDocumentParams(DocumentUri
                 TextDocument = new TextDocumentItem
                 {
                     LanguageId =
-                        PathHelper.HasBicepparamsExension(documentUri.ToUri()) ? LanguageConstants.ParamsLanguageId :
-                        PathHelper.HasArmTemplateLikeExtension(documentUri.ToUri()) ? LanguageConstants.ArmTemplateLanguageId :
+                        PathHelper.HasBicepparamsExension(documentUri.ToUriEncoded()) ? LanguageConstants.ParamsLanguageId :
+                        PathHelper.HasArmTemplateLikeExtension(documentUri.ToUriEncoded()) ? LanguageConstants.ArmTemplateLanguageId :
                         LanguageConstants.LanguageId,
                     Version = version,  
                     Uri = documentUri,

diff --git a/src/Bicep.LangServer.IntegrationTests/HoverTests.cs b/src/Bicep.LangServer.IntegrationTests/HoverTests.cs
@@ -817,7 +817,7 @@ public async Task Verify_Hover_ContainerRegistry(string? documentationUri, strin
             string testOutputPath = FileHelper.GetUniqueTestOutputPath(TestContext);
             var bicepPath = FileHelper.SaveResultFile(TestContext, "input.bicep", bicepFileContents, testOutputPath);
             var documentUri = DocumentUri.FromFileSystemPath(bicepPath);
-            var parentModuleUri = documentUri.ToUri();
+            var parentModuleUri = documentUri.ToUriEncoded();
 
             var client = await GetLanguageClientAsync(
                 documentUri,

diff --git a/src/Bicep.LangServer.IntegrationTests/SemanticTokenTests.cs b/src/Bicep.LangServer.IntegrationTests/SemanticTokenTests.cs
@@ -54,7 +54,7 @@ public static async Task ClassCleanup()
         public async Task Overlapping_tokens_are_not_returned(DataSet dataSet)
         {
             var uri = DocumentUri.From($"/{dataSet.Name}");
-            var bicepFile = SourceFileFactory.CreateBicepFile(uri.ToUri(), dataSet.Bicep);
+            var bicepFile = SourceFileFactory.CreateBicepFile(uri.ToUriEncoded(), dataSet.Bicep);
 
             var helper = await DefaultServer.GetAsync();
             await helper.OpenFileOnceAsync(TestContext, dataSet.Bicep, uri);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,3 +37,5 @@ M:System.Console.WriteLine(System.Decimal);Don't use Console.WriteLine for loggi

		M:Moq.Mock`1.#ctor();Don't use the default Mock constructor. Set Strict mode explicitly or use a MockRepository set to strict mode.
		M:Moq.Mock`1.#ctor(System.Object[]);Don't use the default Mock constructor. Set Strict mode explicitly or use a MockRepository set to strict mode.

		M:OmniSharp.Extensions.LanguageServer.Protocol.DocumentUri.ToUri();Use DocumentUri.ToUriEncoded() instead.