Merge pull request #14698 from peppy/fix-beatmap-overlay-hide

Fix beatmap listing overlay not hiding via keyboard control when scrolled

osu.Game.Tests/Visual/Online/TestSceneBeatmapListingOverlay.cs

@@ -5,10 +5,10 @@ using System;
 using System.Collections.Generic;
 using System.Linq;
 using NUnit.Framework;
-using osu.Framework.Allocation;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Testing;
 using osu.Game.Beatmaps;
+using osu.Game.Graphics.UserInterface;
 using osu.Game.Online.API;
 using osu.Game.Online.API.Requests;
 using osu.Game.Online.API.Requests.Responses;
@@ -17,10 +17,11 @@ using osu.Game.Overlays.BeatmapListing;
 using osu.Game.Rulesets;
 using osu.Game.Scoring;
 using osu.Game.Users;
+using osuTK.Input;
 
 namespace osu.Game.Tests.Visual.Online
 {
-    public class TestSceneBeatmapListingOverlay : OsuTestScene
+    public class TestSceneBeatmapListingOverlay : OsuManualInputManagerTestScene
     {
         private readonly List<APIBeatmapSet> setsForResponse = new List<APIBeatmapSet>();
 
@@ -28,12 +29,20 @@ namespace osu.Game.Tests.Visual.Online
 
         private BeatmapListingSearchControl searchControl => overlay.ChildrenOfType<BeatmapListingSearchControl>().Single();
 
-        [BackgroundDependencyLoader]
+        [SetUpSteps]
-        private void load()
+        public void SetUpSteps()
+        {
+            AddStep("setup overlay", () =>
             {
                 Child = overlay = new BeatmapListingOverlay { State = { Value = Visibility.Visible } };
+                setsForResponse.Clear();
+            });
 
-            ((DummyAPIAccess)API).HandleRequest = req =>
+            AddStep("initialize dummy", () =>
+            {
+                var api = (DummyAPIAccess)API;
+
+                api.HandleRequest = req =>
                 {
                     if (!(req is SearchBeatmapSetsRequest searchBeatmapSetsRequest)) return false;
 
@@ -45,10 +54,8 @@ namespace osu.Game.Tests.Visual.Online
                     return true;
                 };
 
-            AddStep("initialize dummy", () =>
-            {
                 // non-supporter user
-                ((DummyAPIAccess)API).LocalUser.Value = new User
+                api.LocalUser.Value = new User
                 {
                     Username = "TestBot",
                     Id = API.LocalUser.Value.Id + 1,
@@ -56,6 +63,51 @@ namespace osu.Game.Tests.Visual.Online
             });
         }
 
+        [Test]
+        public void TestHideViaBack()
+        {
+            AddAssert("is visible", () => overlay.State.Value == Visibility.Visible);
+            AddStep("hide", () => InputManager.Key(Key.Escape));
+            AddUntilStep("is hidden", () => overlay.State.Value == Visibility.Hidden);
+        }
+
+        [Test]
+        public void TestHideViaBackWithSearch()
+        {
+            AddAssert("is visible", () => overlay.State.Value == Visibility.Visible);
+
+            AddStep("search something", () => overlay.ChildrenOfType<SearchTextBox>().First().Text = "search");
+
+            AddStep("kill search", () => InputManager.Key(Key.Escape));
+
+            AddAssert("search textbox empty", () => string.IsNullOrEmpty(overlay.ChildrenOfType<SearchTextBox>().First().Text));
+            AddAssert("is visible", () => overlay.State.Value == Visibility.Visible);
+
+            AddStep("hide", () => InputManager.Key(Key.Escape));
+            AddUntilStep("is hidden", () => overlay.State.Value == Visibility.Hidden);
+        }
+
+        [Test]
+        public void TestHideViaBackWithScrolledSearch()
+        {
+            AddAssert("is visible", () => overlay.State.Value == Visibility.Visible);
+
+            AddStep("show many results", () => fetchFor(Enumerable.Repeat(CreateBeatmap(Ruleset.Value).BeatmapInfo.BeatmapSet, 100).ToArray()));
+
+            AddUntilStep("placeholder hidden", () => !overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().Any(d => d.IsPresent));
+
+            AddStep("scroll to bottom", () => overlay.ChildrenOfType<OverlayScrollContainer>().First().ScrollToEnd());
+
+            AddStep("kill search", () => InputManager.Key(Key.Escape));
+
+            AddUntilStep("search textbox empty", () => string.IsNullOrEmpty(overlay.ChildrenOfType<SearchTextBox>().First().Text));
+            AddUntilStep("is scrolled to top", () => overlay.ChildrenOfType<OverlayScrollContainer>().First().Current == 0);
+            AddAssert("is visible", () => overlay.State.Value == Visibility.Visible);
+
+            AddStep("hide", () => InputManager.Key(Key.Escape));
+            AddUntilStep("is hidden", () => overlay.State.Value == Visibility.Hidden);
+        }
+
         [Test]
         public void TestNoBeatmapsPlaceholder()
         {
@@ -63,7 +115,7 @@ namespace osu.Game.Tests.Visual.Online
             AddUntilStep("placeholder shown", () => overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().SingleOrDefault()?.IsPresent == true);
 
             AddStep("fetch for 1 beatmap", () => fetchFor(CreateBeatmap(Ruleset.Value).BeatmapInfo.BeatmapSet));
-            AddUntilStep("placeholder hidden", () => !overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().Any());
+            AddUntilStep("placeholder hidden", () => !overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().Any(d => d.IsPresent));
 
             AddStep("fetch for 0 beatmaps", () => fetchFor());
             AddUntilStep("placeholder shown", () => overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().SingleOrDefault()?.IsPresent == true);
@@ -193,13 +245,15 @@ namespace osu.Game.Tests.Visual.Online
             noPlaceholderShown();
         }
 
+        private static int searchCount;
+
         private void fetchFor(params BeatmapSetInfo[] beatmaps)
         {
             setsForResponse.Clear();
             setsForResponse.AddRange(beatmaps.Select(b => new TestAPIBeatmapSet(b)));
 
             // trigger arbitrary change for fetching.
-            searchControl.Query.TriggerChange();
+            searchControl.Query.Value = $"search {searchCount++}";
         }
 
         private void setRankAchievedFilter(ScoreRank[] ranks)
@@ -229,8 +283,8 @@ namespace osu.Game.Tests.Visual.Online
         private void noPlaceholderShown()
         {
             AddUntilStep("no placeholder shown", () =>
-                !overlay.ChildrenOfType<BeatmapListingOverlay.SupporterRequiredDrawable>().Any()
+                !overlay.ChildrenOfType<BeatmapListingOverlay.SupporterRequiredDrawable>().Any(d => d.IsPresent)
-                && !overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().Any());
+                && !overlay.ChildrenOfType<BeatmapListingOverlay.NotFoundDrawable>().Any(d => d.IsPresent));
         }
 
         private class TestAPIBeatmapSet : APIBeatmapSet

osu.Game/Graphics/UserInterface/FocusedTextBox.cs

@@ -70,7 +70,7 @@ namespace osu.Game.Graphics.UserInterface
             return base.OnKeyDown(e);
         }
 
-        public bool OnPressed(GlobalAction action)
+        public virtual bool OnPressed(GlobalAction action)
         {
             if (!HasFocus) return false;
 

osu.Game/Overlays/BeatmapListing/BeatmapListingSearchControl.cs

@@ -3,21 +3,22 @@
 
 using System;
 using osu.Framework.Allocation;
+using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
-using osuTK;
-using osu.Framework.Bindables;
 using osu.Framework.Input.Events;
-using osu.Game.Beatmaps.Drawables;
 using osu.Game.Beatmaps;
+using osu.Game.Beatmaps.Drawables;
 using osu.Game.Configuration;
 using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.UserInterface;
+using osu.Game.Input.Bindings;
 using osu.Game.Resources.Localisation.Web;
-using osuTK.Graphics;
 using osu.Game.Rulesets;
 using osu.Game.Scoring;
+using osuTK;
+using osuTK.Graphics;
 
 namespace osu.Game.Overlays.BeatmapListing
 {
@@ -117,7 +118,7 @@ namespace osu.Game.Overlays.BeatmapListing
                             textBox = new BeatmapSearchTextBox
                             {
                                 RelativeSizeAxes = Axes.X,
-                                TypingStarted = () => TypingStarted?.Invoke(),
+                                TextChanged = () => TypingStarted?.Invoke(),
                             },
                             new ReverseChildIDFillFlowContainer<Drawable>
                             {
@@ -167,7 +168,7 @@ namespace osu.Game.Overlays.BeatmapListing
             /// <summary>
             /// Any time the text box receives key events (even while masked).
             /// </summary>
-            public Action TypingStarted;
+            public Action TextChanged;
 
             protected override Color4 SelectionColour => Color4.Gray;
 
@@ -181,7 +182,16 @@ namespace osu.Game.Overlays.BeatmapListing
                 if (!base.OnKeyDown(e))
                     return false;
 
-                TypingStarted?.Invoke();
+                TextChanged?.Invoke();
+                return true;
+            }
+
+            public override bool OnPressed(GlobalAction action)
+            {
+                if (!base.OnPressed(action))
+                    return false;
+
+                TextChanged?.Invoke();
                 return true;
             }
         }