Merge pull request #16944 from peppy/rooms-request-faster

Update playlists/multiplayer to use new compact response

osu.Game/Online/API/APIAccess.cs

@@ -36,6 +36,8 @@ namespace osu.Game.Online.API
 
         public string WebsiteRootUrl { get; }
 
+        public int APIVersion => 20220217; // We may want to pull this from the game version eventually.
+
         public Exception LastLoginError { get; private set; }
 
         public string ProvidedUsername { get; private set; }

osu.Game/Online/API/APIRequest.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using System.Globalization;
 using JetBrains.Annotations;
 using Newtonsoft.Json;
 using osu.Framework.IO.Network;
@@ -112,6 +113,9 @@ namespace osu.Game.Online.API
             WebRequest = CreateWebRequest();
             WebRequest.Failed += Fail;
             WebRequest.AllowRetryOnTimeout = false;
+
+            WebRequest.AddHeader("x-api-version", API.APIVersion.ToString(CultureInfo.InvariantCulture));
+
             if (!string.IsNullOrEmpty(API.AccessToken))
                 WebRequest.AddHeader("Authorization", $"Bearer {API.AccessToken}");
 

osu.Game/Online/API/DummyAPIAccess.cs

@@ -33,6 +33,8 @@ namespace osu.Game.Online.API
 
         public string WebsiteRootUrl => "http://localhost";
 
+        public int APIVersion => int.Parse(DateTime.Now.ToString("yyyyMMdd"));
+
         public Exception LastLoginError { get; private set; }
 
         /// <summary>

osu.Game/Online/API/IAPIProvider.cs

@@ -57,6 +57,11 @@ namespace osu.Game.Online.API
         /// </summary>
         string WebsiteRootUrl { get; }
 
+        /// <summary>
+        /// The version of the API.
+        /// </summary>
+        int APIVersion { get; }
+
         /// <summary>
         /// The last login error that occurred, if any.
         /// </summary>

osu.Game/Online/API/Requests/Responses/APIUser.cs

