From fc5987bf6978f565bf038d474650fb2409cf5ac8 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Wed, 19 May 2021 16:52:34 +0900
Subject: [PATCH] Refactor `DialogOverlay` logic to avoid dismissal potentially
 being unhandled

---
 osu.Game/Overlays/Dialog/PopupDialog.cs | 6 ++++++
 osu.Game/Overlays/DialogOverlay.cs      | 7 ++++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/osu.Game/Overlays/Dialog/PopupDialog.cs b/osu.Game/Overlays/Dialog/PopupDialog.cs
index df085b56f2..c04ad7afb5 100644
--- a/osu.Game/Overlays/Dialog/PopupDialog.cs
+++ b/osu.Game/Overlays/Dialog/PopupDialog.cs
@@ -95,6 +95,8 @@ namespace osu.Game.Overlays.Dialog
             }
         }
 
+        protected override bool StartHidden => true;
+
         protected PopupDialog()
         {
             RelativeSizeAxes = Axes.Both;
@@ -205,6 +207,10 @@ namespace osu.Game.Overlays.Dialog
                     },
                 },
             };
+
+            // It's important we start in a visible state so our state fires on hide, even before load.
+            // This is used by the DialogOverlay to know when the dialog was dismissed.
+            Show();
         }
 
         /// <summary>
diff --git a/osu.Game/Overlays/DialogOverlay.cs b/osu.Game/Overlays/DialogOverlay.cs
index 4cc17a4c14..bc3b0e6c9a 100644
--- a/osu.Game/Overlays/DialogOverlay.cs
+++ b/osu.Game/Overlays/DialogOverlay.cs
@@ -35,15 +35,16 @@ namespace osu.Game.Overlays
 
         public void Push(PopupDialog dialog)
         {
-            if (dialog == CurrentDialog) return;
+            if (dialog == CurrentDialog || dialog.State.Value != Visibility.Visible) return;
 
+            // if any existing dialog is being displayed, dismiss it before showing a new one.
             CurrentDialog?.Hide();
+
             CurrentDialog = dialog;
+            CurrentDialog.State.ValueChanged += state => onDialogOnStateChanged(dialog, state.NewValue);
 
             dialogContainer.Add(CurrentDialog);
 
-            CurrentDialog.Show();
-            CurrentDialog.State.ValueChanged += state => onDialogOnStateChanged(dialog, state.NewValue);
             Show();
         }