feat: leaderboards remake, weekly xp leaderboards (@Miodec) (#6250)

Author: Miodec

backend/__tests__/api/controllers/leaderboard.spec.ts

@@ -24,11 +24,11 @@ import { ObjectId } from "mongodb";
 import { PersonalBest } from "@monkeytype/contracts/schemas/shared";
 import { pb } from "../../dal/leaderboards.spec";
 import { mockAuthenticateWithApeKey } from "../../__testData__/auth";
-import { LeaderboardRank } from "@monkeytype/contracts/schemas/leaderboards";
 import { randomUUID } from "node:crypto";
 import _ from "lodash";
 import { MonkeyMail, UserStreak } from "@monkeytype/contracts/schemas/users";
 import { isFirebaseError } from "../../../src/utils/error";
+import { LeaderboardEntry } from "@monkeytype/contracts/schemas/leaderboards";
 
 const mockApp = request(app);
 const configuration = Configuration.getCachedConfiguration();
@@ -2696,6 +2696,7 @@ describe("user controller test", () => {
     const getUserByNameMock = vi.spyOn(UserDal, "getUserByName");
     const checkIfUserIsPremiumMock = vi.spyOn(UserDal, "checkIfUserIsPremium");
     const leaderboardGetRankMock = vi.spyOn(LeaderboardDal, "getRank");
+    const leaderboardGetCountMock = vi.spyOn(LeaderboardDal, "getCount");
 
     const foundUser: Partial<UserDal.DBUser> = {
       _id: new ObjectId(),
@@ -2747,15 +2748,17 @@ describe("user controller test", () => {
       getUserByNameMock.mockReset();
       checkIfUserIsPremiumMock.mockReset().mockResolvedValue(true);
       leaderboardGetRankMock.mockReset();
+      leaderboardGetCountMock.mockReset();
       await enableProfiles(true);
     });
 
     it("should get by name without authentication", async () => {
       //GIVEN
       getUserByNameMock.mockResolvedValue(foundUser as any);
 
-      const rank: LeaderboardRank = { count: 100, rank: 24 };
+      const rank = { rank: 24 } as LeaderboardEntry;
       leaderboardGetRankMock.mockResolvedValue(rank);
+      leaderboardGetCountMock.mockResolvedValue(100);
 
       //WHEN
       const { body } = await mockApp.get("/users/bob/profile").expect(200);
@@ -2815,8 +2818,9 @@ describe("user controller test", () => {
         banned: true,
       } as any);
 
-      const rank: LeaderboardRank = { count: 100, rank: 24 };
+      const rank = { rank: 24 } as LeaderboardEntry;
       leaderboardGetRankMock.mockResolvedValue(rank);
+      leaderboardGetCountMock.mockResolvedValue(100);
 
       //WHEN
       const { body } = await mockApp.get("/users/bob/profile").expect(200);
@@ -2865,8 +2869,9 @@ describe("user controller test", () => {
       const uid = foundUser.uid;
       getUserMock.mockResolvedValue(foundUser as any);
 
-      const rank: LeaderboardRank = { count: 100, rank: 24 };
+      const rank = { rank: 24 } as LeaderboardEntry;
       leaderboardGetRankMock.mockResolvedValue(rank);
+      leaderboardGetCountMock.mockResolvedValue(100);
 
       //WHEN
       const { body } = await mockApp

backend/__tests__/api/controllers/user.spec.ts

@@ -28,7 +28,7 @@ describe("LeaderboardsDal", () => {
 
       //WHEN
       await LeaderboardsDal.update("time", "15", "english");
-      const result = await LeaderboardsDal.get("time", "15", "english", 0);
+      const result = await LeaderboardsDal.get("time", "15", "english", 0, 50);
 
       //THEN
       expect(result).toHaveLength(1);
@@ -50,7 +50,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "15",
         "english",
-        0
+        0,
+        50
       )) as DBLeaderboardEntry[];
 
       //THEN
@@ -76,7 +77,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "60",
         "english",
-        0
+        0,
+        50
       )) as LeaderboardsDal.DBLeaderboardEntry[];
 
       //THEN
@@ -102,7 +104,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "60",
         "english",
-        0
+        0,
+        50
       )) as DBLeaderboardEntry[];
 
       //THEN
@@ -125,7 +128,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "15",
         "english",
-        0
+        0,
+        50
       )) as DBLeaderboardEntry[];
 
       //THEN
@@ -187,7 +191,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "15",
         "english",
-        0
+        0,
+        50
       )) as DBLeaderboardEntry[];
 
       //THEN