@@ -12,6 +12,7 @@ using osu.Game.Users;
 
 namespace osu.Game.Online.API.Requests.Responses
 {
+    [JsonObject(MemberSerialization.OptIn)]
     public class APIUser : IEquatable<APIUser>, IUser
     {
         [JsonProperty(@"id")]

osu.Game/Online/Rooms/PlaylistItem.cs

@@ -62,6 +62,10 @@ namespace osu.Game.Online.Rooms
         [JsonProperty("beatmap_id")]
         private int onlineBeatmapId => Beatmap.OnlineID;
 
+        /// <summary>
+        /// A beatmap representing this playlist item.
+        /// In many cases, this will *not* contain any usable information apart from OnlineID.
+        /// </summary>
         [JsonIgnore]
         public IBeatmapInfo Beatmap { get; set; } = null!;
 

osu.Game/Online/Rooms/Room.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Linq;
-using JetBrains.Annotations;
 using Newtonsoft.Json;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
@@ -15,6 +14,7 @@ using osu.Game.Utils;
 
 namespace osu.Game.Online.Rooms
 {
+    [JsonObject(MemberSerialization.OptIn)]
     public class Room : IDeepCloneable<Room>
     {
         [Cached]
@@ -37,8 +37,19 @@ namespace osu.Game.Online.Rooms
         [JsonProperty("channel_id")]
         public readonly Bindable<int> ChannelId = new Bindable<int>();
 
+        [JsonProperty("current_playlist_item")]
+        [Cached]
+        public readonly Bindable<PlaylistItem> CurrentPlaylistItem = new Bindable<PlaylistItem>();
+
+        [JsonProperty("playlist_item_stats")]
+        [Cached]
+        public readonly Bindable<RoomPlaylistItemStats> PlaylistItemStats = new Bindable<RoomPlaylistItemStats>();
+
+        [JsonProperty("difficulty_range")]
+        [Cached]
+        public readonly Bindable<RoomDifficultyRange> DifficultyRange = new Bindable<RoomDifficultyRange>();
+
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<RoomCategory> Category = new Bindable<RoomCategory>();
 
         // Todo: osu-framework bug (https://github.com/ppy/osu-framework/issues/4106)
@@ -51,19 +62,15 @@ namespace osu.Game.Online.Rooms
         }
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<int?> MaxAttempts = new Bindable<int?>();
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<RoomStatus> Status = new Bindable<RoomStatus>(new RoomStatusOpen());
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<RoomAvailability> Availability = new Bindable<RoomAvailability>();
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<MatchType> Type = new Bindable<MatchType>();
 
         // Todo: osu-framework bug (https://github.com/ppy/osu-framework/issues/4106)
@@ -76,7 +83,6 @@ namespace osu.Game.Online.Rooms
         }
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<QueueMode> QueueMode = new Bindable<QueueMode>();
 
         [JsonConverter(typeof(SnakeCaseStringEnumConverter))]
@@ -88,7 +94,6 @@ namespace osu.Game.Online.Rooms
         }
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<int?> MaxParticipants = new Bindable<int?>();
 
         [Cached]
@@ -113,7 +118,6 @@ namespace osu.Game.Online.Rooms
         public readonly Bindable<string> Password = new Bindable<string>();
 
         [Cached]
-        [JsonIgnore]
         public readonly Bindable<TimeSpan?> Duration = new Bindable<TimeSpan?>();
 
         [JsonProperty("duration")]
@@ -158,6 +162,8 @@ namespace osu.Game.Online.Rooms
             var copy = new Room();
 
             copy.CopyFrom(this);
+
+            // ID must be unset as we use this as a marker for whether this is a client-side (not-yet-created) room or not.
             copy.RoomID.Value = null;
 
             return copy;
@@ -183,6 +189,9 @@ namespace osu.Game.Online.Rooms
             EndDate.Value = other.EndDate.Value;
             UserScore.Value = other.UserScore.Value;
             QueueMode.Value = other.QueueMode.Value;
+            DifficultyRange.Value = other.DifficultyRange.Value;
+            PlaylistItemStats.Value = other.PlaylistItemStats.Value;
+            CurrentPlaylistItem.Value = other.CurrentPlaylistItem.Value;
 
             if (EndDate.Value != null && DateTimeOffset.Now >= EndDate.Value)
                 Status.Value = new RoomStatusEnded();
@@ -211,21 +220,27 @@ namespace osu.Game.Online.Rooms
                 Playlist.RemoveAll(i => i.Expired);
         }
 
-        #region Newtonsoft.Json implicit ShouldSerialize() methods
+        [JsonObject(MemberSerialization.OptIn)]
+        public class RoomPlaylistItemStats
+        {
+            [JsonProperty("count_active")]
+            public int CountActive;
 
-        // The properties in this region are used implicitly by Newtonsoft.Json to not serialise certain fields in some cases.
+            [JsonProperty("count_total")]
-        // They rely on being named exactly the same as the corresponding fields (casing included) and as such should NOT be renamed
+            public int CountTotal;
-        // unless the fields are also renamed.
 
-        [UsedImplicitly]
+            [JsonProperty("ruleset_ids")]
-        public bool ShouldSerializeRoomID() => false;
+            public int[] RulesetIDs;
+        }
 
-        [UsedImplicitly]
+        [JsonObject(MemberSerialization.OptIn)]
-        public bool ShouldSerializeHost() => false;
+        public class RoomDifficultyRange
+        {
+            [JsonProperty("min")]
+            public double Min;
 
-        [UsedImplicitly]
+            [JsonProperty("max")]
-        public bool ShouldSerializeEndDate() => false;
+            public double Max;
-
+        }
-        #endregion
     }
 }

osu.Game/Screens/OnlinePlay/Components/OnlinePlayBackgroundSprite.cs

