diff options
| author | Cody Robibero <cody@robibe.ro> | 2026-11-20 07:14:21 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-11-20 07:14:21 -0500 |
| commit | 5c05f2af03642cada0f73a255289c433c88e557c (patch) | |
| tree | 817b3d19de68dca8bf52193b560dc07b31748f4a | |
| parent | 821b849e61f6bd0fa760c76de2dc1f39400abd44 (diff) | |
| parent | 84564153cbd1702cdb24f0e4d8d37968e0f488ab (diff) | |
Merge pull request #18494 from seragAhmed/fix/18447-enum-parsing
Avoid exceptions when parsing invalid enum query values
| -rw-r--r-- | Jellyfin.Api/ModelBinders/CommaDelimitedCollectionModelBinder.cs | 22 | ||||
| -rw-r--r-- | tests/Jellyfin.Api.Tests/ModelBinders/CommaDelimitedCollectionModelBinderTests.cs | 108 |
2 files changed, 125 insertions, 5 deletions
diff --git a/Jellyfin.Api/ModelBinders/CommaDelimitedCollectionModelBinder.cs b/Jellyfin.Api/ModelBinders/CommaDelimitedCollectionModelBinder.cs index 25b84cbcc5..d94c0bf2b1 100644 --- a/Jellyfin.Api/ModelBinders/CommaDelimitedCollectionModelBinder.cs +++ b/Jellyfin.Api/ModelBinders/CommaDelimitedCollectionModelBinder.cs @@ -62,14 +62,26 @@ public class CommaDelimitedCollectionModelBinder : IModelBinder var convertedCount = 0; for (var i = 0; i < values.Count; i++) { - try + var value = values[i].Trim(); + if (elementType.IsEnum) { - parsedValues[i] = converter.ConvertFromString(values[i].Trim()); - convertedCount++; + if (Enum.TryParse(elementType, value, ignoreCase: true, out var parsedValue)) + { + parsedValues[i] = parsedValue; + convertedCount++; + } } - catch (FormatException e) + else { - _logger.LogDebug(e, "Error converting value."); + try + { + parsedValues[i] = converter.ConvertFromString(value); + convertedCount++; + } + catch (FormatException e) + { + _logger.LogDebug(e, "Error converting value."); + } } } diff --git a/tests/Jellyfin.Api.Tests/ModelBinders/CommaDelimitedCollectionModelBinderTests.cs b/tests/Jellyfin.Api.Tests/ModelBinders/CommaDelimitedCollectionModelBinderTests.cs index e6b9acfe19..6514523cf4 100644 --- a/tests/Jellyfin.Api.Tests/ModelBinders/CommaDelimitedCollectionModelBinderTests.cs +++ b/tests/Jellyfin.Api.Tests/ModelBinders/CommaDelimitedCollectionModelBinderTests.cs @@ -3,8 +3,10 @@ using System.Collections.Generic; using System.Globalization; using System.Threading.Tasks; using Jellyfin.Api.ModelBinders; +using MediaBrowser.Model.Querying; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc.ModelBinding; +using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Extensions.Primitives; using Moq; @@ -226,5 +228,111 @@ namespace Jellyfin.Api.Tests.ModelBinders Assert.NotNull(listResult); Assert.Single(listResult); } + + [Fact] + public async Task BindModelAsync_ItemFieldsQuery_SkipsLegacyValues() + { + var bindingContextMock = CreateBindingContext( + "fields", + typeof(ItemFields[]), + new StringValues("PremiereDate,Overview,UserData,Genres,RunTimeTicks")); + var modelBinder = new CommaDelimitedCollectionModelBinder(new NullLogger<CommaDelimitedCollectionModelBinder>()); + + await modelBinder.BindModelAsync(bindingContextMock.Object); + + Assert.Equal( + new[] { ItemFields.Overview, ItemFields.Genres }, + (ItemFields[]?)bindingContextMock.Object.Result.Model); + } + + [Fact] + public async Task BindModelAsync_ItemFieldsQuery_ReturnsEmptyForOnlyLegacyValues() + { + var bindingContextMock = CreateBindingContext( + "fields", + typeof(ItemFields[]), + new StringValues("PremiereDate,UserData,RunTimeTicks")); + var modelBinder = new CommaDelimitedCollectionModelBinder(new NullLogger<CommaDelimitedCollectionModelBinder>()); + + await modelBinder.BindModelAsync(bindingContextMock.Object); + + Assert.Empty((ItemFields[]?)bindingContextMock.Object.Result.Model ?? Array.Empty<ItemFields>()); + } + + [Fact] + public async Task BindModelAsync_ItemFieldsQuery_BindsCaseInsensitiveValues() + { + var bindingContextMock = CreateBindingContext("fields", typeof(ItemFields[]), new StringValues("overview,GENRES")); + var modelBinder = new CommaDelimitedCollectionModelBinder(new NullLogger<CommaDelimitedCollectionModelBinder>()); + + await modelBinder.BindModelAsync(bindingContextMock.Object); + + Assert.Equal( + new[] { ItemFields.Overview, ItemFields.Genres }, + (ItemFields[]?)bindingContextMock.Object.Result.Model); + } + + [Fact] + public async Task BindModelAsync_ItemFieldsQuery_BindsRepeatedQueryParameters() + { + var bindingContextMock = CreateBindingContext( + "fields", + typeof(ItemFields[]), + new StringValues(new[] { "Overview", "Genres" })); + var modelBinder = new CommaDelimitedCollectionModelBinder(new NullLogger<CommaDelimitedCollectionModelBinder>()); + + await modelBinder.BindModelAsync(bindingContextMock.Object); + + Assert.Equal( + new[] { ItemFields.Overview, ItemFields.Genres }, + (ItemFields[]?)bindingContextMock.Object.Result.Model); + } + + [Fact] + public async Task BindModelAsync_EnumArrayQuery_PreservesNumericValues() + { + var bindingContextMock = CreateBindingContext("test", typeof(TestType[]), new StringValues("0,1")); + var modelBinder = new CommaDelimitedCollectionModelBinder(new NullLogger<CommaDelimitedCollectionModelBinder>()); + + await modelBinder.BindModelAsync(bindingContextMock.Object); + + Assert.Equal(new[] { TestType.How, TestType.Much }, (TestType[]?)bindingContextMock.Object.Result.Model); + } + + [Fact] + public async Task BindModelAsync_InvalidEnumValues_DoesNotLogExceptions() + { + var bindingContextMock = CreateBindingContext( + "fields", + typeof(ItemFields[]), + new StringValues("PremiereDate,UserData,RunTimeTicks")); + var loggerMock = new Mock<ILogger<CommaDelimitedCollectionModelBinder>>(); + var modelBinder = new CommaDelimitedCollectionModelBinder(loggerMock.Object); + + await modelBinder.BindModelAsync(bindingContextMock.Object); + + loggerMock.Verify( + logger => logger.Log( + It.IsAny<LogLevel>(), + It.IsAny<EventId>(), + It.IsAny<It.IsAnyType>(), + It.IsAny<Exception?>(), + It.IsAny<Func<It.IsAnyType, Exception?, string>>()), + Times.Never); + } + + private static Mock<ModelBindingContext> CreateBindingContext(string modelName, Type modelType, StringValues values) + { + var valueProvider = new QueryStringValueProvider( + new BindingSource(string.Empty, string.Empty, false, false), + new QueryCollection(new Dictionary<string, StringValues> { { modelName, values } }), + CultureInfo.InvariantCulture); + var bindingContextMock = new Mock<ModelBindingContext>(); + bindingContextMock.Setup(b => b.ValueProvider).Returns(valueProvider); + bindingContextMock.Setup(b => b.ModelName).Returns(modelName); + bindingContextMock.Setup(b => b.ModelType).Returns(modelType); + bindingContextMock.SetupProperty(b => b.Result); + return bindingContextMock; + } } } |
