add CP to global leaderboards (#224)

add CP (recency_weighted) to global leaderboards in a similar method to "excluded" entries

Author: lsabor

front_end/src/app/(main)/(leaderboards)/leaderboard/components/leaderboard_table/index.tsx

@@ -82,9 +82,13 @@ const LeaderboardTable: FC<Props> = ({
           {!!entriesToDisplay.length ? (
             entriesToDisplay.map((entry) => (
               <LeaderboardRow
-                key={`ranking-row-${category}-${entry.user.id}`}
+                key={`ranking-row-${category}-${entry.user ? entry.user.id : entry.aggregation_method!}`}
                 rowEntry={entry}
-                href={`/accounts/profile/${entry.user.id}?mode=medals`}
+                href={
+                  entry.user
+                    ? `/accounts/profile/${entry.user.id}?mode=medals`
+                    : `/questions/track-record`
+                }
               />
             ))
           ) : (

front_end/src/app/(main)/(leaderboards)/leaderboard/components/leaderboard_table/table_row.tsx

@@ -21,7 +21,8 @@ type Props = {
 };
 
 const LeaderboardRow: FC<Props> = ({ rowEntry, href, isUserRow = false }) => {
-  const { user, rank, contribution_count, score, medal } = rowEntry;
+  const { user, aggregation_method, rank, contribution_count, score, medal } =
+    rowEntry;
 
   return (
     <tr
@@ -33,7 +34,7 @@ const LeaderboardRow: FC<Props> = ({ rowEntry, href, isUserRow = false }) => {
         },
         {
           "bg-purple-200 hover:bg-purple-300 dark:bg-purple-200-dark hover:dark:bg-purple-300-dark":
-            !isUserRow && !!user.is_staff,
+            !isUserRow && !!user?.is_staff,
         }
       )}
     >
@@ -56,7 +57,11 @@ const LeaderboardRow: FC<Props> = ({ rowEntry, href, isUserRow = false }) => {
           href={href}
           className="flex items-center truncate px-4 py-2.5 no-underline"
         >
-          {user.username}
+          {user
+            ? user.username
+            : aggregation_method == "recency_weighted"
+              ? "Recency Weighted CP"
+              : aggregation_method}
         </Link>
       </td>
       <td className="hidden w-24 p-0 font-mono text-base leading-4 @md:!table-cell">
@@ -102,7 +107,7 @@ export const UserLeaderboardRow: FC<UserLeaderboardRowProps> = ({
 
   const userHref = userEntry.medal
     ? "/medals"
-    : `/contributions/?${SCORING_CATEGORY_FILTER}=${category}&${CONTRIBUTIONS_USER_FILTER}=${userEntry.user.id}&${SCORING_YEAR_FILTER}=${year}&${SCORING_DURATION_FILTER}=${duration}`;
+    : `/contributions/?${SCORING_CATEGORY_FILTER}=${category}&${CONTRIBUTIONS_USER_FILTER}=${userEntry.user!.id}&${SCORING_YEAR_FILTER}=${year}&${SCORING_DURATION_FILTER}=${duration}`;
 
   return <LeaderboardRow rowEntry={userEntry} href={userHref} isUserRow />;
 };

front_end/src/app/(main)/(leaderboards)/leaderboard/components/project_leaderboard_table/index.tsx

@@ -73,7 +73,7 @@ const ProjectLeaderboardTable: FC<Props> = ({
         <tbody>
           {leaderboardEntries.map((entry) => (
             <TableRow
-              key={entry.user.id}
+              key={entry.user?.id ?? entry.aggregation_method}
               rowEntry={entry}
               userId={userId}
               withTake={withTake}

front_end/src/app/(main)/(leaderboards)/leaderboard/components/project_leaderboard_table/table_row.tsx

@@ -22,9 +22,9 @@ const TableRow: FC<Props> = ({
   userId,
   prizePool,
 }) => {
-  const { user, medal, rank, score, contribution_count, take, percent_prize } =
+  const { user, aggregation_method, medal, rank, score, take, percent_prize } =
     rowEntry;
-  const highlight = user.id === userId;
+  const highlight = user?.id === userId;
 
   return (
     <tr className="h-8">
@@ -37,7 +37,13 @@ const TableRow: FC<Props> = ({
         {rank}
       </Td>
       <Td className="sticky left-0 text-left" highlight={highlight}>
-        <Link href={`/accounts/profile/${user.id}/`}>{user.username}</Link>
+        <Link
+          href={
+            user ? `/accounts/profile/${user.id}/` : `questions/track-record/`
+          }
+        >
+          {user ? user.username : aggregation_method}
+        </Link>
       </Td>
       <Td className="text-right" highlight={highlight}>
         {score.toFixed(2)}

front_end/src/app/(main)/(leaderboards)/medals/page.tsx

@@ -35,7 +35,7 @@ export default async function Medals({
     MedalsPath.Profile;
 
   const userMedals = await LeaderboardApi.getUserMedals(userId);
-  const username = userMedals.at(0)?.user.username;
+  const username = userMedals.at(0)?.user!.username;
 
   return (
     <main className="mb-auto pb-3 text-blue-700 dark:text-blue-700-dark sm:px-3">

front_end/src/types/scoring.ts

@@ -41,7 +41,8 @@ export type MedalCategory = {
 };
 
 export type LeaderboardEntry = {
-  user: User;
+  user: User | null;
+  aggregation_method: string | null;
   score: number;
   rank: number | null;
   excluded: boolean;

scoring/migrations/0010_leaderboardentry_aggregation_method_and_more.py

@@ -0,0 +1,26 @@
+# Generated by Django 5.0.8 on 2024-08-21 21:50
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('scoring', '0009_score_aggregation_method_alter_score_user'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='leaderboardentry',
+            name='aggregation_method',
+            field=models.CharField(choices=[('recency_weighted', 'Recency Weighted'), ('unweighted', 'Unweighted'), ('single_aggregation', 'Single Aggregation')], max_length=200, null=True),
+        ),
+        migrations.AlterField(
+            model_name='leaderboardentry',
+            name='user',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+        ),
+    ]

scoring/models.py

@@ -47,6 +47,7 @@ class ScoreTypes(models.TextChoices):
 
 
 class Leaderboard(TimeStampedModel):
+    # typing
     id: int
     project_id: int
     objects: models.Manager["Leaderboard"]
@@ -138,9 +139,15 @@ def get_questions(self) -> list[Question]:
 
 
 class LeaderboardEntry(TimeStampedModel):
+    # typing
+    id: int
     objects: models.Manager["LeaderboardEntry"]
+    user_id: int | None
 
-    user = models.ForeignKey(User, on_delete=models.CASCADE)
+    user = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
+    aggregation_method = models.CharField(
+        max_length=200, null=True, choices=AggregationMethod.choices
+    )
     leaderboard = models.ForeignKey(
         Leaderboard, on_delete=models.CASCADE, related_name="entries", null=True
     )

scoring/serializers.py

@@ -6,6 +6,7 @@
 
 class LeaderboardEntrySerializer(serializers.ModelSerializer):
     user = BaseUserSerializer(required=False)
+    aggregation_method = serializers.CharField()
     score = serializers.FloatField()
     rank = serializers.IntegerField()
     excluded = serializers.BooleanField()
@@ -21,6 +22,7 @@ class Meta:
         model = LeaderboardEntry
         fields = [
             "user",
+            "aggregation_method",
             "score",
             "rank",
             "excluded",

scoring/utils.py

@@ -10,6 +10,7 @@
 from posts.models import Post
 from projects.models import Project
 from questions.models import Question
+from questions.types import AggregationMethod
 from scoring.models import Score, LeaderboardEntry, Leaderboard, MedalExclusionRecord
 from scoring.score_math import evaluate_question
 from utils.the_math.formulas import string_location_to_bucket_index
@@ -58,34 +59,33 @@ def generate_scoring_leaderboard_entries(
     questions: list[Question],
     leaderboard: Leaderboard,
 ) -> list[LeaderboardEntry]:
-    # TODO: add aggregate scores
     scores: QuerySet[Score] = Score.objects.filter(
-        user__isnull=False,
         question__in=questions,
         score_type=Leaderboard.ScoreTypes.get_base_score(leaderboard.score_type),
     )
-    user_entries: dict[int, LeaderboardEntry] = {}
+    entries: dict[int | AggregationMethod, LeaderboardEntry] = {}
     now = timezone.now()
     for score in scores:
-        user_id = score.user_id
-        if user_id not in user_entries:
-            user_entries[user_id] = LeaderboardEntry(
-                user_id=user_id,
+        identifier = score.user_id or score.aggregation_method
+        if identifier not in entries:
+            entries[identifier] = LeaderboardEntry(
+                user_id=score.user_id,
+                aggregation_method=score.aggregation_method,
                 score=0,
                 coverage=0,
                 contribution_count=0,
                 calculated_on=now,
             )
-        user_entries[user_id].score += score.score
-        user_entries[user_id].coverage += score.coverage
-        user_entries[user_id].contribution_count += 1
+        entries[identifier].score += score.score
+        entries[identifier].coverage += score.coverage
+        entries[identifier].contribution_count += 1
     if leaderboard.score_type == Leaderboard.ScoreTypes.PEER_GLOBAL:
-        for entry in user_entries.values():
+        for entry in entries.values():
             entry.score /= max(30, entry.coverage)
     elif leaderboard.score_type == Leaderboard.ScoreTypes.PEER_GLOBAL_LEGACY:
-        for entry in user_entries.values():
+        for entry in entries.values():
             entry.score /= max(40, entry.contribution_count)
-    return sorted(user_entries.values(), key=lambda entry: entry.score, reverse=True)
+    return sorted(entries.values(), key=lambda entry: entry.score, reverse=True)
 
 
 def generate_comment_insight_leaderboard_entries(
@@ -221,20 +221,27 @@ def update_project_leaderboard(
             start_time__lte=leaderboard.finalize_time
         )
     excluded_users = exclusion_records.values_list("user", flat=True)
+    excluded_user_ids = set([r.user.id for r in exclusion_records])
     # medals
     golds = silvers = bronzes = 0
     if (
         (leaderboard.project.type != "question_series")
         and leaderboard.finalize_time
         and (timezone.now() > leaderboard.finalize_time)
     ):
-        entry_count = len(new_entries)
+        entry_count = len(
+            [
+                e
+                for e in new_entries
+                if (e.user_id and (e.user_id not in excluded_user_ids))
+            ]
+        )
         golds = max(0.01 * entry_count, 1)
         silvers = max(0.01 * entry_count, 1)
         bronzes = max(0.03 * entry_count, 1)
     rank = 1
     for entry in new_entries:
-        if entry.user.id in excluded_users:
+        if (entry.user_id is None) or (entry.user_id in excluded_users):
             entry.excluded = True
             entry.medal = None
             entry.rank = rank
@@ -251,7 +258,9 @@ def update_project_leaderboard(
     for new_entry in new_entries:
         new_entry.leaderboard = leaderboard
         for previous_entry in previous_entries:
-            if previous_entry.user == new_entry.user:
+            if (previous_entry.user_id == new_entry.user_id) and (
+                previous_entry.aggregation_method == new_entry.aggregation_method
+            ):
                 new_entry.id = previous_entry.id
                 seen.add(previous_entry)
                 break