From f5ba746ae5522e6c1ba34f6a34218491ff4aa626 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 23 Mar 2021 17:31:28 +0900
Subject: [PATCH] Fail all API requests sent to DummyAPIAccess
Until now, API requests sent to dummy API were just lost in the void. In most cases this somehow worked as expected, but any logic which is waiting on a request to finish will potentially never get a response.
Going forward, I'm not 100% sure that every `Wait` on a web response will have local timeout logic (I think there is a certain amount of assumption that this is being managed for us by `APIAccess`), so I've made this change to better handle such cases going forward. Now, rather than nothing happening, requests will trigger a failure via the existing exception logic rather than silently pretending the request never arrived.
---
osu.Game/Online/API/APIRequest.cs | 8 ++++++--
osu.Game/Online/API/DummyAPIAccess.cs | 7 ++++++-
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/osu.Game/Online/API/APIRequest.cs b/osu.Game/Online/API/APIRequest.cs
index a7174324d8..16d1b3ab17 100644
--- a/osu.Game/Online/API/APIRequest.cs
+++ b/osu.Game/Online/API/APIRequest.cs
@@ -181,9 +181,13 @@ namespace osu.Game.Online.API
/// <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
index 943b52db88..3cb22381c1 100644
--- a/osu.Game/Online/API/DummyAPIAccess.cs
+++ b/osu.Game/Online/API/DummyAPIAccess.cs
@@ -55,7 +55,12 @@ namespace osu.Game.Online.API
public virtual void Queue(APIRequest request)
{
- HandleRequest?.Invoke(request);
+ if (HandleRequest != null)
+ HandleRequest.Invoke(request);
+ else
+ // 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);