@@ -223,7 +228,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "15",
         "english",
-        0
+        0,
+        50
       )) as DBLeaderboardEntry[];
 
       //THEN
@@ -255,7 +261,8 @@ describe("LeaderboardsDal", () => {
         "time",
         "15",
         "english",
-        0
+        0,
+        50
       )) as DBLeaderboardEntry[];
 
       //THEN

backend/__tests__/dal/leaderboards.spec.ts

@@ -21,4 +21,4 @@ for _, user_id in ipairs(scores_in_range) do
     end
 end
 
-return {results, scores}
+return {results, scores}

backend/redis-scripts/get-results.lua

@@ -7,14 +7,15 @@ import * as WeeklyXpLeaderboard from "../../services/weekly-xp-leaderboard";
 import {
   GetDailyLeaderboardQuery,
   GetDailyLeaderboardRankQuery,
+  GetDailyLeaderboardResponse,
   GetLeaderboardDailyRankResponse,
   GetLeaderboardQuery,
+  GetLeaderboardRankQuery,
   GetLeaderboardRankResponse,
   GetLeaderboardResponse as GetLeaderboardResponse,
   GetWeeklyXpLeaderboardQuery,
   GetWeeklyXpLeaderboardRankResponse,
   GetWeeklyXpLeaderboardResponse,
-  LanguageAndModeQuery,
 } from "@monkeytype/contracts/leaderboards";
 import { Configuration } from "@monkeytype/contracts/schemas/configuration";
 import {
@@ -27,14 +28,14 @@ import { MonkeyRequest } from "../types";
 export async function getLeaderboard(
   req: MonkeyRequest<GetLeaderboardQuery>
 ): Promise<GetLeaderboardResponse> {
-  const { language, mode, mode2, skip = 0, limit = 50 } = req.query;
+  const { language, mode, mode2, page, pageSize } = req.query;
 
   const leaderboard = await LeaderboardsDAL.get(
     mode,
     mode2,
     language,
-    skip,
-    limit
+    page,
+    pageSize
   );
 
   if (leaderboard === false) {
@@ -44,13 +45,18 @@ export async function getLeaderboard(
     );
   }
 
+  const count = await LeaderboardsDAL.getCount(mode, mode2, language);
   const normalizedLeaderboard = leaderboard.map((it) => _.omit(it, ["_id"]));
 
-  return new MonkeyResponse("Leaderboard retrieved", normalizedLeaderboard);
+  return new MonkeyResponse("Leaderboard retrieved", {
+    count,
+    entries: normalizedLeaderboard,
+    pageSize,
+  });
 }
 
 export async function getRankFromLeaderboard(
-  req: MonkeyRequest<LanguageAndModeQuery>
+  req: MonkeyRequest<GetLeaderboardRankQuery>
 ): Promise<GetLeaderboardRankResponse> {
   const { language, mode, mode2 } = req.query;
   const { uid } = req.ctx.decodedToken;
@@ -91,25 +97,33 @@ function getDailyLeaderboardWithError(
 
 export async function getDailyLeaderboard(
   req: MonkeyRequest<GetDailyLeaderboardQuery>
-): Promise<GetLeaderboardResponse> {
-  const { skip = 0, limit = 50 } = req.query;
+): Promise<GetDailyLeaderboardResponse> {
+  const { page, pageSize } = req.query;
 
   const dailyLeaderboard = getDailyLeaderboardWithError(
     req.query,
     req.ctx.configuration.dailyLeaderboards
   );
 
-  const minRank = skip;
-  const maxRank = minRank + limit - 1;
-
-  const topResults = await dailyLeaderboard.getResults(
-    minRank,
-    maxRank,
+  const results = await dailyLeaderboard.getResults(
+    page,
+    pageSize,
     req.ctx.configuration.dailyLeaderboards,
     req.ctx.configuration.users.premium.enabled
   );
 
-  return new MonkeyResponse("Daily leaderboard retrieved", topResults);
+  const minWpm = await dailyLeaderboard.getMinWpm(
+    req.ctx.configuration.dailyLeaderboards
+  );
+
+  const count = await dailyLeaderboard.getCount();
+
+  return new MonkeyResponse("Daily leaderboard retrieved", {
+    entries: results,
+    minWpm,
+    count,
+    pageSize,
+  });
 }
 
 export async function getDailyLeaderboardRank(
@@ -131,8 +145,8 @@ export async function getDailyLeaderboardRank(
 }
 
 function getWeeklyXpLeaderboardWithError(
-  { weeksBefore }: GetWeeklyXpLeaderboardQuery,
-  config: Configuration["leaderboards"]["weeklyXp"]
+  config: Configuration["leaderboards"]["weeklyXp"],
+  weeksBefore?: number
 ): WeeklyXpLeaderboard.WeeklyXpLeaderboard {
   const customTimestamp =
     weeksBefore === undefined
@@ -150,22 +164,26 @@ function getWeeklyXpLeaderboardWithError(
 export async function getWeeklyXpLeaderboardResults(
   req: MonkeyRequest<GetWeeklyXpLeaderboardQuery>
 ): Promise<GetWeeklyXpLeaderboardResponse> {
-  const { skip = 0, limit = 50 } = req.query;
-
-  const minRank = skip;
-  const maxRank = minRank + limit - 1;
+  const { page, pageSize, weeksBefore } = req.query;
 
   const weeklyXpLeaderboard = getWeeklyXpLeaderboardWithError(
-    req.query,
-    req.ctx.configuration.leaderboards.weeklyXp
+    req.ctx.configuration.leaderboards.weeklyXp,
+    weeksBefore
   );
   const results = await weeklyXpLeaderboard.getResults(
-    minRank,
-    maxRank,
-    req.ctx.configuration.leaderboards.weeklyXp
+    page,
+    pageSize,
+    req.ctx.configuration.leaderboards.weeklyXp,
+    req.ctx.configuration.users.premium.enabled
   );
 
-  return new MonkeyResponse("Weekly xp leaderboard retrieved", results);
+  const count = await weeklyXpLeaderboard.getCount();
+
+  return new MonkeyResponse("Weekly xp leaderboard retrieved", {
+    entries: results,
+    count,
+    pageSize,
+  });
 }
 
 export async function getWeeklyXpLeaderboardRank(
@@ -174,7 +192,6 @@ export async function getWeeklyXpLeaderboardRank(
   const { uid } = req.ctx.decodedToken;
 
   const weeklyXpLeaderboard = getWeeklyXpLeaderboardWithError(
-    {},
     req.ctx.configuration.leaderboards.weeklyXp
   );
   const rankEntry = await weeklyXpLeaderboard.getRank(

backend/src/api/controllers/leaderboard.ts

@@ -593,6 +593,7 @@ export async function addResult(
           discordId: user.discordId,
           badgeId: selectedBadgeId,
           lastActivityTimestamp: Date.now(),
+          isPremium,
         },
         xpGained: xpGained.xp,
         timeTypedSeconds: totalDurationTypedSeconds,

backend/src/api/controllers/result.ts

@@ -1071,27 +1071,39 @@ async function getAllTimeLbs(uid: string): Promise<AllTimeLbs> {
     uid
   );
 
+  const allTime15EnglishCount = await LeaderboardsDAL.getCount(
+    "time",
+    "15",
+    "english"
+  );
+
   const allTime60English = await LeaderboardsDAL.getRank(
     "time",
     "60",
     "english",
     uid
   );
 
+  const allTime60EnglishCount = await LeaderboardsDAL.getCount(
+    "time",
+    "60",
+    "english"
+  );
+
   const english15 =
-    allTime15English === false
+    allTime15English === false || allTime15English === null
       ? undefined
       : {
           rank: allTime15English.rank,
-          count: allTime15English.count,
+          count: allTime15EnglishCount,
         };
 
   const english60 =
-    allTime60English === false
+    allTime60English === false || allTime60English === null
       ? undefined
       : {
           rank: allTime60English.rank,
-          count: allTime60English.count,
+          count: allTime60EnglishCount,
         };
 
   return {