Rewrite gameserver slot filter system (#763)

* Initial implementation of new slot sorting and filtering system * Initial implementation of filtering for lbp3 community tab * Add support for organization on lbp3 * Add playlist and user categories * Implement unit tests for all filters Refactor more systems to use PaginationData * Fix PlayerCountFilter test * Add more unit tests and integration tests for the filter system * Fix LBP2 move filter and gameFilterType * Fix sort by likes in LBP3 category * Add sort for total plays * Remove extra whitespace and make styling more consistent * Order hearted and queued levels by primary key ID * Fix query without order warnings
2025-06-20 22:41:28 +00:00 · 2023-05-31 16:33:39 -05:00 · 2023-05-31 16:33:39 -05:00 · 0c1e350fa3
commit 0c1e350fa3
parent de228cb242
106 changed files with 4040 additions and 1183 deletions
--- a/ProjectLighthouse.Tests.GameApiTests/Unit/Controllers/ControllerExtensionTests.cs
+++ b/ProjectLighthouse.Tests.GameApiTests/Unit/Controllers/ControllerExtensionTests.cs
@ -0,0 +1,388 @@
+using System.Collections.Generic;
+using System.Linq;
+using LBPUnion.ProjectLighthouse.Filter;
+using LBPUnion.ProjectLighthouse.Filter.Filters;
+using LBPUnion.ProjectLighthouse.Servers.GameServer.Controllers.Slots;
+using LBPUnion.ProjectLighthouse.Servers.GameServer.Extensions;
+using LBPUnion.ProjectLighthouse.Tests.Helpers;
+using LBPUnion.ProjectLighthouse.Types.Entities.Token;
+using LBPUnion.ProjectLighthouse.Types.Filter;
+using LBPUnion.ProjectLighthouse.Types.Users;
+using Microsoft.AspNetCore.Http;
+using Xunit;
+
+namespace ProjectLighthouse.Tests.GameApiTests.Unit.Controllers;
+
+[Trait("Category", "Unit")]
+public class ControllerExtensionTests
+{
+    [Fact]
+    public void GetDefaultFilters_ShouldReturnFilterBuilder()
+    {
+        SlotQueryBuilder queryBuilder = new SlotsController(null!).GetDefaultFilters(MockHelper.GetUnitTestToken());
+
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(GameVersionFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(SubLevelFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(HiddenSlotFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(SlotTypeFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddExcludeLbp1Filter_WhenTokenNotLbp1()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString(),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(ExcludeLBP1OnlyFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldReturnFilters_WhenQueryEmpty()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString(),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(GameVersionFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(ExcludeLBP1OnlyFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(SubLevelFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(HiddenSlotFilter)));
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(SlotTypeFilter)));
+    }
+
+    private static List<ISlotFilter> GetDefaultFilters
+        (SlotQueryBuilder queryBuilder) =>
+        queryBuilder.GetFilters(typeof(GameVersionFilter))
+            .Union(queryBuilder.GetFilters(typeof(SubLevelFilter))
+                .Union(queryBuilder.GetFilters(typeof(HiddenSlotFilter))
+                    .Union(queryBuilder.GetFilters(typeof(SlotTypeFilter)))))
+            .ToList();
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddLabelFilter_WhenAuthorLabelPresent()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?labelFilter0=LABEL_TEST"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(AuthorLabelFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddPlayerCountFilter_WhenPlayersPresent()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?players=1"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(PlayerCountFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddTextFilter_WhenTextFilterPresent()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?textFilter=test"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(TextFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddFirstUploadedFilter_WhenDateFilterPresent()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?dateFilterType=thisWeek"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(FirstUploadedFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddExcludeMoveFilter_WhenMoveEqualsFalse()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?move=false"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(ExcludeMovePackFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddMoveFilter_WhenMoveEqualsOnly()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?move=only"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(MovePackFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddCrossControlFilter_WhenCrossControlEqualsTrue()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet2;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?crosscontrol=true"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(CrossControlFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddAdventureFilter_WhenAdventureEqualsAllMust()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet3;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?adventure=allMust"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(AdventureFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddExcludeAdventureFilter_WhenAdventureEqualsNoneCan()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet3;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?adventure=noneCan"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(ExcludeAdventureFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddMovePackFilter_WhenMoveEqualsAllMust()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet3;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?move=allMust"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(MovePackFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddExcludeMoveFilter_WhenMoveEqualsNoneCan()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet3;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?move=noneCan"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(ExcludeMovePackFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddGameVersionListFilter_WhenGameFilterIsPresent()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet3;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?gameFilter[]=lbp1&gameFilter[]=lbp3"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(GameVersionListFilter)));
+    }
+
+    [Fact]
+    public void FilterFromRequest_ShouldAddResultTypeFilter_WhenResultTypeIsPresent()
+    {
+        GameTokenEntity token = MockHelper.GetUnitTestToken();
+        token.GameVersion = GameVersion.LittleBigPlanet3;
+        SlotsController controller = new(null!)
+        {
+            ControllerContext =
+            {
+                HttpContext = new DefaultHttpContext
+                {
+                    Request =
+                    {
+                        QueryString = new QueryString("?resultType[]=slot&resultType[]=playlist"),
+                    },
+                },
+            },
+        };
+
+        SlotQueryBuilder queryBuilder = controller.FilterFromRequest(token);
+        Assert.NotEmpty(queryBuilder.GetFilters(typeof(ResultTypeFilter)));
+    }
+}