Merge pull request #11782 from peppy/fix-test-signalr-connection-failures

Move HubClientConnector retrieval to IAPIProvider

osu.Game.Tests/Visual/Gameplay/TestSceneSpectator.cs

@@ -12,7 +12,6 @@ using osu.Framework.Testing;
 using osu.Framework.Utils;
 using osu.Game.Beatmaps;
 using osu.Game.Online;
-using osu.Game.Online.API;
 using osu.Game.Online.Spectator;
 using osu.Game.Replays.Legacy;
 using osu.Game.Rulesets.Osu;
@@ -244,8 +243,6 @@ namespace osu.Game.Tests.Visual.Gameplay
             {
             }
 
-            protected override HubClientConnector CreateConnector(string name, string endpoint, IAPIProvider api) => null;
-
             public void StartPlay(int beatmapId)
             {
                 this.beatmapId = beatmapId;

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerGameplayLeaderboard.cs

@@ -13,7 +13,6 @@ using osu.Framework.Testing;
 using osu.Framework.Utils;
 using osu.Game.Database;
 using osu.Game.Online;
-using osu.Game.Online.API;
 using osu.Game.Online.Spectator;
 using osu.Game.Replays.Legacy;
 using osu.Game.Rulesets.Osu.Scoring;
@@ -106,8 +105,6 @@ namespace osu.Game.Tests.Visual.Multiplayer
                 this.totalUsers = totalUsers;
             }
 
-            protected override HubClientConnector CreateConnector(string name, string endpoint, IAPIProvider api) => null;
-
             public void Start(int beatmapId)
             {
                 for (int i = 0; i < totalUsers; i++)

osu.Game/Online/API/APIAccess.cs

@@ -243,6 +243,8 @@ namespace osu.Game.Online.API
             this.password = password;
         }
 
+        public IHubClientConnector GetHubConnector(string clientName, string endpoint) => new HubClientConnector(clientName, endpoint, this);
+
         public RegistrationRequest.RegistrationRequestErrors CreateAccount(string email, string username, string password)
         {
             Debug.Assert(State.Value == APIState.Offline);

osu.Game/Online/API/DummyAPIAccess.cs

@@ -83,6 +83,8 @@ namespace osu.Game.Online.API
             state.Value = APIState.Offline;
         }
 
+        public IHubClientConnector GetHubConnector(string clientName, string endpoint) => null;
+
         public RegistrationRequest.RegistrationRequestErrors CreateAccount(string email, string username, string password)
         {
             Thread.Sleep(200);

osu.Game/Online/API/IAPIProvider.cs

@@ -1,6 +1,8 @@
 // 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.
 
+#nullable enable
+
 using System.Threading.Tasks;
 using osu.Framework.Bindables;
 using osu.Game.Users;
@@ -95,6 +97,13 @@ namespace osu.Game.Online.API
         /// </summary>
         void Logout();
 
+        /// <summary>
+        /// Constructs a new <see cref="IHubClientConnector"/>. May be null if not supported.
+        /// </summary>
+        /// <param name="clientName">The name of the client this connector connects for, used for logging.</param>
+        /// <param name="endpoint">The endpoint to the hub.</param>
+        IHubClientConnector? GetHubConnector(string clientName, string endpoint);
+
         /// <summary>
         /// Create a new user account. This is a blocking operation.
         /// </summary>
@@ -102,6 +111,6 @@ namespace osu.Game.Online.API
         /// <param name="username">The username to create the account with.</param>
         /// <param name="password">The password to create the account with.</param>
         /// <returns>Any errors encoutnered during account creation.</returns>
-        RegistrationRequest.RegistrationRequestErrors CreateAccount(string email, string username, string password);
+        RegistrationRequest.RegistrationRequestErrors? CreateAccount(string email, string username, string password);
     }
 }

osu.Game/Online/HubClientConnector.cs

