Add DateOnly and TimeOnly to MVC Model Binding

src/Mvc/Mvc.Core/src/Infrastructure/MvcCoreMvcOptionsSetup.cs

@@ -74,6 +74,8 @@ public void Configure(MvcOptions options)
         options.ModelBinderProviders.Add(new ArrayModelBinderProvider());
         options.ModelBinderProviders.Add(new CollectionModelBinderProvider());
         options.ModelBinderProviders.Add(new ComplexObjectModelBinderProvider());
+        options.ModelBinderProviders.Add(new DateOnlyModelBinderProvider());
+        options.ModelBinderProviders.Add(new TimeOnlyModelBinderProvider());
 
         // Set up filters
         options.Filters.Add(new UnsupportedContentTypeFilter());

src/Mvc/Mvc.Core/src/ModelBinding/Binders/DateOnlyModelBinder.cs

@@ -0,0 +1,104 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#nullable enable
+
+using System.Globalization;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;
+
+/// <summary>
+/// An <see cref="IModelBinder"/> for <see cref="DateOnly"/> and nullable <see cref="DateOnly"/> models.
+/// </summary>
+public class DateOnlyModelBinder : IModelBinder
+{
+    private readonly DateTimeStyles _supportedStyles;
+    private readonly ILogger _logger;
+
+    /// <summary>
+    /// Initializes a new instance of <see cref="DateOnlyModelBinder"/>.
+    /// </summary>
+    /// <param name="supportedStyles">The <see cref="DateTimeStyles"/>.</param>
+    /// <param name="loggerFactory">The <see cref="ILoggerFactory"/>.</param>
+    public DateOnlyModelBinder(DateTimeStyles supportedStyles, ILoggerFactory loggerFactory)
+    {
+        if (loggerFactory == null)
+        {
+            throw new ArgumentNullException(nameof(loggerFactory));
+        }
+
+        _supportedStyles = supportedStyles;
+        _logger = loggerFactory.CreateLogger<DateOnlyModelBinder>();
+    }
+
+    /// <inheritdoc />
+    public Task BindModelAsync(ModelBindingContext bindingContext)
+    {
+        if (bindingContext == null)
+        {
+            throw new ArgumentNullException(nameof(bindingContext));
+        }
+
+        _logger.AttemptingToBindModel(bindingContext);
+
+        var modelName = bindingContext.ModelName;
+        var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);
+        if (valueProviderResult == ValueProviderResult.None)
+        {
+            _logger.FoundNoValueInRequest(bindingContext);
+
+            // no entry
+            _logger.DoneAttemptingToBindModel(bindingContext);
+            return Task.CompletedTask;
+        }
+
+        var modelState = bindingContext.ModelState;
+        modelState.SetModelValue(modelName, valueProviderResult);
+
+        var metadata = bindingContext.ModelMetadata;
+        var type = metadata.UnderlyingOrModelType;
+        try
+        {
+            var value = valueProviderResult.FirstValue;
+
+            object? model;
+            if (string.IsNullOrWhiteSpace(value))
+            {
+                // Parse() method trims the value (with common DateTimeSyles) then throws if the result is empty.
+                model = null;
+            }
+            else if (type == typeof(DateOnly))
+            {
+                model = DateOnly.Parse(value, valueProviderResult.Culture, _supportedStyles);
+            }
+            else
+            {
+                throw new NotSupportedException();
+            }
+
+            // When converting value, a null model may indicate a failed conversion for an otherwise required
+            // model (can't set a ValueType to null). This detects if a null model value is acceptable given the
+            // current bindingContext. If not, an error is logged.
+            if (model == null && !metadata.IsReferenceOrNullableType)
+            {
+                modelState.TryAddModelError(
+                    modelName,
+                    metadata.ModelBindingMessageProvider.ValueMustNotBeNullAccessor(
+                        valueProviderResult.ToString()));
+            }
+            else
+            {
+                bindingContext.Result = ModelBindingResult.Success(model);
+            }
+        }
+        catch (Exception exception)
+        {
+            // Conversion failed.
+            modelState.TryAddModelError(modelName, exception, metadata);
+        }
+
+        _logger.DoneAttemptingToBindModel(bindingContext);
+        return Task.CompletedTask;
+    }
+}

src/Mvc/Mvc.Core/src/ModelBinding/Binders/DateOnlyModelBinderProvider.cs

