Started classroom leaderboard implementation

Author: gabortodor

zeeguu/api/endpoints/leaderboards.py

@@ -4,11 +4,13 @@
 import flask
 from flask import request
 
+from zeeguu.core.leaderboards.leaderboards import cohort_leaderboard_user_ids_subquery
 from zeeguu.api.utils.abort_handling import make_error
 from zeeguu.api.utils.json_result import json_result
 from zeeguu.api.utils.route_wrappers import cross_domain, requires_session
 from zeeguu.core.leaderboards.leaderboards import exercise_time_leaderboard, exercises_done_leaderboard, \
-    read_articles_leaderboard, reading_time_leaderboard, listening_time_leaderboard
+    read_articles_leaderboard, reading_time_leaderboard, listening_time_leaderboard, \
+    friend_leaderboard_user_ids_subquery
 from . import api
 
 LeaderboardMetric = Callable[[int, int, Optional[datetime], Optional[datetime]], list]
@@ -38,7 +40,36 @@ def friends_leaderboard():
         return make_error(400, "Invalid leaderboard metric")
 
     rows = metric(
-        flask.g.user_id,
+        friend_leaderboard_user_ids_subquery(flask.g.user_id),
+        params["limit"],
+        params["from_date"],
+        params["to_date"],
+    )
+
+    result = [
+        _serialize_leaderboard_row(row)
+        for row in rows
+    ]
+
+    return json_result(result)
+
+# ---------------------------------------------------------------------------
+@api.route("/cohort_leaderboard/<cohort_id>", methods=["GET"])
+# ---------------------------------------------------------------------------
+@cross_domain
+@requires_session
+def cohort_leaderboard(cohort_id: int):
+    params, error_response = _parse_leaderboard_query_params()
+    if error_response:
+        return error_response
+
+    metric = LEADERBOARD_METRICS.get(request.args.get("metric"))
+
+    if not metric:
+        return make_error(400, "Invalid leaderboard metric")
+
+    rows = metric(
+        cohort_leaderboard_user_ids_subquery(cohort_id),
         params["limit"],
         params["from_date"],
         params["to_date"],

zeeguu/core/leaderboards/leaderboards.py

@@ -7,7 +7,7 @@
 
 
 def exercise_time_leaderboard(
-        user_id: int,
+        user_ids_subquery,
         limit: int = 20,
         from_date=None,
         to_date=None,
@@ -18,8 +18,6 @@ def exercise_time_leaderboard(
     """
     from zeeguu.core.model.user_exercise_session import UserExerciseSession
 
-    related_user_ids = _friend_leaderboard_user_ids_subquery(user_id)
-
     total_duration = func.coalesce(func.sum(UserExerciseSession.duration), 0)
 
     joins = [
@@ -34,15 +32,15 @@ def exercise_time_leaderboard(
     ]
 
     return _leaderboard_base(
-        related_user_ids,
+        user_ids_subquery,
         total_duration,
         joins,
         limit,
     )
 
 
 def listening_time_leaderboard(
-        user_id: int,
+        user_ids_subquery,
         limit: int = 20,
         from_date=None,
         to_date=None,
@@ -53,8 +51,6 @@ def listening_time_leaderboard(
     """
     from zeeguu.core.model.user_listening_session import UserListeningSession
 
-    related_user_ids = _friend_leaderboard_user_ids_subquery(user_id)
-
     total_duration = func.coalesce(func.sum(UserListeningSession.duration), 0)
 
     joins = [
@@ -69,15 +65,15 @@ def listening_time_leaderboard(
     ]
 
     return _leaderboard_base(
-        related_user_ids,
+        user_ids_subquery,
         total_duration,
         joins,
         limit,
     )
 
 
 def read_articles_leaderboard(
-        user_id: int,
+        user_ids_subquery,
         limit: int = 20,
         from_date=None,
         to_date=None,
@@ -88,8 +84,6 @@ def read_articles_leaderboard(
     """
     from zeeguu.core.model.user_article import UserArticle
 
-    related_user_ids = _friend_leaderboard_user_ids_subquery(user_id)
-
     completed_articles_count = func.count(UserArticle.id)
 
     joins = [
@@ -105,15 +99,15 @@ def read_articles_leaderboard(
     ]
 
     return _leaderboard_base(
-        related_user_ids,
+        user_ids_subquery,
         completed_articles_count,
         joins,
         limit,
     )
 
 
 def reading_time_leaderboard(
-        user_id: int,
+        user_ids_subquery,
         limit: int = 20,
         from_date=None,
         to_date=None,
@@ -124,8 +118,6 @@ def reading_time_leaderboard(
     """
     from zeeguu.core.model.user_reading_session import UserReadingSession
 
-    related_user_ids = _friend_leaderboard_user_ids_subquery(user_id)
-
     total_duration = func.coalesce(func.sum(UserReadingSession.duration), 0)
 
     joins = [
@@ -140,15 +132,15 @@ def reading_time_leaderboard(
     ]
 
     return _leaderboard_base(
-        related_user_ids,
+        user_ids_subquery,
         total_duration,
         joins,
         limit,
     )
 
 
 def exercises_done_leaderboard(
-        user_id: int,
+        user_ids_subquery,
         limit: int = 20,
         from_date=None,
         to_date=None,
@@ -167,8 +159,6 @@ def exercises_done_leaderboard(
         *ExerciseOutcome.correct_after_translation
     ]
 
-    related_user_ids = _friend_leaderboard_user_ids_subquery(user_id)
-
     exercises_done_count = func.coalesce(
         func.sum(
             case(
@@ -193,14 +183,14 @@ def exercises_done_leaderboard(
     ]
 
     return _leaderboard_base(
-        related_user_ids,
+        user_ids_subquery,
         exercises_done_count,
         joins,
         limit,
     )
 
 
-def _friend_leaderboard_user_ids_subquery(user_id: int):
+def friend_leaderboard_user_ids_subquery(user_id: int):
     # For each friendship row touching this user, select "the other user".
     return (
         db.session.query(
@@ -216,6 +206,15 @@ def _friend_leaderboard_user_ids_subquery(user_id: int):
         .subquery()
     )
 
+def cohort_leaderboard_user_ids_subquery(cohort_id: int):
+    from zeeguu.core.model.user_cohort_map import UserCohortMap
+
+    return (
+        db.session.query(UserCohortMap.user_id.label("user_id"))
+        .filter(UserCohortMap.cohort_id == cohort_id)
+        .subquery()
+    )
+
 
 def _leaderboard_base(
         user_ids_subquery,