Merge pull request #8142 from peppy/add-star-difficulty-max-migration

Fix song select max displayable star difficulty getting stuck at wrong maximum

osu.Game.Tests/Visual/Navigation/OsuGameTestScene.cs

@@ -62,14 +62,7 @@ namespace osu.Game.Tests.Visual.Navigation
                 var frameworkConfig = host.Dependencies.Get<FrameworkConfigManager>();
                 frameworkConfig.GetBindable<double>(FrameworkSetting.CursorSensitivity).Disabled = false;
 
-                Game = new TestOsuGame(LocalStorage, API);
-                Game.SetHost(host);
-
-                // todo: this can be removed once we can run audio tracks without a device present
-                // see https://github.com/ppy/osu/issues/1302
-                Game.LocalConfig.Set(OsuSetting.IntroSequence, IntroSequence.Circles);
-
-                Add(Game);
+                CreateGame();
             });
 
             AddUntilStep("Wait for load", () => Game.IsLoaded);
@@ -78,6 +71,18 @@ namespace osu.Game.Tests.Visual.Navigation
             ConfirmAtMainMenu();
         }
 
+        protected void CreateGame()
+        {
+            Game = new TestOsuGame(LocalStorage, API);
+            Game.SetHost(host);
+
+            // todo: this can be removed once we can run audio tracks without a device present
+            // see https://github.com/ppy/osu/issues/1302
+            Game.LocalConfig.Set(OsuSetting.IntroSequence, IntroSequence.Circles);
+
+            Add(Game);
+        }
+
         protected void PushAndConfirm(Func<Screen> newScreen)
         {
             Screen screen = null;
@@ -103,6 +108,9 @@ namespace osu.Game.Tests.Visual.Navigation
 
             public new Bindable<RulesetInfo> Ruleset => base.Ruleset;
 
+            // if we don't do this, when running under nUnit the version that gets populated is that of nUnit.
+            public override string Version => "test game";
+
             protected override Loader CreateLoader() => new TestLoader();
 
             public new void PerformFromScreen(Action<IScreen> action, IEnumerable<Type> validScreens = null) => base.PerformFromScreen(action, validScreens);

osu.Game.Tests/Visual/Navigation/TestSettingsMigration.cs

@@ -0,0 +1,41 @@
+// 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 NUnit.Framework;
+using osu.Framework.Utils;
+using osu.Game.Configuration;
+
+namespace osu.Game.Tests.Visual.Navigation
+{
+    public class TestSettingsMigration : OsuGameTestScene
+    {
+        public override void RecycleLocalStorage()
+        {
+            base.RecycleLocalStorage();
+
+            using (var config = new OsuConfigManager(LocalStorage))
+            {
+                config.Set(OsuSetting.Version, "2020.101.0");
+                config.Set(OsuSetting.DisplayStarsMaximum, 10.0);
+            }
+        }
+
+        [Test]
+        public void TestDisplayStarsMigration()
+        {
+            AddAssert("config has migrated value", () => Precision.AlmostEquals(Game.LocalConfig.Get<double>(OsuSetting.DisplayStarsMaximum), 10.1));
+
+            AddStep("set value again", () => Game.LocalConfig.Set<double>(OsuSetting.DisplayStarsMaximum, 10));
+
+            AddStep("force save config", () => Game.LocalConfig.Save());
+
+            AddStep("remove game", () => Remove(Game));
+
+            AddStep("create game again", CreateGame);
+
+            AddUntilStep("Wait for load", () => Game.IsLoaded);
+
+            AddAssert("config did not migrate value", () => Precision.AlmostEquals(Game.LocalConfig.Get<double>(OsuSetting.DisplayStarsMaximum), 10));
+        }
+    }
+}

osu.Game/Configuration/OsuConfigManager.cs

@@ -1,6 +1,7 @@
 // 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 osu.Framework.Bindables;
 using osu.Framework.Configuration;
 using osu.Framework.Configuration.Tracking;
 using osu.Framework.Extensions;
@@ -126,6 +127,35 @@ namespace osu.Game.Configuration
         public OsuConfigManager(Storage storage)
             : base(storage)
         {
+            Migrate();
+        }
+
+        public void Migrate()
+        {
+            // arrives as 2020.123.0
+            var rawVersion = Get<string>(OsuSetting.Version);
+
+            if (rawVersion.Length < 6)
+                return;
+
+            var pieces = rawVersion.Split('.');
+
+            // on a fresh install or when coming from a non-release build, execution will end here.
+            // we don't want to run migrations in such cases.
+            if (!int.TryParse(pieces[0], out int year)) return;
+            if (!int.TryParse(pieces[1], out int monthDay)) return;
+
+            int combined = (year * 10000) + monthDay;
+
+            if (combined < 20200305)
+            {
+                // the maximum value of this setting was changed.
+                // if we don't manually increase this, it causes song select to filter out beatmaps the user expects to see.
+                var maxStars = (BindableDouble)GetOriginalBindable<double>(OsuSetting.DisplayStarsMaximum);
+
+                if (maxStars.Value == 10)
+                    maxStars.Value = maxStars.MaxValue;
+            }
         }
 
         public override TrackedSettings CreateTrackedSettings() => new TrackedSettings

osu.Game/OsuGameBase.cs

@@ -97,7 +97,7 @@ namespace osu.Game
 
         public bool IsDeployedBuild => AssemblyVersion.Major > 0;
 
-        public string Version
+        public virtual string Version
         {
             get
             {

osu.Game/Tests/Visual/OsuTestScene.cs

@@ -104,7 +104,7 @@ namespace osu.Game.Tests.Visual
             base.Content.Add(content = new DrawSizePreservingFillContainer());
         }
 
-        public void RecycleLocalStorage()
+        public virtual void RecycleLocalStorage()
         {
             if (localStorage?.IsValueCreated == true)
             {