feat(user): add fetchTopLanguageLeaderboardSlugs API and mirage handler

Add a new member action fetchTopLanguageLeaderboardSlugs to the UserModel
to retrieve the top language leaderboard slugs for the current user. This 
enables fetching the top 3 language leaderboards where the user has the highest 
scores.

Implement a corresponding MirageJS handler to support this endpoint for 
development and testing, returning sorted and filtered leaderboard slugs based 
on the current user's leaderboard entries.

Fix swapped implementations of fetchCurrent and fetchNextInvoicePreview actions 
to correctly match their respective API endpoints and return types.

Author: rohitpaulk

app/models/leaderboard-entry.ts

@@ -2,7 +2,6 @@ import Model, { attr, belongsTo } from '@ember-data/model';
 import type LeaderboardModel from './leaderboard';
 import type UserModel from './user';
 import CourseModel from './course';
-import { collectionAction } from 'ember-api-actions';
 
 export default class LeaderboardEntryModel extends Model {
   @belongsTo('leaderboard', { async: false, inverse: 'entries' }) declare leaderboard: LeaderboardModel;
@@ -23,22 +22,4 @@ export default class LeaderboardEntryModel extends Model {
 
     return this.relatedCourseSlugs.map((slug) => allCourses.find((course) => course.slug === slug)).filter(Boolean);
   }
-
-  declare fetchForCurrentUser: (this: Model, payload: unknown) => Promise<LeaderboardEntryModel[]>;
 }
-
-LeaderboardEntryModel.prototype.fetchForCurrentUser = collectionAction({
-  path: 'for-current-user',
-  type: 'get',
-  urlType: 'findAll',
-
-  after(response) {
-    if (response.data) {
-      this.store.pushPayload(response);
-
-      return response.data.map((data: { id: string }) => this.store.peekRecord('leaderboard-entry', data.id));
-    } else {
-      return [];
-    }
-  },
-});

app/models/user.ts

@@ -226,41 +226,47 @@ export default class UserModel extends Model {
 
   declare fetchCurrent: (this: Model, payload: unknown) => Promise<UserModel | null>;
   declare fetchNextInvoicePreview: (this: Model, payload: unknown) => Promise<InvoiceModel | null>;
+  declare fetchTopLanguageLeaderboardSlugs: (this: Model, payload: unknown) => Promise<string[]>;
   declare syncFeatureFlags: (this: Model, payload: unknown) => Promise<void>;
   declare syncUsernameFromGitHub: (this: Model, payload: unknown) => Promise<void>;
 }
 