@@ -0,0 +1,36 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#nullable enable
+
+using System.Globalization;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;
+
+/// <summary>
+/// An <see cref="IModelBinderProvider"/> for binding <see cref="DateOnly" /> and nullable <see cref="DateOnly"/> models.
+/// </summary>
+public class DateOnlyModelBinderProvider : IModelBinderProvider
+{
+    internal const DateTimeStyles SupportedStyles = DateTimeStyles.AllowWhiteSpaces;
+
+    /// <inheritdoc />
+    public IModelBinder? GetBinder(ModelBinderProviderContext context)
+    {
+        if (context == null)
+        {
+            throw new ArgumentNullException(nameof(context));
+        }
+
+        var modelType = context.Metadata.UnderlyingOrModelType;
+        if (modelType == typeof(DateOnly))
+        {
+            var loggerFactory = context.Services.GetRequiredService<ILoggerFactory>();
+            return new DateOnlyModelBinder(SupportedStyles, loggerFactory);
+        }
+
+        return null;
+    }
+}

src/Mvc/Mvc.Core/src/ModelBinding/Binders/TimeOnlyModelBinder.cs

@@ -0,0 +1,104 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#nullable enable
+
+using System.Globalization;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;
+
+/// <summary>
+/// An <see cref="IModelBinder"/> for <see cref="TimeOnly"/> and nullable <see cref="TimeOnly"/> models.
+/// </summary>
+public class TimeOnlyModelBinder : IModelBinder
+{
+    private readonly DateTimeStyles _supportedStyles;
+    private readonly ILogger _logger;
+
+    /// <summary>
+    /// Initializes a new instance of <see cref="TimeOnlyModelBinder"/>.
+    /// </summary>
+    /// <param name="supportedStyles">The <see cref="DateTimeStyles"/>.</param>
+    /// <param name="loggerFactory">The <see cref="ILoggerFactory"/>.</param>
+    public TimeOnlyModelBinder(DateTimeStyles supportedStyles, ILoggerFactory loggerFactory)
+    {
+        if (loggerFactory == null)
+        {
+            throw new ArgumentNullException(nameof(loggerFactory));
+        }
+
+        _supportedStyles = supportedStyles;
+        _logger = loggerFactory.CreateLogger<TimeOnlyModelBinder>();
+    }
+
+    /// <inheritdoc />
+    public Task BindModelAsync(ModelBindingContext bindingContext)
+    {
+        if (bindingContext == null)
+        {
+            throw new ArgumentNullException(nameof(bindingContext));
+        }
+
+        _logger.AttemptingToBindModel(bindingContext);
+
+        var modelName = bindingContext.ModelName;
+        var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);
+        if (valueProviderResult == ValueProviderResult.None)
+        {
+            _logger.FoundNoValueInRequest(bindingContext);
+
+            // no entry
+            _logger.DoneAttemptingToBindModel(bindingContext);
+            return Task.CompletedTask;
+        }
+
+        var modelState = bindingContext.ModelState;
+        modelState.SetModelValue(modelName, valueProviderResult);
+
+        var metadata = bindingContext.ModelMetadata;
+        var type = metadata.UnderlyingOrModelType;
+        try
+        {
+            var value = valueProviderResult.FirstValue;
+
+            object? model;
+            if (string.IsNullOrWhiteSpace(value))
+            {
+                // Parse() method trims the value (with common DateTimeSyles) then throws if the result is empty.
+                model = null;
+            }
+            else if (type == typeof(TimeOnly))
+            {
+                model = TimeOnly.Parse(value, valueProviderResult.Culture, _supportedStyles);
+            }
+            else
+            {
+                throw new NotSupportedException();
+            }
+
+            // When converting value, a null model may indicate a failed conversion for an otherwise required
+            // model (can't set a ValueType to null). This detects if a null model value is acceptable given the
+            // current bindingContext. If not, an error is logged.
+            if (model == null && !metadata.IsReferenceOrNullableType)
+            {
+                modelState.TryAddModelError(
+                    modelName,
+                    metadata.ModelBindingMessageProvider.ValueMustNotBeNullAccessor(
+                        valueProviderResult.ToString()));
+            }
+            else
+            {
+                bindingContext.Result = ModelBindingResult.Success(model);
+            }
+        }
+        catch (Exception exception)
+        {
+            // Conversion failed.
+            modelState.TryAddModelError(modelName, exception, metadata);
+        }
+
+        _logger.DoneAttemptingToBindModel(bindingContext);
+        return Task.CompletedTask;
+    }
+}

src/Mvc/Mvc.Core/src/ModelBinding/Binders/TimeOnlyModelBinderProvider.cs

@@ -0,0 +1,36 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#nullable enable
+
+using System.Globalization;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;
+
+/// <summary>
+/// An <see cref="IModelBinderProvider"/> for binding <see cref="TimeOnly"/> and nullable <see cref="TimeOnly"/> models.
+/// </summary>
+public class TimeOnlyModelBinderProvider : IModelBinderProvider
+{
+    internal const DateTimeStyles SupportedStyles = DateTimeStyles.AllowWhiteSpaces;
+
+    /// <inheritdoc />
+    public IModelBinder? GetBinder(ModelBinderProviderContext context)
+    {
+        if (context == null)
+        {
+            throw new ArgumentNullException(nameof(context));
+        }
+
+        var modelType = context.Metadata.UnderlyingOrModelType;
+        if (modelType == typeof(TimeOnly))
+        {
+            var loggerFactory = context.Services.GetRequiredService<ILoggerFactory>();
+            return new TimeOnlyModelBinder(SupportedStyles, loggerFactory);
+        }
+
+        return null;
+    }
+}

