Merge pull request #11673 from peppy/fix-mod-settings-serlisation-signalr50

Add custom MessagePack resolver for mod settings dictionary

osu.Game.Tests/Online/TestAPIModJsonSerialization.cs

@@ -16,7 +16,7 @@ using osu.Game.Rulesets.UI;
 namespace osu.Game.Tests.Online
 {
     [TestFixture]
-    public class TestAPIModSerialization
+    public class TestAPIModJsonSerialization
     {
         [Test]
         public void TestAcronymIsPreserved()

osu.Game.Tests/Online/TestAPIModMessagePackSerialization.cs

@@ -0,0 +1,139 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Collections.Generic;
+using MessagePack;
+using NUnit.Framework;
+using osu.Framework.Bindables;
+using osu.Game.Beatmaps;
+using osu.Game.Configuration;
+using osu.Game.Online.API;
+using osu.Game.Rulesets;
+using osu.Game.Rulesets.Difficulty;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.UI;
+
+namespace osu.Game.Tests.Online
+{
+    [TestFixture]
+    public class TestAPIModMessagePackSerialization
+    {
+        [Test]
+        public void TestAcronymIsPreserved()
+        {
+            var apiMod = new APIMod(new TestMod());
+
+            var deserialized = MessagePackSerializer.Deserialize<APIMod>(MessagePackSerializer.Serialize(apiMod));
+
+            Assert.That(deserialized.Acronym, Is.EqualTo(apiMod.Acronym));
+        }
+
+        [Test]
+        public void TestRawSettingIsPreserved()
+        {
+            var apiMod = new APIMod(new TestMod { TestSetting = { Value = 2 } });
+
+            var deserialized = MessagePackSerializer.Deserialize<APIMod>(MessagePackSerializer.Serialize(apiMod));
+
+            Assert.That(deserialized.Settings, Contains.Key("test_setting").With.ContainValue(2.0));
+        }
+
+        [Test]
+        public void TestConvertedModHasCorrectSetting()
+        {
+            var apiMod = new APIMod(new TestMod { TestSetting = { Value = 2 } });
+
+            var deserialized = MessagePackSerializer.Deserialize<APIMod>(MessagePackSerializer.Serialize(apiMod));
+            var converted = (TestMod)deserialized.ToMod(new TestRuleset());
+
+            Assert.That(converted.TestSetting.Value, Is.EqualTo(2));
+        }
+
+        [Test]
+        public void TestDeserialiseTimeRampMod()
+        {
+            // Create the mod with values different from default.
+            var apiMod = new APIMod(new TestModTimeRamp
+            {
+                AdjustPitch = { Value = false },
+                InitialRate = { Value = 1.25 },
+                FinalRate = { Value = 0.25 }
+            });
+
+            var deserialised = MessagePackSerializer.Deserialize<APIMod>(MessagePackSerializer.Serialize(apiMod));
+            var converted = (TestModTimeRamp)deserialised.ToMod(new TestRuleset());
+
+            Assert.That(converted.AdjustPitch.Value, Is.EqualTo(false));
+            Assert.That(converted.InitialRate.Value, Is.EqualTo(1.25));
+            Assert.That(converted.FinalRate.Value, Is.EqualTo(0.25));
+        }
+
+        private class TestRuleset : Ruleset
+        {
+            public override IEnumerable<Mod> GetModsFor(ModType type) => new Mod[]
+            {
+                new TestMod(),
+                new TestModTimeRamp(),
+            };
+
+            public override DrawableRuleset CreateDrawableRulesetWith(IBeatmap beatmap, IReadOnlyList<Mod> mods = null) => throw new System.NotImplementedException();
+
+            public override IBeatmapConverter CreateBeatmapConverter(IBeatmap beatmap) => throw new System.NotImplementedException();
+
+            public override DifficultyCalculator CreateDifficultyCalculator(WorkingBeatmap beatmap) => throw new System.NotImplementedException();
+
+            public override string Description { get; } = string.Empty;
+            public override string ShortName { get; } = string.Empty;
+        }
+
+        private class TestMod : Mod
+        {
+            public override string Name => "Test Mod";
+            public override string Acronym => "TM";
+            public override double ScoreMultiplier => 1;
+
+            [SettingSource("Test")]
+            public BindableNumber<double> TestSetting { get; } = new BindableDouble
+            {
+                MinValue = 0,
+                MaxValue = 10,
+                Default = 5,
+                Precision = 0.01,
+            };
+        }
+
+        private class TestModTimeRamp : ModTimeRamp
+        {
+            public override string Name => "Test Mod";
+            public override string Acronym => "TMTR";
+            public override double ScoreMultiplier => 1;
+
+            [SettingSource("Initial rate", "The starting speed of the track")]
+            public override BindableNumber<double> InitialRate { get; } = new BindableDouble
+            {
+                MinValue = 1,
+                MaxValue = 2,
+                Default = 1.5,
+                Value = 1.5,
+                Precision = 0.01,
+            };
+
+            [SettingSource("Final rate", "The speed increase to ramp towards")]
+            public override BindableNumber<double> FinalRate { get; } = new BindableDouble
+            {
+                MinValue = 0,
+                MaxValue = 1,
+                Default = 0.5,
+                Value = 0.5,
+                Precision = 0.01,
+            };
+
+            [SettingSource("Adjust pitch", "Should pitch be adjusted with speed")]
+            public override BindableBool AdjustPitch { get; } = new BindableBool
+            {
+                Default = true,
+                Value = true
+            };
+        }
+    }
+}

osu.Game/Online/API/APIMod.cs

@@ -23,6 +23,7 @@ namespace osu.Game.Online.API
 
         [JsonProperty("settings")]
         [Key(1)]
+        [MessagePackFormatter(typeof(ModSettingsDictionaryFormatter))]
         public Dictionary<string, object> Settings { get; set; } = new Dictionary<string, object>();
 
         [JsonConstructor]

osu.Game/Online/API/ModSettingsDictionaryFormatter.cs

@@ -0,0 +1,67 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Buffers;
+using System.Collections.Generic;
+using System.Text;
+using MessagePack;
+using MessagePack.Formatters;
+using osu.Framework.Bindables;
+
+namespace osu.Game.Online.API
+{
+    public class ModSettingsDictionaryFormatter : IMessagePackFormatter<Dictionary<string, object>>
+    {
+        public void Serialize(ref MessagePackWriter writer, Dictionary<string, object> value, MessagePackSerializerOptions options)
+        {
+            var primitiveFormatter = PrimitiveObjectFormatter.Instance;
+
+            writer.WriteArrayHeader(value.Count);
+
+            foreach (var kvp in value)
+            {
+                var stringBytes = new ReadOnlySequence<byte>(Encoding.UTF8.GetBytes(kvp.Key));
+                writer.WriteString(in stringBytes);
+
+                switch (kvp.Value)
+                {
+                    case Bindable<double> d:
+                        primitiveFormatter.Serialize(ref writer, d.Value, options);
+                        break;
+
+                    case Bindable<int> i:
+                        primitiveFormatter.Serialize(ref writer, i.Value, options);
+                        break;
+
+                    case Bindable<float> f:
+                        primitiveFormatter.Serialize(ref writer, f.Value, options);
+                        break;
+
+                    case Bindable<bool> b:
+                        primitiveFormatter.Serialize(ref writer, b.Value, options);
+                        break;
+
+                    default:
+                        // fall back for non-bindable cases.
+                        primitiveFormatter.Serialize(ref writer, kvp.Value, options);
+                        break;
+                }
+            }
+        }
+
+        public Dictionary<string, object> Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
+        {
+            var output = new Dictionary<string, object>();
+
+            int itemCount = reader.ReadArrayHeader();
+
+            for (int i = 0; i < itemCount; i++)
+            {
+                output[reader.ReadString()] =
+                    PrimitiveObjectFormatter.Instance.Deserialize(ref reader, options);
+            }
+
+            return output;
+        }
+    }
+}

osu.Game/osu.Game.csproj

@@ -20,11 +20,13 @@
   <ItemGroup Label="Package References">
     <PackageReference Include="DiffPlex" Version="1.6.3" />
     <PackageReference Include="Humanizer" Version="2.8.26" />
-    <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="3.1.10" />
-    <PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="3.1.11" />
-    <PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.NewtonsoftJson" Version="3.1.10" />
+    <PackageReference Include="MessagePack" Version="2.2.85" />
+    <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="5.0.2" />
+    <PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="5.0.2" />
+    <PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.NewtonsoftJson" Version="5.0.2" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="2.2.6" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite.Core" Version="2.2.6" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.NETCore.Targets" Version="3.1.0" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="ppy.osu.Framework" Version="2021.128.0" />

osu.iOS.props

@@ -80,6 +80,9 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="3.0.3" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.0.3" />
+    <PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.MessagePack" Version="3.0.3" />
+    <PackageReference Include="MessagePack" Version="1.7.3.7" />
+    <PackageReference Include="MessagePack.Annotations" Version="2.2.85" />
   </ItemGroup>
   <!-- Xamarin.iOS does not automatically handle transitive dependencies from NuGet packages. -->
   <ItemGroup Label="Transitive Dependencies">