Add MediaStreamProtocol enum (#10153)

* Add MediaStreamProtocol enum

* Add default handling for enum during deserialization

---------

Co-authored-by: Cody Robibero <cody@robibe.ro>

2 files changed, 117 insertions, 4 deletions

diff --git a/tests/Jellyfin.Extensions.Tests/Json/Converters/JsonDefaultStringEnumConverterTests.cs b/tests/Jellyfin.Extensions.Tests/Json/Converters/JsonDefaultStringEnumConverterTests.cs
new file mode 100644
index 000000000..4fd9fd290
--- /dev/null
+++ b/tests/Jellyfin.Extensions.Tests/Json/Converters/JsonDefaultStringEnumConverterTests.cs
@@ -0,0 +1,112 @@
+using System.Text.Json;
+using Jellyfin.Data.Enums;
+using Jellyfin.Extensions.Json.Converters;
+using Xunit;
+
+namespace Jellyfin.Extensions.Tests.Json.Converters;
+
+public class JsonDefaultStringEnumConverterTests
+{
+    private readonly JsonSerializerOptions _jsonOptions = new() { Converters = { new JsonDefaultStringEnumConverterFactory() } };
+
+    /// <summary>
+    /// Test to ensure that `null` and empty string are deserialized to the default value.
+    /// </summary>
+    /// <param name="input">The input string.</param>
+    /// <param name="output">The expected enum value.</param>
+    [Theory]
+    [InlineData("\"\"", MediaStreamProtocol.Http)]
+    [InlineData("\"Http\"", MediaStreamProtocol.Http)]
+    [InlineData("\"Hls\"", MediaStreamProtocol.Hls)]
+    public void Deserialize_Enum_Direct(string input, MediaStreamProtocol output)
+    {
+        var value = JsonSerializer.Deserialize<MediaStreamProtocol>(input, _jsonOptions);
+        Assert.Equal(output, value);
+    }
+
+    /// <summary>
+    /// Test to ensure that `null` and empty string are deserialized to the default value.
+    /// </summary>
+    /// <param name="input">The input string.</param>
+    /// <param name="output">The expected enum value.</param>
+    [Theory]
+    [InlineData(null, MediaStreamProtocol.Http)]
+    [InlineData("\"\"", MediaStreamProtocol.Http)]
+    [InlineData("\"Http\"", MediaStreamProtocol.Http)]
+    [InlineData("\"Hls\"", MediaStreamProtocol.Hls)]
+    public void Deserialize_Enum(string? input, MediaStreamProtocol output)
+    {
+        input ??= "null";
+        var json = $"{{ \"EnumValue\": {input} }}";
+        var value = JsonSerializer.Deserialize<TestClass>(json, _jsonOptions);
+        Assert.NotNull(value);
+        Assert.Equal(output, value.EnumValue);
+    }
+
+    /// <summary>
+    /// Test to ensure that empty string is deserialized to the default value,
+    /// and `null` is deserialized to `null`.
+    /// </summary>
+    /// <param name="input">The input string.</param>
+    /// <param name="output">The expected enum value.</param>
+    [Theory]
+    [InlineData(null, null)]
+    [InlineData("\"\"", MediaStreamProtocol.Http)]
+    [InlineData("\"Http\"", MediaStreamProtocol.Http)]
+    [InlineData("\"Hls\"", MediaStreamProtocol.Hls)]
+    public void Deserialize_Enum_Nullable(string? input, MediaStreamProtocol? output)
+    {
+        input ??= "null";
+        var json = $"{{ \"EnumValue\": {input} }}";
+        var value = JsonSerializer.Deserialize<NullTestClass>(json, _jsonOptions);
+        Assert.NotNull(value);
+        Assert.Equal(output, value.EnumValue);
+    }
+
+    /// <summary>
+    /// Ensures that the roundtrip serialization & deserialization is successful.
+    /// </summary>
+    /// <param name="input">Input enum.</param>
+    /// <param name="output">Output enum.</param>
+    [Theory]
+    [InlineData(MediaStreamProtocol.Http, MediaStreamProtocol.Http)]
+    [InlineData(MediaStreamProtocol.Hls, MediaStreamProtocol.Hls)]
+    public void Enum_RoundTrip(MediaStreamProtocol input, MediaStreamProtocol output)
+    {
+        var inputObj = new TestClass { EnumValue = input };
+
+        var outputObj = JsonSerializer.Deserialize<TestClass>(JsonSerializer.Serialize(inputObj, _jsonOptions), _jsonOptions);
+
+        Assert.NotNull(outputObj);
+        Assert.Equal(output, outputObj.EnumValue);
+    }
+
+    /// <summary>
+    /// Ensures that the roundtrip serialization & deserialization is successful, including null.
+    /// </summary>
+    /// <param name="input">Input enum.</param>
+    /// <param name="output">Output enum.</param>
+    [Theory]
+    [InlineData(MediaStreamProtocol.Http, MediaStreamProtocol.Http)]
+    [InlineData(MediaStreamProtocol.Hls, MediaStreamProtocol.Hls)]
+    [InlineData(null, null)]
+    public void Enum_RoundTrip_Nullable(MediaStreamProtocol? input, MediaStreamProtocol? output)
+    {
+        var inputObj = new NullTestClass { EnumValue = input };
+
+        var outputObj = JsonSerializer.Deserialize<NullTestClass>(JsonSerializer.Serialize(inputObj, _jsonOptions), _jsonOptions);
+
+        Assert.NotNull(outputObj);
+        Assert.Equal(output, outputObj.EnumValue);
+    }
+
+    private sealed class TestClass
+    {
+        public MediaStreamProtocol EnumValue { get; set; }
+    }
+
+    private sealed class NullTestClass
+    {
+        public MediaStreamProtocol? EnumValue { get; set; }
+    }
+}
diff --git a/tests/Jellyfin.Model.Tests/Dlna/StreamBuilderTests.cs b/tests/Jellyfin.Model.Tests/Dlna/StreamBuilderTests.cs
index 909de8f72..183997fdb 100644
--- a/tests/Jellyfin.Model.Tests/Dlna/StreamBuilderTests.cs
+++ b/tests/Jellyfin.Model.Tests/Dlna/StreamBuilderTests.cs
@@ -5,6 +5,7 @@ using System.Linq;
 using System.Runtime.Serialization;
 using System.Text.Json;
 using System.Threading.Tasks;
+using Jellyfin.Data.Enums;
 using Jellyfin.Extensions.Json;
 using MediaBrowser.Model.Dlna;
 using MediaBrowser.Model.Dto;
@@ -388,21 +389,21 @@ namespace Jellyfin.Model.Tests
                     // Assert.Equal("webm", val.Container);
                     Assert.Equal(streamInfo.Container, uri.Extension);
                     Assert.Equal("stream", uri.Filename);
-                    Assert.Equal("http", streamInfo.SubProtocol);
+                    Assert.Equal(MediaStreamProtocol.Http, streamInfo.SubProtocol);
                 }
                 else if (transcodeProtocol.Equals("HLS.mp4", StringComparison.Ordinal))
                 {
                     Assert.Equal("mp4", streamInfo.Container);
                     Assert.Equal("m3u8", uri.Extension);
                     Assert.Equal("master", uri.Filename);
-                    Assert.Equal("hls", streamInfo.SubProtocol);
+                    Assert.Equal(MediaStreamProtocol.Hls, streamInfo.SubProtocol);
                 }
                 else
                 {
                     Assert.Equal("ts", streamInfo.Container);
                     Assert.Equal("m3u8", uri.Extension);
                     Assert.Equal("master", uri.Filename);
-                    Assert.Equal("hls", streamInfo.SubProtocol);
+                    Assert.Equal(MediaStreamProtocol.Hls, streamInfo.SubProtocol);
                 }
 
                 // Full transcode
@@ -488,7 +489,7 @@ namespace Jellyfin.Model.Tests
             }
             else if (playMethod is null)
             {
-                Assert.Null(streamInfo.SubProtocol);
+                Assert.Equal(MediaStreamProtocol.Http, streamInfo.SubProtocol);
                 Assert.Equal("stream", uri.Filename);
 
                 Assert.False(streamInfo.EstimateContentLength);