From cdde5d1d690adf16a02cc8b48cdb85467f68fb61 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 10 Dec 2019 02:30:23 +0900
Subject: [PATCH] Fix song select filters not reapplied if in a child screen

Closes https://github.com/ppy/osu/issues/6980.
---
 .../SongSelect/TestScenePlaySongSelect.cs     | 36 +++++++++++++++++++
 .../Visual/TestSceneOsuScreenStack.cs         |  2 +-
 osu.Game/Screens/Select/SongSelect.cs         |  8 ++---
 osu.Game/Tests/Visual/ScreenTestScene.cs      | 10 +++---
 4 files changed, 46 insertions(+), 10 deletions(-)

diff --git a/osu.Game.Tests/Visual/SongSelect/TestScenePlaySongSelect.cs b/osu.Game.Tests/Visual/SongSelect/TestScenePlaySongSelect.cs
index a4b8d1a24a..5dd02c1ddd 100644
--- a/osu.Game.Tests/Visual/SongSelect/TestScenePlaySongSelect.cs
+++ b/osu.Game.Tests/Visual/SongSelect/TestScenePlaySongSelect.cs
@@ -95,6 +95,42 @@ namespace osu.Game.Tests.Visual.SongSelect
             AddAssert("filter count is 1", () => songSelect.FilterCount == 1);
         }
 
+        [Test]
+        public void TestNoFilterOnSimpleResume()
+        {
+            addRulesetImportStep(0);
+            addRulesetImportStep(0);
+
+            createSongSelect();
+
+            AddStep("push child screen", () => Stack.Push(new TestSceneOsuScreenStack.TestScreen("test child")));
+            AddUntilStep("wait for not current", () => !songSelect.IsCurrentScreen());
+
+            AddStep("return", () => songSelect.MakeCurrent());
+            AddUntilStep("wait for current", () => songSelect.IsCurrentScreen());
+            AddAssert("filter count is 1", () => songSelect.FilterCount == 1);
+        }
+
+        [Test]
+        public void TestFilterOnResumeAfterChange()
+        {
+            addRulesetImportStep(0);
+            addRulesetImportStep(0);
+
+            AddStep("change convert setting", () => config.Set(OsuSetting.ShowConvertedBeatmaps, false));
+
+            createSongSelect();
+
+            AddStep("push child screen", () => Stack.Push(new TestSceneOsuScreenStack.TestScreen("test child")));
+            AddUntilStep("wait for not current", () => !songSelect.IsCurrentScreen());
+
+            AddStep("change convert setting", () => config.Set(OsuSetting.ShowConvertedBeatmaps, true));
+
+            AddStep("return", () => songSelect.MakeCurrent());
+            AddUntilStep("wait for current", () => songSelect.IsCurrentScreen());
+            AddAssert("filter count is 2", () => songSelect.FilterCount == 2);
+        }
+
         [Test]
         public void TestAudioResuming()
         {
diff --git a/osu.Game.Tests/Visual/TestSceneOsuScreenStack.cs b/osu.Game.Tests/Visual/TestSceneOsuScreenStack.cs
index a68fd0ef40..c55988d1bb 100644
--- a/osu.Game.Tests/Visual/TestSceneOsuScreenStack.cs
+++ b/osu.Game.Tests/Visual/TestSceneOsuScreenStack.cs
@@ -42,7 +42,7 @@ namespace osu.Game.Tests.Visual
             AddAssert("Parallax is off", () => stack.ParallaxAmount == 0);
         }
 
-        private class TestScreen : ScreenWithBeatmapBackground
+        public class TestScreen : ScreenWithBeatmapBackground
         {
             private readonly string screenText;
 
diff --git a/osu.Game/Screens/Select/SongSelect.cs b/osu.Game/Screens/Select/SongSelect.cs
index a52edb70db..8f7ad2022d 100644
--- a/osu.Game/Screens/Select/SongSelect.cs
+++ b/osu.Game/Screens/Select/SongSelect.cs
@@ -262,8 +262,10 @@ namespace osu.Game.Screens.Select
 
         protected virtual void ApplyFilterToCarousel(FilterCriteria criteria)
         {
-            if (this.IsCurrentScreen())
-                Carousel.Filter(criteria);
+            // if not the current screen, we want to get carousel in a good presentation state before displaying (resume or enter).
+            bool shouldDebounce = this.IsCurrentScreen();
+
+            Schedule(() => Carousel.Filter(criteria, shouldDebounce));
         }
 
         private DependencyContainer dependencies;
@@ -437,8 +439,6 @@ namespace osu.Game.Screens.Select
         {
             base.OnEntering(last);
 
-            Carousel.Filter(FilterControl.CreateCriteria(), false);
-
             this.FadeInFromZero(250);
             FilterControl.Activate();
         }
diff --git a/osu.Game/Tests/Visual/ScreenTestScene.cs b/osu.Game/Tests/Visual/ScreenTestScene.cs
index 23f45e0d0f..707aa61283 100644
--- a/osu.Game/Tests/Visual/ScreenTestScene.cs
+++ b/osu.Game/Tests/Visual/ScreenTestScene.cs
@@ -12,7 +12,7 @@ namespace osu.Game.Tests.Visual
     /// </summary>
     public abstract class ScreenTestScene : ManualInputManagerTestScene
     {
-        private readonly OsuScreenStack stack;
+        protected readonly OsuScreenStack Stack;
 
         private readonly Container content;
 
@@ -22,16 +22,16 @@ namespace osu.Game.Tests.Visual
         {
             base.Content.AddRange(new Drawable[]
             {
-                stack = new OsuScreenStack { RelativeSizeAxes = Axes.Both },
+                Stack = new OsuScreenStack { RelativeSizeAxes = Axes.Both },
                 content = new Container { RelativeSizeAxes = Axes.Both }
             });
         }
 
         protected void LoadScreen(OsuScreen screen)
         {
-            if (stack.CurrentScreen != null)
-                stack.Exit();
-            stack.Push(screen);
+            if (Stack.CurrentScreen != null)
+                Stack.Exit();
+            Stack.Push(screen);
         }
     }
 }