group results, count and minWpm into one redis call

fehmer · fehmer · commit 53963711339e · 2025-08-07T15:46:05.000+02:00
diff --git a/backend/__tests__/__integration__/utils/daily-leaderboards.spec.ts b/backend/__tests__/__integration__/utils/daily-leaderboards.spec.ts
@@ -119,10 +119,14 @@ describe("Daily Leaderboards", () => {
           true
         );
         //THEN
-        expect(results).toEqual([
-          { rank: 1, ...bestResult },
-          { rank: 2, ...user2 },
-        ]);
+        expect(results).toEqual({
+          count: 2,
+          minWpm: 20,
+          entries: [
+            { rank: 1, ...bestResult },
+            { rank: 2, ...user2 },
+          ],
+        });
       });
 
       it("limits max amount of results", async () => {
@@ -135,7 +139,9 @@ describe("Daily Leaderboards", () => {
             .fill(0)
             .map(() => givenResult({ wpm: 20 + Math.random() * 100 }))
         );
-        expect(await lb.getCount()).toEqual(maxResults);
+        expect(
+          await lb.getResults(0, 5, dailyLeaderboardsConfig, true)
+        ).toEqual(expect.objectContaining({ count: maxResults }));
         expect(await lb.getRank(bob.uid, dailyLeaderboardsConfig)).toEqual({
           rank: maxResults,
           ...bob,
@@ -146,7 +152,9 @@ describe("Daily Leaderboards", () => {
 
         //THEN
         //max count is still the same, but bob is no longer on the leaderboard
-        expect(await lb.getCount()).toEqual(maxResults);
+        expect(
+          await lb.getResults(0, 5, dailyLeaderboardsConfig, true)
+        ).toEqual(expect.objectContaining({ count: maxResults }));
         expect(await lb.getRank(bob.uid, dailyLeaderboardsConfig)).toBeNull();
       });
     });
@@ -165,11 +173,15 @@ describe("Daily Leaderboards", () => {
           true
         );
         //THEN
-        expect(results).toEqual([
-          { rank: 1, ...user2 },
-          { rank: 2, ...user1 },
-          { rank: 3, ...user3 },
-        ]);
+        expect(results).toEqual({
+          count: 3,
+          minWpm: 40,
+          entries: [
+            { rank: 1, ...user2 },
+            { rank: 2, ...user1 },
+            { rank: 3, ...user3 },
+          ],
+        });
       });
       it("gets result for page", async () => {
         //GIVEN
@@ -187,10 +199,14 @@ describe("Daily Leaderboards", () => {
           true
         );
         //THEN
-        expect(results).toEqual([
-          { rank: 3, ...user4 },
-          { rank: 4, ...user3 },
-        ]);
+        expect(results).toEqual({
+          count: 5,
+          minWpm: 20,
+          entries: [
+            { rank: 3, ...user4 },
+            { rank: 4, ...user3 },
+          ],
+        });
       });
 
       it("gets result without premium", async () => {
@@ -207,11 +223,15 @@ describe("Daily Leaderboards", () => {
           false
         );
         //THEN
-        expect(results).toEqual([
-          { rank: 1, ...user2, isPremium: undefined },
-          { rank: 2, ...user1, isPremium: undefined },
-          { rank: 3, ...user3, isPremium: undefined },
-        ]);
+        expect(results).toEqual({
+          count: 3,
+          minWpm: 40,
+          entries: [
+            { rank: 1, ...user2, isPremium: undefined },
+            { rank: 2, ...user1, isPremium: undefined },
+            { rank: 3, ...user3, isPremium: undefined },
+          ],
+        });
       });
 
       it("should get for friends only", async () => {
@@ -220,6 +240,7 @@ describe("Daily Leaderboards", () => {
         const user2 = await givenResult({ wpm: 80 });
         const _user3 = await givenResult({ wpm: 70 });
         const user4 = await givenResult({ wpm: 60 });
+        const _user5 = await givenResult({ wpm: 50 });
 
         //WHEN
         const results = await lb.getResults(
@@ -230,10 +251,14 @@ describe("Daily Leaderboards", () => {
           [user2.uid, user4.uid]
         );
         //THEN
-        expect(results).toEqual([
-          { rank: 2, friendsRank: 1, ...user2 },
-          { rank: 4, friendsRank: 2, ...user4 },
-        ]);
+        expect(results).toEqual({
+          count: 2,
+          minWpm: 60,
+          entries: [
+            { rank: 2, friendsRank: 1, ...user2 },
+            { rank: 4, friendsRank: 2, ...user4 },
+          ],
+        });
       });
 
       it("should get for friends only with page", async () => {
@@ -242,6 +267,7 @@ describe("Daily Leaderboards", () => {
         const user2 = await givenResult({ wpm: 100 });
         const _user3 = await givenResult({ wpm: 95 });
         const user4 = await givenResult({ wpm: 90 });
+        const _user5 = await givenResult({ wpm: 70 });
 
         //WHEN
 
@@ -254,7 +280,11 @@ describe("Daily Leaderboards", () => {
         );
 
         //THEN
-        expect(results).toEqual([{ rank: 4, friendsRank: 3, ...user4 }]);
+        expect(results).toEqual({
+          count: 3,
+          minWpm: 90,
+          entries: [{ rank: 4, friendsRank: 3, ...user4 }],
+        });
       });
 
       it("should return empty list if no friends", async () => {
@@ -269,20 +299,11 @@ describe("Daily Leaderboards", () => {
           []
         );
         //THEN
-        expect(results).toEqual([]);
-      });
-    });
-
-    describe("minWpm", () => {
-      it("gets min wpm", async () => {
-        //GIVEN
-        await givenResult({ wpm: 50 });
-        await givenResult({ wpm: 60 });
-
-        //WHEN
-        const minWpm = await lb.getMinWpm(dailyLeaderboardsConfig);
-        //THEN
-        expect(minWpm).toEqual(50);
+        expect(results).toEqual({
+          count: 0,
+          minWpm: 0,
+          entries: [],
+        });
       });
     });
 
@@ -299,23 +320,11 @@ describe("Daily Leaderboards", () => {
       });
     });
 
-    describe("getCount", () => {
-      it("gets count", async () => {
-        //GIVEN
-        await givenResult({ wpm: 50 });
-        await givenResult({ wpm: 60 });
-
-        //WHEN
-        const count = await lb.getCount();
-        //THEN
-        expect(count).toEqual(2);
-      });
-    });
-
     it("purgeUserFromDailyLeaderboards", async () => {
       //GIVEN
       const cheater = await givenResult({ wpm: 50 });
-      const validUser = await givenResult();
+      const user1 = await givenResult({ wpm: 60 });
+      const user2 = await givenResult({ wpm: 40 });
 
       //WHEN
       await DailyLeaderboards.purgeUserFromDailyLeaderboards(
@@ -325,7 +334,14 @@ describe("Daily Leaderboards", () => {
       //THEN
       expect(await lb.getRank(cheater.uid, dailyLeaderboardsConfig)).toBeNull();
       expect(await lb.getResults(0, 50, dailyLeaderboardsConfig, true)).toEqual(
-        [{ rank: 1, ...validUser }]
+        {
+          count: 2,
+          minWpm: 40,
+          entries: [
+            { rank: 1, ...user1 },
+            { rank: 2, ...user2 },
+          ],
+        }
       );
     });
 
diff --git a/backend/__tests__/api/controllers/leaderboard.spec.ts b/backend/__tests__/api/controllers/leaderboard.spec.ts
@@ -457,31 +457,21 @@ describe("Loaderboard Controller", () => {
     const getFriendsUidsMock = vi.spyOn(FriendDal, "getFriendsUids");
 
     const getResultMock = vi.fn();
-    const getCountMock = vi.fn();
-    const getMinWpmMock = vi.fn();
 
     beforeEach(async () => {
-      [
-        getDailyLeaderboardMock,
-        getFriendsUidsMock,
-        getResultMock,
-        getCountMock,
-        getMinWpmMock,
-      ].forEach((it) => it.mockClear());
+      [getDailyLeaderboardMock, getFriendsUidsMock, getResultMock].forEach(
+        (it) => it.mockClear()
+      );
 
       vi.useFakeTimers();
       vi.setSystemTime(1722606812000);
       await dailyLeaderboardEnabled(true);
 
       getDailyLeaderboardMock.mockReturnValue({
         getResults: getResultMock,
-        getCount: getCountMock,
-        getMinWpm: getMinWpmMock,
       } as any);
 
-      getResultMock.mockResolvedValue([]);
-      getCountMock.mockResolvedValue(0);
-      getMinWpmMock.mockResolvedValue(0);
+      getResultMock.mockResolvedValue(null);
     });
 
     afterEach(() => {
@@ -521,9 +511,11 @@ describe("Loaderboard Controller", () => {
         ],
       };
 
-      getResultMock.mockResolvedValue(resultData);
-      getCountMock.mockResolvedValue(2);
-      getMinWpmMock.mockResolvedValue(10);
+      getResultMock.mockResolvedValue({
+        count: 2,
+        minWpm: 10,
+        entries: resultData,
+      });
 
       //WHEN
       const { body } = await mockApp
@@ -600,9 +592,7 @@ describe("Loaderboard Controller", () => {
       const page = 2;
       const pageSize = 25;
 
-      getResultMock.mockResolvedValue([]);
-      getCountMock.mockResolvedValue(0);
-      getMinWpmMock.mockResolvedValue(0);
+      getResultMock.mockResolvedValue({ entries: [] });
 
       //WHEN
       const { body } = await mockApp
diff --git a/backend/redis-scripts/get-results.lua b/backend/redis-scripts/get-results.lua
@@ -18,22 +18,29 @@ local user_ids_csv = ARGV[4]
 local results = {}
 local scores = {}
 local ranks = {}
+local count = nil
+local min_score = {user_id = nil, score = nil}
 
 
--- Filtered leaderboard
+-- filtered leaderboard
 if user_ids_csv ~= "" then  
 
     local filtered_user_ids = split_csv(user_ids_csv)
     local scored_users = {}
     for _, user_id in ipairs(filtered_user_ids) do
         local score = redis_call('ZSCORE', leaderboard_scores_key, user_id)
         if score then
-            table.insert(scored_users, {user_id = user_id, score = tonumber(score)})
+            local number_score = tonumber(score)            
+            table.insert(scored_users, {user_id = user_id, score = number_score})
         end
     end
     table.sort(scored_users, function(a, b) return a.score > b.score end)
 
 
+    if #scored_users > 0 then
+        min_score = {scored_users[#scored_users].user_id, scored_users[#scored_users].score}
+    end
+    count = #scored_users
 
     for i = min_rank + 1, math.min(max_rank + 1, #scored_users) do
         local entry = scored_users[i]
@@ -54,10 +61,12 @@ if user_ids_csv ~= "" then
         end
    
     end 
--- Global leaderboard
-else
 
+else
+-- global leaderboard
     local scores_in_range = redis_call('ZRANGE', leaderboard_scores_key, min_rank, max_rank, 'REV')
+    min_score = redis_call('ZRANGE', leaderboard_scores_key, 0, 0, 'WITHSCORES')
+    count = redis_call('ZCARD', leaderboard_scores_key)
 
     for _, user_id in ipairs(scores_in_range) do
         local result_data = redis_call('HGET', leaderboard_results_key, user_id)
@@ -72,4 +81,4 @@ else
     end
 end
 
-return {results, scores, ranks}
+return {results, scores, count, min_score, ranks}
diff --git a/backend/src/api/controllers/leaderboard.ts b/backend/src/api/controllers/leaderboard.ts
@@ -160,16 +160,10 @@ export async function getDailyLeaderboard(
     friendUids
   );
 
-  const minWpm = await dailyLeaderboard.getMinWpm(
-    req.ctx.configuration.dailyLeaderboards
-  );
-
-  const count = await dailyLeaderboard.getCount();
-
   return new MonkeyResponse("Daily leaderboard retrieved", {
-    entries: results,
-    minWpm,
-    count,
+    entries: results?.entries ?? [],
+    count: results?.count ?? 0,
+    minWpm: results?.minWpm ?? 0,
     pageSize,
   });
 }
diff --git a/backend/src/init/redis.ts b/backend/src/init/redis.ts
@@ -35,7 +35,7 @@ export type RedisConnectionWithCustomMethods = Redis & {
     maxRank: number,
     withScores: string,
     userIds: string
-  ) => Promise<[string[], string[], string[]]>; //entries, scores(optional), ranks(optional)
+  ) => Promise<[string[], string[], string, string, string[]]>; //entries, scores(optional), count, min_score(optiona), ranks(optional)
   purgeResults: (
     keyCount: number,
     uid: string,
diff --git a/backend/src/services/weekly-xp-leaderboard.ts b/backend/src/services/weekly-xp-leaderboard.ts
@@ -144,7 +144,8 @@ export class WeeklyXpLeaderboard {
       weeklyXpLeaderboardResultsKey,
       minRank,
       maxRank,
-      "true"
+      "true",
+      "" //TODO friends
     )) as string[][];
 
     if (results === undefined) {
diff --git a/backend/src/utils/daily-leaderboards.ts b/backend/src/utils/daily-leaderboards.ts
diff --git a/backend/src/workers/later-worker.ts b/backend/src/workers/later-worker.ts
