Merge pull request ppy#12151 from peppy/fail-dummy-api-requests

Fail all API requests sent to DummyAPIAccess
RizonFTW · Mar 23, 2021 · bb6e50e · bb6e50e
2 parents ade5421 + 578128f
commit bb6e50e
Show file tree

Hide file tree

Showing 12 changed files with 88 additions and 30 deletions.
diff --git a/osu.Game.Tests/Online/TestDummyAPIRequestHandling.cs b/osu.Game.Tests/Online/TestDummyAPIRequestHandling.cs
@@ -23,8 +23,10 @@ public void TestGenericRequestHandling()
                 {
                     case CommentVoteRequest cRequest:
                         cRequest.TriggerSuccess(new CommentBundle());
-                        break;
+                        return true;
                 }
+
+                return false;
             });
 
             CommentVoteRequest request = null;
@@ -108,8 +110,10 @@ private void registerHandler()
                 {
                     case LeaveChannelRequest cRequest:
                         cRequest.TriggerSuccess();
-                        break;
+                        return true;
                 }
+
+                return false;
             });
         }
     }

diff --git a/osu.Game.Tests/Visual/Background/TestSceneSeasonalBackgroundLoader.cs b/osu.Game.Tests/Visual/Background/TestSceneSeasonalBackgroundLoader.cs
@@ -135,13 +135,15 @@ private void registerBackgroundsResponse(DateTimeOffset endDate)
                 dummyAPI.HandleRequest = request =>
                 {
                     if (dummyAPI.State.Value != APIState.Online || !(request is GetSeasonalBackgroundsRequest backgroundsRequest))
-                        return;
+                        return false;
 
                     backgroundsRequest.TriggerSuccess(new APISeasonalBackgrounds
                     {
                         Backgrounds = seasonal_background_urls.Select(url => new APISeasonalBackground { Url = url }).ToList(),
                         EndDate = endDate
                     });
+
+                    return true;
                 };
             });
 

diff --git a/osu.Game.Tests/Visual/Online/TestSceneBeatmapListingOverlay.cs b/osu.Game.Tests/Visual/Online/TestSceneBeatmapListingOverlay.cs
@@ -30,13 +30,14 @@ private void load()
 
             ((DummyAPIAccess)API).HandleRequest = req =>
             {
-                if (req is SearchBeatmapSetsRequest searchBeatmapSetsRequest)
+                if (!(req is SearchBeatmapSetsRequest searchBeatmapSetsRequest)) return false;
+
+                searchBeatmapSetsRequest.TriggerSuccess(new SearchBeatmapSetsResponse
                 {
-                    searchBeatmapSetsRequest.TriggerSuccess(new SearchBeatmapSetsResponse
-                    {
-                        BeatmapSets = setsForResponse,
-                    });
-                }
+                    BeatmapSets = setsForResponse,
+                });
+
+                return true;
             };
         }
 

diff --git a/osu.Game.Tests/Visual/Online/TestSceneChangelogOverlay.cs b/osu.Game.Tests/Visual/Online/TestSceneChangelogOverlay.cs
@@ -63,13 +63,15 @@ public void SetUp() => Schedule(() =>
                             Builds = builds.Values.ToList()
                         };
                         changelogRequest.TriggerSuccess(changelogResponse);
-                        break;
+                        return true;
 
                     case GetChangelogBuildRequest buildRequest:
                         if (requestedBuild != null)
                             buildRequest.TriggerSuccess(requestedBuild);
-                        break;
+                        return true;
                 }
+
+                return false;
             };
 
             Child = changelog = new TestChangelogOverlay();

diff --git a/osu.Game.Tests/Visual/Online/TestSceneChatOverlay.cs b/osu.Game.Tests/Visual/Online/TestSceneChatOverlay.cs
@@ -11,6 +11,8 @@
 using osu.Framework.Graphics.UserInterface;
 using osu.Framework.Testing;
 using osu.Game.Graphics.UserInterface;
