Support comments in recipes (#15386)

Co-authored-by: Sébastien Ros <sebastienros@gmail.com>
OrchardCMS · Feb 21, 2024 · fe2ba6e · fe2ba6e
1 parent 3bd5ae8
commit fe2ba6e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 12 deletions.
diff --git a/src/OrchardCore.Modules/OrchardCore.Deployment/Controllers/ImportController.cs b/src/OrchardCore.Modules/OrchardCore.Deployment/Controllers/ImportController.cs
@@ -1,5 +1,6 @@
 using System.IO;
 using System.IO.Compression;
+using System.Text.Json;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Http;
@@ -129,7 +130,7 @@ public async Task<IActionResult> Json(ImportJsonViewModel model)
                 return Forbid();
             }
 
-            if (!model.Json.IsJson())
+            if (!model.Json.IsJson(JOptions.Document))
             {
                 ModelState.AddModelError(nameof(model.Json), S["The recipe is written in an incorrect json format."]);
             }

diff --git a/src/OrchardCore/OrchardCore.Abstractions/Json/JOptions.cs b/src/OrchardCore/OrchardCore.Abstractions/Json/JOptions.cs
@@ -62,8 +62,8 @@ static JOptions()
 
         Document = new JsonDocumentOptions
         {
-            CommentHandling = Default.ReadCommentHandling,
-            AllowTrailingCommas = Default.AllowTrailingCommas,
+            CommentHandling = JsonCommentHandling.Skip,
+            AllowTrailingCommas = true,
         };
     }
 }
diff --git a/...hardCore/OrchardCore.Abstractions/Shell/Configuration/Internal/JsonConfigurationParser.cs b/...hardCore/OrchardCore.Abstractions/Shell/Configuration/Internal/JsonConfigurationParser.cs
@@ -54,15 +54,10 @@ private JsonConfigurationParser() { }
 
     private async Task<IDictionary<string, string?>> ParseStreamAsync(Stream input)
     {
-        var jsonDocumentOptions = new JsonDocumentOptions
-        {
-            CommentHandling = JsonCommentHandling.Skip,
-            AllowTrailingCommas = true,
-        };
-
         try
         {
-            using (var doc = await JsonDocument.ParseAsync(input, jsonDocumentOptions))
+            // Use JOptions.Document to allow comments and trailing commas
+            using (var doc = await JsonDocument.ParseAsync(input, JOptions.Document))
             {
                 if (doc.RootElement.ValueKind != JsonValueKind.Object)
                 {

diff --git a/src/OrchardCore/OrchardCore.Mvc.Core/Utilities/StringExtensions.cs b/src/OrchardCore/OrchardCore.Mvc.Core/Utilities/StringExtensions.cs
@@ -4,6 +4,7 @@
 using System.Globalization;
 using System.Net;
 using System.Text;
+using System.Text.Json;
 using System.Text.Json.Nodes;
 using System.Text.RegularExpressions;
 using Cysharp.Text;
@@ -501,11 +502,11 @@ public static string ToPascalCase(this string attribute, char upperAfterDelimite
         /// <summary>
         /// Tests if a string is valid json.
         /// </summary>
-        public static bool IsJson(this string json)
+        public static bool IsJson(this string json, JsonDocumentOptions jsonDocumentOptions = default)
         {
             try
             {
-                JsonNode.Parse(json);
+                JsonNode.Parse(json, null, jsonDocumentOptions);
                 return true;
             }
             catch