@@ -16,15 +16,12 @@ using osu.Game.Online.API;
 
 namespace osu.Game.Online
 {
-    /// <summary>
+    public class HubClientConnector : IHubClientConnector
-    /// A component that manages the life cycle of a connection to a SignalR Hub.
-    /// </summary>
-    public class HubClientConnector : IDisposable
     {
         /// <summary>
         /// Invoked whenever a new hub connection is built, to configure it before it's started.
         /// </summary>
-        public Action<HubConnection>? ConfigureConnection;
+        public Action<HubConnection>? ConfigureConnection { get; set; }
 
         private readonly string clientName;
         private readonly string endpoint;

osu.Game/Online/IHubClientConnector.cs

@@ -0,0 +1,34 @@
+// 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.
+
+#nullable enable
+
+using System;
+using Microsoft.AspNetCore.SignalR.Client;
+using osu.Framework.Bindables;
+using osu.Game.Online.API;
+
+namespace osu.Game.Online
+{
+    /// <summary>
+    /// A component that manages the life cycle of a connection to a SignalR Hub.
+    /// Should generally be retrieved from an <see cref="IAPIProvider"/>.
+    /// </summary>
+    public interface IHubClientConnector : IDisposable
+    {
+        /// <summary>
+        /// The current connection opened by this connector.
+        /// </summary>
+        HubConnection? CurrentConnection { get; }
+
+        /// <summary>
+        /// Whether this is connected to the hub, use <see cref="CurrentConnection"/> to access the connection, if this is <c>true</c>.
+        /// </summary>
+        IBindable<bool> IsConnected { get; }
+
+        /// <summary>
+        /// Invoked whenever a new hub connection is built, to configure it before it's started.
+        /// </summary>
+        public Action<HubConnection>? ConfigureConnection { get; set; }
+    }
+}

osu.Game/Online/Multiplayer/MultiplayerClient.cs

@@ -17,7 +17,8 @@ namespace osu.Game.Online.Multiplayer
     public class MultiplayerClient : StatefulMultiplayerClient
     {
         private readonly string endpoint;
-        private HubClientConnector? connector;
+
+        private IHubClientConnector? connector;
 
         public override IBindable<bool> IsConnected { get; } = new BindableBool();
 
@@ -31,9 +32,11 @@ namespace osu.Game.Online.Multiplayer
         [BackgroundDependencyLoader]
         private void load(IAPIProvider api)
         {
-            connector = new HubClientConnector(nameof(MultiplayerClient), endpoint, api)
+            connector = api.GetHubConnector(nameof(MultiplayerClient), endpoint);
+
+            if (connector != null)
             {
-                ConfigureConnection = connection =>
+                connector.ConfigureConnection = connection =>
                 {
                     // this is kind of SILLY
                     // https://github.com/dotnet/aspnetcore/issues/15198
@@ -48,10 +51,10 @@ namespace osu.Game.Online.Multiplayer
                     connection.On(nameof(IMultiplayerClient.ResultsReady), ((IMultiplayerClient)this).ResultsReady);
                     connection.On<int, IEnumerable<APIMod>>(nameof(IMultiplayerClient.UserModsChanged), ((IMultiplayerClient)this).UserModsChanged);
                     connection.On<int, BeatmapAvailability>(nameof(IMultiplayerClient.UserBeatmapAvailabilityChanged), ((IMultiplayerClient)this).UserBeatmapAvailabilityChanged);
-                },
+                };
-            };
 
-            IsConnected.BindTo(connector.IsConnected);
+                IsConnected.BindTo(connector.IsConnected);
+            }
         }
 
         protected override Task<MultiplayerRoom> JoinRoom(long roomId)

osu.Game/Online/Spectator/SpectatorStreamingClient.cs

@@ -33,7 +33,7 @@ namespace osu.Game.Online.Spectator
         private readonly string endpoint;
 
         [CanBeNull]
-        private HubClientConnector connector;
+        private IHubClientConnector connector;
 
         private readonly IBindable<bool> isConnected = new BindableBool();
 
@@ -86,7 +86,7 @@ namespace osu.Game.Online.Spectator
         [BackgroundDependencyLoader]
         private void load(IAPIProvider api)
         {
-            connector = CreateConnector(nameof(SpectatorStreamingClient), endpoint, api);
+            connector = api.GetHubConnector(nameof(SpectatorStreamingClient), endpoint);
 
             if (connector != null)
             {
@@ -129,8 +129,6 @@ namespace osu.Game.Online.Spectator
             }
         }
 
-        protected virtual HubClientConnector CreateConnector(string name, string endpoint, IAPIProvider api) => new HubClientConnector(name, endpoint, api);
-
         Task ISpectatorClient.UserBeganPlaying(int userId, SpectatorState state)
         {
             if (!playingUsers.Contains(userId))