Display up-to-date online status in user panels

osu.Game.Tests/Online/TestSceneMetadataClient.cs

@@ -0,0 +1,52 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using NUnit.Framework;
+using osu.Framework.Testing;
+using osu.Game.Tests.Visual;
+using osu.Game.Tests.Visual.Metadata;
+
+namespace osu.Game.Tests.Online
+{
+    [TestFixture]
+    [HeadlessTest]
+    public partial class TestSceneMetadataClient : OsuTestScene
+    {
+        private TestMetadataClient client = null!;
+
+        [SetUp]
+        public void Setup() => Schedule(() =>
+        {
+            Child = client = new TestMetadataClient();
+        });
+
+        [Test]
+        public void TestWatchingMultipleTimesInvokesServerMethodsOnce()
+        {
+            int countBegin = 0;
+            int countEnd = 0;
+
+            IDisposable token1 = null!;
+            IDisposable token2 = null!;
+
+            AddStep("setup", () =>
+            {
+                client.OnBeginWatchingUserPresence += () => countBegin++;
+                client.OnEndWatchingUserPresence += () => countEnd++;
+            });
+
+            AddStep("begin watching presence (1)", () => token1 = client.BeginWatchingUserPresence());
+            AddAssert("server method invoked once", () => countBegin, () => Is.EqualTo(1));
+
+            AddStep("begin watching presence (2)", () => token2 = client.BeginWatchingUserPresence());
+            AddAssert("server method not invoked a second time", () => countBegin, () => Is.EqualTo(1));
+
+            AddStep("end watching presence (1)", () => token1.Dispose());
+            AddAssert("server method not invoked", () => countEnd, () => Is.EqualTo(0));
+
+            AddStep("end watching presence (2)", () => token2.Dispose());
+            AddAssert("server method invoked once", () => countEnd, () => Is.EqualTo(1));
+        }
+    }
+}

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

@@ -65,7 +65,9 @@ public void SetUpSteps()
         [Test]
         public void TestBasicDisplay()
         {
-            AddStep("Begin watching user presence", () => metadataClient.BeginWatchingUserPresence());
+            IDisposable token = null!;
+
+            AddStep("Begin watching user presence", () => token = metadataClient.BeginWatchingUserPresence());
             AddStep("Add online user", () => metadataClient.UserPresenceUpdated(streamingUser.Id, new UserPresence { Status = UserStatus.Online, Activity = new UserActivity.ChoosingBeatmap() }));
             AddUntilStep("Panel loaded", () => currentlyOnline.ChildrenOfType<UserGridPanel>().FirstOrDefault()?.User.Id == 2);
             AddAssert("Spectate button disabled", () => currentlyOnline.ChildrenOfType<PurpleRoundedButton>().First().Enabled.Value, () => Is.False);
@@ -78,22 +80,24 @@ public void TestBasicDisplay()
 
             AddStep("Remove playing user", () => metadataClient.UserPresenceUpdated(streamingUser.Id, null));
             AddUntilStep("Panel no longer present", () => !currentlyOnline.ChildrenOfType<UserGridPanel>().Any());
-            AddStep("End watching user presence", () => metadataClient.EndWatchingUserPresence());
+            AddStep("End watching user presence", () => token.Dispose());
         }
 
         [Test]
         public void TestUserWasPlayingBeforeWatchingUserPresence()
         {
+            IDisposable token = null!;
+
             AddStep("User began playing", () => spectatorClient.SendStartPlay(streamingUser.Id, 0));
-            AddStep("Begin watching user presence", () => metadataClient.BeginWatchingUserPresence());
+            AddStep("Begin watching user presence", () => token = metadataClient.BeginWatchingUserPresence());
             AddStep("Add online user", () => metadataClient.UserPresenceUpdated(streamingUser.Id, new UserPresence { Status = UserStatus.Online, Activity = new UserActivity.ChoosingBeatmap() }));
             AddUntilStep("Panel loaded", () => currentlyOnline.ChildrenOfType<UserGridPanel>().FirstOrDefault()?.User.Id == 2);
             AddAssert("Spectate button enabled", () => currentlyOnline.ChildrenOfType<PurpleRoundedButton>().First().Enabled.Value, () => Is.True);
 
             AddStep("User finished playing", () => spectatorClient.SendEndPlay(streamingUser.Id));
             AddAssert("Spectate button disabled", () => currentlyOnline.ChildrenOfType<PurpleRoundedButton>().First().Enabled.Value, () => Is.False);
             AddStep("Remove playing user", () => metadataClient.UserPresenceUpdated(streamingUser.Id, null));
-            AddStep("End watching user presence", () => metadataClient.EndWatchingUserPresence());
+            AddStep("End watching user presence", () => token.Dispose());
         }
 
         internal partial class TestUserLookupCache : UserLookupCache