Overall and Contest leaderboard (leaderboard + retrieval from backend)

Author: tohyzhong

src/commons/application/ApplicationTypes.ts

@@ -354,7 +354,10 @@ export const defaultAchievement: AchievementState = {
 };
 
 export const defaultLeaderboard: LeaderboardState = {
-  userXp: []
+  userXp: [],
+  contestScore: [],
+  contestPopularVote: [],
+  code: "Initial code"
 }
 
 const getDefaultLanguageConfig = (): SALanguage => {

src/commons/sagas/LeaderboardSaga.ts

@@ -3,7 +3,7 @@ import { combineSagaHandlers } from "../redux/utils";
 import { call, put } from 'redux-saga/effects';
 import { Tokens } from '../application/types/SessionTypes';
 import { selectTokens } from './BackendSaga';
-import { getAllTotalXp } from "./RequestsSaga";
+import { getAllTotalXp, getContestScoreLeaderboard, getContestPopularVoteLeaderboard } from "./RequestsSaga";
 import { actions } from "../utils/ActionsHelper";
 
 const LeaderboardSaga = combineSagaHandlers(LeaderboardActions, {
@@ -15,6 +15,28 @@ const LeaderboardSaga = combineSagaHandlers(LeaderboardActions, {
         if (usersXp) {
           yield put(actions.saveAllUsersXp(usersXp))
         }
+    },
+
+    getAllContestScores: function* (action) {
+      const tokens: Tokens = yield selectTokens();
+      const assessmentId = action.payload;
+  
+      const contestScores = yield call(getContestScoreLeaderboard, assessmentId, tokens);
+  
+      if (contestScores) {
+        yield put(actions.saveAllContestScores(contestScores))
+      }
+    },
+
+    getAllContestPopularVotes: function* (action) {
+      const tokens: Tokens = yield selectTokens();
+      const assessmentId = action.payload;
+  
+      const contestPopularVotes = yield call(getContestPopularVoteLeaderboard, assessmentId, tokens);
+  
+      if (contestPopularVotes) {
+        yield put(actions.saveAllContestPopularVotes(contestPopularVotes))
+      }
     }
 });
 

src/commons/sagas/RequestsSaga.ts

@@ -56,7 +56,7 @@ import { castLibrary } from '../utils/CastBackend';
 import Constants from '../utils/Constants';
 import { showWarningMessage } from '../utils/notifications/NotificationsHelper';
 import { request } from '../utils/RequestHelper';
-import { LeaderboardRow } from 'src/features/leaderboard/LeaderboardTypes';
+import { ContestLeaderboardRow, LeaderboardRow } from 'src/features/leaderboard/LeaderboardTypes';
 
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const XLSX = require('xlsx');
@@ -485,6 +485,70 @@ export const getAllTotalXp = async (tokens: Tokens): Promise<number | null> => {
   );
 };
 
+/**
+ * GET /courses/{courseId}/leaderboard/contests/{assessment_id}/get_score_leaderboard
+ */
+export const getContestScoreLeaderboard = async (
+  assessmentId: number,
+  tokens: Tokens
+): Promise<number | null> => {
+  let resp;
+  resp = await request(`${courseId()}/leaderboard/contests/${assessmentId}/get_score_leaderboard`, 'GET', {
+    ...tokens
+  });
+
+  if (!resp || !resp.ok) {
+    return null; // invalid accessToken _and_ refreshToken
+  }
+  
+  const rows = await resp.json();
+
+  return rows.contest_score.map(
+    (row: any): ContestLeaderboardRow => ({
+      rank: row.rank,
+      name: row.name,
+      username: row.username,
+      score: row.score,
+      avatar: "",
+      code: row.code,
+      submissionId: row.submission_id,
+      votingId: rows.voting_id
+    })
+  );
+};
+
+/**
+ * GET /courses/{courseId}/leaderboard/contests/{assessment_id}/get_popular_vote_leaderboard
+ */
+export const getContestPopularVoteLeaderboard = async (
+  assessmentId: number,
+  tokens: Tokens
+): Promise<number | null> => {
+  let resp;
+  resp = await request(`${courseId()}/leaderboard/contests/${assessmentId}/get_popular_vote_leaderboard`, 'GET', {
+    ...tokens
+  });
+
+  if (!resp || !resp.ok) {
+    return null; // invalid accessToken _and_ refreshToken
+  }
+  
+  const rows = await resp.json();
+
+  return rows.contest_popular.map(
+    (row: any): ContestLeaderboardRow => ({
+      rank: row.rank,
+      name: row.name,
+      username: row.username,
+      score: row.score,
+      avatar: "",
+      code: row.code,
+      submissionId: row.submission_id,
+      votingId: rows.voting_id
+    })
+  );
+};
+
 /**
  * GET /courses/{courseId}/admin/users/{course_reg_id}/assessments
  */
@@ -1169,6 +1233,20 @@ export const deleteSourcecastEntry = async (
   return resp;
 };
 
+/**
+ * POST /courses/{courseId}/admin/assessments/{assessmentId}/calculateContestScore
+ */
+export const calculateContestScore = async (
+  assessmentId: number,
+  tokens: Tokens
+) : Promise<Response | null> => {
+  const resp = await request(`${courseId()}/admin/assessments/${assessmentId}/calculateContestScore`, 'POST', {
+    ...tokens
+  });
+  
+  return resp;
+};
+
 /**
  * GET /courses/{courseId}/admin/assessments/{assessmentId}/scoreLeaderboard
  */

src/features/leaderboard/LeaderboardActions.ts

@@ -1,9 +1,16 @@
 import { createActions } from "src/commons/redux/utils";
-import { LeaderboardRow } from "./LeaderboardTypes";
+import { ContestLeaderboardRow, LeaderboardRow } from "./LeaderboardTypes";
 
 const LeaderboardActions = createActions('leaderboard', {
     getAllUsersXp: () => ({}),
-    saveAllUsersXp: (userXp: LeaderboardRow[]) => userXp
+    saveAllUsersXp: (userXp: LeaderboardRow[]) => userXp,
+    getAllContestScores: (assessmentId: number) => assessmentId,
+    saveAllContestScores: (contestScore: ContestLeaderboardRow[]) => contestScore,
+    getAllContestPopularVotes: (assessmentId: number) => assessmentId,
+    saveAllContestPopularVotes: (contestPopularVote: ContestLeaderboardRow[]) => contestPopularVote,
+    getCode: () => ({}),
+    saveCode: (code: string) => code,
+    clearCode: () => ({})
 });
 
 export default LeaderboardActions

src/features/leaderboard/LeaderboardReducer.ts

@@ -11,6 +11,18 @@ export const LeaderboardReducer: Reducer<LeaderboardState, SourceActionType> = c
     builder
       .addCase(LeaderboardActions.saveAllUsersXp, (state, action) => {
         state.userXp = action.payload;
+      })
+      .addCase(LeaderboardActions.saveAllContestScores, (state, action) => {
+        state.contestScore = action.payload;
+      })
+      .addCase(LeaderboardActions.saveAllContestPopularVotes, (state, action) => {
+        state.contestPopularVote = action.payload;
+      })
+      .addCase(LeaderboardActions.saveCode, (state, action) => {
+        state.code = action.payload;
+      })
+      .addCase(LeaderboardActions.clearCode, (state, action) => {
+        state.code = "";
       });
   }
 );

src/features/leaderboard/LeaderboardTypes.ts

@@ -7,6 +7,26 @@ export type LeaderboardRow = {
     achievements: string;
 };
 
+export type ContestLeaderboardRow = {
+    rank: number;
+    name: string;
+    username: string;
+    score: number;
+    avatar: string;
+    code: string;
+    submissionId: number;
+    votingId: number;
+};
+
 export type LeaderboardState = {
-    userXp: LeaderboardRow[]
-};
+    userXp: LeaderboardRow[];
+    contestScore: ContestLeaderboardRow[];
+    contestPopularVote: ContestLeaderboardRow[];
+    code: string;
+};
+
+export type LeaderboardContestDetails = {
+    contest_id: number;
+    title: string;
+    published: boolean | undefined;
+}