Skip to content

Fix JsonSerializerIsReflectionDisabled exception for .NET10 AOT scenarios #2970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 8 commits into from
Closed

Fix JsonSerializerIsReflectionDisabled exception for .NET10 AOT scenarios #2970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
34bbd2a
chore: Initial plan
Copilot Dec 3, 2025
9ff5de6
fix: Fix JsonSerializerIsReflectionDisabled issue for .NET10 AOT scen…
Copilot Dec 3, 2025
086095c
chore: Address code review feedback: improve JsonSourceGenerationOpti…
Copilot Dec 3, 2025
b892588
chore: add JsonSerializerIsReflectionEnabledByDefault
kazo0 Dec 4, 2025
c0bac11
Fix serialization tests to use source-generated JSON type info for AO…
Copilot Dec 5, 2025
7b56265
Address code review: use explicit casts instead of 'as' casts in tests
Copilot Dec 5, 2025
06da163
Fix library code to configure TypeInfoResolver for AOT compatibility
Copilot Dec 5, 2025
7d33014
Improve comment for TypeInfoResolver combine order
Copilot Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions src/Uno.Extensions.Serialization.Tests/ServiceCollectionExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,63 @@ public void AddSystemTextJsonSerializationTest()
serializer = _services.GetService<ISerializer<SimpleClass>>();
serializer.Should().NotBeNull();
}

[TestMethod]
public void StringSerializationWithRegisteredTypeInfoTest()
{
// This test validates the fix for the JsonSerializerIsReflectionDisabled issue
// where serializing strings would fail in AOT scenarios without registered type info
var context = new HostBuilderContext(new Dictionary<object, object>());
var services = new ServiceCollection();
services.AddSystemTextJsonSerialization(context);
var serviceProvider = services.BuildServiceProvider();

var serializer = serviceProvider.GetRequiredService<ISerializer>();
serializer.Should().NotBeNull();

// Test string serialization
const string testValue = "test token value";
var serialized = serializer.ToString(testValue, typeof(string));
serialized.Should().NotBeNullOrEmpty();

var deserialized = serializer.FromString(serialized, typeof(string));
deserialized.Should().Be(testValue);

// Test string[] serialization
var testArray = new[] { "value1", "value2", "value3" };
var serializedArray = serializer.ToString(testArray, typeof(string[]));
serializedArray.Should().NotBeNullOrEmpty();

var deserializedArray = serializer.FromString(serializedArray, typeof(string[]));
deserializedArray.Should().BeEquivalentTo(testArray);

// Test bool serialization
var serializedBool = serializer.ToString(true, typeof(bool));
serializedBool.Should().NotBeNullOrEmpty();

var deserializedBool = serializer.FromString(serializedBool, typeof(bool));
deserializedBool.Should().Be(true);
}

[TestMethod]
public void StringSerializerExtensionsWithRegisteredTypeInfoTest()
{
// This test validates that the SerializerExtensions.ToString<T> method works
// for string types with the registered type info (same path as KeyValueStorage)
var context = new HostBuilderContext(new Dictionary<object, object>());
var services = new ServiceCollection();
services.AddSystemTextJsonSerialization(context);
var serviceProvider = services.BuildServiceProvider();

var serializer = serviceProvider.GetRequiredService<ISerializer>();
serializer.Should().NotBeNull();

// Test using extension method (same as ApplicationDataKeyValueStorage.Serialize<string>)
const string testValue = "authentication_token_12345";
var serialized = serializer.ToString(testValue);
serialized.Should().NotBeNullOrEmpty();

var deserialized = serializer.FromString<string>(serialized);
deserialized.Should().Be(testValue);
}
}
2 changes: 2 additions & 0 deletions src/Uno.Extensions.Serialization.Tests/Uno.Extensions.Serialization.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<TargetFramework>net9.0</TargetFramework>
<IsPackable>false</IsPackable>
<Nullable>disable</Nullable>
<!-- Disable JSON reflection to test AOT-compatible serialization -->
<JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
</PropertyGroup>

<ItemGroup>
Expand Down
16 changes: 16 additions & 0 deletions src/Uno.Extensions.Serialization/CommonTypesJsonSerializerContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
using System.Text.Json.Serialization;

namespace Uno.Extensions.Serialization;