@@ -23,6 +23,7 @@ namespace osu.Game.Screens.OnlinePlay.Components
         {
             InternalChild = sprite = CreateBackgroundSprite();
 
+            CurrentPlaylistItem.BindValueChanged(_ => updateBeatmap());
             Playlist.CollectionChanged += (_, __) => updateBeatmap();
 
             updateBeatmap();
@@ -30,7 +31,7 @@ namespace osu.Game.Screens.OnlinePlay.Components
 
         private void updateBeatmap()
         {
-            sprite.Beatmap.Value = Playlist.GetCurrentItem()?.Beatmap;
+            sprite.Beatmap.Value = CurrentPlaylistItem.Value?.Beatmap ?? Playlist.GetCurrentItem()?.Beatmap;
         }
 
         protected virtual UpdateableBeatmapBackgroundSprite CreateBackgroundSprite() => new UpdateableBeatmapBackgroundSprite(BeatmapSetCoverType) { RelativeSizeAxes = Axes.Both };

osu.Game/Screens/OnlinePlay/Components/StarRatingRangeDisplay.cs

@@ -2,7 +2,6 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
-using System.Collections.Specialized;
 using System.Linq;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
@@ -75,15 +74,29 @@ namespace osu.Game.Screens.OnlinePlay.Components
         {
             base.LoadComplete();
 
-            Playlist.BindCollectionChanged(updateRange, true);
+            DifficultyRange.BindValueChanged(_ => updateRange());
+            Playlist.BindCollectionChanged((_, __) => updateRange(), true);
         }
 
-        private void updateRange(object sender, NotifyCollectionChangedEventArgs e)
+        private void updateRange()
         {
-            var orderedDifficulties = Playlist.Select(p => p.Beatmap).OrderBy(b => b.StarRating).ToArray();
+            StarDifficulty minDifficulty;
+            StarDifficulty maxDifficulty;
 
-            StarDifficulty minDifficulty = new StarDifficulty(orderedDifficulties.Length > 0 ? orderedDifficulties[0].StarRating : 0, 0);
+            if (DifficultyRange.Value != null)
-            StarDifficulty maxDifficulty = new StarDifficulty(orderedDifficulties.Length > 0 ? orderedDifficulties[^1].StarRating : 0, 0);
+            {
+                minDifficulty = new StarDifficulty(DifficultyRange.Value.Min, 0);
+                maxDifficulty = new StarDifficulty(DifficultyRange.Value.Max, 0);
+            }
+            else
+            {
+                // In multiplayer rooms, the beatmaps of playlist items will not be populated to a point this can be correct.
+                // Either populating them via BeatmapLookupCache or polling the API for the room's DifficultyRange will be required.
+                var orderedDifficulties = Playlist.Select(p => p.Beatmap).OrderBy(b => b.StarRating).ToArray();
+
+                minDifficulty = new StarDifficulty(orderedDifficulties.Length > 0 ? orderedDifficulties[0].StarRating : 0, 0);
+                maxDifficulty = new StarDifficulty(orderedDifficulties.Length > 0 ? orderedDifficulties[^1].StarRating : 0, 0);
+            }
 
             minDisplay.Current.Value = minDifficulty;
             maxDisplay.Current.Value = maxDifficulty;

osu.Game/Screens/OnlinePlay/Lounge/Components/DrawableRoom.cs

@@ -388,7 +388,7 @@ namespace osu.Game.Screens.OnlinePlay.Lounge.Components
             protected override void LoadComplete()
             {
                 base.LoadComplete();
-                SelectedItem.BindValueChanged(onSelectedItemChanged, true);
+                CurrentPlaylistItem.BindValueChanged(onSelectedItemChanged, true);
             }
 
             private CancellationTokenSource beatmapLookupCancellation;

osu.Game/Screens/OnlinePlay/Lounge/Components/PlaylistCountPill.cs

@@ -1,7 +1,7 @@
 // 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.
 
-using System.Collections.Specialized;
+using System.Linq;
 using Humanizer;
 using osu.Framework.Allocation;
 using osu.Framework.Extensions.LocalisationExtensions;
@@ -41,15 +41,22 @@ namespace osu.Game.Screens.OnlinePlay.Lounge.Components
         {
             base.LoadComplete();
 
-            Playlist.BindCollectionChanged(updateCount, true);
+            PlaylistItemStats.BindValueChanged(_ => updateCount());
+            Playlist.BindCollectionChanged((_, __) => updateCount(), true);
         }
 
-        private void updateCount(object sender, NotifyCollectionChangedEventArgs e)
+        private void updateCount()
         {
+            int activeItems = Playlist.Count > 0 || PlaylistItemStats.Value == null
+                // For now, use the playlist as the source of truth if it has any items.
+                // This allows the count to display correctly on the room screen (after joining a room).
+                ? Playlist.Count(i => !i.Expired)
+                : PlaylistItemStats.Value.CountActive;
+
             count.Clear();
-            count.AddText(Playlist.Count.ToLocalisableString(), s => s.Font = s.Font.With(weight: FontWeight.Bold));
+            count.AddText(activeItems.ToLocalisableString(), s => s.Font = s.Font.With(weight: FontWeight.Bold));
             count.AddText(" ");
-            count.AddText("Beatmap".ToQuantity(Playlist.Count, ShowQuantityAs.None));
+            count.AddText("Beatmap".ToQuantity(activeItems, ShowQuantityAs.None));
         }
     }
 }

