1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-19 03:42:55 +08:00

Apply NRT to APIRequest

This commit is contained in:
Dean Herbert 2024-08-30 18:21:30 +09:00
parent dd7133657d
commit 2d745fb67e
No known key found for this signature in database
7 changed files with 17 additions and 21 deletions

View File

@ -1,12 +1,9 @@
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence. // 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. // See the LICENCE file in the repository root for full licence text.
#nullable disable
using System; using System;
using System.Diagnostics; using System.Diagnostics;
using System.Globalization; using System.Globalization;
using JetBrains.Annotations;
using Newtonsoft.Json; using Newtonsoft.Json;
using osu.Framework.Extensions.TypeExtensions; using osu.Framework.Extensions.TypeExtensions;
using osu.Framework.IO.Network; using osu.Framework.IO.Network;
@ -27,18 +24,17 @@ namespace osu.Game.Online.API
/// <summary> /// <summary>
/// The deserialised response object. May be null if the request or deserialisation failed. /// The deserialised response object. May be null if the request or deserialisation failed.
/// </summary> /// </summary>
[CanBeNull] public T? Response { get; private set; }
public T Response { get; private set; }
/// <summary> /// <summary>
/// Invoked on successful completion of an API request. /// Invoked on successful completion of an API request.
/// This will be scheduled to the API's internal scheduler (run on update thread automatically). /// This will be scheduled to the API's internal scheduler (run on update thread automatically).
/// </summary> /// </summary>
public new event APISuccessHandler<T> Success; public new event APISuccessHandler<T>? Success;
protected APIRequest() protected APIRequest()
{ {
base.Success += () => Success?.Invoke(Response); base.Success += () => Success?.Invoke(Response!);
} }
protected override void PostProcess() protected override void PostProcess()
@ -72,28 +68,28 @@ namespace osu.Game.Online.API
protected virtual WebRequest CreateWebRequest() => new OsuWebRequest(Uri); protected virtual WebRequest CreateWebRequest() => new OsuWebRequest(Uri);
protected virtual string Uri => $@"{API.APIEndpointUrl}/api/v2/{Target}"; protected virtual string Uri => $@"{API!.APIEndpointUrl}/api/v2/{Target}";
protected IAPIProvider API; protected IAPIProvider? API;
protected WebRequest WebRequest; protected WebRequest? WebRequest;
/// <summary> /// <summary>
/// The currently logged in user. Note that this will only be populated during <see cref="Perform"/>. /// The currently logged in user. Note that this will only be populated during <see cref="Perform"/>.
/// </summary> /// </summary>
protected APIUser User { get; private set; } protected APIUser? User { get; private set; }
/// <summary> /// <summary>
/// Invoked on successful completion of an API request. /// Invoked on successful completion of an API request.
/// This will be scheduled to the API's internal scheduler (run on update thread automatically). /// This will be scheduled to the API's internal scheduler (run on update thread automatically).
/// </summary> /// </summary>
public event APISuccessHandler Success; public event APISuccessHandler? Success;
/// <summary> /// <summary>
/// Invoked on failure to complete an API request. /// Invoked on failure to complete an API request.
/// This will be scheduled to the API's internal scheduler (run on update thread automatically). /// This will be scheduled to the API's internal scheduler (run on update thread automatically).
/// </summary> /// </summary>
public event APIFailureHandler Failure; public event APIFailureHandler? Failure;
private readonly object completionStateLock = new object(); private readonly object completionStateLock = new object();
@ -210,7 +206,7 @@ namespace osu.Game.Online.API
// in the case of a cancellation we don't care about whether there's an error in the response. // in the case of a cancellation we don't care about whether there's an error in the response.
if (!(e is OperationCanceledException)) if (!(e is OperationCanceledException))
{ {
string responseString = WebRequest?.GetResponseString(); string? responseString = WebRequest?.GetResponseString();
// naive check whether there's an error in the response to avoid unnecessary JSON deserialisation. // naive check whether there's an error in the response to avoid unnecessary JSON deserialisation.
if (!string.IsNullOrEmpty(responseString) && responseString.Contains(@"""error""")) if (!string.IsNullOrEmpty(responseString) && responseString.Contains(@"""error"""))
@ -248,7 +244,7 @@ namespace osu.Game.Online.API
private class DisplayableError private class DisplayableError
{ {
[JsonProperty("error")] [JsonProperty("error")]
public string ErrorMessage { get; set; } public string ErrorMessage { get; set; } = string.Empty;
} }
} }

View File

@ -23,6 +23,6 @@ namespace osu.Game.Online.API.Requests
return req; return req;
} }
protected override string Target => $@"chat/channels/{channel.Id}/users/{User.Id}"; protected override string Target => $@"chat/channels/{channel.Id}/users/{User!.Id}";
} }
} }

View File

@ -23,6 +23,6 @@ namespace osu.Game.Online.API.Requests
return req; return req;
} }
protected override string Target => $@"chat/channels/{channel.Id}/users/{User.Id}"; protected override string Target => $@"chat/channels/{channel.Id}/users/{User!.Id}";
} }
} }

View File

@ -80,7 +80,7 @@ namespace osu.Game.Online.Chat
fetchReq.Success += updates => fetchReq.Success += updates =>
{ {
if (updates?.Presence != null) if (updates.Presence != null)
{ {
foreach (var channel in updates.Presence) foreach (var channel in updates.Presence)
joinChannel(channel); joinChannel(channel);

View File

@ -27,6 +27,6 @@ namespace osu.Game.Online.Rooms
return req; return req;
} }
protected override string Target => $@"rooms/{Room.RoomID.Value}/users/{User.Id}"; protected override string Target => $@"rooms/{Room.RoomID.Value}/users/{User!.Id}";
} }
} }

View File

@ -23,6 +23,6 @@ namespace osu.Game.Online.Rooms
return req; return req;
} }
protected override string Target => $"rooms/{room.RoomID.Value}/users/{User.Id}"; protected override string Target => $"rooms/{room.RoomID.Value}/users/{User!.Id}";
} }
} }

View File

@ -48,7 +48,7 @@ namespace osu.Game.Tests
fetchReq.Success += updates => fetchReq.Success += updates =>
{ {
if (updates?.Presence != null) if (updates.Presence != null)
{ {
foreach (var channel in updates.Presence) foreach (var channel in updates.Presence)
handleChannelJoined(channel); handleChannelJoined(channel);