Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix double binding causing game crash after API enters failing state #27754

Merged
merged 3 commits into from
Mar 29, 2024
Merged

Fix double binding causing game crash after API enters failing state #27754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c51a2e1
Add test coverage of crash scenario
peppy Mar 29, 2024
fef8afb
Fix double binding causing game crash after API enters failing state
peppy Mar 29, 2024
d9cf5b5
Fix bindable not being correctly re-bound across local user changes
peppy Mar 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions osu.Game.Tests/Visual/Menus/TestSceneLoginOverlay.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
using osu.Game.Overlays;
using osu.Game.Overlays.Login;
using osu.Game.Overlays.Settings;
using osu.Game.Users;
using osu.Game.Users.Drawables;
using osuTK.Input;

Expand Down Expand Up @@ -72,9 +73,24 @@ public void TestLoginSuccess()

return false;
});

AddStep("enter code", () => loginOverlay.ChildrenOfType<OsuTextBox>().First().Text = "88800088");
assertAPIState(APIState.Online);
assertDropdownState(UserAction.Online);

AddStep("set failing", () => { dummyAPI.SetState(APIState.Failing); });
AddStep("return to online", () => { dummyAPI.SetState(APIState.Online); });

AddStep("clear handler", () => dummyAPI.HandleRequest = null);

assertDropdownState(UserAction.Online);
AddStep("change user state", () => dummyAPI.LocalUser.Value.Status.Value = UserStatus.DoNotDisturb);
assertDropdownState(UserAction.DoNotDisturb);
}

private void assertDropdownState(UserAction state)
{
AddAssert($"dropdown state is {state}", () => loginOverlay.ChildrenOfType<UserDropdown>().First().Current.Value, () => Is.EqualTo(state));
}

private void assertAPIState(APIState expected) =>
Expand Down
28 changes: 21 additions & 7 deletions osu.Game/Overlays/Login/LoginPanel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
using osu.Game.Graphics.UserInterface;
using osu.Game.Localisation;
using osu.Game.Online.API;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Overlays.Settings;
using osu.Game.Users;
using osuTK;
Expand All @@ -30,15 +31,17 @@ public partial class LoginPanel : Container
[Resolved]
private OsuColour colours { get; set; } = null!;

private UserDropdown dropdown = null!;
private UserDropdown? dropdown;

/// <summary>
/// Called to request a hide of a parent displaying this container.
/// </summary>
public Action? RequestHide;

private IBindable<APIUser> user = null!;
private readonly Bindable<UserStatus?> status = new Bindable<UserStatus?>();

private readonly IBindable<APIState> apiState = new Bindable<APIState>();
private readonly Bindable<UserStatus?> userStatus = new Bindable<UserStatus?>();

[Resolved]
private IAPIProvider api { get; set; } = null!;
Expand All @@ -61,11 +64,21 @@ public LoginPanel()
AutoSizeAxes = Axes.Y;
}

[BackgroundDependencyLoader]
private void load()
protected override void LoadComplete()
{
base.LoadComplete();

apiState.BindTo(api.State);
apiState.BindValueChanged(onlineStateChanged, true);

user = api.LocalUser.GetBoundCopy();
user.BindValueChanged(u =>
{
status.UnbindBindings();
status.BindTo(u.NewValue.Status);
}, true);

status.BindValueChanged(e => updateDropdownCurrent(e.NewValue), true);
}

private void onlineStateChanged(ValueChangedEvent<APIState> state) => Schedule(() =>
Expand Down Expand Up @@ -144,9 +157,6 @@ private void load()
},
};

userStatus.BindTo(api.LocalUser.Value.Status);
userStatus.BindValueChanged(e => updateDropdownCurrent(e.NewValue), true);

dropdown.Current.BindValueChanged(action =>
{
switch (action.NewValue)
Expand All @@ -171,6 +181,7 @@ private void load()
break;
}
}, true);

break;
}

Expand All @@ -180,6 +191,9 @@ private void load()

private void updateDropdownCurrent(UserStatus? status)
{
if (dropdown == null)
return;

switch (status)
{
case UserStatus.Online:
Expand Down