osu.Game/Screens/OnlinePlay/Lounge/Components/RoomsContainer.cs

@@ -77,7 +77,7 @@ namespace osu.Game.Screens.OnlinePlay.Lounge.Components
                 {
                     bool matchingFilter = true;
 
-                    matchingFilter &= r.Room.Playlist.Count == 0 || criteria.Ruleset == null || r.Room.Playlist.Any(i => i.RulesetID == criteria.Ruleset.OnlineID);
+                    matchingFilter &= criteria.Ruleset == null || r.Room.PlaylistItemStats.Value?.RulesetIDs.Any(id => id == criteria.Ruleset.OnlineID) != false;
 
                     if (!string.IsNullOrEmpty(criteria.SearchString))
                         matchingFilter &= r.FilterTerms.Any(term => term.Contains(criteria.SearchString, StringComparison.InvariantCultureIgnoreCase));

osu.Game/Screens/OnlinePlay/Multiplayer/Match/MultiplayerMatchSettingsOverlay.cs

@@ -343,7 +343,7 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer.Match
                 base.LoadComplete();
 
                 drawablePlaylist.Items.BindTo(Playlist);
-                drawablePlaylist.SelectedItem.BindTo(SelectedItem);
+                drawablePlaylist.SelectedItem.BindTo(CurrentPlaylistItem);
             }
 
             protected override void Update()
@@ -419,7 +419,7 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer.Match
                 if (text.StartsWith(not_found_prefix, StringComparison.Ordinal))
                 {
                     ErrorText.Text = "The selected beatmap is not available online.";
-                    SelectedItem.Value.MarkInvalid();
+                    CurrentPlaylistItem.Value.MarkInvalid();
                 }
                 else
                 {

osu.Game/Screens/OnlinePlay/Multiplayer/Match/MultiplayerReadyButton.cs

@@ -67,7 +67,7 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer.Match
         {
             base.LoadComplete();
 
-            SelectedItem.BindValueChanged(_ => updateState());
+            CurrentPlaylistItem.BindValueChanged(_ => updateState());
         }
 
         protected override void OnRoomUpdated()
@@ -111,7 +111,7 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer.Match
 
             bool enableButton =
                 Room?.State == MultiplayerRoomState.Open
-                && SelectedItem.Value?.ID == Room.Settings.PlaylistItemId
+                && CurrentPlaylistItem.Value?.ID == Room.Settings.PlaylistItemId
                 && !Room.Playlist.Single(i => i.ID == Room.Settings.PlaylistItemId).Expired
                 && !operationInProgress.Value;
 

osu.Game/Screens/OnlinePlay/Multiplayer/Match/Playlist/MultiplayerPlaylist.cs

@@ -52,14 +52,14 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer.Match.Playlist
                         queueList = new MultiplayerQueueList
                         {
                             RelativeSizeAxes = Axes.Both,
-                            SelectedItem = { BindTarget = SelectedItem },
+                            SelectedItem = { BindTarget = CurrentPlaylistItem },
                             RequestEdit = item => RequestEdit?.Invoke(item)
                         },
                         historyList = new MultiplayerHistoryList
                         {
                             RelativeSizeAxes = Axes.Both,
                             Alpha = 0,
-                            SelectedItem = { BindTarget = SelectedItem }
+                            SelectedItem = { BindTarget = CurrentPlaylistItem }
                         }
                     }
                 }

