Provides an abstraction for creating the JavaScriptEncoder used in SystemTextConfigurationEditorJsonSerializer (#19849)

* Provides an abstraction for creating the JavaScriptEncoder used in SystemTextConfigurationEditorJsonSerializer.

* Generalised JSON serialization encoder factory to work for all System.Tex.Json serializers.
Added the serializer's name as a parameter to allow for different encodings per serializer if required.

* Fixed tests by removing use of obsolete constructors.

* Removed name parameter and used a generic type instead.

Author: AndyButland

src/Umbraco.Core/Serialization/IJsonSerializer.cs

@@ -16,7 +16,6 @@ public interface IJsonSerializer
     /// </returns>
     string Serialize(object? input);
 
-
     /// <summary>
     /// Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter.
     /// </summary>

src/Umbraco.Core/Serialization/IJsonSerializerEncoderFactory.cs

@@ -0,0 +1,17 @@
+using System.Text.Encodings.Web;
+
+namespace Umbraco.Cms.Core.Serialization;
+
+/// <summary>
+/// Provides a factory method for creating a <see cref="JavaScriptEncoder"/> for use in instantiating JSON serializers.
+/// </summary>
+public interface IJsonSerializerEncoderFactory
+{
+    /// <summary>
+    /// Creates a <see cref="JavaScriptEncoder"/> for use in the serialization of configuration editor JSON.
+    /// </summary>
+    /// <typeparam name="TSerializer">The type of the serializer for which the encoder is being created.</typeparam>
+    /// <returns>A <see cref="JavaScriptEncoder"/> instance.</returns>
+    JavaScriptEncoder CreateEncoder<TSerializer>()
+        where TSerializer : IJsonSerializer;
+}

src/Umbraco.Infrastructure/DependencyInjection/UmbracoBuilder.CoreServices.cs

@@ -127,6 +127,7 @@ public static IUmbracoBuilder AddCoreInitialServices(this IUmbracoBuilder builde
 
         builder.Services.AddSingleton<IJsonSerializer, SystemTextJsonSerializer>();
         builder.Services.AddSingleton<IConfigurationEditorJsonSerializer, SystemTextConfigurationEditorJsonSerializer>();
+        builder.Services.AddUnique<IJsonSerializerEncoderFactory, DefaultJsonSerializerEncoderFactory>();
         builder.Services.AddUnique<IWebhookJsonSerializer, SystemTextWebhookJsonSerializer>();
 
         // register database builder

src/Umbraco.Infrastructure/Serialization/DefaultJsonSerializerEncoderFactory.cs

@@ -0,0 +1,14 @@
+using System.Text.Encodings.Web;
+using System.Text.Unicode;
+using Umbraco.Cms.Core.Serialization;
+
+namespace Umbraco.Cms.Infrastructure.Serialization;
+
+/// <inheritdoc />
+public sealed class DefaultJsonSerializerEncoderFactory : IJsonSerializerEncoderFactory
+{
+    /// <inheritdoc />
+    public JavaScriptEncoder CreateEncoder<TSerializer>()
+        where TSerializer : IJsonSerializer
+        => JavaScriptEncoder.Create(UnicodeRanges.BasicLatin);
+}

src/Umbraco.Infrastructure/Serialization/SystemTextConfigurationEditorJsonSerializer.cs

@@ -1,6 +1,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Text.Json.Serialization.Metadata;
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.PropertyEditors;
 using Umbraco.Cms.Core.Serialization;
 
@@ -14,11 +16,24 @@ public sealed class SystemTextConfigurationEditorJsonSerializer : SystemTextJson
     /// <summary>
     /// Initializes a new instance of the <see cref="SystemTextConfigurationEditorJsonSerializer" /> class.
     /// </summary>
+    [Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 18.")]
     public SystemTextConfigurationEditorJsonSerializer()
+        : this(
+              StaticServiceProvider.Instance.GetRequiredService<IJsonSerializerEncoderFactory>())
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextConfigurationEditorJsonSerializer" /> class.
+    /// </summary>
+    public SystemTextConfigurationEditorJsonSerializer(IJsonSerializerEncoderFactory jsonSerializerEncoderFactory)
+        : base(jsonSerializerEncoderFactory)
         => _jsonSerializerOptions = new JsonSerializerOptions()
         {
             PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
 
+            Encoder = jsonSerializerEncoderFactory.CreateEncoder<SystemTextConfigurationEditorJsonSerializer>(),
+
             // In some cases, configs aren't camel cased in the DB, so we have to resort to case insensitive
             // property name resolving when creating configuration objects (deserializing DB configs).
             PropertyNameCaseInsensitive = true,
@@ -40,6 +55,7 @@ public SystemTextConfigurationEditorJsonSerializer()
                 .WithAddedModifier(UseAttributeConfiguredPropertyNames()),
         };
 
+    /// <inheritdoc/>
     protected override JsonSerializerOptions JsonSerializerOptions => _jsonSerializerOptions;
 
     /// <summary>

src/Umbraco.Infrastructure/Serialization/SystemTextJsonSerializer.cs

@@ -1,5 +1,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core.DependencyInjection;
+using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Infrastructure.Serialization;
 
@@ -9,12 +12,26 @@ public sealed class SystemTextJsonSerializer : SystemTextJsonSerializerBase
     private readonly JsonSerializerOptions _jsonSerializerOptions;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="SystemTextJsonSerializer" /> class.
+    /// Initializes a new instance of the <see cref="SystemTextConfigurationEditorJsonSerializer" /> class.
     /// </summary>
+    [Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 18.")]
     public SystemTextJsonSerializer()
+        : this(
+              StaticServiceProvider.Instance.GetRequiredService<IJsonSerializerEncoderFactory>())
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextJsonSerializer" /> class.
+    /// </summary>
+    public SystemTextJsonSerializer(IJsonSerializerEncoderFactory jsonSerializerEncoderFactory)
+        : base(jsonSerializerEncoderFactory)
         => _jsonSerializerOptions = new JsonSerializerOptions
         {
             PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+
+            Encoder = jsonSerializerEncoderFactory.CreateEncoder<SystemTextJsonSerializer>(),
+
             Converters =
             {
                 new JsonStringEnumConverter(),
@@ -25,5 +42,6 @@ public SystemTextJsonSerializer()
             }
         };
 
+    /// <inheritdoc/>
     protected override JsonSerializerOptions JsonSerializerOptions => _jsonSerializerOptions;
 }

src/Umbraco.Infrastructure/Serialization/SystemTextJsonSerializerBase.cs

@@ -1,13 +1,38 @@
-using System.Diagnostics.CodeAnalysis;
+using System.Diagnostics.CodeAnalysis;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using System.Text.Json.Nodes;
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Serialization;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Infrastructure.Serialization;
 
 public abstract class SystemTextJsonSerializerBase : IJsonSerializer
 {
+    private readonly IJsonSerializerEncoderFactory _jsonSerializerEncoderFactory;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextJsonSerializerBase" /> class.
+    /// </summary>
+    [Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 18.")]
+    protected SystemTextJsonSerializerBase()
+        : this(
+              StaticServiceProvider.Instance.GetRequiredService<IJsonSerializerEncoderFactory>())
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextJsonSerializerBase"/> class.
+    /// </summary>
+    /// <param name="jsonSerializerEncoderFactory">The <see cref="IJsonSerializerEncoderFactory"/> for creating the <see cref="JavaScriptEncoder"/>.</param>
+    protected SystemTextJsonSerializerBase(IJsonSerializerEncoderFactory jsonSerializerEncoderFactory)
+        => _jsonSerializerEncoderFactory = jsonSerializerEncoderFactory;
+
+    /// <summary>
+    /// Gets the <see cref="System.Text.Json.JsonSerializerOptions"/>.
+    /// </summary>
     protected abstract JsonSerializerOptions JsonSerializerOptions { get; }
 
     /// <inheritdoc />

src/Umbraco.Infrastructure/Serialization/SystemTextWebhookJsonSerializer.cs

@@ -1,5 +1,7 @@
-using System.Text.Json;
+using System.Text.Json;
 using System.Text.Json.Serialization;
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Infrastructure.Serialization;
@@ -10,22 +12,37 @@ public sealed class SystemTextWebhookJsonSerializer : SystemTextJsonSerializerBa
     private readonly JsonSerializerOptions _jsonSerializerOptions;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="SystemTextWebhookJsonSerializer" /> class.
+    /// Initializes a new instance of the <see cref="SystemTextConfigurationEditorJsonSerializer" /> class.
     /// </summary>
+    [Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 18.")]
     public SystemTextWebhookJsonSerializer()
+        : this(
+              StaticServiceProvider.Instance.GetRequiredService<IJsonSerializerEncoderFactory>())
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextWebhookJsonSerializer" /> class.
+    /// </summary>
+    public SystemTextWebhookJsonSerializer(IJsonSerializerEncoderFactory jsonSerializerEncoderFactory)
+        : base(jsonSerializerEncoderFactory)
         => _jsonSerializerOptions = new JsonSerializerOptions()
         {
             PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+
+            Encoder = jsonSerializerEncoderFactory.CreateEncoder<SystemTextWebhookJsonSerializer>(),
+
             Converters =
             {
                 new JsonStringEnumConverter(),
                 new JsonUdiConverter(),
                 new JsonUdiRangeConverter(),
                 new JsonObjectConverter(), // Required for block editor values
-                new JsonBlockValueConverter()
+                new JsonBlockValueConverter(),
             },
             TypeInfoResolver = new WebhookJsonTypeResolver(),
         };
 
+    /// <inheritdoc/>
     protected override JsonSerializerOptions JsonSerializerOptions => _jsonSerializerOptions;
 }

tests/Umbraco.TestData/UmbracoTestDataController.cs

@@ -299,7 +299,7 @@ private IDataType GetOrCreateDataType(string name, string editorAlias)
             throw new InvalidOperationException($"No {editorAlias} editor found");
         }
 
-        var serializer = new SystemTextConfigurationEditorJsonSerializer();
+        var serializer = new SystemTextConfigurationEditorJsonSerializer(new DefaultJsonSerializerEncoderFactory());
 
         dt = new DataType(editor, serializer)
         {

tests/Umbraco.Tests.Common/Builders/DataTypeBuilder.cs

@@ -138,7 +138,7 @@ public override DataType Build()
         var creatorId = _creatorId ?? 1;
         var databaseType = _databaseType ?? ValueStorageType.Ntext;
         var sortOrder = _sortOrder ?? 0;
-        var serializer = new SystemTextConfigurationEditorJsonSerializer();
+        var serializer = new SystemTextConfigurationEditorJsonSerializer(new DefaultJsonSerializerEncoderFactory());
 
         var dataType = new DataType(editor, serializer, parentId)
         {