+using osu.Game.Online.API;
+using osu.Game.Online.API.Requests;
 using osu.Game.Online.Chat;
 using osu.Game.Overlays;
 using osu.Game.Overlays.Chat.Selection;
@@ -64,6 +66,24 @@ public void Setup()
             });
         }
 
+        [SetUpSteps]
+        public void SetUpSteps()
+        {
+            AddStep("register request handling", () =>
+            {
+                ((DummyAPIAccess)API).HandleRequest = req =>
+                {
+                    switch (req)
+                    {
+                        case JoinChannelRequest _:
+                            return true;
+                    }
+
+                    return false;
+                };
+            });
+        }
+
         [Test]
         public void TestHideOverlay()
         {

diff --git a/osu.Game.Tests/Visual/Online/TestSceneCommentsContainer.cs b/osu.Game.Tests/Visual/Online/TestSceneCommentsContainer.cs
@@ -85,9 +85,10 @@ private void setUpCommentsResponse(CommentBundle commentBundle)
                 dummyAPI.HandleRequest = request =>
                 {
                     if (!(request is GetCommentsRequest getCommentsRequest))
-                        return;
+                        return false;
 
                     getCommentsRequest.TriggerSuccess(commentBundle);
+                    return true;
                 };
             });
 

diff --git a/osu.Game.Tests/Visual/Online/TestSceneNewsOverlay.cs b/osu.Game.Tests/Visual/Online/TestSceneNewsOverlay.cs
@@ -33,9 +33,10 @@ private void setUpNewsResponse(GetNewsResponse r)
                 dummyAPI.HandleRequest = request =>
                 {
                     if (!(request is GetNewsRequest getNewsRequest))
-                        return;
+                        return false;
 
                     getNewsRequest.TriggerSuccess(r);
+                    return true;
                 };
             });
 

diff --git a/osu.Game.Tests/Visual/Playlists/TestScenePlaylistsResultsScreen.cs b/osu.Game.Tests/Visual/Playlists/TestScenePlaylistsResultsScreen.cs
@@ -170,6 +170,17 @@ private void waitForDisplay()
 
         private void bindHandler(bool delayed = false, ScoreInfo userScore = null, bool failRequests = false) => ((DummyAPIAccess)API).HandleRequest = request =>
         {
+            // pre-check for requests we should be handling (as they are scheduled below).
+            switch (request)
+            {
+                case ShowPlaylistUserScoreRequest _:
+                case IndexPlaylistScoresRequest _:
+                    break;
+
+                default:
+                    return false;
+            }
+
             requestComplete = false;
 
             double delay = delayed ? 3000 : 0;
@@ -196,6 +207,8 @@ private void bindHandler(bool delayed = false, ScoreInfo userScore = null, bool
                         break;
                 }
             }, delay);
+
+            return true;
         };
 
         private void triggerSuccess<T>(APIRequest<T> req, T result)

diff --git a/osu.Game.Tests/Visual/SongSelect/TestSceneBeatmapRecommendations.cs b/osu.Game.Tests/Visual/SongSelect/TestSceneBeatmapRecommendations.cs
@@ -32,8 +32,10 @@ public override void SetUpSteps()
                     {
                         case GetUserRequest userRequest:
                             userRequest.TriggerSuccess(getUser(userRequest.Ruleset.ID));
-                            break;
+                            return true;
                     }
+
+                    return false;
                 };
             });
 

diff --git a/osu.Game/Online/API/APIRequest.cs b/osu.Game/Online/API/APIRequest.cs
@@ -131,8 +131,11 @@ protected virtual void PostProcess()
         {
         }
 
+        private bool succeeded;
+
         internal virtual void TriggerSuccess()
         {
+            succeeded = true;
             Success?.Invoke();
         }
 
