feat(Leaderboard): add updateStrategy

Author: leeyeh

src/leaderboard.js

@@ -25,6 +25,11 @@ AV.LeaderboardOrder = {
   DESCENDING: 'descending',
 };
 
+AV.LeaderboardUpdateStrategy = {
+  BETTER: 'better',
+  LAST: 'last',
+};
+
 /**
  * @class
  */
@@ -60,6 +65,14 @@ AV.Leaderboard = function(statisticName) {
    * @type {string}
    */
   this.statisticName = statisticName;
+  /**
+   * @type {AV.LeaderboardOrder}
+   */
+  this.order = undefined;
+  /**
+   * @type {AV.LeaderboardUpdateStrategy}
+   */
+  this.updateStrategy = undefined;
   /**
    * @type {AV.LeaderboardVersionChangeInterval}
    */
@@ -72,6 +85,10 @@ AV.Leaderboard = function(statisticName) {
    * @type {Date?}
    */
   this.nextResetAt = undefined;
+  /**
+   * @type {Date?}
+   */
+  this.createdAt = undefined;
 };
 const Leaderboard = AV.Leaderboard;
 
@@ -87,12 +104,13 @@ AV.Leaderboard.createWithoutData = statisticName =>
  * @param {Object} options
  * @param {string} options.statisticName
  * @param {AV.LeaderboardOrder} options.order
- * @param {AV.LeaderboardVersionChangeInterval} options.versionChangeInterval
+ * @param {AV.LeaderboardVersionChangeInterval} [options.versionChangeInterval] default to WEEK
+ * @param {AV.LeaderboardUpdateStrategy} [options.updateStrategy] default to BETTER
  * @param {AuthOptions} [authOptions]
  * @return {Promise<AV.Leaderboard>}
  */
 AV.Leaderboard.createLeaderboard = (
-  { statisticName, order, versionChangeInterval },
+  { statisticName, order, versionChangeInterval, updateStrategy },
   authOptions
 ) =>
   request({
@@ -102,6 +120,7 @@ AV.Leaderboard.createLeaderboard = (
       statisticName,
       order,
       versionChangeInterval,
+      updateStrategy,
     },
     authOptions,
   }).then(data => {
@@ -185,6 +204,9 @@ _.extend(
         if (key === 'expiredAt') {
           key = 'nextResetAt';
         }
+        if (key === 'createdAt') {
+          value = parseDate(value);
+        }
         if (value.__type === 'Date') {
           value = parseDate(value.iso);
         }
@@ -253,21 +275,31 @@ _.extend(
     getResultsAroundUser({ limit, includeUserKeys } = {}, authOptions) {
       return this._getResults({ limit, includeUserKeys }, authOptions, true);
     },
+    _update(data, authOptions) {
+      return request({
+        method: 'PUT',
+        path: `/play/leaderboards/${this.statisticName}`,
+        data,
+        authOptions,
+      }).then(result => this._finishFetch(result));
+    },
     /**
      * (masterKey required) Update the version change interval of the Leaderboard.
      * @param {AV.LeaderboardVersionChangeInterval} versionChangeInterval
      * @param {AuthOptions} [authOptions]
      * @return {Promise<AV.Leaderboard>}
      */
     updateVersionChangeInterval(versionChangeInterval, authOptions) {
-      return request({
-        method: 'PUT',
-        path: `/play/leaderboards/${this.statisticName}`,
-        data: {
-          versionChangeInterval,
-        },
-        authOptions,
-      }).then(data => this._finishFetch(data));
+      return this._update({ versionChangeInterval }, authOptions);
+    },
+    /**
+     * (masterKey required) Update the version change interval of the Leaderboard.
+     * @param {AV.LeaderboardUpdateStrategy} updateStrategy
+     * @param {AuthOptions} [authOptions]
+     * @return {Promise<AV.Leaderboard>}
+     */
+    updateUpdateStrategy(updateStrategy, authOptions) {
+      return this._update({ updateStrategy }, authOptions);
     },
     /**
      * (masterKey required) Reset the Leaderboard. The version of the Leaderboard will be incremented by 1.

storage.d.ts

@@ -798,16 +798,20 @@ declare class Statistic {
 
 export class Leaderboard {
   statisticName: string;
-  versionChangeInterval: LeaderboardVersionChangeInterval;
-  version: number;
+  order?: LeaderboardOrder;
+  updateStrategy?: LeaderboardUpdateStrategy;
+  versionChangeInterval?: LeaderboardVersionChangeInterval;
+  version?: number;
   nextResetAt?: Date;
+  createdAt?: Date;
 
   static createWithoutData(statisticName: string): Leaderboard;
   static createLeaderboard(
     options: {
       statisticName: string;
       order: LeaderboardOrder;
-      versionChangeInterval: LeaderboardVersionChangeInterval;
+      versionChangeInterval?: LeaderboardVersionChangeInterval;
+      updateStrategy?: LeaderboardUpdateStrategy;
     },
     authOptions?: AuthOptions
   ): Promise<Leaderboard>;
@@ -838,6 +842,10 @@ export class Leaderboard {
     versionChangeInterval: LeaderboardVersionChangeInterval,
     authOptions?: AuthOptions
   ): Promise<Leaderboard>;
+  updateUpdateStrategy(
+    updateStrategy: LeaderboardUpdateStrategy,
+    authOptions?: AuthOptions
+  ): Promise<Leaderboard>;
   reset(authOptions?: AuthOptions): Promise<Leaderboard>;
 }
 
@@ -846,6 +854,11 @@ export enum LeaderboardOrder {
   DESCENDING,
 }
 
+export enum LeaderboardUpdateStrategy {
+  BETTER,
+  LAST,
+}
+
 export enum LeaderboardVersionChangeInterval {
   NEVER,
   HOUR,

test/leaderboard.js

@@ -5,6 +5,7 @@ describe('Leaderboard', () => {
     return AV.Leaderboard.createLeaderboard(
       {
         statisticName,
+        updateStrategy: AV.LeaderboardUpdateStrategy.BETTER,
         order: AV.LeaderboardOrder.ASCENDING,
         versionChangeInterval: AV.LeaderboardVersionChangeInterval.WEEK,
       },
@@ -19,6 +20,9 @@ describe('Leaderboard', () => {
   function validateLeaderboard(leaderboard) {
     leaderboard.should.be.instanceof(AV.Leaderboard);
     leaderboard.statisticName.should.be.eql(statisticName);
+    leaderboard.updateStrategy.should.be.eql(
+      AV.LeaderboardUpdateStrategy.BETTER
+    );
     leaderboard.versionChangeInterval.should.be.eql(
       AV.LeaderboardVersionChangeInterval.WEEK
     );
@@ -50,6 +54,17 @@ describe('Leaderboard', () => {
         );
       });
   });
+  it('mutation with masterKey', function() {
+    return this.leaderboard
+      .updateUpdateStrategy(AV.LeaderboardUpdateStrategy.LAST, {
+        useMasterKey: true,
+      })
+      .then(leaderboard => {
+        leaderboard.updateStrategy.should.be.eql(
+          AV.LeaderboardUpdateStrategy.LAST
+        );
+      });
+  });
 
   describe('Statistics', function() {
     let users;