Merge pull request #5382 from crobibero/json-version-converter

MediaBrowser.Common/Json/Converters/JsonVersionConverter.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace MediaBrowser.Common.Json.Converters
+{
+    /// <summary>
+    /// Converts a Version object or value to/from JSON.
+    /// </summary>
+    /// <remarks>
+    /// Required to send <see cref="Version"/> as a string instead of an object.
+    /// </remarks>
+    public class JsonVersionConverter : JsonConverter<Version>
+    {
+        /// <inheritdoc />
+        public override Version Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+            => new Version(reader.GetString());
+
+        /// <inheritdoc />
+        public override void Write(Utf8JsonWriter writer, Version value, JsonSerializerOptions options)
+            => writer.WriteStringValue(value.ToString());
+    }
+}

MediaBrowser.Common/Json/JsonDefaults.cs

@@ -35,6 +35,7 @@ namespace MediaBrowser.Common.Json
             {
                 new JsonGuidConverter(),
                 new JsonNullableGuidConverter(),
+                new JsonVersionConverter(),
                 new JsonStringEnumConverter(),
                 new JsonNullableStructConverterFactory(),
                 new JsonBoolNumberConverter(),

MediaBrowser.Common/MediaBrowser.Common.csproj

@@ -14,7 +14,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <FrameworkReference Include="Microsoft.AspNetCore.App"/>
+    <FrameworkReference Include="Microsoft.AspNetCore.App" />
     <ProjectReference Include="..\MediaBrowser.Model\MediaBrowser.Model.csproj" />
   </ItemGroup>
 

tests/Jellyfin.Common.Tests/Json/JsonVersionConverterTests.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Text.Json;
+using MediaBrowser.Common.Json.Converters;
+using Xunit;
+
+namespace Jellyfin.Common.Tests.Json
+{
+    public class JsonVersionConverterTests
+    {
+        private readonly JsonSerializerOptions _options;
+
+        public JsonVersionConverterTests()
+        {
+            _options = new JsonSerializerOptions();
+            _options.Converters.Add(new JsonVersionConverter());
+        }
+
+        [Fact]
+        public void Deserialize_Version_Success()
+        {
+            var input = "\"1.025.222\"";
+            var output = new Version(1, 25, 222);
+            var deserializedInput = JsonSerializer.Deserialize<Version>(input, _options);
+            Assert.Equal(output, deserializedInput);
+        }
+
+        [Fact]
+        public void Serialize_Version_Success()
+        {
+            var input = new Version(1, 09, 59);
+            var output = "\"1.9.59\"";
+            var serializedInput = JsonSerializer.Serialize(input, _options);
+            Assert.Equal(output, serializedInput);
+        }
+    }
+}