fix bug in Rebirth test, add new tests, adjust apidocs (#7293)

test/api/v3/integration/user/POST-user_rebirth.test.js

@@ -31,6 +31,7 @@ describe('POST /user/rebirth', () => {
     let daily = await generateDaily({
       text: 'test habit',
       type: 'daily',
+      value: 1,
       streak: 1,
       userId: user._id,
     });

test/common/ops/rebirth.js

@@ -3,7 +3,9 @@ import i18n from '../../../common/script/i18n';
 import { MAX_LEVEL } from '../../../common/script/constants';
 import {
   generateUser,
+  generateHabit,
   generateDaily,
+  generateTodo,
   generateReward,
 } from '../../helpers/common.helper';
 import {
@@ -19,7 +21,7 @@ describe('shared.ops.rebirth', () => {
   beforeEach(() => {
     user = generateUser();
     user.balance = 2;
-    tasks = [generateDaily(), generateReward()];
+    tasks = [generateHabit(), generateDaily(), generateTodo(), generateReward()];
   });
 
   it('returns an error when user balance is too low and user is less than max level', (done) => {
@@ -49,22 +51,35 @@ describe('shared.ops.rebirth', () => {
     expect(message).to.equal(i18n.t('rebirthComplete'));
   });
 
-  it('resets user\'s taks values except for rewards to 0', () => {
+  it('rebirths a user with not enough gems but more than max level', () => {
+    user.balance = 0;
+    user.stats.lvl = MAX_LEVEL + 1;
+
+    let [, message] = rebirth(user);
+
+    expect(message).to.equal(i18n.t('rebirthComplete'));
+  });
+
+  it('resets user\'s tasks values except for rewards to 0', () => {
     tasks[0].value = 1;
     tasks[1].value = 1;
+    tasks[2].value = 1;
+    tasks[3].value = 1; // Reward
 
     rebirth(user, tasks);
 
     expect(tasks[0].value).to.equal(0);
-    expect(tasks[1].value).to.equal(1);
+    expect(tasks[1].value).to.equal(0);
+    expect(tasks[2].value).to.equal(0);
+    expect(tasks[3].value).to.equal(1); // Reward
   });
 
   it('resets user\'s daily streaks to 0', () => {
-    tasks[0].streak = 1;
+    tasks[1].streak = 1; // Daily
 
     rebirth(user, tasks);
 
-    expect(tasks[0].streak).to.equal(0);
+    expect(tasks[1].streak).to.equal(0);
   });
 
   it('resets a user\'s buffs', () => {
@@ -156,7 +171,7 @@ describe('shared.ops.rebirth', () => {
     expect(user.flags.dropsEnabled).to.be.false;
     expect(user.flags.classSelected).to.be.false;
     expect(user.flags.rebirthEnabled).to.be.false;
-    expect(user.flags.levelDrops).to.be.emtpy;
+    expect(user.flags.levelDrops).to.be.empty;
   });
 
   it('does not reset rebirthEnabled if user has beastMaster', () => {
@@ -175,7 +190,7 @@ describe('shared.ops.rebirth', () => {
     expect(user.achievements.rebirthLevel).to.equal(user.stats.lvl);
   });
 
-  it('increments rebirth achievemnts', () => {
+  it('increments rebirth achievements', () => {
     user.stats.lvl = 2;
     user.achievements.rebirths = 1;
     user.achievements.rebirthLevel = 1;
@@ -185,4 +200,37 @@ describe('shared.ops.rebirth', () => {
     expect(user.achievements.rebirths).to.equal(2);
     expect(user.achievements.rebirthLevel).to.equal(2);
   });
+
+  it('does not increment rebirth achievements when level is lower than previous', () => {
+    user.stats.lvl = 2;
+    user.achievements.rebirths = 1;
+    user.achievements.rebirthLevel = 3;
+
+    rebirth(user);
+
+    expect(user.achievements.rebirths).to.equal(1);
+    expect(user.achievements.rebirthLevel).to.equal(3);
+  });
+
+  it('always increments rebirth achievements when level is MAX_LEVEL', () => {
+    user.stats.lvl = MAX_LEVEL;
+    user.achievements.rebirths = 1;
+    user.achievements.rebirthLevel = MAX_LEVEL + 1; // this value is not actually possible (actually capped at MAX_LEVEL) but makes a good test
+
+    rebirth(user);
+
+    expect(user.achievements.rebirths).to.equal(2);
+    expect(user.achievements.rebirthLevel).to.equal(MAX_LEVEL);
+  });
+
+  it('always increments rebirth achievements when level is greater than MAX_LEVEL', () => {
+    user.stats.lvl = MAX_LEVEL + 1;
+    user.achievements.rebirths = 1;
+    user.achievements.rebirthLevel = MAX_LEVEL + 2; // this value is not actually possible (actually capped at MAX_LEVEL) but makes a good test
+
+    rebirth(user);
+
+    expect(user.achievements.rebirths).to.equal(2);
+    expect(user.achievements.rebirthLevel).to.equal(MAX_LEVEL);
+  });
 });

website/server/controllers/api-v3/user.js

@@ -1093,12 +1093,12 @@ api.userRevive = {
 };
 
 /*
-* @api {post} /api/v3/user/rebirth Resets a user.
+* @api {post} /api/v3/user/rebirth Use Orb of Rebirth on user
 * @apiVersion 3.0.0
 * @apiName UserRebirth
 * @apiGroup User
 *
-* @apiSuccess {Object} data.userr
+* @apiSuccess {Object} data.user
 * @apiSuccess {array} data.tasks User's modified tasks (no rewards)
 * @apiSuccess {string} message Success message
 */