feat(back): filterUserIDs query param on maps/{id}/leaderboard

momentum-mod · Feb 6, 2024 · d67db78 · d67db78
1 parent d721489
commit d67db78
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 13 deletions.
diff --git a/apps/backend-e2e/src/maps-2.e2e-spec.ts b/apps/backend-e2e/src/maps-2.e2e-spec.ts
@@ -1461,6 +1461,21 @@ describe('Maps Part 2', () => {
           token
         }));
 
+      it('should respond with filtered runs given using the filterUserID param', async () => {
+        const res = await req.get({
+          url: `maps/${map.id}/leaderboard`,
+          query: {
+            gamemode: Gamemode.AHOP,
+            filterUserIDs: `${u1.id},${u3.id}`
+          },
+          validatePaged: { type: MinimalLeaderboardRunDto, count: 2 },
+          token
+        });
+
+        expect(res.body.data[0].userID).toBe(u1.id);
+        expect(res.body.data[1].userID).toBe(u3.id);
+      });
+
       // Test that permissions checks are getting called
       // Yes, u1 has runs on the map, but we don't actually test for that
       it('should 403 if the user does not have permission to access to the map', async () => {
@@ -1495,7 +1510,7 @@ describe('Maps Part 2', () => {
     });
 
     describe("GET - 'around' filter", () => {
-      let map, user7Token, runs;
+      let map, u7, u7Token, runs;
 
       beforeAll(async () => {
         map = await db.createMap();
@@ -1508,7 +1523,8 @@ describe('Maps Part 2', () => {
             })
           )
         );
-        user7Token = auth.login(runs[6].user);
+        u7 = runs[6].user;
+        u7Token = auth.login(u7);
       });
 
       afterAll(() => db.cleanup('leaderboardRun', 'pastRun', 'user', 'mMap'));
@@ -1518,7 +1534,7 @@ describe('Maps Part 2', () => {
           url: `maps/${map.id}/leaderboard`,
           query: { gamemode: Gamemode.AHOP, filter: 'around', take: 8 },
           status: 200,
-          token: user7Token,
+          token: u7Token,
           validatePaged: { type: MinimalLeaderboardRunDto, count: 9 }
         });
 
@@ -1534,6 +1550,22 @@ describe('Maps Part 2', () => {
         // 12.
         expect(rankIndex).toBe(12);
       });
+
+      it('should return a list of ranks around your rank filter by userID if given', async () => {
+        const res = await req.get({
+          url: `maps/${map.id}/leaderboard`,
+          query: {
+            gamemode: Gamemode.AHOP,
+            filter: 'around',
+            filterUserIDs: u7.id
+          },
+          status: 200,
+          token: u7Token,
+          validatePaged: { type: MinimalLeaderboardRunDto, count: 1 }
+        });
+
+        expect(res.body.data[0].userID).toBe(u7.id);
+      });
     });
 
     describe("GET - 'friends' filter", () => {

diff --git a/apps/backend/src/app/dto/queries/map-queries.dto.ts b/apps/backend/src/app/dto/queries/map-queries.dto.ts
@@ -36,6 +36,7 @@ import {
   EnumQueryProperty,
   ExpandQueryProperty,
   FilterQueryProperty,
+  IntCsvQueryProperty,
   IntQueryProperty,
   SingleExpandQueryProperty,
   SkipQueryProperty,
@@ -266,6 +267,9 @@ export class MapLeaderboardGetQueryDto
   })
   readonly filter?: MapRunsGetFilter;
 
+  @IntCsvQueryProperty({ description: 'List of users to limit results to' })
+  readonly filterUserIDs?: number[];
+
   @BooleanQueryProperty({
     description: 'Whether to order by date or not (false for reverse)'
   })

diff --git a/apps/backend/src/app/modules/runs/leaderboard-runs.service.ts b/apps/backend/src/app/modules/runs/leaderboard-runs.service.ts
@@ -74,6 +74,10 @@ export class LeaderboardRunsService {
       style: query.style
     };
 
+    if (query.filterUserIDs) {
+      where.userID = { in: query.filterUserIDs };
+    }
+
     const select = {
       ...this.minimalRunsSelect,
       stats: Boolean(query.expand)
@@ -89,17 +93,23 @@ export class LeaderboardRunsService {
     // Potentially a faster way of doing this in one query in raw SQL, something
     // to investigate when we move to that/query builder.
     if (query.filter?.[0] === 'around') {
-      const userRun = await this.db.leaderboardRun.findUnique({
-        where: {
-          userID_gamemode_style_mapID_trackType_trackNum: {
-            mapID,
-            userID: loggedInUserID,
-            gamemode: query.gamemode,
-            trackType: query.trackType,
-            trackNum: query.trackNum,
-            style: query.style
-          }
+      const whereAround: Prisma.LeaderboardRunWhereUniqueInput = {
+        userID_gamemode_style_mapID_trackType_trackNum: {
+          mapID,
+          userID: loggedInUserID,
+          gamemode: query.gamemode,
+          trackType: query.trackType,
+          trackNum: query.trackNum,
+          style: query.style
         }
+      };
+
+      // if (query.filterUserIDs) {
+      //   where.userID = { in: query.filterUserIDs };
+      // }
+
+      const userRun = await this.db.leaderboardRun.findUnique({
+        where: whereAround
       });
 
       if (!userRun)

diff --git a/libs/constants/src/types/queries/map-queries.model.ts b/libs/constants/src/types/queries/map-queries.model.ts
@@ -122,6 +122,7 @@ export type MapLeaderboardGetQuery = PagedQuery & {
   style?: Style; // Default 0
   expand?: MapRunsGetExpand;
   filter?: MapRunsGetFilter;
+  filterUserIDs?: number[];
   orderByDate?: boolean;
 };