Improve multiplayer room status handling

osu.Game.Tests/Visual/Multiplayer/TestSceneDrawableRoom.cs

@@ -14,7 +14,6 @@
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Online.Multiplayer;
 using osu.Game.Online.Rooms;
-using osu.Game.Online.Rooms.RoomStatuses;
 using osu.Game.Overlays;
 using osu.Game.Rulesets.Osu;
 using osu.Game.Screens.OnlinePlay.Lounge;
@@ -76,7 +75,6 @@ public void TestMultipleStatuses()
                         createLoungeRoom(new Room
                         {
                             Name = "Multiplayer room",
-                            Status = new RoomStatusOpen(),
                             EndDate = DateTimeOffset.Now.AddDays(1),
                             Type = MatchType.HeadToHead,
                             Playlist = [item1],
@@ -85,7 +83,6 @@ public void TestMultipleStatuses()
                         createLoungeRoom(new Room
                         {
                             Name = "Private room",
-                            Status = new RoomStatusOpenPrivate(),
                             Password = "*",
                             EndDate = DateTimeOffset.Now.AddDays(1),
                             Type = MatchType.HeadToHead,
@@ -95,36 +92,38 @@ public void TestMultipleStatuses()
                         createLoungeRoom(new Room
                         {
                             Name = "Playlist room with multiple beatmaps",
-                            Status = new RoomStatusPlaying(),
+                            Status = RoomStatus.Playing,
                             EndDate = DateTimeOffset.Now.AddDays(1),
                             Playlist = [item1, item2],
                             CurrentPlaylistItem = item1
                         }),
                         createLoungeRoom(new Room
                         {
-                            Name = "Finished room",
-                            Status = new RoomStatusEnded(),
+                            Name = "Closing soon",
+                            EndDate = DateTimeOffset.Now.AddSeconds(5),
+                        }),
+                        createLoungeRoom(new Room
+                        {
+                            Name = "Closed room",
                             EndDate = DateTimeOffset.Now,
                         }),
                         createLoungeRoom(new Room
                         {
                             Name = "Spotlight room",
-                            Status = new RoomStatusOpen(),
                             Category = RoomCategory.Spotlight,
                         }),
                         createLoungeRoom(new Room
                         {
                             Name = "Featured artist room",
-                            Status = new RoomStatusOpen(),
                             Category = RoomCategory.FeaturedArtist,
                         }),
                     }
                 };
             });
 
-            AddUntilStep("wait for panel load", () => rooms.Count == 6);
+            AddUntilStep("wait for panel load", () => rooms.Count == 7);
             AddUntilStep("correct status text", () => rooms.ChildrenOfType<OsuSpriteText>().Count(s => s.Text.ToString().StartsWith("Currently playing", StringComparison.Ordinal)) == 2);
-            AddUntilStep("correct status text", () => rooms.ChildrenOfType<OsuSpriteText>().Count(s => s.Text.ToString().StartsWith("Ready to play", StringComparison.Ordinal)) == 4);
+            AddUntilStep("correct status text", () => rooms.ChildrenOfType<OsuSpriteText>().Count(s => s.Text.ToString().StartsWith("Ready to play", StringComparison.Ordinal)) == 5);
         }
 
         [Test]
@@ -136,7 +135,6 @@ public void TestEnableAndDisablePassword()
             AddStep("create room", () => Child = drawableRoom = createLoungeRoom(room = new Room
             {
                 Name = "Room with password",
-                Status = new RoomStatusOpen(),
                 Type = MatchType.HeadToHead,
             }));
 

osu.Game/Graphics/OsuColour.cs

@@ -195,6 +195,27 @@ public Color4 ForModType(ModType modType)
             }
         }
 
+        /// <summary>
+        /// Retrieves the accent colour representing a <see cref="Room"/>'s current status.
+        /// </summary>
+        public Color4 ForRoomStatus(Room room)
+        {
+            if (room.HasEnded)
+                return YellowDarker;
+
+            switch (room.Status)
+            {
+                case RoomStatus.Playing:
+                    return Purple;
+
+                default:
+                    if (room.HasPassword)
+                        return GreenDark;
+
+                    return GreenLight;
+            }
+        }
+
         /// <summary>
         /// Retrieves colour for a <see cref="RankingTier"/>.
         /// See https://www.figma.com/file/YHWhp9wZ089YXgB7pe6L1k/Tier-Colours

osu.Game/Localisation/RoomStatusPillStrings.cs

