Revert configuration-based approach

Author: MackinnonBuck

src/Components/Components/src/Infrastructure/ComponentStatePersistenceManager.cs

@@ -1,10 +1,8 @@
 // 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 Microsoft.AspNetCore.Components.RenderTree;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Components.Infrastructure;
 
@@ -23,25 +21,8 @@ public class ComponentStatePersistenceManager
     /// Initializes a new instance of <see cref="ComponentStatePersistenceManager"/>.
     /// </summary>
     public ComponentStatePersistenceManager(ILogger<ComponentStatePersistenceManager> logger)
-        : this(DefaultJsonSerializerOptions.Instance, logger)
     {
-    }
-
-    /// <summary>
-    /// Initializes a new instance of <see cref="ComponentStatePersistenceManager"/>.
-    /// </summary>
-    public ComponentStatePersistenceManager(
-        IOptions<JsonOptions> jsonOptions,
-        ILogger<ComponentStatePersistenceManager> logger)
-        : this(jsonOptions.Value.SerializerOptions, logger)
-    {
-    }
-
-    private ComponentStatePersistenceManager(
-        JsonSerializerOptions jsonSerializerOptions,
-        ILogger<ComponentStatePersistenceManager> logger)
-    {
-        State = new PersistentComponentState(jsonSerializerOptions, _currentState, _registeredCallbacks);
+        State = new PersistentComponentState(_currentState, _registeredCallbacks);
         _logger = logger;
     }
 

src/Components/Components/src/JsonOptions.cs

@@ -15,7 +15,8 @@
 
   <ItemGroup>
     <Compile Include="$(ComponentsSharedSourceRoot)src\ArrayBuilder.cs" LinkBase="RenderTree" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\DefaultJsonSerializerOptions.cs" />
+    <Compile Include="$(ComponentsSharedSourceRoot)src\JsonSerializerOptionsProvider.cs" />
+    <Compile Include="$(ComponentsSharedSourceRoot)src\JsonSerializerOptionsCache.cs" />
     <Compile Include="$(ComponentsSharedSourceRoot)src\HotReloadManager.cs" LinkBase="HotReload" />
     <Compile Include="$(SharedSourceRoot)LinkerFlags.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)QueryStringEnumerable.cs" LinkBase="Shared" />

src/Components/Components/src/JsonServiceCollectionExtensions.cs

@@ -3,6 +3,7 @@
 
 using System.Diagnostics.CodeAnalysis;
 using System.Text.Json;
+using System.Text.Json.Serialization.Metadata;
 using static Microsoft.AspNetCore.Internal.LinkerFlags;
 
 namespace Microsoft.AspNetCore.Components;
@@ -14,15 +15,14 @@ public class PersistentComponentState
 {
     private IDictionary<string, byte[]>? _existingState;
     private readonly IDictionary<string, byte[]> _currentState;
-    private readonly JsonSerializerOptions _jsonSerializerOptions;
+
     private readonly List<PersistComponentStateRegistration> _registeredCallbacks;
+    private readonly JsonSerializerOptionsCache _jsonSerializerOptionsCache = new(JsonSerializerOptionsProvider.Options);
 
     internal PersistentComponentState(
-        JsonSerializerOptions jsonSerializerOptions,
-        IDictionary<string, byte[]> currentState,
+        IDictionary<string , byte[]> currentState,
         List<PersistComponentStateRegistration> pauseCallbacks)
     {
-        _jsonSerializerOptions = jsonSerializerOptions;
         _currentState = currentState;
         _registeredCallbacks = pauseCallbacks;
     }
@@ -86,7 +86,7 @@ public PersistingComponentStateSubscription RegisterOnPersisting(Func<Task> call
             throw new ArgumentException($"There is already a persisted object under the same key '{key}'");
         }
 
-        _currentState.Add(key, JsonSerializer.SerializeToUtf8Bytes(instance, _jsonSerializerOptions));
+        _currentState.Add(key, JsonSerializer.SerializeToUtf8Bytes(instance, JsonSerializerOptionsProvider.Options));
     }
 
     /// <summary>
