From 1a85e1267bc0ccf3700360f831b69f5e5cc26312 Mon Sep 17 00:00:00 2001
From: Jai Sharma <jai@jai.moe>
Date: Wed, 4 May 2022 14:43:40 +0100
Subject: [PATCH] Ensure focus is directed to `ChatTextBox` from `ChatOverlay`
 and add tests

---
 .../Visual/Online/TestSceneChatOverlayV2.cs   | 27 ++++++++++++++++++-
 osu.Game/Overlays/ChatOverlayV2.cs            |  8 ++++--
 2 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/osu.Game.Tests/Visual/Online/TestSceneChatOverlayV2.cs b/osu.Game.Tests/Visual/Online/TestSceneChatOverlayV2.cs
index c7bb6760c7..9d4de11c5a 100644
--- a/osu.Game.Tests/Visual/Online/TestSceneChatOverlayV2.cs
+++ b/osu.Game.Tests/Visual/Online/TestSceneChatOverlayV2.cs
@@ -144,7 +144,7 @@ namespace osu.Game.Tests.Visual.Online
         {
             AddStep("Show overlay", () => chatOverlay.Show());
             AddAssert("Listing is visible", () => listingVisibility == Visibility.Visible);
-            AddStep("Search for 'number 2'", () => chatOverlay.ChildrenOfType<ChatTextBox>().Single().Text = "number 2");
+            AddStep("Search for 'number 2'", () => chatOverlayTextBox.Text = "number 2");
             AddUntilStep("Only channel 2 visibile", () =>
             {
                 IEnumerable<ChannelListingItem> listingItems = chatOverlay.ChildrenOfType<ChannelListingItem>()
@@ -325,6 +325,28 @@ namespace osu.Game.Tests.Visual.Online
             AddStep("Highlight message", () => chatOverlay.HighlightMessage(message, testChannel1));
         }
 
+        [Test]
+        public void TextBoxRetainsFocus()
+        {
+            AddStep("Show overlay", () => chatOverlay.Show());
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Join channel 1", () => channelManager.JoinChannel(testChannel1));
+            AddStep("Select channel 1", () => clickDrawable(getChannelListItem(testChannel1)));
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Click selector", () => clickDrawable(chatOverlay.ChildrenOfType<ChannelListSelector>().Single()));
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Click listing", () => clickDrawable(chatOverlay.ChildrenOfType<ChannelListing>().Single()));
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Click drawable channel", () => clickDrawable(chatOverlay.ChildrenOfType<DrawableChannel>().Single()));
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Click channel list", () => clickDrawable(chatOverlay.ChildrenOfType<ChannelList>().Single()));
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Click top bar", () => clickDrawable(chatOverlay.ChildrenOfType<ChatOverlayTopBar>().Single()));
+            AddAssert("TextBox is focused", () => InputManager.FocusedDrawable == chatOverlayTextBox);
+            AddStep("Hide overlay", () => chatOverlay.Hide());
+            AddAssert("TextBox is not focused", () => InputManager.FocusedDrawable == null);
+        }
+
         private Visibility listingVisibility =>
             chatOverlay.ChildrenOfType<ChannelListing>().Single().State.Value;
 
@@ -337,6 +359,9 @@ namespace osu.Game.Tests.Visual.Online
         private ChannelListItem getChannelListItem(Channel channel) =>
             chatOverlay.ChildrenOfType<ChannelListItem>().Single(item => item.Channel == channel);
 
+        private ChatTextBox chatOverlayTextBox =>
+            chatOverlay.ChildrenOfType<ChatTextBox>().Single();
+
         private void clickDrawable(Drawable d)
         {
             InputManager.MoveMouseTo(d);
diff --git a/osu.Game/Overlays/ChatOverlayV2.cs b/osu.Game/Overlays/ChatOverlayV2.cs
index f6190bbe20..658a28bfdb 100644
--- a/osu.Game/Overlays/ChatOverlayV2.cs
+++ b/osu.Game/Overlays/ChatOverlayV2.cs
@@ -218,8 +218,6 @@ namespace osu.Game.Overlays
 
             this.MoveToY(0, transition_length, Easing.OutQuint);
             this.FadeIn(transition_length, Easing.OutQuint);
-
-            textBar.TextBoxTakeFocus();
         }
 
         protected override void PopOut()
@@ -232,6 +230,12 @@ namespace osu.Game.Overlays
             textBar.TextBoxKillFocus();
         }
 
+        protected override void OnFocus(FocusEvent e)
+        {
+            textBar.TextBoxTakeFocus();
+            base.OnFocus(e);
+        }
+
         private void currentChannelChanged(ValueChangedEvent<Channel> e)
         {
             Channel? newChannel = e.NewValue;