@@ -0,0 +1,34 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using osu.Framework.Localisation;
+
+namespace osu.Game.Localisation
+{
+    public static class RoomStatusPillStrings
+    {
+        private const string prefix = @"osu.Game.Resources.Localisation.RoomStatusPill";
+
+        /// <summary>
+        /// "Ended"
+        /// </summary>
+        public static LocalisableString Ended => new TranslatableString(getKey(@"ended"), @"Ended");
+
+        /// <summary>
+        /// "Playing"
+        /// </summary>
+        public static LocalisableString Playing => new TranslatableString(getKey(@"playing"), @"Playing");
+
+        /// <summary>
+        /// "Open (Private)"
+        /// </summary>
+        public static LocalisableString OpenPrivate => new TranslatableString(getKey(@"open_private"), @"Open (Private)");
+
+        /// <summary>
+        /// "Open"
+        /// </summary>
+        public static LocalisableString Open => new TranslatableString(getKey(@"open"), @"Open");
+
+        private static string getKey(string key) => $@"{prefix}:{key}";
+    }
+}

osu.Game/Online/Multiplayer/MultiplayerClient.cs

@@ -18,7 +18,6 @@
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Online.Multiplayer.Countdown;
 using osu.Game.Online.Rooms;
-using osu.Game.Online.Rooms.RoomStatuses;
 using osu.Game.Overlays.Notifications;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Mods;
@@ -395,15 +394,17 @@ Task IMultiplayerClient.RoomStateChanged(MultiplayerRoomState state)
                 switch (state)
                 {
                     case MultiplayerRoomState.Open:
-                        APIRoom.Status = APIRoom.HasPassword ? new RoomStatusOpenPrivate() : new RoomStatusOpen();
+                        APIRoom.Status = RoomStatus.Idle;
                         break;
 
+                    case MultiplayerRoomState.WaitingForLoad:
                     case MultiplayerRoomState.Playing:
-                        APIRoom.Status = new RoomStatusPlaying();
+                        APIRoom.Status = RoomStatus.Playing;
                         break;
 
                     case MultiplayerRoomState.Closed:
-                        APIRoom.Status = new RoomStatusEnded();
+                        APIRoom.EndDate = DateTimeOffset.Now;
+                        APIRoom.Status = RoomStatus.Idle;
                         break;
                 }
 
@@ -821,7 +822,6 @@ private void updateLocalRoomSettings(MultiplayerRoomSettings settings)
             Room.Settings = settings;
             APIRoom.Name = Room.Settings.Name;
             APIRoom.Password = Room.Settings.Password;
-            APIRoom.Status = string.IsNullOrEmpty(Room.Settings.Password) ? new RoomStatusOpen() : new RoomStatusOpenPrivate();
             APIRoom.Type = Room.Settings.MatchType;
             APIRoom.QueueMode = Room.Settings.QueueMode;
             APIRoom.AutoStartDuration = Room.Settings.AutoStartDuration;

osu.Game/Online/Rooms/Room.cs

@@ -6,12 +6,10 @@
 using System.ComponentModel;
 using System.Linq;
 using System.Runtime.CompilerServices;
-using System.Runtime.Serialization;
 using Newtonsoft.Json;
 using osu.Game.IO.Serialization.Converters;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Online.Multiplayer;
-using osu.Game.Online.Rooms.RoomStatuses;
 
 namespace osu.Game.Online.Rooms
 {
@@ -248,7 +246,7 @@ public int ChannelId
         }
 
         /// <summary>
-        /// The current room status.
+        /// The current status of the room.
         /// </summary>
         public RoomStatus Status
         {
@@ -265,18 +263,6 @@ public RoomAvailability Availability
             set => SetField(ref availability, value);
         }
 
-        [OnDeserialized]
-        private void onDeserialised(StreamingContext context)
-        {
-            // API doesn't populate status so let's do it here.
-            if (EndDate != null && DateTimeOffset.Now >= EndDate)
-                Status = new RoomStatusEnded();
-            else if (HasPassword)
-                Status = new RoomStatusOpenPrivate();
-            else
-                Status = new RoomStatusOpen();
-        }
-
         [JsonProperty("id")]
         private long? roomId;
 
@@ -349,8 +335,9 @@ private void onDeserialised(StreamingContext context)
         [JsonProperty("channel_id")]
         private int channelId;
 
-        // Not serialised (see: GetRoomsRequest).
-        private RoomStatus status = new RoomStatusOpen();
+        [JsonProperty("status")]
+        [JsonConverter(typeof(SnakeCaseStringEnumConverter))]
+        private RoomStatus status;
 
         // Not yet serialised (not implemented).
         private RoomAvailability availability;
@@ -388,6 +375,15 @@ public void CopyFrom(Room other)
             RecentParticipants = other.RecentParticipants;
         }
 
+        /// <summary>
+        /// Whether the room is no longer available.
+        /// </summary>
+        /// <remarks>
+        /// This property does not update in real-time and needs to be queried periodically.
+        /// Subscribe to <see cref="EndDate"/> to be notified of any immediate changes.
+        /// </remarks>
+        public bool HasEnded => DateTimeOffset.Now >= EndDate;
+
         [JsonObject(MemberSerialization.OptIn)]
         public class RoomPlaylistItemStats
         {