/// <summary>
/// A source-generated JSON serializer context for common types used internally by the serialization infrastructure.
/// This enables AOT-compatible serialization for types like string, string arrays, and bool
/// without requiring reflection-based JSON serialization.
/// </summary>
[JsonSourceGenerationOptions(GenerationMode = JsonSourceGenerationMode.Metadata)]
[JsonSerializable(typeof(string))]
[JsonSerializable(typeof(string[]))]
[JsonSerializable(typeof(bool))]
internal sealed partial class CommonTypesJsonSerializerContext : JsonSerializerContext
{
}
6 changes: 5 additions & 1 deletion src/Uno.Extensions.Serialization/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ public static IServiceCollection AddSystemTextJsonSerialization(
})
.AddSingleton<SystemTextJsonSerializer>()
.AddSingleton<ISerializer>(services => services.GetRequiredService<SystemTextJsonSerializer>())
.AddSingleton(typeof(ISerializer<>), typeof(SystemTextJsonGeneratedSerializer<>));
.AddSingleton(typeof(ISerializer<>), typeof(SystemTextJsonGeneratedSerializer<>))
// Register JSON type info for common types to support AOT scenarios where reflection is disabled
.AddJsonTypeInfo(CommonTypesJsonSerializerContext.Default.String)
.AddJsonTypeInfo(CommonTypesJsonSerializerContext.Default.StringArray)
.AddJsonTypeInfo(CommonTypesJsonSerializerContext.Default.Boolean);
}

/// <summary>
Expand Down
35 changes: 33 additions & 2 deletions src/Uno.Extensions.Serialization/SystemTextJsonSerializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Diagnostics.CodeAnalysis;
using System.Text.Json.Serialization.Metadata;

namespace Uno.Extensions.Serialization;

Expand All @@ -7,7 +8,7 @@ namespace Uno.Extensions.Serialization;
/// </summary>
public class SystemTextJsonSerializer : ISerializer
{
private readonly JsonSerializerOptions? _serializerOptions;
private readonly JsonSerializerOptions _serializerOptions;
private readonly IServiceProvider _services;

private ISerializerTypedInstance? TypedSerializer(Type jsonType) => _services.GetServices<ISerializerTypedInstance>().FirstOrDefault(x => x.JsonType == jsonType);
Expand All @@ -24,7 +25,37 @@ public class SystemTextJsonSerializer : ISerializer
public SystemTextJsonSerializer(IServiceProvider services, JsonSerializerOptions? serializerOptions = null)
{
_services = services;
_serializerOptions = serializerOptions;
_serializerOptions = ConfigureSerializerOptions(serializerOptions);
}

private static JsonSerializerOptions ConfigureSerializerOptions(JsonSerializerOptions? options)
{
// Create a new options instance or clone the provided one to avoid modifying shared instances
var configuredOptions = options is null
? new JsonSerializerOptions()
: new JsonSerializerOptions(options);

// Configure TypeInfoResolver to support both reflection-based and AOT scenarios.
// Use DefaultJsonTypeInfoResolver for reflection-based serialization combined with
// CommonTypesJsonSerializerContext for common types that have source-generated metadata.
if (configuredOptions.TypeInfoResolver is null)
{
configuredOptions.TypeInfoResolver = JsonTypeInfoResolver.Combine(
new DefaultJsonTypeInfoResolver(),

@jonpryor jonpryor Dec 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DefaultJsonTypeInfoResolver itself is problematic in a trimming context! From the docs: https://learn.microsoft.com/en-us/dotnet/api/system.text.json.serialization.metadata.defaultjsontypeinforesolver?view=net-10.0

Defines the default, reflection-based JSON contract resolver used by System.Text.Json.

(Emphasis added.)

You cannot reliably use DefaultJsonTypeInfoResolver in a trimmable environment.

Use of DefaultJsonTypeInfoResolver in and of itself invalidates this as a fix!

@jonpryor jonpryor Dec 5, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also note the docs for the constructor: https://learn.microsoft.com/en-us/dotnet/api/system.text.json.serialization.metadata.defaultjsontypeinforesolver.-ctor?view=net-10.0

which notes:

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public DefaultJsonTypeInfoResolver();

which is the trimmer way of saying "this requires Reflection, y'all!"

CommonTypesJsonSerializerContext.Default);
}
else
{
// User provided a resolver - place it first so it has priority.
// DefaultJsonTypeInfoResolver and CommonTypesJsonSerializerContext serve as fallbacks
// for types not handled by the user's resolver.
configuredOptions.TypeInfoResolver = JsonTypeInfoResolver.Combine(
configuredOptions.TypeInfoResolver,
new DefaultJsonTypeInfoResolver(),
CommonTypesJsonSerializerContext.Default);
}

return configuredOptions;
}

/// <summary>
Expand Down
Loading