@@ -106,7 +106,34 @@ public PersistingComponentStateSubscription RegisterOnPersisting(Func<Task> call
         if (TryTake(key, out var data))
         {
             var reader = new Utf8JsonReader(data);
-            instance = JsonSerializer.Deserialize<TValue>(ref reader, _jsonSerializerOptions)!;
+            instance = JsonSerializer.Deserialize<TValue>(ref reader, JsonSerializerOptionsProvider.Options)!;
+            return true;
+        }
+        else
+        {
+            instance = default;
+            return false;
+        }
+    }
+
+    /// <summary>
+    /// Tries to retrieve the persisted state as JSON with the given <paramref name="key"/> and deserializes it into an
+    /// instance of type <typeparamref name="TValue"/>.
+    /// </summary>
+    /// <param name="key">The key used to persist the instance.</param>
+    /// <param name="resolver">The <see cref="IJsonTypeInfoResolver"/> to use when deserializing from JSON.</param>
+    /// <param name="instance">The persisted instance.</param>
+    /// <returns><c>true</c> if the state was found; <c>false</c> otherwise.</returns>
+    [RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")]
+    public bool TryTakeFromJson<TValue>(string key, IJsonTypeInfoResolver resolver, [MaybeNullWhen(false)] out TValue? instance)
+    {
+        ArgumentNullException.ThrowIfNull(key);
+
+        if (TryTake(key, out var data))
+        {
+            var reader = new Utf8JsonReader(data);
+            var options = _jsonSerializerOptionsCache.GetOrAdd(resolver);
+            instance = JsonSerializer.Deserialize<TValue>(ref reader, options)!;
             return true;
         }
         else

src/Components/Components/src/Microsoft.AspNetCore.Components.csproj

@@ -1,7 +1,2 @@
 #nullable enable
-Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.ComponentStatePersistenceManager(Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Components.JsonOptions!>! jsonOptions, Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager!>! logger) -> void
-Microsoft.AspNetCore.Components.JsonOptions
-Microsoft.AspNetCore.Components.JsonOptions.JsonOptions() -> void
-Microsoft.AspNetCore.Components.JsonOptions.SerializerOptions.get -> System.Text.Json.JsonSerializerOptions!
-Microsoft.Extensions.DependencyInjection.JsonServiceCollectionExtensions
-static Microsoft.Extensions.DependencyInjection.JsonServiceCollectionExtensions.ConfigureComponentsJsonOptions(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<Microsoft.AspNetCore.Components.JsonOptions!>! configureOptions) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+Microsoft.AspNetCore.Components.PersistentComponentState.TryTakeFromJson<TValue>(string! key, System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver! resolver, out TValue? instance) -> bool

src/Components/Components/src/PersistentComponentState.cs

@@ -11,7 +11,7 @@ public class ComponentApplicationStateTest
     public void InitializeExistingState_SetupsState()
     {
         // Arrange
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
+        var applicationState = new PersistentComponentState(new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
         var existingState = new Dictionary<string, byte[]>
         {
             ["MyState"] = JsonSerializer.SerializeToUtf8Bytes(new byte[] { 1, 2, 3, 4 })
@@ -29,7 +29,7 @@ public void InitializeExistingState_SetupsState()
     public void InitializeExistingState_ThrowsIfAlreadyInitialized()
     {
         // Arrange
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
+        var applicationState = new PersistentComponentState(new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
         var existingState = new Dictionary<string, byte[]>
         {
             ["MyState"] = new byte[] { 1, 2, 3, 4 }
@@ -45,7 +45,7 @@ public void InitializeExistingState_ThrowsIfAlreadyInitialized()
     public void TryRetrieveState_ReturnsStateWhenItExists()
     {
         // Arrange
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
+        var applicationState = new PersistentComponentState(new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
         var existingState = new Dictionary<string, byte[]>
         {
             ["MyState"] = JsonSerializer.SerializeToUtf8Bytes(new byte[] { 1, 2, 3, 4 })
@@ -65,7 +65,7 @@ public void PersistState_SavesDataToTheStoreAsync()
     {
         // Arrange
         var currentState = new Dictionary<string, byte[]>();
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, currentState, new List<PersistComponentStateRegistration>())
+        var applicationState = new PersistentComponentState(currentState, new List<PersistComponentStateRegistration>())
         {
             PersistingState = true
         };
@@ -84,7 +84,7 @@ public void PersistState_ThrowsForDuplicateKeys()
     {
         // Arrange
         var currentState = new Dictionary<string, byte[]>();
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, currentState, new List<PersistComponentStateRegistration>())
+        var applicationState = new PersistentComponentState(currentState, new List<PersistComponentStateRegistration>())
         {
             PersistingState = true
         };
@@ -101,7 +101,7 @@ public void PersistAsJson_SerializesTheDataToJsonAsync()
     {
         // Arrange
         var currentState = new Dictionary<string, byte[]>();
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, currentState, new List<PersistComponentStateRegistration>())
+        var applicationState = new PersistentComponentState(currentState, new List<PersistComponentStateRegistration>())
         {
             PersistingState = true
         };
@@ -120,7 +120,7 @@ public void PersistAsJson_NullValueAsync()
     {
         // Arrange
         var currentState = new Dictionary<string, byte[]>();
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, currentState, new List<PersistComponentStateRegistration>())
+        var applicationState = new PersistentComponentState(currentState, new List<PersistComponentStateRegistration>())
         {
             PersistingState = true
         };
@@ -140,7 +140,7 @@ public void TryRetrieveFromJson_DeserializesTheDataFromJson()
         var myState = new byte[] { 1, 2, 3, 4 };
         var serialized = JsonSerializer.SerializeToUtf8Bytes(myState);
         var existingState = new Dictionary<string, byte[]>() { ["MyState"] = serialized };
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
+        var applicationState = new PersistentComponentState(new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
 
         applicationState.InitializeExistingState(existingState);
 
@@ -158,7 +158,7 @@ public void TryRetrieveFromJson_NullValue()
         // Arrange
         var serialized = JsonSerializer.SerializeToUtf8Bytes<byte[]>(null);
         var existingState = new Dictionary<string, byte[]>() { ["MyState"] = serialized };
-        var applicationState = new PersistentComponentState(DefaultJsonSerializerOptions.Instance, new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
+        var applicationState = new PersistentComponentState(new Dictionary<string, byte[]>(), new List<PersistComponentStateRegistration>());
 
         applicationState.InitializeExistingState(existingState);
 

src/Components/Components/src/PublicAPI.Unshipped.txt

@@ -40,7 +40,6 @@ internal partial class RemoteJSRuntime : JSRuntime
     public RemoteJSRuntime(
         IOptions<CircuitOptions> circuitOptions,
         IOptions<HubOptions<ComponentHub>> componentHubOptions,
-        IOptions<JsonOptions> jsonOptions,
         ILogger<RemoteJSRuntime> logger)
     {
         _options = circuitOptions.Value;
@@ -49,13 +48,6 @@ public RemoteJSRuntime(
         DefaultAsyncTimeout = _options.JSInteropDefaultCallTimeout;
         ElementReferenceContext = new WebElementReferenceContext(this);
         JsonSerializerOptions.Converters.Add(new ElementReferenceJsonConverter(ElementReferenceContext));
-
-        JsonSerializerOptions.TypeInfoResolverChain.Add(JsonConverterFactoryTypeInfoResolver.Instance);
-
-        if (jsonOptions.Value.SerializerOptions is { TypeInfoResolver: { } typeInfoResolver })
-        {
-            JsonSerializerOptions.TypeInfoResolverChain.Add(typeInfoResolver);
-        }
     }
 
     public JsonSerializerOptions ReadJsonSerializerOptions() => JsonSerializerOptions;

src/Components/Components/test/Lifetime/ComponentApplicationStateTest.cs

@@ -11,7 +11,6 @@
 using Microsoft.AspNetCore.Components.Server.Circuits;
 using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage;
 using Microsoft.AspNetCore.Components.Web;
-using Microsoft.AspNetCore.Components.Web.Infrastructure;
 using Microsoft.AspNetCore.SignalR.Protocol;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Options;
@@ -88,10 +87,6 @@ public static IServerSideBlazorBuilder AddServerSideBlazor(this IServiceCollecti
         services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<CircuitOptions>, CircuitOptionsJSInteropDetailedErrorsConfiguration>());
         services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<CircuitOptions>, CircuitOptionsJavaScriptInitializersConfiguration>());
 
-        // Configure JSON serializer options
-        services.ConfigureComponentsWebJsonOptions();
-        services.ConfigureDefaultAntiforgeryJsonOptions();
-
         if (configure != null)
         {
             services.Configure(configure);

src/Components/Server/src/Circuits/RemoteJSRuntime.cs

@@ -59,15 +59,11 @@
     <Compile Include="$(ComponentsSharedSourceRoot)src\RootComponentOperationBatch.cs" />
     <Compile Include="$(ComponentsSharedSourceRoot)src\RootComponentOperationType.cs" />
     <Compile Include="$(ComponentsSharedSourceRoot)src\RootComponentTypeCache.cs" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\DefaultJsonSerializerOptions.cs" />
     <Compile Include="$(ComponentsSharedSourceRoot)src\DefaultAntiforgeryStateProvider.cs" LinkBase="Forms" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\DefaultAntiforgeryJsonOptionsServiceCollectionExtensions.cs" LinkBase="DependencyInjection" />
     <Compile Include="$(ComponentsSharedSourceRoot)src\WebRendererId.cs" />
 
-    <Compile Include="$(ComponentsSharedSourceRoot)src\JsonSerialization\JsonConverterFactoryTypeInfoResolver.cs" LinkBase="JsonSerialization" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\JsonSerialization\JSRuntimeSerializerContext.cs" LinkBase="JsonSerialization" />
-
     <Compile Include="..\..\Shared\src\BrowserNavigationManagerInterop.cs" />
+    <Compile Include="..\..\Shared\src\JsonSerializerOptionsProvider.cs" />
     <Compile Include="..\..\Shared\src\WebEventData\*.cs" LinkBase="WebEventData" />
 
     <Compile Include="$(RepoRoot)src\SignalR\common\Shared\BinaryMessageFormatter.cs" LinkBase="BlazorPack" />

src/Components/Server/src/DependencyInjection/ComponentServiceCollectionExtensions.cs

@@ -16,7 +16,6 @@ public abstract class ProtectedBrowserStorage
     private readonly string _storeName;
     private readonly IJSRuntime _jsRuntime;
     private readonly IDataProtectionProvider _dataProtectionProvider;
-    private readonly JsonSerializerOptions _jsonSerializerOptions;
     private readonly ConcurrentDictionary<string, IDataProtector> _cachedDataProtectorsByPurpose
         = new ConcurrentDictionary<string, IDataProtector>(StringComparer.Ordinal);
 
@@ -26,12 +25,7 @@ private readonly ConcurrentDictionary<string, IDataProtector> _cachedDataProtect
     /// <param name="storeName">The name of the store in which the data should be stored.</param>
     /// <param name="jsRuntime">The <see cref="IJSRuntime"/>.</param>
     /// <param name="dataProtectionProvider">The <see cref="IDataProtectionProvider"/>.</param>
-    /// <param name="jsonSerializerOptions">The <see cref="JsonSerializerOptions"/>.</param>
-    private protected ProtectedBrowserStorage(
-        string storeName,
-        IJSRuntime jsRuntime,
-        IDataProtectionProvider dataProtectionProvider,
-        JsonSerializerOptions? jsonSerializerOptions)
+    private protected ProtectedBrowserStorage(string storeName, IJSRuntime jsRuntime, IDataProtectionProvider dataProtectionProvider)
     {
         // Performing data protection on the client would give users a false sense of security, so we'll prevent this.
         if (OperatingSystem.IsBrowser())
@@ -44,7 +38,6 @@ private protected ProtectedBrowserStorage(
         _storeName = storeName;
         _jsRuntime = jsRuntime ?? throw new ArgumentNullException(nameof(jsRuntime));
         _dataProtectionProvider = dataProtectionProvider ?? throw new ArgumentNullException(nameof(dataProtectionProvider));
-        _jsonSerializerOptions = jsonSerializerOptions ?? DefaultJsonSerializerOptions.Instance;
     }
 
     /// <summary>
@@ -129,7 +122,7 @@ public ValueTask DeleteAsync(string key)
 
     private string Protect(string purpose, object value)
     {
-        var json = JsonSerializer.Serialize(value, options: _jsonSerializerOptions);
+        var json = JsonSerializer.Serialize(value, options: JsonSerializerOptionsProvider.Options);
         var protector = GetOrCreateCachedProtector(purpose);
 
         return protector.Protect(json);
@@ -140,7 +133,7 @@ private TValue Unprotect<TValue>(string purpose, string protectedJson)
         var protector = GetOrCreateCachedProtector(purpose);
         var json = protector.Unprotect(protectedJson);
 
-        return JsonSerializer.Deserialize<TValue>(json, options: _jsonSerializerOptions)!;
+        return JsonSerializer.Deserialize<TValue>(json, options: JsonSerializerOptionsProvider.Options)!;
     }
 
     private ValueTask SetProtectedJsonAsync(string key, string protectedJson)