src/Mvc/Mvc.Core/src/PublicAPI.Shipped.txt

@@ -1139,6 +1139,12 @@ Microsoft.AspNetCore.Mvc.ModelBinding.Binders.ComplexObjectModelBinderProvider.G
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.ComplexTypeModelBinder
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.ComplexTypeModelBinderProvider
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.ComplexTypeModelBinderProvider.ComplexTypeModelBinderProvider() -> void
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateOnlyModelBinder
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateOnlyModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext! bindingContext) -> System.Threading.Tasks.Task!
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateOnlyModelBinder.DateOnlyModelBinder(System.Globalization.DateTimeStyles supportedStyles, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory) -> void
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateOnlyModelBinderProvider
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateOnlyModelBinderProvider.DateOnlyModelBinderProvider() -> void
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateOnlyModelBinderProvider.GetBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext! context) -> Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder?
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateTimeModelBinder
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateTimeModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext! bindingContext) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DateTimeModelBinder.DateTimeModelBinder(System.Globalization.DateTimeStyles supportedStyles, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory) -> void
@@ -1206,6 +1212,12 @@ Microsoft.AspNetCore.Mvc.ModelBinding.Binders.SimpleTypeModelBinder.SimpleTypeMo
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.SimpleTypeModelBinderProvider
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.SimpleTypeModelBinderProvider.GetBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext! context) -> Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder?
 Microsoft.AspNetCore.Mvc.ModelBinding.Binders.SimpleTypeModelBinderProvider.SimpleTypeModelBinderProvider() -> void
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.TimeOnlyModelBinder
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.TimeOnlyModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext! bindingContext) -> System.Threading.Tasks.Task!
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.TimeOnlyModelBinder.TimeOnlyModelBinder(System.Globalization.DateTimeStyles supportedStyles, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory) -> void
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.TimeOnlyModelBinderProvider
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.TimeOnlyModelBinderProvider.TimeOnlyModelBinderProvider() -> void
+Microsoft.AspNetCore.Mvc.ModelBinding.Binders.TimeOnlyModelBinderProvider.GetBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext! context) -> Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder?
 Microsoft.AspNetCore.Mvc.ModelBinding.BindingBehavior
 Microsoft.AspNetCore.Mvc.ModelBinding.BindingBehavior.Never = 1 -> Microsoft.AspNetCore.Mvc.ModelBinding.BindingBehavior
 Microsoft.AspNetCore.Mvc.ModelBinding.BindingBehavior.Optional = 0 -> Microsoft.AspNetCore.Mvc.ModelBinding.BindingBehavior

src/Mvc/Mvc.Core/test/ModelBinding/Binders/DateOnlyModelBinderProviderTest.cs

@@ -0,0 +1,54 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;
+
+public class DateOnlyModelBinderProviderTest
+{
+    private readonly DateOnlyModelBinderProvider _provider = new DateOnlyModelBinderProvider();
+
+    [Theory]
+    [InlineData(typeof(string))]
+    [InlineData(typeof(DateTimeOffset))]
+    [InlineData(typeof(DateTimeOffset?))]
+    [InlineData(typeof(DateTime))]
+    [InlineData(typeof(DateTime?))]
+    [InlineData(typeof(TimeSpan))]
+    public void Create_ForNonDateOnly_ReturnsNull(Type modelType)
+    {
+        // Arrange
+        var context = new TestModelBinderProviderContext(modelType);
+
+        // Act
+        var result = _provider.GetBinder(context);
+
+        // Assert
+        Assert.Null(result);
+    }
+
+    [Fact]
+    public void Create_ForDateOnly_ReturnsBinder()
+    {
+        // Arrange
+        var context = new TestModelBinderProviderContext(typeof(DateOnly));
+
+        // Act
+        var result = _provider.GetBinder(context);
+
+        // Assert
+        Assert.IsType<DateOnlyModelBinder>(result);
+    }
+
+    [Fact]
+    public void Create_ForNullableDateOnly_ReturnsBinder()
+    {
+        // Arrange
+        var context = new TestModelBinderProviderContext(typeof(DateOnly?));
+
+        // Act
+        var result = _provider.GetBinder(context);
+
+        // Assert
+        Assert.IsType<DateOnlyModelBinder>(result);
+    }
+}