Merge pull request #12446 from jvyden/master

Reset SessionStatics on inactivity

osu.Game.Tests/NonVisual/SessionStaticsTest.cs

@@ -0,0 +1,47 @@
+// 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.Game.Configuration;
+using osu.Game.Input;
+
+namespace osu.Game.Tests.NonVisual
+{
+    [TestFixture]
+    public class SessionStaticsTest
+    {
+        private SessionStatics sessionStatics;
+        private IdleTracker sessionIdleTracker;
+
+        [SetUp]
+        public void SetUp()
+        {
+            sessionStatics = new SessionStatics();
+            sessionIdleTracker = new GameIdleTracker(1000);
+
+            sessionStatics.SetValue(Static.LoginOverlayDisplayed, true);
+            sessionStatics.SetValue(Static.MutedAudioNotificationShownOnce, true);
+            sessionStatics.SetValue(Static.LowBatteryNotificationShownOnce, true);
+            sessionStatics.SetValue(Static.LastHoverSoundPlaybackTime, (double?)1d);
+
+            sessionIdleTracker.IsIdle.BindValueChanged(e =>
+            {
+                if (e.NewValue)
+                    sessionStatics.ResetValues();
+            });
+        }
+
+        [Test]
+        [Timeout(2000)]
+        public void TestSessionStaticsReset()
+        {
+            sessionIdleTracker.IsIdle.BindValueChanged(e =>
+            {
+                Assert.IsTrue(sessionStatics.GetBindable<bool>(Static.LoginOverlayDisplayed).IsDefault);
+                Assert.IsTrue(sessionStatics.GetBindable<bool>(Static.MutedAudioNotificationShownOnce).IsDefault);
+                Assert.IsTrue(sessionStatics.GetBindable<bool>(Static.LowBatteryNotificationShownOnce).IsDefault);
+                Assert.IsTrue(sessionStatics.GetBindable<double?>(Static.LastHoverSoundPlaybackTime).IsDefault);
+            });
+        }
+    }
+}

osu.Game.Tests/Visual/Components/TestSceneIdleTracker.cs

@@ -149,7 +149,7 @@ namespace osu.Game.Tests.Visual.Components
 
         private void waitForAllIdle()
         {
-            AddUntilStep("Wait for all idle", () => box1.IsIdle && box2.IsIdle && box3.IsIdle && box4.IsIdle);
+            AddUntilStep("wait for all idle", () => box1.IsIdle && box2.IsIdle && box3.IsIdle && box4.IsIdle);
         }
 
         private class IdleTrackingBox : CompositeDrawable
@@ -158,7 +158,7 @@ namespace osu.Game.Tests.Visual.Components
 
             public bool IsIdle => idleTracker.IsIdle.Value;
 
-            public IdleTrackingBox(double timeToIdle)
+            public IdleTrackingBox(int timeToIdle)
             {
                 Box box;
 
@@ -167,7 +167,7 @@ namespace osu.Game.Tests.Visual.Components
 
                 InternalChildren = new Drawable[]
                 {
-                    idleTracker = new IdleTracker(timeToIdle),
+                    idleTracker = new GameIdleTracker(timeToIdle),
                     box = new Box
                     {
                         Colour = Color4.White,

osu.Game/Configuration/SessionStatics.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.Game.Graphics.UserInterface;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Overlays;
@@ -12,14 +13,18 @@ namespace osu.Game.Configuration
     /// </summary>
     public class SessionStatics : InMemoryConfigManager<Static>
     {
-        protected override void InitialiseDefaults()
+        protected override void InitialiseDefaults() => ResetValues();
+
+        public void ResetValues()
         {
-            SetDefault(Static.LoginOverlayDisplayed, false);
+            ensureDefault(SetDefault(Static.LoginOverlayDisplayed, false));
-            SetDefault(Static.MutedAudioNotificationShownOnce, false);
+            ensureDefault(SetDefault(Static.MutedAudioNotificationShownOnce, false));
-            SetDefault(Static.LowBatteryNotificationShownOnce, false);
+            ensureDefault(SetDefault(Static.LowBatteryNotificationShownOnce, false));
-            SetDefault(Static.LastHoverSoundPlaybackTime, (double?)null);
+            ensureDefault(SetDefault(Static.LastHoverSoundPlaybackTime, (double?)null));
-            SetDefault<APISeasonalBackgrounds>(Static.SeasonalBackgrounds, null);
+            ensureDefault(SetDefault<APISeasonalBackgrounds>(Static.SeasonalBackgrounds, null));
         }
+
+        private void ensureDefault<T>(Bindable<T> bindable) => bindable.SetDefault();
     }
 
     public enum Static

osu.Game/OsuGame.cs

@@ -577,6 +577,15 @@ namespace osu.Game
 
             dependencies.CacheAs(idleTracker = new GameIdleTracker(6000));
 
+            var sessionIdleTracker = new GameIdleTracker(300000);
+            sessionIdleTracker.IsIdle.BindValueChanged(idle =>
+            {
+                if (idle.NewValue)
+                    SessionStatics.ResetValues();
+            });
+
+            Add(sessionIdleTracker);
+
             AddRange(new Drawable[]
             {
                 new VolumeControlReceptor

osu.Game/OsuGameBase.cs

@@ -61,6 +61,8 @@ namespace osu.Game
 
         protected OsuConfigManager LocalConfig;
 
+        protected SessionStatics SessionStatics { get; private set; }
+
         protected BeatmapManager BeatmapManager;
 
         protected ScoreManager ScoreManager;
@@ -289,7 +291,7 @@ namespace osu.Game
             if (powerStatus != null)
                 dependencies.CacheAs(powerStatus);
 
-            dependencies.Cache(new SessionStatics());
+            dependencies.Cache(SessionStatics = new SessionStatics());
             dependencies.Cache(new OsuColour());
 
             RegisterImportHandler(BeatmapManager);