feat(leaderboard): allow to specify a user to get results around

Author: leeyeh

demo/leaderboard/leaderboard.js

@@ -117,13 +117,14 @@ var app = new Vue({
           limit: MAX_RESULTS_COUNT,
           selectUserKeys: ['username'],
         }),
-        Promise.resolve(
-          AV.User.current()
-            ? leaderboard.getResultsAroundUser({
-                limit: 3,
-                selectUserKeys: ['username'],
-              })
-            : []
+        Promise.resolve(AV.User.current()).then(
+          currentUser =>
+            currentUser
+              ? leaderboard.getResultsAroundUser(currentUser, {
+                  limit: 3,
+                  selectUserKeys: ['username'],
+                })
+              : []
         ),
       ])
         .then(([topRankings, [beforeUserRankings, userRanking]]) => {

src/leaderboard.js

@@ -241,12 +241,12 @@ _.extend(
     _getResults(
       { skip, limit, selectUserKeys, includeStatistics, version },
       authOptions,
-      self
+      userId
     ) {
       return request({
         method: 'GET',
         path: `/leaderboard/leaderboards/${this.statisticName}/ranks${
-          self ? '/self' : ''
+          userId ? `/${userId}` : ''
         }`,
         query: {
           skip,
@@ -298,7 +298,8 @@ _.extend(
       );
     },
     /**
-     * Retrieve a list of ranked users for this Leaderboard, centered on the current user.
+     * Retrieve a list of ranked users for this Leaderboard, centered on the specified user.
+     * @param {AV.User} user The specified AV.User pointer.
      * @param {Object} [options]
      * @param {number} [options.limit] The limit of the number of results.
      * @param {string[]} [options.selectUserKeys] Specify keys of the users to include
@@ -307,14 +308,16 @@ _.extend(
      * @param {AuthOptions} [authOptions]
      * @return {Promise<Ranking[]>}
      */
-    getResultsAroundUser(
-      { limit, selectUserKeys, includeStatistics, version } = {},
-      authOptions
-    ) {
+    getResultsAroundUser(user, options = {}, authOptions) {
+      // getResultsAroundUser(options, authOptions)
+      if (user && typeof user.id !== 'string') {
+        return this.getResultsAroundUser(undefined, user, options);
+      }
+      const { limit, selectUserKeys, includeStatistics, version } = options;
       return this._getResults(
         { limit, selectUserKeys, includeStatistics, version },
         authOptions,
-        true
+        user ? user.id : 'self'
       );
     },
     _update(data, authOptions) {

storage.d.ts

@@ -897,6 +897,16 @@ export class Leaderboard {
     },
     authOptions?: AuthOptions
   ): Promise<Ranking[]>;
+  getResultsAroundUser(
+    user: User,
+    options?: {
+      limit?: number;
+      selectUserKeys?: string | string[];
+      includeStatistics?: string | string[];
+      version?: number;
+    },
+    authOptions?: AuthOptions
+  ): Promise<Ranking[]>;
   getResultsAroundUser(
     options?: {
       limit?: number;

test/leaderboard.js

@@ -170,7 +170,7 @@ describe('Leaderboard', () => {
         })
         .should.be.rejected();
     });
-    it('getResultsAroundUser', function() {
+    it('get results around user', function() {
       const leaderboard = this.leaderboard;
       return leaderboard
         .getResultsAroundUser({ limit: 3 }, { user: currentUser })
@@ -183,6 +183,19 @@ describe('Leaderboard', () => {
           rankings.map(ranking => ranking.rank).should.eql([1, 2, 3]);
         });
     });
+    it('get results around a specified user', function() {
+      const leaderboard = this.leaderboard;
+      return leaderboard
+        .getResultsAroundUser(users[1], { limit: 3 }, { user: currentUser })
+        .then(rankings => {
+          rankings.should.be.an.Array();
+          rankings.should.be.length(3);
+          rankings[1].value.should.eql(1);
+          expect(rankings[1].user.get('username')).to.be(undefined);
+          rankings[1].includedStatistics.should.be.an.Array();
+          rankings.map(ranking => ranking.rank).should.eql([0, 1, 2]);
+        });
+    });
   });
 
   after(function() {