-UserModel.prototype.fetchNextInvoicePreview = memberAction({
-  path: 'next-invoice-preview',
+UserModel.prototype.fetchCurrent = collectionAction({
+  path: 'current',
   type: 'get',
+  urlType: 'findRecord',
 
   after(response) {
     if (response.data) {
       this.store.pushPayload(response);
 
-      return this.store.peekRecord('invoice', response.data.id);
+      return this.store.peekRecord('user', response.data.id);
     } else {
       return null;
     }
   },
 });
 
-UserModel.prototype.fetchCurrent = collectionAction({
-  path: 'current',
+UserModel.prototype.fetchNextInvoicePreview = memberAction({
+  path: 'next-invoice-preview',
   type: 'get',
-  urlType: 'findRecord',
 
   after(response) {
     if (response.data) {
       this.store.pushPayload(response);
 
-      return this.store.peekRecord('user', response.data.id);
+      return this.store.peekRecord('invoice', response.data.id);
     } else {
       return null;
     }
   },
 });
 
+UserModel.prototype.fetchTopLanguageLeaderboardSlugs = memberAction({
+  path: 'top-language-leaderboard-slugs',
+  type: 'get',
+});
+
 UserModel.prototype.syncFeatureFlags = memberAction({
   path: 'sync-feature-flags',
   type: 'post',

app/routes/contest.ts

@@ -111,17 +111,16 @@ export default class ContestRoute extends BaseRoute {
       }
     }
 
-    // TODO[Vasyl]: This interacts with the usage in preferredLanguageLeaderboard where we create a temporary leaderboard entry
-    //              Figure out a way to use `query` instead of the adapterOptions strategy? Or maybe more explicit caching?
-    let topLeaderboardEntries = (await this.store.findAll('leaderboard-entry', {
+    // TODO[Vasyl]: This has an issue where it can end up picking _any_ leaderboard entry and not just the top ones. We
+    //              don't happen to render contest leaderboards elsewhere so it isn't a problem for now. As a pattern this is something
+    //              I'd like to figure out though. Maybe we use `query` instead of the adapterOptions strategy? Or maybe more explicit caching?
+    const topLeaderboardEntries = (await this.store.findAll('leaderboard-entry', {
       adapterOptions: {
         leaderboard_id: contest.leaderboard.id,
       },
       include: 'user,leaderboard',
     })) as unknown as LeaderboardEntryModel[];
 
-    topLeaderboardEntries = topLeaderboardEntries.reject((entry) => entry.isNew);
-
     const languages = await this.store.findAll('language');
 
     return {

app/services/preferred-language-leaderboard.ts

@@ -70,19 +70,7 @@ export default class PreferredLanguageLeaderboardService extends Service {
 
   async refresh(): Promise<void> {
     await this.authenticator.authenticate();
-
-    const userLeaderboardEntries = (await this.store.createRecord('leaderboard-entry').fetchForCurrentUser({
-      include: 'leaderboard,leaderboard.language,user',
-    })) as unknown as LeaderboardEntryModel[];
-
-    this.preferredLanguageSlugs = userLeaderboardEntries
-      .filter((entry) => entry.score > 0)
-      // @ts-expect-error: languageId not defined on LeaderboardModel
-      .filter((entry) => entry.leaderboard.languageId !== null)
-      .sort((a, b) => b.score - a.score)
-      .slice(0, 3)
-      .map((entry) => entry.leaderboard.language!.slug);
-
+    this.preferredLanguageSlugs = (await this.authenticator.currentUser!.fetchTopLanguageLeaderboardSlugs({})).slice(0, 3);
     this.localStorage.setItem(PreferredLanguageLeaderboardService.STORAGE_KEY, new StoredData(this.preferredLanguageSlugs, new Date()).toJSON());
   }
 }

mirage/handlers/leaderboard-entries.js

@@ -32,8 +32,4 @@ export default function (server) {
       throw new Error(`Invalid filter type: ${request.queryParams.filter_type}`);
     }
   });
-
-  server.get('/leaderboard-entries/for-current-user', function (schema) {
-    return schema.leaderboardEntries.all().filter((leaderboardEntry) => leaderboardEntry.user.id === CurrentMirageUser.currentUserId);
-  });
 }

mirage/handlers/users.js

@@ -1,4 +1,5 @@
 import { Response } from 'miragejs';
+import CurrentMirageUser from 'codecrafters-frontend/mirage/utils/current-mirage-user';
 
 export default function (server) {
   server.get('/users', function (schema, request) {
@@ -25,6 +26,25 @@ export default function (server) {
     });
   });
 
+  server.get('/users/:id/top-language-leaderboard-slugs', function (schema) {
+    if (!CurrentMirageUser.currentUserId) {
+      return [];
+    }
+
+    const languageLeaderboardIds = schema.languages
+      .all()
+      .models.map((language) => language.leaderboard?.id)
+      .filter(Boolean);
+
+    return schema.leaderboardEntries
+      .all()
+      .models.filter((leaderboardEntry) => languageLeaderboardIds.includes(leaderboardEntry.leaderboard.id))
+      .filter((leaderboardEntry) => leaderboardEntry.user.id === CurrentMirageUser.currentUserId)
+      .sort((a, b) => b.score - a.score)
+      .slice(0, 3)
+      .map((entry) => entry.leaderboard.language.slug);
+  });
+
   server.post('/users/:id/sync-username-from-github', function (schema, request) {
     let user = schema.users.find(request.params.id);
     user.update({ username: 'updated-username' });

tests/support/api-requests-count.js

@@ -15,7 +15,7 @@ export default function apiRequestsCount(server) {
       // Triggered on application boot
       pathname !== '/api/v1/users/current' &&
       // Triggered when header is rendered
-      pathname !== '/api/v1/leaderboard-entries/for-current-user'
+      !pathname.match(/^\/api\/v1\/users\/[^/]+\/top-language-leaderboard-slugs$/)
     );
   });
 

tests/support/verify-api-requests.js

@@ -11,7 +11,7 @@ export default function verifyApiRequests(server, expectedRequests) {
       // Triggered on application boot
       pathname !== '/api/v1/users/current' &&
       // Triggered when header is rendered
-      pathname !== '/api/v1/leaderboard-entries/for-current-user'
+      !pathname.match(/^\/api\/v1\/users\/[^/]+\/top-language-leaderboard-slugs$/)
     );
   });