@@ -145,10 +148,7 @@ internal void TriggerFailure(Exception e)
 
         public void Fail(Exception e)
         {
-            if (WebRequest?.Completed == true)
-                return;
-
-            if (cancelled)
+            if (succeeded || cancelled)
                 return;
 
             cancelled = true;
@@ -181,9 +181,13 @@ public void Fail(Exception e)
         /// <returns>Whether we are in a failed or cancelled state.</returns>
         private bool checkAndScheduleFailure()
         {
-            if (API == null || pendingFailure == null) return cancelled;
+            if (pendingFailure == null) return cancelled;
+
+            if (API == null)
+                pendingFailure();
+            else
+                API.Schedule(pendingFailure);
 
-            API.Schedule(pendingFailure);
             pendingFailure = null;
             return true;
         }

diff --git a/osu.Game/Online/API/DummyAPIAccess.cs b/osu.Game/Online/API/DummyAPIAccess.cs
@@ -34,8 +34,9 @@ public class DummyAPIAccess : Component, IAPIProvider
 
         /// <summary>
         /// Provide handling logic for an arbitrary API request.
+        /// Should return true is a request was handled. If null or false return, the request will be failed with a <see cref="NotSupportedException"/>.
         /// </summary>
-        public Action<APIRequest> HandleRequest;
+        public Func<APIRequest, bool> HandleRequest;
 
         private readonly Bindable<APIState> state = new Bindable<APIState>(APIState.Online);
 
@@ -55,7 +56,12 @@ public DummyAPIAccess()
 
         public virtual void Queue(APIRequest request)
         {
-            HandleRequest?.Invoke(request);
+            if (HandleRequest?.Invoke(request) != true)
+            {
+                // this will fail due to not receiving an APIAccess, and trigger a failure on the request.
+                // this is intended - any request in testing that needs non-failures should use HandleRequest.
+                request.Perform(this);
+            }
         }
 
         public void Perform(APIRequest request) => HandleRequest?.Invoke(request);

diff --git a/osu.Game/Tests/Visual/Multiplayer/TestMultiplayerRoomManager.cs b/osu.Game/Tests/Visual/Multiplayer/TestMultiplayerRoomManager.cs
@@ -52,15 +52,15 @@ protected override void LoadComplete()
 
                         Rooms.Add(createdRoom);
                         createRoomRequest.TriggerSuccess(createdRoom);
-                        break;
+                        return true;
 
                     case JoinRoomRequest joinRoomRequest:
                         joinRoomRequest.TriggerSuccess();
-                        break;
+                        return true;
 
                     case PartRoomRequest partRoomRequest:
                         partRoomRequest.TriggerSuccess();
-                        break;
+                        return true;
 
                     case GetRoomsRequest getRoomsRequest:
                         var roomsWithoutParticipants = new List<Room>();
@@ -76,11 +76,11 @@ protected override void LoadComplete()
                         }
 
                         getRoomsRequest.TriggerSuccess(roomsWithoutParticipants);
-                        break;
+                        return true;
 
                     case GetRoomRequest getRoomRequest:
                         getRoomRequest.TriggerSuccess(Rooms.Single(r => r.RoomID.Value == getRoomRequest.RoomId));
-                        break;
+                        return true;
 
                     case GetBeatmapSetRequest getBeatmapSetRequest:
                         var onlineReq = new GetBeatmapSetRequest(getBeatmapSetRequest.ID, getBeatmapSetRequest.Type);
@@ -89,11 +89,11 @@ protected override void LoadComplete()
 
                         // Get the online API from the game's dependencies.
                         game.Dependencies.Get<IAPIProvider>().Queue(onlineReq);
-                        break;
+                        return true;
 
                     case CreateRoomScoreRequest createRoomScoreRequest:
                         createRoomScoreRequest.TriggerSuccess(new APIScoreToken { ID = 1 });
-                        break;
+                        return true;
 
                     case SubmitRoomScoreRequest submitRoomScoreRequest:
                         submitRoomScoreRequest.TriggerSuccess(new MultiplayerScore
@@ -108,8 +108,10 @@ protected override void LoadComplete()
                             User = api.LocalUser.Value,
                             Statistics = new Dictionary<HitResult, int>()
                         });
-                        break;
+                        return true;
                 }
+
+                return false;
             };
         }