From 66a01d1ed29a261a0b5a490eef1e63b0177d2a5c Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Mon, 20 Jun 2022 19:48:46 +0900
Subject: [PATCH] Allow song select to refresh the global `WorkingBeatmap`
 after an external update

---
 osu.Game/Beatmaps/BeatmapManager.cs       |  6 ++++++
 osu.Game/Beatmaps/IWorkingBeatmapCache.cs |  4 ++++
 osu.Game/Beatmaps/WorkingBeatmapCache.cs  |  3 +++
 osu.Game/Screens/Select/SongSelect.cs     | 18 ++++++++++++++++++
 4 files changed, 31 insertions(+)

diff --git a/osu.Game/Beatmaps/BeatmapManager.cs b/osu.Game/Beatmaps/BeatmapManager.cs
index effa0ab094..ff176484b6 100644
--- a/osu.Game/Beatmaps/BeatmapManager.cs
+++ b/osu.Game/Beatmaps/BeatmapManager.cs
@@ -453,6 +453,12 @@ namespace osu.Game.Beatmaps
         void IWorkingBeatmapCache.Invalidate(BeatmapSetInfo beatmapSetInfo) => workingBeatmapCache.Invalidate(beatmapSetInfo);
         void IWorkingBeatmapCache.Invalidate(BeatmapInfo beatmapInfo) => workingBeatmapCache.Invalidate(beatmapInfo);
 
+        public event Action<WorkingBeatmap>? OnInvalidated
+        {
+            add => workingBeatmapCache.OnInvalidated += value;
+            remove => workingBeatmapCache.OnInvalidated -= value;
+        }
+
         public override bool IsAvailableLocally(BeatmapSetInfo model) => Realm.Run(realm => realm.All<BeatmapSetInfo>().Any(s => s.OnlineID == model.OnlineID));
 
         #endregion
diff --git a/osu.Game/Beatmaps/IWorkingBeatmapCache.cs b/osu.Game/Beatmaps/IWorkingBeatmapCache.cs
index ad9cac6957..36c53fce99 100644
--- a/osu.Game/Beatmaps/IWorkingBeatmapCache.cs
+++ b/osu.Game/Beatmaps/IWorkingBeatmapCache.cs
@@ -3,6 +3,8 @@
 
 #nullable disable
 
+using System;
+
 namespace osu.Game.Beatmaps
 {
     public interface IWorkingBeatmapCache
@@ -25,5 +27,7 @@ namespace osu.Game.Beatmaps
         /// </summary>
         /// <param name="beatmapInfo">The beatmap info to invalidate any cached entries for.</param>
         void Invalidate(BeatmapInfo beatmapInfo);
+
+        event Action<WorkingBeatmap> OnInvalidated;
     }
 }
diff --git a/osu.Game/Beatmaps/WorkingBeatmapCache.cs b/osu.Game/Beatmaps/WorkingBeatmapCache.cs
index 4495fb8318..9d31c58709 100644
--- a/osu.Game/Beatmaps/WorkingBeatmapCache.cs
+++ b/osu.Game/Beatmaps/WorkingBeatmapCache.cs
@@ -76,10 +76,13 @@ namespace osu.Game.Beatmaps
                 {
                     Logger.Log($"Invalidating working beatmap cache for {info}");
                     workingCache.Remove(working);
+                    OnInvalidated?.Invoke(working);
                 }
             }
         }
 
+        public event Action<WorkingBeatmap> OnInvalidated;
+
         public virtual WorkingBeatmap GetWorkingBeatmap(BeatmapInfo beatmapInfo)
         {
             if (beatmapInfo?.BeatmapSet == null)
diff --git a/osu.Game/Screens/Select/SongSelect.cs b/osu.Game/Screens/Select/SongSelect.cs
index 41fb55a856..d3635ea553 100644
--- a/osu.Game/Screens/Select/SongSelect.cs
+++ b/osu.Game/Screens/Select/SongSelect.cs
@@ -296,8 +296,24 @@ namespace osu.Game.Screens.Select
             base.LoadComplete();
 
             modSelectOverlayRegistration = OverlayManager?.RegisterBlockingOverlay(ModSelect);
+
+            beatmaps.OnInvalidated += workingBeatmapInvalidated;
         }
 
+        private void workingBeatmapInvalidated(WorkingBeatmap working) => Scheduler.AddOnce(w =>
+        {
+            // The global beatmap may have already been updated (ie. by the editor).
+            // Only perform the actual switch if we still need to.
+            if (w == Beatmap.Value)
+            {
+                // Not sure if this refresh is required.
+                var beatmapInfo = beatmaps.QueryBeatmap(b => b.ID == w.BeatmapInfo.ID);
+                Beatmap.Value = beatmaps.GetWorkingBeatmap(beatmapInfo);
+            }
+
+            updateComponentFromBeatmap(Beatmap.Value);
+        }, working);
+
         /// <summary>
         /// Creates the buttons to be displayed in the footer.
         /// </summary>
@@ -700,6 +716,8 @@ namespace osu.Game.Screens.Select
                 music.TrackChanged -= ensureTrackLooping;
 
             modSelectOverlayRegistration?.Dispose();
+
+            beatmaps.OnInvalidated -= workingBeatmapInvalidated;
         }
 
         /// <summary>