Merge pull request #34231 from bdach/user-tag-search-wip

Add initial support for filtering by user tags in song select

Author: peppy

osu.Game.Tests/NonVisual/Filtering/FilterMatchingTest.cs

@@ -40,6 +40,11 @@ public class FilterMatchingTest
                 Author = { Username = "The Author" },
                 Source = "unit tests",
                 Tags = "look for tags too",
+                UserTags =
+                {
+                    "song representation/simple",
+                    "style/clean",
+                }
             },
             DifficultyName = "version as well",
             Length = 2500,
@@ -292,6 +297,33 @@ public void TestCriteriaMatchingBeatmapIDs(string query, bool filtered)
             Assert.AreEqual(filtered, carouselItem.Filtered.Value);
         }
 
+        [TestCase("simple", false)]
+        [TestCase("\"style/clean\"", false)]
+        [TestCase("\"style/clean\"!", false)]
+        [TestCase("iNiS-style", true)]
+        [TestCase("\"reading/visually dense\"!", true)]
+        public void TestCriteriaMatchingUserTags(string query, bool filtered)
+        {
+            var beatmap = getExampleBeatmap();
+            var criteria = new FilterCriteria { UserTag = { SearchTerm = query } };
+            var carouselItem = new CarouselBeatmap(beatmap);
+            carouselItem.Filter(criteria);
+
+            Assert.AreEqual(filtered, carouselItem.Filtered.Value);
+        }
+
+        [Test]
+        public void TestBeatmapMustHaveAtLeastOneTagIfUserTagFilterActive()
+        {
+            var beatmap = getExampleBeatmap();
+            var criteria = new FilterCriteria { UserTag = { SearchTerm = "simple" } };
+            var carouselItem = new CarouselBeatmap(beatmap);
+            carouselItem.BeatmapInfo.Metadata.UserTags.Clear();
+            carouselItem.Filter(criteria);
+
+            Assert.True(carouselItem.Filtered.Value);
+        }
+
         [Test]
         public void TestCustomRulesetCriteria([Values(null, true, false)] bool? matchCustomCriteria)
         {

osu.Game.Tests/Visual/SongSelectV2/TestSceneBeatmapMetadataWedge.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Linq;
 using NUnit.Framework;
+using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Testing;
 using osu.Game.Beatmaps;
@@ -25,9 +26,19 @@ protected override void LoadComplete()
         {
             base.LoadComplete();
 
-            Child = wedge = new BeatmapMetadataWedge
+            var lookupSource = new RealmPopulatingOnlineLookupSource();
+            Child = new DependencyProvidingContainer
             {
-                State = { Value = Visibility.Visible },
+                RelativeSizeAxes = Axes.Both,
+                CachedDependencies = [(typeof(RealmPopulatingOnlineLookupSource), lookupSource)],
+                Children =
+                [
+                    lookupSource,
+                    wedge = new BeatmapMetadataWedge
+                    {
+                        State = { Value = Visibility.Visible },
+                    }
+                ]
             };
         }
 

osu.Game/Beatmaps/BeatmapMetadata.cs

@@ -2,9 +2,11 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Newtonsoft.Json;
 using osu.Game.Models;
+using osu.Game.Screens.SelectV2;
 using osu.Game.Users;
 using osu.Game.Utils;
 using Realms;
@@ -15,10 +17,10 @@ namespace osu.Game.Beatmaps
     /// A realm model containing metadata for a beatmap.
     /// </summary>
     /// <remarks>
-    /// This is currently stored against each beatmap difficulty, even when it is duplicated.
+    /// An instance of this object is stored against each beatmap difficulty.
     /// It is also provided via <see cref="BeatmapSetInfo"/> for convenience and historical purposes.
-    /// A future effort could see this converted to an <see cref="EmbeddedObject"/> or potentially de-duped
-    /// and shared across multiple difficulties in the same set, if required.
+    /// Note that accessing the metadata via <see cref="BeatmapSetInfo"/> may result in indeterminate results
+    /// as metadata can meaningfully differ per beatmap in a set.
     ///
     /// Note that difficulty name is not stored in this metadata but in <see cref="BeatmapInfo"/>.
     /// </remarks>
@@ -43,6 +45,13 @@ public class BeatmapMetadata : RealmObject, IBeatmapMetadataInfo, IDeepCloneable
         [JsonProperty(@"tags")]
         public string Tags { get; set; } = string.Empty;
 
+        /// <summary>
+        /// The list of user-voted tags applicable to this beatmap.
+        /// This information is populated from online sources (<see cref="RealmPopulatingOnlineLookupSource"/>)
+        /// and can meaningfully differ between beatmaps of a single set.
+        /// </summary>
+        public IList<string> UserTags { get; } = null!;
+
         /// <summary>
         /// The time in milliseconds to begin playing the track for preview purposes.
         /// If -1, the track should begin playing at 40% of its length.

osu.Game/Database/RealmAccess.cs

@@ -99,8 +99,9 @@ public class RealmAccess : IDisposable
         /// 47   2025-01-21    Remove right mouse button binding for absolute scroll. Never use mouse buttons (or scroll) for global actions.
         /// 48   2025-03-19    Clear online status for all qualified beatmaps (some were stuck in a qualified state due to local caching issues).
         /// 49   2025-06-10    Reset the LegacyOnlineID to -1 for all scores that have it set to 0 (which is semantically the same) for consistency of handling with OnlineID.
+        /// 50   2025-07-11    Add UserTags to BeatmapMetadata.
         /// </summary>
-        private const int schema_version = 49;
+        private const int schema_version = 50;
 
         /// <summary>
         /// Lock object which is held during <see cref="BlockAllOperations"/> sections, blocking realm retrieval during blocking periods.

osu.Game/Screens/Select/Carousel/CarouselBeatmap.cs

@@ -83,6 +83,15 @@ private bool checkMatch(FilterCriteria criteria)
                      criteria.Title.Matches(BeatmapInfo.Metadata.TitleUnicode);
             match &= !criteria.DifficultyName.HasFilter || criteria.DifficultyName.Matches(BeatmapInfo.DifficultyName);
             match &= !criteria.Source.HasFilter || criteria.Source.Matches(BeatmapInfo.Metadata.Source);
+
+            if (criteria.UserTag.HasFilter)
+            {
+                bool anyTagMatched = false;
+                foreach (string tag in BeatmapInfo.Metadata.UserTags)
+                    anyTagMatched |= criteria.UserTag.Matches(tag);
+                match &= anyTagMatched;
+            }
+
             match &= !criteria.UserStarDifficulty.HasFilter || criteria.UserStarDifficulty.IsInRange(BeatmapInfo.StarRating);
 
             if (!match) return false;

osu.Game/Screens/Select/FilterCriteria.cs

@@ -39,6 +39,7 @@ public class FilterCriteria
         public OptionalTextFilter Title;
         public OptionalTextFilter DifficultyName;
         public OptionalTextFilter Source;
+        public OptionalTextFilter UserTag;
 
         public OptionalRange<double> UserStarDifficulty = new OptionalRange<double>
         {

osu.Game/Screens/Select/FilterQueryParser.cs

@@ -116,6 +116,9 @@ private static bool tryParseKeywordCriteria(FilterCriteria criteria, string key,
                 case "source":
                     return TryUpdateCriteriaText(ref criteria.Source, op, value);
 
+                case "tag":
+                    return TryUpdateCriteriaText(ref criteria.UserTag, op, value);
+
                 default:
                     return criteria.RulesetCriteria?.TryParseCustomKeywordCriteria(key, op, value) ?? false;
             }

osu.Game/Screens/SelectV2/BeatmapCarouselFilterMatching.cs

@@ -105,6 +105,15 @@ private static bool checkCriteriaMatch(BeatmapInfo beatmap, FilterCriteria crite
                      criteria.Title.Matches(beatmap.Metadata.TitleUnicode);
             match &= !criteria.DifficultyName.HasFilter || criteria.DifficultyName.Matches(beatmap.DifficultyName);
             match &= !criteria.Source.HasFilter || criteria.Source.Matches(beatmap.Metadata.Source);
+
+            if (criteria.UserTag.HasFilter)
+            {
+                bool anyTagMatched = false;
+                foreach (string tag in beatmap.Metadata.UserTags)
+                    anyTagMatched |= criteria.UserTag.Matches(tag);
+                match &= anyTagMatched;
+            }
+
             match &= !criteria.UserStarDifficulty.HasFilter || criteria.UserStarDifficulty.IsInRange(beatmap.StarRating);
 
             if (!match) return false;

osu.Game/Screens/SelectV2/BeatmapMetadataWedge.cs

@@ -2,18 +2,21 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
-using System.Collections.Generic;
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
+using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Logging;
 using osu.Game.Beatmaps;
+using osu.Game.Database;
 using osu.Game.Graphics.Containers;
 using osu.Game.Localisation;
 using osu.Game.Online;
 using osu.Game.Online.API;
-using osu.Game.Online.API.Requests;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Online.Chat;
 using osu.Game.Resources.Localisation.Web;
@@ -51,6 +54,12 @@ public partial class BeatmapMetadataWedge : VisibilityContainer
         [Resolved]
         private IAPIProvider api { get; set; } = null!;
 
+        [Resolved]
+        private RealmPopulatingOnlineLookupSource onlineLookupSource { get; set; } = null!;
+
+        [Resolved]
+        private RealmAccess realm { get; set; } = null!;
+
         private IBindable<APIState> apiState = null!;
 
         [Resolved]
@@ -314,34 +323,34 @@ private void updateDisplay()
         }
 
         private APIBeatmapSet? currentOnlineBeatmapSet;
-        private GetBeatmapSetRequest? currentRequest;
+        private CancellationTokenSource? cancellationTokenSource;
+        private Task<APIBeatmapSet?>? currentFetchTask;
 
         private void refetchBeatmapSet()
         {
             var beatmapSetInfo = beatmap.Value.BeatmapSetInfo;
 
-            currentRequest?.Cancel();
-            currentRequest = null;
+            cancellationTokenSource?.Cancel();
             currentOnlineBeatmapSet = null;
 
             if (beatmapSetInfo.OnlineID >= 1)
             {
-                // todo: consider introducing a BeatmapSetLookupCache for caching benefits.
-                currentRequest = new GetBeatmapSetRequest(beatmapSetInfo.OnlineID);
-                currentRequest.Failure += _ => updateOnlineDisplay();
-                currentRequest.Success += s =>
+                cancellationTokenSource = new CancellationTokenSource();
+                currentFetchTask = onlineLookupSource.GetBeatmapSetAsync(beatmapSetInfo.OnlineID);
+                currentFetchTask.ContinueWith(t =>
                 {
-                    currentOnlineBeatmapSet = s;
-                    updateOnlineDisplay();
-                };
-
-                api.Queue(currentRequest);
+                    if (t.IsCompletedSuccessfully)
+                        currentOnlineBeatmapSet = t.GetResultSafely();
+                    if (t.Exception != null)
+                        Logger.Log($"Error when fetching online beatmap set: {t.Exception}", LoggingTarget.Network);
+                    Scheduler.AddOnce(updateOnlineDisplay);
+                });
             }
         }
 
         private void updateOnlineDisplay()
         {
-            if (currentRequest?.CompletionState == APIRequestCompletionState.Waiting)
+            if (currentFetchTask?.IsCompleted == false)
             {
                 genre.Data = null;
                 language.Data = null;
@@ -379,28 +388,21 @@ private void updateOnlineDisplay()
 
         private void updateUserTags()
         {
-            var beatmapInfo = beatmap.Value.BeatmapInfo;
-            var onlineBeatmapSet = currentOnlineBeatmapSet;
-            var onlineBeatmap = onlineBeatmapSet?.Beatmaps.SingleOrDefault(b => b.OnlineID == beatmapInfo.OnlineID);
+            string[] tags = realm.Run(r =>
+            {
+                // need to refetch because `beatmap.Value.BeatmapInfo` is not going to have the latest tags
+                var refetchedBeatmap = r.Find<BeatmapInfo>(beatmap.Value.BeatmapInfo.ID);
+                return refetchedBeatmap?.Metadata.UserTags.ToArray() ?? [];
+            });
 
-            if (onlineBeatmap?.TopTags == null || onlineBeatmap.TopTags.Length == 0 || onlineBeatmapSet?.RelatedTags == null)
+            if (tags.Length == 0)
             {
                 userTags.FadeOut(transition_duration, Easing.OutQuint);
                 return;
             }
 
-            var tagsById = onlineBeatmapSet.RelatedTags.ToDictionary(t => t.Id);
-            string[] userTagsArray = onlineBeatmap.TopTags
-                                                  .Select(t => (topTag: t, relatedTag: tagsById.GetValueOrDefault(t.TagId)))
-                                                  .Where(t => t.relatedTag != null)
-                                                  // see https://github.com/ppy/osu-web/blob/bb3bd2e7c6f84f26066df5ea20a81c77ec9bb60a/resources/js/beatmapsets-show/controller.ts#L103-L106 for sort criteria
-                                                  .OrderByDescending(t => t.topTag.VoteCount)
-                                                  .ThenBy(t => t.relatedTag!.Name)
-                                                  .Select(t => t.relatedTag!.Name)
-                                                  .ToArray();
-
             userTags.FadeIn(transition_duration, Easing.OutQuint);
-            userTags.Tags = (userTagsArray, t => songSelect?.Search(t));
+            userTags.Tags = (tags, t => songSelect?.Search($@"tag=""{t}""!"));
         }
     }
 }

osu.Game/Screens/SelectV2/BeatmapMetadataWedge_MetadataDisplay.cs

@@ -56,12 +56,12 @@ public DateTimeOffset? Date
                 }
             }
 
-            public (string[] tags, Action<string> linkAction)? Tags
+            public (string[] tags, Action<string> searchAction)? Tags
             {
                 set
                 {
                     if (value != null)
-                        setTags(value.Value.tags, value.Value.linkAction);
+                        setTags(value.Value.tags, value.Value.searchAction);
                     else
                         setLoading();
                 }
@@ -161,12 +161,12 @@ private void setDate(DateTimeOffset date)
                 contentDate.Date = date;
             }
 
-            private void setTags(string[] tags, Action<string> link)
+            private void setTags(string[] tags, Action<string> searchAction)
             {
                 clear();
 
                 contentTags.Tags = tags;
-                contentTags.Action = link;
+                contentTags.PerformSearch = searchAction;
             }
 
             private void setLoading()