Introduce an option for the leaderboard endpoint to include all contest members (#120)

Author: Antony1060

apps/backend/src/routes/contest/ContestHandler.ts

@@ -33,6 +33,7 @@ import { generateDocument } from "../../lib/document";
 import { generateSnowflake } from "../../lib/snowflake";
 import { useValidation } from "../../middlewares/useValidation";
 import {
+    hasContestPermission as requestHasContestPermission,
     hasOrganisationPermission,
     mustHaveContestPermission,
     mustHaveCurrentOrganisationPermission,
@@ -430,88 +431,106 @@ ContestHandler.get("/members/self", async (req, res) => {
     );
 });
 
-ContestHandler.get("/:contest_id/leaderboard", async (req, res) => {
-    const contest = await extractContest(req);
+const LeaderboardQuerySchema = Type.Object({
+    show_all_users: Type.Optional(Type.Union([Type.Literal("true"), Type.Literal("false")])),
+});
 
-    if (
-        (!contest.show_leaderboard_during_contest || !isContestRunning(contest)) &&
-        !isContestOver(contest)
-    ) {
-        await mustHaveContestPermission(req, ContestMemberPermissions.VIEW_PRIVATE, contest.id);
-    }
+ContestHandler.get(
+    "/:contest_id/leaderboard",
+    useValidation(LeaderboardQuerySchema, { query: true }),
+    async (req, res) => {
+        const contest = await extractContest(req);
 
-    const _contestMembers = await Database.selectFrom("contest_members", "*", {
-        contest_id: contest.id,
-    });
-
-    const users = (
-        await Promise.all(
-            R.chunk(_contestMembers, 100).map((chunk) => {
-                return Database.selectFrom("users", "*", {
-                    id: eqIn(...chunk.map((it) => it.user_id)),
-                });
-            })
-        )
-    ).flat();
+        if (
+            (!contest.show_leaderboard_during_contest || !isContestRunning(contest)) &&
+            !isContestOver(contest)
+        ) {
+            await mustHaveContestPermission(req, ContestMemberPermissions.VIEW_PRIVATE, contest.id);
+        }
 
-    // if for every contestMember doesn't exist a corresponding user
-    if (!_contestMembers.every((it) => users.some((user) => user.id === it.user_id)))
-        throw new SafeError(StatusCodes.INTERNAL_SERVER_ERROR);
+        const _contestMembers = await Database.selectFrom("contest_members", "*", {
+            contest_id: contest.id,
+        });
 
-    const contestMembers = _contestMembers.filter(
-        (it, _, __, user = users.find((user) => user.id === it.user_id)!) =>
-            !hasContestPermission(
-                it.contest_permissions,
-                ContestMemberPermissions.VIEW_PRIVATE,
-                user.permissions
+        const users = (
+            await Promise.all(
+                R.chunk(_contestMembers, 100).map((chunk) => {
+                    return Database.selectFrom("users", "*", {
+                        id: eqIn(...chunk.map((it) => it.user_id)),
+                    });
+                })
             )
-    );
+        ).flat();
 
-    const eduUsers = (
-        await Promise.all(
-            R.chunk(contestMembers, 100).map((chunk) => {
-                return Database.selectFrom("edu_users", "*", {
-                    id: eqIn(...chunk.map((it) => it.user_id)),
-                });
-            })
-        )
-    ).flat();
+        // if for every contestMember doesn't exist a corresponding user
+        if (!_contestMembers.every((it) => users.some((user) => user.id === it.user_id)))
+            throw new SafeError(StatusCodes.INTERNAL_SERVER_ERROR);
 
-    const organisationMembers = await Database.selectFrom(
-        "organisation_members",
-        "*",
-        {
-            organisation_id: contest.organisation_id,
-        },
-        "ALLOW FILTERING"
-    );
-
-    return respond(
-        res,
-        StatusCodes.OK,
-        contestMembers
-            .map(
-                (
-                    it,
-                    _,
-                    __,
-                    user = users.find((user) => user.id === it.user_id)!,
-                    eduUser = eduUsers.find((user) => user.id === it.user_id)
-                ) => ({
-                    ...it,
-                    ...R.pick(
-                        organisationMembers.find((member) => member.user_id === it.user_id)!,
-                        ["elo"]
-                    ),
-                    full_name:
-                        (contest.require_edu_verification && eduUser?.full_name) || user.full_name,
-                    email_domain: user.email.split("@").at(-1),
-                    edu_mail_domain: eduUser?.email.split("@").at(-1),
+        const showAll =
+            req.query.show_all_users === "true" &&
+            (await requestHasContestPermission(
+                req,
+                ContestMemberPermissions.VIEW_PRIVATE,
+                contest.id
+            ).catch(() => false));
+
+        const contestMembers = _contestMembers.filter(
+            (it, _, __, user = users.find((user) => user.id === it.user_id)!) =>
+                showAll ||
+                !hasContestPermission(
+                    it.contest_permissions,
+                    ContestMemberPermissions.VIEW_PRIVATE,
+                    user.permissions
+                )
+        );
+
+        const eduUsers = (
+            await Promise.all(
+                R.chunk(contestMembers, 100).map((chunk) => {
+                    return Database.selectFrom("edu_users", "*", {
+                        id: eqIn(...chunk.map((it) => it.user_id)),
+                    });
                 })
             )
-            .map((it) => ({ ...it, score: it.score ?? {} }))
-    );
-});
+        ).flat();
+
+        const organisationMembers = await Database.selectFrom(
+            "organisation_members",
+            "*",
+            {
+                organisation_id: contest.organisation_id,
+            },
+            "ALLOW FILTERING"
+        );
+
+        return respond(
+            res,
+            StatusCodes.OK,
+            contestMembers
+                .map(
+                    (
+                        it,
+                        _,
+                        __,
+                        user = users.find((user) => user.id === it.user_id)!,
+                        eduUser = eduUsers.find((user) => user.id === it.user_id)
+                    ) => ({
+                        ...it,
+                        ...R.pick(
+                            organisationMembers.find((member) => member.user_id === it.user_id)!,
+                            ["elo"]
+                        ),
+                        full_name:
+                            (contest.require_edu_verification && eduUser?.full_name) ||
+                            user.full_name,
+                        email_domain: user.email.split("@").at(-1),
+                        edu_mail_domain: eduUser?.email.split("@").at(-1),
+                    })
+                )
+                .map((it) => ({ ...it, score: it.score ?? {} }))
+        );
+    }
+);
 
 ContestHandler.get("/:contest_id", async (req, res) => {
     const contest = await extractContest(req);

apps/frontend/src/hooks/contest/participants/useAllContestMembers.ts

@@ -3,12 +3,19 @@ import { useQuery } from "react-query";
 
 import { http, QueryHandler, wrapAxios } from "../../../api/http";
 
-export const useAllContestMembers: QueryHandler<ContestMemberWithInfo[], Snowflake> = (
-    contest_id,
-    options
-) =>
+export const useAllContestMembers: QueryHandler<
+    ContestMemberWithInfo[],
+    [Snowflake, { showAllUsers?: boolean }]
+> = ([contest_id, leaderboardOptions], options) =>
     useQuery({
         queryKey: ["contests", contest_id, "members"],
-        queryFn: () => wrapAxios(http.get(`/contest/${contest_id}/leaderboard`)),
+        queryFn: () =>
+            wrapAxios(
+                http.get(
+                    `/contest/${contest_id}/leaderboard?show_all_users=${
+                        leaderboardOptions.showAllUsers ?? false
+                    }`
+                )
+            ),
         ...options,
     });

apps/frontend/src/pages/contests/Leaderboard.tsx

@@ -28,7 +28,7 @@ export const Leaderboard: FC<Properties> = ({ contest, problems }) => {
         [contest, contestEnded, user]
     );
 
-    const { isSuccess, data } = useAllContestMembers(contest.id, {
+    const { isSuccess, data } = useAllContestMembers([contest.id, {}], {
         enabled: leaderboardVisible,
     });
 

apps/frontend/src/pages/management/contest/overview/ContestOverviewPage.tsx

@@ -96,7 +96,7 @@ export const ContestOverviewPage: FC = () => {
 
     // I guess we could make a route to get this info without getting all data, but it should be fine
     const questions = useAllContestQuestions(contest.id);
-    const members = useAllContestMembers(contest.id);
+    const members = useAllContestMembers([contest.id, {}]);
     const announcements = useAllContestAnnouncements(contest.id);
 
     const { t } = useTranslation();

apps/frontend/src/pages/management/contest/participants/ContestParticipantsPage.tsx

@@ -144,7 +144,7 @@ const AddParticipantSchema = z.object({
 export const ContestParticipantsPage: FC = () => {
     const { contest } = useContestContext();
 
-    const { data: members } = useAllContestMembers(contest.id);
+    const { data: members } = useAllContestMembers([contest.id, { showAllUsers: true }]);
 
     const addMutation = useAddParticipant(contest.id);
 

apps/frontend/src/pages/management/contest/results/ContestResultsPage.tsx

@@ -36,7 +36,7 @@ const calculateGradeFromScale = (
 export const ContestResultsPage: FC = () => {
     const { contest } = useContestContext();
 
-    const { data: members } = useAllContestMembers(contest.id);
+    const { data: members } = useAllContestMembers([contest.id, {}]);
     const { data: problems } = useAllProblems(contest.id);
     const { data: gradingScales } = useAllContestGradingScales(contest.id);