From 688e4479506645bdacee7cdc7ae9ee9deaa5f1b4 Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Wed, 12 Aug 2020 01:33:06 +0900
Subject: [PATCH] Fix potential hierarchy mutation from async context

---
 osu.Game/Overlays/MusicController.cs | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs
index 813ad26ae4..c18b564b4f 100644
--- a/osu.Game/Overlays/MusicController.cs
+++ b/osu.Game/Overlays/MusicController.cs
@@ -317,11 +317,28 @@ private void beatmapChanged(ValueChangedEvent<WorkingBeatmap> beatmap)
 
         private void changeTrack()
         {
-            CurrentTrack.Expire();
-            CurrentTrack = new DrawableTrack(current.GetTrack());
-            CurrentTrack.Completed += () => onTrackCompleted(current);
+            var lastTrack = CurrentTrack;
 
-            AddInternal(CurrentTrack);
+            var newTrack = new DrawableTrack(current.GetTrack());
+            newTrack.Completed += () => onTrackCompleted(current);
+
+            CurrentTrack = newTrack;
+
+            // At this point we may potentially be in an async context from tests. This is extremely dangerous but we have to make do for now.
+            // CurrentTrack is immediately updated above for situations where a immediate knowledge about the new track is required,
+            // but the mutation of the hierarchy is scheduled to avoid exceptions.
+            Schedule(() =>
+            {
+                lastTrack.Expire();
+
+                if (newTrack == CurrentTrack)
+                    AddInternal(newTrack);
+                else
+                {
+                    // If the track has changed via changeTrack() being called multiple times in a single update, force disposal on the old track.
+                    newTrack.Dispose();
+                }
+            });
         }
 
         private void onTrackCompleted(WorkingBeatmap workingBeatmap)