From 668cc144f68c339ab03a4601c4d36faae86b051e Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Thu, 18 Feb 2021 17:39:01 +0900
Subject: [PATCH] Fix test failures + multiple filter operations firing

---
 .../Collections/CollectionFilterDropdown.cs   | 22 ++++++++++++++-----
 .../Collections/CollectionFilterMenuItem.cs   |  8 ++++++-
 2 files changed, 24 insertions(+), 6 deletions(-)

diff --git a/osu.Game/Collections/CollectionFilterDropdown.cs b/osu.Game/Collections/CollectionFilterDropdown.cs
index 3e55ecb084..aad8400faa 100644
--- a/osu.Game/Collections/CollectionFilterDropdown.cs
+++ b/osu.Game/Collections/CollectionFilterDropdown.cs
@@ -29,6 +29,14 @@ namespace osu.Game.Collections
         /// </summary>
         protected virtual bool ShowManageCollectionsItem => true;
 
+        private readonly BindableWithCurrent<CollectionFilterMenuItem> current = new BindableWithCurrent<CollectionFilterMenuItem>();
+
+        public new Bindable<CollectionFilterMenuItem> Current
+        {
+            get => current.Current;
+            set => current.Current = value;
+        }
+
         private readonly IBindableList<BeatmapCollection> collections = new BindableList<BeatmapCollection>();
         private readonly IBindableList<BeatmapInfo> beatmaps = new BindableList<BeatmapInfo>();
         private readonly BindableList<CollectionFilterMenuItem> filters = new BindableList<CollectionFilterMenuItem>();
@@ -36,14 +44,15 @@ namespace osu.Game.Collections
         [Resolved(CanBeNull = true)]
         private ManageCollectionsDialog manageCollectionsDialog { get; set; }
 
+        [Resolved(CanBeNull = true)]
+        private CollectionManager collectionManager { get; set; }
+
         public CollectionFilterDropdown()
         {
             ItemSource = filters;
+            Current.Value = new AllBeatmapsCollectionFilterMenuItem();
         }
 
-        [Resolved(CanBeNull = true)]
-        private CollectionManager collectionManager { get; set; }
-
         protected override void LoadComplete()
         {
             base.LoadComplete();
@@ -51,9 +60,12 @@ namespace osu.Game.Collections
             if (collectionManager != null)
                 collections.BindTo(collectionManager.Collections);
 
-            collections.CollectionChanged += (_, __) => collectionsChanged();
-            collectionsChanged();
+            // Dropdown has logic which triggers a change on the bindable with every change to the contained items.
+            // This is not desirable here, as it leads to multiple filter operations running even though nothing has changed.
+            // An extra bindable is enough to subvert this behaviour.
+            base.Current.BindTo(Current);
 
+            collections.BindCollectionChanged((_, __) => collectionsChanged(), true);
             Current.BindValueChanged(filterChanged, true);
         }
 
diff --git a/osu.Game/Collections/CollectionFilterMenuItem.cs b/osu.Game/Collections/CollectionFilterMenuItem.cs
index 4a489d2945..fe79358223 100644
--- a/osu.Game/Collections/CollectionFilterMenuItem.cs
+++ b/osu.Game/Collections/CollectionFilterMenuItem.cs
@@ -1,6 +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;
 using JetBrains.Annotations;
 using osu.Framework.Bindables;
 
@@ -9,7 +10,7 @@ namespace osu.Game.Collections
     /// <summary>
     /// A <see cref="BeatmapCollection"/> filter.
     /// </summary>
-    public class CollectionFilterMenuItem
+    public class CollectionFilterMenuItem : IEquatable<CollectionFilterMenuItem>
     {
         /// <summary>
         /// The collection to filter beatmaps from.
@@ -33,6 +34,11 @@ namespace osu.Game.Collections
             Collection = collection;
             CollectionName = Collection?.Name.GetBoundCopy() ?? new Bindable<string>("All beatmaps");
         }
+
+        public bool Equals(CollectionFilterMenuItem other)
+            => other != null && CollectionName.Value == other.CollectionName.Value;
+
+        public override int GetHashCode() => CollectionName.Value.GetHashCode();
     }
 
     public class AllBeatmapsCollectionFilterMenuItem : CollectionFilterMenuItem