Add support for comment handling in launchSettings.json (#938)

* Closes: #772 * Add test to assert LaunchSetttingsSerializerContext does not throw when json has comments in it. * Update tests/Aspire.Hosting.Tests/LaunchSettingsSerializerContextTests.cs Co-authored-by: Dan Moseley <[email protected]> * Add blank line after the namespace * fix: Remove excessive parens --------- Co-authored-by: Dan Moseley <[email protected]>
dotnet · Nov 17, 2023 · 4269be4 · 4269be4
1 parent a7901cd
commit 4269be4
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 1 deletion.
diff --git a/src/Aspire.Hosting/Aspire.Hosting.csproj b/src/Aspire.Hosting/Aspire.Hosting.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>$(NetCurrent)</TargetFramework>
@@ -42,4 +42,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="Aspire.Hosting.Tests"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Aspire.Hosting/Utils/LaunchProfileExtensions.cs b/src/Aspire.Hosting/Utils/LaunchProfileExtensions.cs
@@ -145,6 +145,7 @@ private static bool TrySelectLaunchProfileFromAnnotation(ProjectResource project
 internal delegate bool LaunchProfileSelector(ProjectResource project, out string? launchProfile);
 
 [JsonSerializable(typeof(LaunchSettings))]
+[JsonSourceGenerationOptions(ReadCommentHandling = JsonCommentHandling.Skip)]
 internal sealed partial class LaunchSetttingsSerializerContext : JsonSerializerContext
 {
 

diff --git a/tests/Aspire.Hosting.Tests/LaunchSettingsSerializerContextTests.cs b/tests/Aspire.Hosting.Tests/LaunchSettingsSerializerContextTests.cs
@@ -0,0 +1,35 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Text.Json;
+using Xunit;
+
+namespace Aspire.Hosting.Tests;
+
+public class LaunchSettingsSerializerContextTests
+{
+    [Fact]
+    public void CommentsInLaunchSettingsJsonDoesNotThrow()
+    {
+        const string launchSettingsJson = """
+        {
+          "$schema": "http://json.schemastore.org/launchsettings.json",
+          "profiles": {
+            // comment
+            "http": {
+              "commandName": "Project",
+              "dotnetRunMessages": true,
+              "launchBrowser": true,
+              "applicationUrl": "http://localhost:5261",
+              "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+              }
+            }
+          }
+        }
+        """;
+
+        // should not throw
+        JsonSerializer.Deserialize(launchSettingsJson, LaunchSetttingsSerializerContext.Default.LaunchSettings);
+    }
+}