Skip to content

Node.js based forum software built for the modern web

fix: closes #14431, use lock when awarding rewards

Barış Soner Uşaklı80aeb6318a8b
diff --git a/src/rewards/index.js b/src/rewards/index.js
index 477a290693..ead4656304 100644
--- a/src/rewards/index.js
+++ b/src/rewards/index.js
@@ -17,13 +17,26 @@ rewards.checkConditionAndRewardUser = async function (params) {
let rewardData = await getRewardDataByIDs(ids);
// filter disabled
rewardData = rewardData.filter(r => r && !(r.disabled === 'true' || r.disabled === true));
- rewardData = await filterCompletedRewards(uid, rewardData);
- if (!rewardData || !rewardData.length) {
- return;
+
+ for (const reward of rewardData) {
+ const lockValue = `reward:lock:${uid}:${reward.id}`;
+ /* eslint-disable no-await-in-loop */
+ const count = await db.incrObjectField('locks', lockValue);
+ if (count > 1) {
+ throw new Error('[[error:reward-locked]]');
+ }
+ try {
+ const canClaim = await isClaimable(uid, reward);
+ if (canClaim) {
+ const isEligible = await checkCondition(reward, method);
+ if (isEligible) {
+ await giveRewards(uid, [reward]);
+ }
+ }
+ } finally {
+ await db.deleteObjectFields('locks', [lockValue]);
+ }
}
- const eligible = await Promise.all(rewardData.map(reward => checkCondition(reward, method)));
- const eligibleRewards = rewardData.filter((reward, index) => eligible[index]);
- await giveRewards(uid, eligibleRewards);
};
async function isConditionActive(condition) {
@@ -34,22 +47,14 @@ async function getIDsByCondition(condition) {
return await db.getSetMembers(`condition:${condition}:rewards`);
}
-async function filterCompletedRewards(uid, rewards) {
- const data = await db.getSortedSetRangeByScoreWithScores(`uid:${uid}:rewards`, 0, -1, 1, '+inf');
- const userRewards = {};
-
- data.forEach((obj) => {
- userRewards[obj.value] = parseInt(obj.score, 10);
- });
-
- return rewards.filter((reward) => {
- if (!reward) {
- return false;
- }
+async function isClaimable(uid, reward) {
+ const timesClaimable = parseInt(reward.claimable, 10);
+ if (timesClaimable === 0) { // no limit on how many times a user can claim this reward
+ return true;
+ }
- const claimable = parseInt(reward.claimable, 10);
- return claimable === 0 || (!userRewards[reward.id] || userRewards[reward.id] < reward.claimable);
- });
+ const userClaims = await db.sortedSetScore(`uid:${uid}:rewards`, reward.id);
+ return !userClaims || userClaims < timesClaimable;
}
async function getRewardDataByIDs(ids) {
@@ -65,7 +70,9 @@ async function checkCondition(reward, method) {
method = util.promisify(method);
}
const value = await method();
- const bool = await plugins.hooks.fire(`filter:rewards.checkConditional:${reward.conditional}`, { left: value, right: reward.value });
+ const bool = await plugins.hooks.fire(`filter:rewards.checkConditional:${reward.conditional}`, {
+ left: value, right: reward.value,
+ });
return bool;
}
diff --git a/test/mocks/databasemock.js b/test/mocks/databasemock.js
index 097a753c35..0bd6bdc922 100644
--- a/test/mocks/databasemock.js
+++ b/test/mocks/databasemock.js
@@ -263,6 +263,7 @@ async function enableDefaultPlugins() {
'nodebb-plugin-dbsearch',
'nodebb-widget-essentials',
'nodebb-plugin-composer-default',
+ 'nodebb-rewards-essentials',
].concat(testPlugins);
winston.info('[install/enableDefaultPlugins] activating default plugins', defaultEnabled);
diff --git a/test/rewards.js b/test/rewards.js
index 2a6cc0a14b..ed4b009748 100644
--- a/test/rewards.js
+++ b/test/rewards.js
@@ -1,47 +1,27 @@
'use strict';
const assert = require('assert');
-const async = require('async');
const db = require('./mocks/databasemock');
const meta = require('../src/meta');
const User = require('../src/user');
const Groups = require('../src/groups');
+const Topics = require('../src/topics');
+const Categories = require('../src/categories');
+const rewards = require('../src/rewards');
+const socketAdmin = require('../src/socket.io/admin');
describe('rewards', () => {
let adminUid;
- let bazUid;
- let herpUid;
- before((done) => {
+ before(async () => {
// Create 3 users: 1 admin, 2 regular
- async.series([
- async.apply(User.create, { username: 'foo' }),
- async.apply(User.create, { username: 'baz' }),
- async.apply(User.create, { username: 'herp' }),
- ], (err, uids) => {
- if (err) {
- return done(err);
- }
-
- adminUid = uids[0];
- bazUid = uids[1];
- herpUid = uids[2];
-
- async.series([
- function (next) {
- Groups.join('administrators', adminUid, next);
- },
- function (next) {
- Groups.join('rewardGroup', adminUid, next);
- },
- ], done);
- });
+ adminUid = await User.create({ username: 'foo' });
+ await Groups.join('administrators', adminUid);
+ await Groups.join('rewardGroup', adminUid);
});
describe('rewards create', () => {
- const socketAdmin = require('../src/socket.io/admin');
- const rewards = require('../src/rewards');
it('it should save a reward', (done) => {
const data = [
{
@@ -61,7 +41,9 @@ describe('rewards', () => {
done();
});
});
+ });
+ describe('rewards checkCondition', () => {
it('should check condition', (done) => {
function method(next) {
next(null, 1);
@@ -75,5 +57,34 @@ describe('rewards', () => {
done();
});
});
+
+ it('should award user 10 reputation after posting 2 times only once', async () => {
+ const data = [
+ {
+ rewards: { reputation: 10 },
+ condition: 'essentials/user.postcount',
+ conditional: 'greaterthan',
+ value: '1',
+ rid: 'essentials/award-reputation',
+ claimable: '1',
+ id: '',
+ disabled: false,
+ },
+ ];
+ const { cid } = await Categories.create({
+ name: 'test category',
+ description: 'test category description',
+ });
+
+ await socketAdmin.rewards.save({ uid: adminUid }, data);
+ const uid = await User.create({ username: 'poster' });
+ await Topics.post({ uid, cid, title: 'test topic', content: 'test content' });
+ await Topics.post({ uid, cid, title: 'test topic 2', content: 'test content' });
+ const reputation = await User.getUserField(uid, 'reputation');
+ assert.equal(reputation, 10);
+ await Topics.post({ uid, cid, title: 'test topic 3', content: 'test content' });
+ const reputation2 = await User.getUserField(uid, 'reputation');
+ assert.equal(reputation2, 10);
+ });
});
});