[Blazor] Remaining model binding work (#49492)

* Mapping recursive types.
* Types with constructors
* Ignore properties via IgnoreDataMember attribute.
* Rename properties via DataMember attribute.
* Require properties to be present on the payload via DataMember attribute.
* Map enum values.
* Expose form mapping options via RazorComponentOptions:
  * Collection Size, recursion depth, max errors.
  * Culture.
  * Key buffer size.
* More error handling:
  * Convert mapping exceptions to errors.

Author: javiercn

src/Components/Endpoints/src/DependencyInjection/RazorComponentOptions.cs

@@ -0,0 +1,70 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.AspNetCore.Components.Endpoints.FormMapping;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+/// <summary>
+/// Provides options for configuring server-side rendering of Razor Components.
+/// </summary>
+public class RazorComponentOptions
+{
+    internal readonly FormDataMapperOptions _formMappingOptions = new();
+
+    /// <summary>
+    /// Gets or sets the maximum number of elements allowed in a form collection.
+    /// </summary>
+    public int MaxFormMappingCollectionSize
+    {
+        get => _formMappingOptions.MaxCollectionSize;
+        set
+        {
+            ArgumentOutOfRangeException.ThrowIfNegativeOrZero(value);
+            _formMappingOptions.MaxCollectionSize = value;
+        }
+    }
+
+    /// <summary>
+    /// Gets or sets the maximum depth allowed when recursively mapping form data.
+    /// </summary>
+    public int MaxFormMappingRecursionDepth
+    {
+        get => _formMappingOptions.MaxRecursionDepth;
+        set
+        {
+            ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(value, 1);
+            _formMappingOptions.MaxRecursionDepth = value;
+        }
+    }
+
+    /// <summary>
+    /// Gets or sets the maximum number of errors allowed when mapping form data.
+    /// </summary>
+    public int MaxFormMappingErrorCount
+    {
+        get => _formMappingOptions.MaxErrorCount;
+        set
+        {
+            _formMappingOptions.MaxErrorCount = value;
+        }
+    }
+
+    /// <summary>
+    /// Gets or sets the maximum size of the buffer used to read form data keys.
+    /// </summary>
+    public int MaxFormMappingKeySize
+    {
+        get => _formMappingOptions.MaxKeyBufferSize;
+        set => _formMappingOptions.MaxKeyBufferSize = value;
+    }
+
+    /// <summary>
+    /// Gets or sets a value that determines whether the current culture should be used when mapping form data.
+    /// </summary>
+    public bool FormMappingUseCurrentCulture
+    {
+        get => _formMappingOptions.UseCurrentCulture;
+        set => _formMappingOptions.UseCurrentCulture = value;
+    }
+}

src/Components/Endpoints/src/DependencyInjection/RazorComponentsServiceCollectionExtensions.cs

@@ -27,10 +27,12 @@ public static class RazorComponentsServiceCollectionExtensions
     /// Registers services required for server-side rendering of Razor Components.
     /// </summary>
     /// <param name="services">The service collection.</param>
-    /// <returns>A builder for configuring the Razor Components endpoints.</returns>
+    /// <returns>An <see cref="IRazorComponentsBuilder"/> that can be used to further configure the Razor component services.</returns>
     [RequiresUnreferencedCode("Razor Components does not currently support native AOT.", Url = "https://aka.ms/aspnet/nativeaot")]
     public static IRazorComponentsBuilder AddRazorComponents(this IServiceCollection services)
     {
+        ArgumentNullException.ThrowIfNull(services);
+
         // Dependencies
         services.AddAntiforgery();
 
@@ -69,13 +71,28 @@ public static IRazorComponentsBuilder AddRazorComponents(this IServiceCollection
         return new DefaultRazorComponentsBuilder(services);
     }
 
-    private sealed class DefaultRazorComponentsBuilder : IRazorComponentsBuilder
+    /// <summary>
+    /// Registers services required for server-side rendering of Razor Components.
+    /// </summary>
+    /// <param name="services">The service collection.</param>
+    /// <param name="setupAction">An <see cref="Action{RazorComponentOptions}"/> to configure the provided <see cref="RazorComponentOptions"/>.</param>
+    /// <returns>An <see cref="IRazorComponentsBuilder"/> that can be used to further configure the Razor component services.</returns>
+    public static IRazorComponentsBuilder AddRazorComponents(
+        this IServiceCollection services,
+        Action<RazorComponentOptions> setupAction
+        )
     {
-        public DefaultRazorComponentsBuilder(IServiceCollection services)
-        {
-            Services = services;
-        }
+        ArgumentNullException.ThrowIfNull(services);
+        ArgumentNullException.ThrowIfNull(setupAction);
 
-        public IServiceCollection Services { get; }
+        var builder = services.AddRazorComponents();
+        services.Configure(setupAction);
+
+        return builder;
+    }
+
+    private sealed class DefaultRazorComponentsBuilder(IServiceCollection services) : IRazorComponentsBuilder
+    {
+        public IServiceCollection Services { get; } = services;
     }
 }

src/Components/Endpoints/src/FormMapping/Converters/CollectionConverter.cs

@@ -24,6 +24,8 @@ internal abstract class CollectionConverter<TCollection> : FormDataConverter<TCo
 internal class CollectionConverter<TCollection, TCollectionPolicy, TBuffer, TElement> : CollectionConverter<TCollection>
     where TCollectionPolicy : ICollectionBufferAdapter<TCollection, TBuffer, TElement>
 {
+    private static readonly Type _elementType = typeof(TElement);
+
     // Indexes up to 100 are pre-allocated to avoid allocations for common cases.
     private static readonly string[] Indexes = new string[] {
         "[0]", "[1]", "[2]", "[3]", "[4]", "[5]", "[6]", "[7]", "[8]", "[9]",
@@ -46,6 +48,8 @@ public CollectionConverter(FormDataConverter<TElement> elementConverter)
         _elementConverter = elementConverter;
     }
 
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
     internal override bool TryRead(
         ref FormDataReader context,
         Type type,
@@ -63,7 +67,7 @@ internal override bool TryRead(
         try
         {
             context.PushPrefix("[0]");
-            succeded = _elementConverter.TryRead(ref context, typeof(TElement), options, out currentElement!, out found);
+            succeded = _elementConverter.TryRead(ref context, _elementType, options, out currentElement!, out found);
         }
         finally
         {
@@ -85,7 +89,7 @@ internal override bool TryRead(
         try
         {
             context.PushPrefix("[1]");
-            currentElementSuccess = _elementConverter.TryRead(ref context, typeof(TElement), options, out currentElement!, out foundCurrentElement);
+            currentElementSuccess = _elementConverter.TryRead(ref context, _elementType, options, out currentElement!, out foundCurrentElement);
             succeded = succeded && currentElementSuccess;
         }
         finally
@@ -113,7 +117,7 @@ internal override bool TryRead(
             try
             {
                 context.PushPrefix(prefix);
-                currentElementSuccess = _elementConverter.TryRead(ref context, typeof(TElement), options, out currentElement!, out foundCurrentElement);
+                currentElementSuccess = _elementConverter.TryRead(ref context, _elementType, options, out currentElement!, out foundCurrentElement);
                 succeded = succeded && currentElementSuccess;
             }
             finally
@@ -156,7 +160,7 @@ internal override bool TryRead(
             {
                 computedPrefix[charsWritten + 1] = ']';
                 context.PushPrefix(computedPrefix[..(charsWritten + 2)]);
-                currentElementSuccess = _elementConverter.TryRead(ref context, typeof(TElement), options, out currentElement!, out foundCurrentElement);
+                currentElementSuccess = _elementConverter.TryRead(ref context, _elementType, options, out currentElement!, out foundCurrentElement);
                 succeded = succeded && currentElementSuccess;
             }
             finally

src/Components/Endpoints/src/FormMapping/Converters/CompiledComplexTypeConverter.cs

@@ -1,12 +1,29 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics.CodeAnalysis;
+
 namespace Microsoft.AspNetCore.Components.Endpoints.FormMapping;
 
 internal class CompiledComplexTypeConverter<T>(CompiledComplexTypeConverter<T>.ConverterDelegate body) : FormDataConverter<T>
 {
     public delegate bool ConverterDelegate(ref FormDataReader reader, Type type, FormDataMapperOptions options, out T? result, out bool found);
 
-    internal override bool TryRead(ref FormDataReader context, Type type, FormDataMapperOptions options, out T? result, out bool found) =>
-        body(ref context, type, options, out result, out found);
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
+    internal override bool TryRead(ref FormDataReader context, Type type, FormDataMapperOptions options, out T? result, out bool found)
+    {
+        result = default;
+        found = false;
+
+        try
+        {
+            return body(ref context, type, options, out result, out found);
+        }
+        catch (Exception ex)
+        {
+            context.AddMappingError(ex, null);
+            return false;
+        }
+    }
 }

src/Components/Endpoints/src/FormMapping/Converters/DictionaryConverter.cs

@@ -16,14 +16,16 @@ internal sealed class DictionaryConverter<TDictionary, TDictionaryPolicy, TBuffe
     where TDictionaryPolicy : IDictionaryBufferAdapter<TDictionary, TBuffer, TKey, TValue>
 {
     private readonly FormDataConverter<TValue> _valueConverter;
+    private static readonly Type _elementType = typeof(TValue);
 
     public DictionaryConverter(FormDataConverter<TValue> elementConverter)
     {
         ArgumentNullException.ThrowIfNull(elementConverter);
-
         _valueConverter = elementConverter;
     }
 
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
     internal override bool TryRead(
         ref FormDataReader context,
         Type type,
@@ -57,7 +59,7 @@ internal override bool TryRead(
         foreach (var key in keys)
         {
             context.PushPrefix(key.Span);
-            currentElementSuccess = _valueConverter.TryRead(ref context, typeof(TValue), options, out currentValue!, out foundCurrentValue);
+            currentElementSuccess = _valueConverter.TryRead(ref context, _elementType, options, out currentValue!, out foundCurrentValue);
             succeded &= currentElementSuccess;
             context.PopPrefix(key.Span);
 

src/Components/Endpoints/src/FormMapping/Converters/EnumConverter.cs

@@ -0,0 +1,33 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
+
+namespace Microsoft.AspNetCore.Components.Endpoints.FormMapping;
+
+internal class EnumConverter<TEnum> : FormDataConverter<TEnum> where TEnum : struct, Enum
+{
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
+    internal override bool TryRead(ref FormDataReader reader, Type type, FormDataMapperOptions options, out TEnum result, out bool found)
+    {
+        found = reader.TryGetValue(out var value);
+        if (!found)
+        {
+            result = default;
+            return true;
+        }
+        if (Enum.TryParse(value, ignoreCase: true, out result))
+        {
+            return true;
+        }
+        else
+        {
+            var segment = reader.GetLastPrefixSegment();
+            reader.AddMappingError(FormattableStringFactory.Create(FormDataResources.EnumMappingError, value, segment), value);
+            result = default;
+            return false;
+        }
+    }
+}

src/Components/Endpoints/src/FormMapping/Converters/NullableConverter.cs

@@ -1,6 +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.Diagnostics.CodeAnalysis;
+
 namespace Microsoft.AspNetCore.Components.Endpoints.FormMapping;
 
 internal sealed class NullableConverter<T> : FormDataConverter<T?> where T : struct
@@ -12,6 +14,8 @@ public NullableConverter(FormDataConverter<T> nonNullableConverter)
         _nonNullableConverter = nonNullableConverter;
     }
 
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
     internal override bool TryRead(ref FormDataReader context, Type type, FormDataMapperOptions options, out T? result, out bool found)
     {
         if (!(_nonNullableConverter.TryRead(ref context, type, options, out var innerResult, out found) && found))

src/Components/Endpoints/src/FormMapping/Converters/ParsableConverter.cs

@@ -1,12 +1,15 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 
 namespace Microsoft.AspNetCore.Components.Endpoints.FormMapping;
 
 internal sealed class ParsableConverter<T> : FormDataConverter<T>, ISingleValueConverter where T : IParsable<T>
 {
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
     internal override bool TryRead(ref FormDataReader reader, Type type, FormDataMapperOptions options, out T? result, out bool found)
     {
         found = reader.TryGetValue(out var value);

src/Components/Endpoints/src/FormMapping/Factories/CollectionConverterFactory.cs

@@ -14,14 +14,12 @@ internal class CollectionConverterFactory : IFormDataConverterFactory
     [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
     public bool CanConvert(Type type, FormDataMapperOptions options)
     {
-        var enumerable = ClosedGenericMatcher.ExtractGenericInterface(type, typeof(IEnumerable<>));
-        if (enumerable == null && !(type.IsArray && type.GetArrayRank() == 1))
+        var element = ResolveElementType(type);
+        if (element == null)
         {
             return false;
         }
 
-        var element = enumerable != null ? enumerable.GetGenericArguments()[0] : type.GetElementType()!;
-
         if (Activator.CreateInstance(typeof(TypedCollectionConverterFactory<,>)
             .MakeGenericType(type, element!)) is not IFormDataConverterFactory factory)
         {
@@ -31,6 +29,19 @@ public bool CanConvert(Type type, FormDataMapperOptions options)
         return factory.CanConvert(type, options);
     }
 
+    [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
+    [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
+    public static Type? ResolveElementType(Type type)
+    {
+        var enumerable = ClosedGenericMatcher.ExtractGenericInterface(type, typeof(IEnumerable<>));
+        if (enumerable == null && !(type.IsArray && type.GetArrayRank() == 1))
+        {
+            return null;
+        }
+
+        return enumerable != null ? enumerable.GetGenericArguments()[0] : type.GetElementType()!;
+    }
+
     [RequiresDynamicCode(FormMappingHelpers.RequiresDynamicCodeMessage)]
     [RequiresUnreferencedCode(FormMappingHelpers.RequiresUnreferencedCodeMessage)]
     public FormDataConverter CreateConverter(Type type, FormDataMapperOptions options)

src/Components/Endpoints/src/FormMapping/Factories/Collections/TypedCollectionConverterFactory.cs

@@ -26,9 +26,7 @@ internal sealed class TypedCollectionConverterFactory<TCollection, TElement> : T
     public override bool CanConvert(Type _, FormDataMapperOptions options)
     {
         // Resolve the element type converter
-        var elementTypeConverter = options.ResolveConverter<TElement>();
-
-        if (elementTypeConverter == null)
+        if (!options.CanConvert(typeof(TElement)))
         {
             return false;
         }