Refactor categories to extend GameCategory (#989)

This is a refactor which removes `GameLevelCategory`,
`GameUserCategory`, their equivalent game and API serialization classes
and makes all category classes directly extend `GameCategory`.
De-duplicating category code, especially for the API responses, was
suggested in a [previous PR's
review](#922 (comment)),
and this is the easiest and least hacky way I could think of.

While I have tried to implement the suggested strategy of using a
generic type for `ApiCategoryResponse`, it became too complicated for me
due to one of the two `FromOldList` methods needing to call the `Fetch`
method of every category in order to add their preview items to the
responses. I've thought to instead have the preview item attribute be of
type `IApiResultResponse` which both `ApiGameLevelResponse` and
`ApiGameUserResponse` implement.

For LBP3 the `Results` attribute, which used to be in
`SerializedLevelCategory` and `SerializedUserCategory`, is now in
`SerializedCategory` and of type `SerializedCategoryResultsList` so the
categories could include either users or levels as previews. This works
with LBP3.

The overridden `GameCategory.Fetch` method now returns a
`DatabaseResultList`, which references a nullable `DatabaseList` of
`GameLevel`s, `GameUser`s and `GamePlaylist`s each (3 lists in total).
This is so that both level and user categories could override the method
without any problems, while also being a preparation to make searching
users for LBP1-3 and the API (and then maybe also playlists in
LBP1/3/API) alongside levels possible.

Author: Toastbrot236

Refresh.Core/Types/Categories/CategoryService.cs

@@ -9,10 +9,10 @@ namespace Refresh.Core.Types.Categories;
 public class CategoryService : EndpointService
 {
     // Level Categories
-    public readonly FrozenSet<GameLevelCategory> LevelCategories;
+    public readonly FrozenSet<GameCategory> LevelCategories;
 
     // ReSharper disable once InconsistentNaming
-    private readonly List<GameLevelCategory> _levelCategories =
+    private readonly List<GameCategory> _levelCategories =
     [
         new CoolLevelsCategory(),
         new TeamPickedLevelsCategory(),
@@ -38,10 +38,10 @@ public class CategoryService : EndpointService
     ];
 
     // User Categories
-    public readonly FrozenSet<GameUserCategory> UserCategories;
+    public readonly FrozenSet<GameCategory> UserCategories;
 
     // ReSharper disable once InconsistentNaming
-    private readonly List<GameUserCategory> _userCategories =
+    private readonly List<GameCategory> _userCategories =
     [
         new HeartedUsersByUserCategory(),
         new MostHeartedUsersCategory(),

Refresh.Core/Types/Categories/DatabaseResultList.cs

@@ -0,0 +1,35 @@
+using Refresh.Database;
+using Refresh.Database.Models.Levels;
+using Refresh.Database.Models.Playlists;
+using Refresh.Database.Models.Users;
+
+namespace Refresh.Core.Types.Categories;
+
+public class DatabaseResultList
+{
+    public DatabaseList<GameLevel>? Levels { get; set; } = null;
+    public DatabaseList<GameUser>? Users { get; set; } = null;
+    public DatabaseList<GamePlaylist>? Playlists { get; set; } = null;
+
+    /// <summary>
+    /// All items in total
+    /// </summary>
+    public int TotalItems => (Levels?.TotalItems ?? 0)
+        + (Users?.TotalItems ?? 0)
+        + (Playlists?.TotalItems ?? 0);
+    
+    public DatabaseResultList(DatabaseList<GameLevel> levels)
+    {
+        Levels = levels;
+    }
+
+    public DatabaseResultList(DatabaseList<GameUser> users)
+    {
+        Users = users;
+    }
+
+    public DatabaseResultList(DatabaseList<GamePlaylist> playlists)
+    {
+        Playlists = playlists;
+    }
+}

Refresh.Core/Types/Categories/GameCategory.cs

@@ -1,3 +1,8 @@
+using Bunkum.Core;
+using Refresh.Core.Types.Data;
+using Refresh.Database.Models.Users;
+using Refresh.Database.Query;
+
 namespace Refresh.Core.Types.Categories;
 
 [JsonObject(MemberSerialization.OptIn)]
@@ -8,11 +13,12 @@ public abstract class GameCategory
     [JsonProperty] public string IconHash { get; set; } = "0";
     [JsonProperty] public string FontAwesomeIcon { get; set; } = "faCertificate";
     [JsonProperty] public bool Hidden { get; set; } = false;
+    public ResultType PrimaryResultType { get; set; }
 
     [JsonProperty] public readonly bool RequiresUser;
     [JsonProperty] public readonly string ApiRoute;
     public readonly string[] GameRoutes;
-    
+
     internal GameCategory(string apiRoute, string gameRoute, bool requiresUser) : this(apiRoute, [gameRoute], requiresUser) {}
     internal GameCategory(string apiRoute, string[] gameRoutes, bool requiresUser)
     {
@@ -21,4 +27,7 @@ internal GameCategory(string apiRoute, string[] gameRoutes, bool requiresUser)
 
         this.RequiresUser = requiresUser;
     }
+
+    public abstract DatabaseResultList? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
+        LevelFilterSettings levelFilterSettings, GameUser? user);
 }

Refresh.Core/Types/Categories/Levels/AdventureCategory.cs

@@ -1,25 +1,24 @@
 using Bunkum.Core;
 using Refresh.Core.Types.Data;
-using Refresh.Database;
-using Refresh.Database.Models.Levels;
 using Refresh.Database.Models.Users;
 using Refresh.Database.Query;
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class AdventureCategory : GameLevelCategory
+public class AdventureCategory : GameCategory
 {
     public AdventureCategory() : base("adventure", [], false)
     {
         this.Name = "Adventures";
         this.Description = "Storylines and other big projects by the community.";
         this.FontAwesomeIcon = "book-bookmark";
         this.IconHash = "g820625";
+        this.PrimaryResultType = ResultType.Level; // Adventures are GameLevels
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? _)
     {
-        return dataContext.Database.GetAdventureLevels(count, skip, dataContext.User, levelFilterSettings);
+        return new(dataContext.Database.GetAdventureLevels(count, skip, dataContext.User, levelFilterSettings));
     }
 }

Refresh.Core/Types/Categories/Levels/ByTagCategory.cs

@@ -1,13 +1,12 @@
 using Bunkum.Core;
 using Refresh.Core.Types.Data;
-using Refresh.Database;
 using Refresh.Database.Models.Levels;
 using Refresh.Database.Models.Users;
 using Refresh.Database.Query;
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class ByTagCategory : GameLevelCategory
+public class ByTagCategory : GameCategory
 {
     internal ByTagCategory() : base("tag", "tag", false)
     {
@@ -17,9 +16,10 @@ internal ByTagCategory() : base("tag", "tag", false)
         this.IconHash = "g820605";
         this.FontAwesomeIcon = "tag";
         this.Hidden = true; // The by-tag category is not meant to be shown, as it requires a special implementation on all frontends
+        this.PrimaryResultType = ResultType.Level;
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count,
         DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? user)
     {
@@ -33,6 +33,6 @@ internal ByTagCategory() : base("tag", "tag", false)
         if (tag == null)
             return null;
 
-        return dataContext.Database.GetLevelsByTag(count, skip, user, tag.Value, levelFilterSettings);
+        return new(dataContext.Database.GetLevelsByTag(count, skip, user, tag.Value, levelFilterSettings));
     }
 }

Refresh.Core/Types/Categories/Levels/ByUserLevelCategory.cs

@@ -1,13 +1,11 @@
 using Bunkum.Core;
 using Refresh.Core.Types.Data;
-using Refresh.Database;
-using Refresh.Database.Models.Levels;
 using Refresh.Database.Models.Users;
 using Refresh.Database.Query;
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class ByUserLevelCategory : GameLevelCategory
+public class ByUserLevelCategory : GameCategory
 {
     internal ByUserLevelCategory() : base("byUser", "by", true)
     {
@@ -16,9 +14,10 @@ internal ByUserLevelCategory() : base("byUser", "by", true)
         this.Description = "Levels you've shared with the community!";
         this.IconHash = "g820625";
         this.FontAwesomeIcon = "user";
+        this.PrimaryResultType = ResultType.Level;
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count,
         DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? user)
     {
@@ -28,6 +27,6 @@ internal ByUserLevelCategory() : base("byUser", "by", true)
 
         if (user == null) return null;
 
-        return dataContext.Database.GetLevelsByUser(user, count, skip, levelFilterSettings, dataContext.User);
+        return new(dataContext.Database.GetLevelsByUser(user, count, skip, levelFilterSettings, dataContext.User));
     }
 }

Refresh.Core/Types/Categories/Levels/ContestCategory.cs

@@ -1,24 +1,23 @@
 using Bunkum.Core;
 using Refresh.Core.Types.Data;
-using Refresh.Database;
 using Refresh.Database.Models.Contests;
-using Refresh.Database.Models.Levels;
 using Refresh.Database.Models.Users;
 using Refresh.Database.Query;
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class ContestCategory : GameLevelCategory
+public class ContestCategory : GameCategory
 {
     public ContestCategory() : base("contest", [], false)
     {
         this.Name = "Contests";
         this.Description = "Levels from a contest.";
         this.FontAwesomeIcon = "certificate";
         this.IconHash = "g820608";
+        this.PrimaryResultType = ResultType.Level;
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? _)
     {
         // try to find a contest by the query parameter
@@ -35,6 +34,6 @@ public ContestCategory() : base("contest", [], false)
         if (contest == null)
             return null;
 
-        return dataContext.Database.GetLevelsFromContest(contest, count, skip, dataContext.User, levelFilterSettings);
+        return new(dataContext.Database.GetLevelsFromContest(contest, count, skip, dataContext.User, levelFilterSettings));
     }
 }

Refresh.Core/Types/Categories/Levels/CoolLevelsCategory.cs

@@ -1,25 +1,24 @@
 using Bunkum.Core;
 using Refresh.Core.Types.Data;
-using Refresh.Database;
-using Refresh.Database.Models.Levels;
 using Refresh.Database.Models.Users;
 using Refresh.Database.Query;
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class CoolLevelsCategory : GameLevelCategory
+public class CoolLevelsCategory : GameCategory
 {
     public CoolLevelsCategory() : base("coolLevels", ["lbpcool", "lbp2cool", "cool", "hot"], false)
     {
         this.Name = "Cool Levels";
         this.Description = "Levels trending with players like you!";
         this.FontAwesomeIcon = "fire";
         this.IconHash = "g820625";
+        this.PrimaryResultType = ResultType.Level;
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count, DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? _)
     {
-        return dataContext.Database.GetCoolLevels(count, skip, dataContext.User, levelFilterSettings);
+        return new(dataContext.Database.GetCoolLevels(count, skip, dataContext.User, levelFilterSettings));
     }
 }

Refresh.Core/Types/Categories/Levels/CurrentlyPlayingCategory.cs

@@ -8,17 +8,18 @@
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class CurrentlyPlayingCategory : GameLevelCategory
+public class CurrentlyPlayingCategory : GameCategory
 {
     internal CurrentlyPlayingCategory() : base("currentlyPlaying", "busiest", false)
     {
         this.Name = "Popular Now";
         this.Description = "Levels people are playing right now!";
         this.IconHash = "g820602";
         this.FontAwesomeIcon = "users";
+        this.PrimaryResultType = ResultType.Level;
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count,
         DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? _)
     {
@@ -27,9 +28,9 @@ internal CurrentlyPlayingCategory() : base("currentlyPlaying", "busiest", false)
             .GroupBy(r => dataContext.Database.GetLevelById(r.LevelId))
             .OrderBy(r => r.Sum(room => room.PlayerIds.Count));
 
-        return new DatabaseList<GameLevel>(rooms.Select(r => r.Key)
+        return new(new DatabaseList<GameLevel>(rooms.Select(r => r.Key)
             .Where(l => l != null && l.StoryId == 0)!
             .FilterByLevelFilterSettings(dataContext.User, levelFilterSettings)
-            .FilterByGameVersion(levelFilterSettings.GameVersion), skip, count);
+            .FilterByGameVersion(levelFilterSettings.GameVersion), skip, count));
     }
 }

Refresh.Core/Types/Categories/Levels/DeveloperLevelsCategory.cs

@@ -1,13 +1,11 @@
 using Bunkum.Core;
 using Refresh.Core.Types.Data;
-using Refresh.Database;
-using Refresh.Database.Models.Levels;
 using Refresh.Database.Models.Users;
 using Refresh.Database.Query;
 
 namespace Refresh.Core.Types.Categories.Levels;
 
-public class DeveloperLevelsCategory : GameLevelCategory
+public class DeveloperLevelsCategory : GameCategory
 {
     internal DeveloperLevelsCategory() : base("developer", [], false)
     {
@@ -16,10 +14,11 @@ internal DeveloperLevelsCategory() : base("developer", [], false)
         this.FontAwesomeIcon = "certificate";
         this.IconHash = "g820604";
         this.Hidden = true; // TODO: Set to false when we import story level names
+        this.PrimaryResultType = ResultType.Level;
     }
 
-    public override DatabaseList<GameLevel>? Fetch(RequestContext context, int skip, int count,
+    public override DatabaseResultList? Fetch(RequestContext context, int skip, int count,
         DataContext dataContext,
         LevelFilterSettings levelFilterSettings, GameUser? _) 
-        => dataContext.Database.GetDeveloperLevels(count, skip, levelFilterSettings);
+        => new(dataContext.Database.GetDeveloperLevels(count, skip, levelFilterSettings));
 }