osu.Game/Screens/OnlinePlay/OnlinePlayComposite.cs

@@ -32,9 +32,22 @@ namespace osu.Game.Screens.OnlinePlay
         [Resolved(typeof(Room))]
         protected Bindable<MatchType> Type { get; private set; }
 
+        /// <summary>
+        /// The currently selected item in the <see cref="RoomSubScreen"/>, or the current item from <see cref="Playlist"/>
+        /// if this <see cref="OnlinePlayComposite"/> is not within a <see cref="RoomSubScreen"/>.
+        /// </summary>
+        [Resolved(typeof(Room))]
+        protected Bindable<PlaylistItem> CurrentPlaylistItem { get; private set; }
+
+        [Resolved(typeof(Room))]
+        protected Bindable<Room.RoomPlaylistItemStats> PlaylistItemStats { get; private set; }
+
         [Resolved(typeof(Room))]
         protected BindableList<PlaylistItem> Playlist { get; private set; }
 
+        [Resolved(typeof(Room))]
+        protected Bindable<Room.RoomDifficultyRange> DifficultyRange { get; private set; }
+
         [Resolved(typeof(Room))]
         protected Bindable<RoomCategory> Category { get; private set; }
 
@@ -71,12 +84,6 @@ namespace osu.Game.Screens.OnlinePlay
         [Resolved(CanBeNull = true)]
         private IBindable<PlaylistItem> subScreenSelectedItem { get; set; }
 
-        /// <summary>
-        /// The currently selected item in the <see cref="RoomSubScreen"/>, or the current item from <see cref="Playlist"/>
-        /// if this <see cref="OnlinePlayComposite"/> is not within a <see cref="RoomSubScreen"/>.
-        /// </summary>
-        protected readonly Bindable<PlaylistItem> SelectedItem = new Bindable<PlaylistItem>();
-
         protected override void LoadComplete()
         {
             base.LoadComplete();
@@ -85,9 +92,13 @@ namespace osu.Game.Screens.OnlinePlay
             Playlist.BindCollectionChanged((_, __) => UpdateSelectedItem(), true);
         }
 
-        protected virtual void UpdateSelectedItem()
+        protected void UpdateSelectedItem()
-            => SelectedItem.Value = RoomID.Value == null || subScreenSelectedItem == null
+        {
-                ? Playlist.GetCurrentItem()
+            // null room ID means this is a room in the process of being created.
-                : subScreenSelectedItem.Value;
+            if (RoomID.Value == null)
+                CurrentPlaylistItem.Value = Playlist.GetCurrentItem();
+            else if (subScreenSelectedItem != null)
+                CurrentPlaylistItem.Value = subScreenSelectedItem.Value;
+        }
     }
 }

osu.Game/Tests/Visual/OnlinePlay/TestRoomManager.cs

@@ -43,6 +43,11 @@ namespace osu.Game.Tests.Visual.OnlinePlay
 
                 if (ruleset != null)
                 {
+                    room.PlaylistItemStats.Value = new Room.RoomPlaylistItemStats
+                    {
+                        RulesetIDs = new[] { ruleset.OnlineID },
+                    };
+
                     room.Playlist.Add(new PlaylistItem(new BeatmapInfo { Metadata = new BeatmapMetadata() })
                     {
                         RulesetID = ruleset.OnlineID,