feat(Leaderboard): add includeUserKeys option

for #getResults

Author: leeyeh

src/leaderboard.js

@@ -279,7 +279,14 @@ _.extend(
       }).then(({ count }) => count);
     },
     _getResults(
-      { skip, limit, selectUserKeys, includeStatistics, version },
+      {
+        skip,
+        limit,
+        selectUserKeys,
+        includeUserKeys,
+        includeStatistics,
+        version,
+      },
       authOptions,
       userId
     ) {
@@ -291,8 +298,13 @@ _.extend(
         query: {
           skip,
           limit,
-          includeUser: selectUserKeys
-            ? ensureArray(selectUserKeys).join(',')
+          selectUserKeys:
+            _.union(
+              ensureArray(selectUserKeys),
+              ensureArray(includeUserKeys)
+            ).join(',') || undefined,
+          includeUser: includeUserKeys
+            ? ensureArray(includeUserKeys).join(',')
             : undefined,
           includeStatistics: includeStatistics
             ? ensureArray(includeStatistics).join(',')
@@ -322,18 +334,33 @@ _.extend(
      * @param {Object} [options]
      * @param {number} [options.skip] The number of results to skip. This is useful for pagination.
      * @param {number} [options.limit] The limit of the number of results.
-     * @param {string[]} [options.selectUserKeys] Specify keys of the users to include
+     * @param {string[]} [options.selectUserKeys] Specify keys of the users to include in the Rankings
+     * @param {string[]} [options.includeUserKeys] If the value of a selected user keys is a Pointer, use this options to include its value.
      * @param {string[]} [options.includeStatistics] Specify other statistics to include in the Rankings
      * @param {number} [options.version] Specify the version of the leaderboard
      * @param {AuthOptions} [authOptions]
      * @return {Promise<Ranking[]>}
      */
     getResults(
-      { skip, limit, selectUserKeys, includeStatistics, version } = {},
+      {
+        skip,
+        limit,
+        selectUserKeys,
+        includeUserKeys,
+        includeStatistics,
+        version,
+      } = {},
       authOptions
     ) {
       return this._getResults(
-        { skip, limit, selectUserKeys, includeStatistics, version },
+        {
+          skip,
+          limit,
+          selectUserKeys,
+          includeUserKeys,
+          includeStatistics,
+          version,
+        },
         authOptions
       );
     },
@@ -342,7 +369,8 @@ _.extend(
      * @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
+     * @param {string[]} [options.selectUserKeys] Specify keys of the users to include in the Rankings
+     * @param {string[]} [options.includeUserKeys] If the value of a selected user keys is a Pointer, use this options to include its value.
      * @param {string[]} [options.includeStatistics] Specify other statistics to include in the Rankings
      * @param {number} [options.version] Specify the version of the leaderboard
      * @param {AuthOptions} [authOptions]
@@ -353,9 +381,15 @@ _.extend(
       if (user && typeof user.id !== 'string') {
         return this.getResultsAroundUser(undefined, user, options);
       }
-      const { limit, selectUserKeys, includeStatistics, version } = options;
+      const {
+        limit,
+        selectUserKeys,
+        includeUserKeys,
+        includeStatistics,
+        version,
+      } = options;
       return this._getResults(
-        { limit, selectUserKeys, includeStatistics, version },
+        { limit, selectUserKeys, includeUserKeys, includeStatistics, version },
         authOptions,
         user ? user.id : 'self'
       );

storage.d.ts

@@ -953,6 +953,7 @@ export class Leaderboard {
       skip?: number;
       limit?: number;
       selectUserKeys?: string | string[];
+      includeUserKeys?: string | string[];
       includeStatistics?: string | string[];
       version?: number;
     },
@@ -963,6 +964,7 @@ export class Leaderboard {
     options?: {
       limit?: number;
       selectUserKeys?: string | string[];
+      includeUserKeys?: string | string[];
       includeStatistics?: string | string[];
       version?: number;
     },
@@ -972,6 +974,7 @@ export class Leaderboard {
     options?: {
       limit?: number;
       selectUserKeys?: string | string[];
+      includeUserKeys?: string | string[];
       includeStatistics?: string | string[];
       version?: number;
     },

test/leaderboard.js

@@ -1,9 +1,11 @@
 const statisticName = `score_${Date.now()}`;
 const statisticName2 = `score_${Date.now()}_2`;
 
+const Company = AV.Object.extend('Company');
+
 describe('Leaderboard', () => {
-  before(function setUpLeaderboard() {
-    return Promise.all([
+  before(async function setUpLeaderboard() {
+    const [leaderboard, leaderboard2] = await Promise.all([
       AV.Leaderboard.createLeaderboard(
         {
           statisticName,
@@ -26,10 +28,9 @@ describe('Leaderboard', () => {
           useMasterKey: true,
         }
       ),
-    ]).then(([leaderboard, leaderboard2]) => {
-      this.leaderboard = leaderboard;
-      this.leaderboard2 = leaderboard2;
-    });
+    ]);
+    this.leaderboard = leaderboard;
+    this.leaderboard2 = leaderboard2;
   });
 
   function validateLeaderboard(leaderboard) {
@@ -90,31 +91,29 @@ describe('Leaderboard', () => {
     let users;
     let currentUser;
     let stats;
-    before(() =>
-      Promise.all(
+    before(async () => {
+      const company = await new Company({ name: 'LeanCloud' }).save();
+      users = await Promise.all(
         ['0', '1', '2', '3'].map(value =>
-          AV.User.signUp(Date.now() + value, Date.now() + value)
+          new AV.User({ company })
+            .setUsername(Date.now() + value)
+            .setPassword(Date.now() + value)
+            .signUp()
         )
-      )
-        .then(result => {
-          users = result;
-          currentUser = users[2];
-          return Promise.all(
-            users.map((user, index) =>
-              AV.Leaderboard.updateStatistics(
-                user,
-                { [statisticName]: index, [statisticName2]: -index },
-                {
-                  user,
-                }
-              )
-            )
-          );
-        })
-        .then(result => {
-          stats = result[2];
-        })
-    );
+      );
+      currentUser = users[2];
+      stats = (await Promise.all(
+        users.map((user, index) =>
+          AV.Leaderboard.updateStatistics(
+            user,
+            { [statisticName]: index, [statisticName2]: -index },
+            {
+              user,
+            }
+          )
+        )
+      ))[2];
+    });
 
     after(() =>
       Promise.all(users.map(user => user.destroy({ useMasterKey: true })))
@@ -152,6 +151,7 @@ describe('Leaderboard', () => {
       return leaderboard
         .getResults({
           selectUserKeys: ['username'],
+          includeUserKeys: 'company',
           includeStatistics: [statisticName2],
         })
         .then(rankings => {
@@ -162,6 +162,9 @@ describe('Leaderboard', () => {
           rankings[2].user
             .get('username')
             .should.be.eql(currentUser.get('username'));
+          const company = rankings[2].user.get('company');
+          company.should.be.instanceof(Company);
+          company.get('name').should.be.eql('LeanCloud');
           rankings[2].includedStatistics.should.be.an.Array();
           rankings[2].includedStatistics[0].name.should.be.eql(statisticName2);
         });