'use strict'; const assert = require('assert'); const async = require('async'); const util = require('util'); const sleep = util.promisify(setTimeout); const db = require('./mocks/databasemock'); const Flags = require('../src/flags'); const Categories = require('../src/categories'); const Topics = require('../src/topics'); const Posts = require('../src/posts'); const User = require('../src/user'); const Groups = require('../src/groups'); const Meta = require('../src/meta'); const Privileges = require('../src/privileges'); describe('Flags', function () { let uid1; let adminUid; let uid3; let category; before(async () => { // Create some stuff to flag uid1 = await User.create({ username: 'testUser', password: 'abcdef', email: 'b@c.com' }); adminUid = await User.create({ username: 'testUser2', password: 'abcdef', email: 'c@d.com' }); await Groups.join('administrators', adminUid); category = await Categories.create({ name: 'test category', }); await Topics.post({ cid: category.cid, uid: uid1, title: 'Topic to flag', content: 'This is flaggable content', }); uid3 = await User.create({ username: 'unprivileged', password: 'abcdef', email: 'd@e.com', }); }); describe('.create()', function () { it('should create a flag and return its data', function (done) { Flags.create('post', 1, 1, 'Test flag', function (err, flagData) { assert.ifError(err); var compare = { flagId: 1, targetId: 1, type: 'post', state: 'open', target_readable: 'Post 1', }; assert(flagData); for (var key in compare) { if (compare.hasOwnProperty(key)) { assert.ok(flagData[key], 'undefined key ' + key); assert.equal(flagData[key], compare[key]); } } done(); }); }); it('should add the flag to the byCid zset for category 1 if it is of type post', function (done) { db.isSortedSetMember('flags:byCid:' + 1, 1, function (err, isMember) { assert.ifError(err); assert.ok(isMember); done(); }); }); it('should add the flag to the byPid zset for pid 1 if it is of type post', function (done) { db.isSortedSetMember('flags:byPid:' + 1, 1, function (err, isMember) { assert.ifError(err); assert.ok(isMember); done(); }); }); }); describe('.exists()', function () { it('should return Boolean True if a flag matching the flag hash already exists', function (done) { Flags.exists('post', 1, 1, function (err, exists) { assert.ifError(err); assert.strictEqual(true, exists); done(); }); }); it('should return Boolean False if a flag matching the flag hash does not already exists', function (done) { Flags.exists('post', 1, 2, function (err, exists) { assert.ifError(err); assert.strictEqual(false, exists); done(); }); }); }); describe('.targetExists()', function () { it('should return Boolean True if the targeted element exists', function (done) { Flags.targetExists('post', 1, function (err, exists) { assert.ifError(err); assert.strictEqual(true, exists); done(); }); }); it('should return Boolean False if the targeted element does not exist', function (done) { Flags.targetExists('post', 15, function (err, exists) { assert.ifError(err); assert.strictEqual(false, exists); done(); }); }); }); describe('.get()', function () { it('should retrieve and display a flag\'s data', function (done) { Flags.get(1, function (err, flagData) { assert.ifError(err); var compare = { flagId: 1, targetId: 1, type: 'post', state: 'open', target_readable: 'Post 1', }; assert(flagData); for (var key in compare) { if (compare.hasOwnProperty(key)) { assert.ok(flagData[key], 'undefined key ' + key); assert.equal(flagData[key], compare[key]); } } done(); }); }); }); describe('.list()', function () { it('should show a list of flags (with one item)', function (done) { Flags.list({ filters: {}, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.equal(payload.flags.length, 1); Flags.get(payload.flags[0].flagId, function (err, flagData) { assert.ifError(err); assert.equal(payload.flags[0].flagId, flagData.flagId); assert.equal(payload.flags[0].description, flagData.description); done(); }); }); }); describe('(with filters)', function () { it('should return a filtered list of flags if said filters are passed in', function (done) { Flags.list({ filters: { state: 'open', }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(1, parseInt(payload.flags[0].flagId, 10)); done(); }); }); it('should return no flags if a filter with no matching flags is used', function (done) { Flags.list({ filters: { state: 'rejected', }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(0, payload.flags.length); done(); }); }); it('should return a flag when filtered by cid 1', function (done) { Flags.list({ filters: { cid: 1, }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(1, payload.flags.length); done(); }); }); it('shouldn\'t return a flag when filtered by cid 2', function (done) { Flags.list({ filters: { cid: 2, }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(0, payload.flags.length); done(); }); }); it('should return a flag when filtered by both cid 1 and 2', function (done) { Flags.list({ filters: { cid: [1, 2], }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(1, payload.flags.length); done(); }); }); it('should return one flag if filtered by both cid 1 and 2 and open state', function (done) { Flags.list({ filters: { cid: [1, 2], state: 'open', }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(1, payload.flags.length); done(); }); }); it('should return no flag if filtered by both cid 1 and 2 and non-open state', function (done) { Flags.list({ filters: { cid: [1, 2], state: 'resolved', }, uid: 1, }, function (err, payload) { assert.ifError(err); assert.ok(payload.hasOwnProperty('flags')); assert.ok(payload.hasOwnProperty('page')); assert.ok(payload.hasOwnProperty('pageCount')); assert.ok(Array.isArray(payload.flags)); assert.strictEqual(0, payload.flags.length); done(); }); }); }); describe('(with sort)', () => { before(async () => { // Create a second flag to test sorting const post = await Topics.reply({ tid: 1, uid: uid1, content: 'this is a reply -- flag me', }); await Flags.create('post', post.pid, adminUid, 'another flag'); await Flags.create('post', 1, uid3, 'additional flag report'); }); it('should return sorted flags latest first if no sort is passed in', async () => { const payload = await Flags.list({ uid: adminUid, }); assert(payload.flags.every((cur, idx) => { if (idx === payload.flags.length - 1) { return true; } const next = payload.flags[idx + 1]; return parseInt(cur.datetime, 10) > parseInt(next.datetime, 10); })); }); it('should return sorted flags oldest first if "oldest" sort is passed in', async () => { const payload = await Flags.list({ uid: adminUid, sort: 'oldest', }); assert(payload.flags.every((cur, idx) => { if (idx === payload.flags.length - 1) { return true; } const next = payload.flags[idx + 1]; return parseInt(cur.datetime, 10) < parseInt(next.datetime, 10); })); }); it('should return flags with more reports first if "reports" sort is passed in', async () => { const payload = await Flags.list({ uid: adminUid, sort: 'reports', }); assert(payload.flags.every((cur, idx) => { if (idx === payload.flags.length - 1) { return true; } const next = payload.flags[idx + 1]; return parseInt(cur.heat, 10) >= parseInt(next.heat, 10); })); }); }); }); describe('.update()', function () { it('should alter a flag\'s various attributes and persist them to the database', function (done) { Flags.update(1, adminUid, { state: 'wip', assignee: adminUid, }, function (err) { assert.ifError(err); db.getObjectFields('flag:1', ['state', 'assignee'], function (err, data) { if (err) { throw err; } assert.strictEqual('wip', data.state); assert.ok(!isNaN(parseInt(data.assignee, 10))); assert.strictEqual(adminUid, parseInt(data.assignee, 10)); done(); }); }); }); it('should persist to the flag\'s history', function (done) { Flags.getHistory(1, function (err, history) { if (err) { throw err; } history.forEach(function (change) { switch (change.attribute) { case 'state': assert.strictEqual('[[flags:state-wip]]', change.value); break; case 'assignee': assert.strictEqual(1, change.value); break; } }); done(); }); }); it('should allow assignment if user is an admin and do nothing otherwise', async () => { await Flags.update(1, adminUid, { assignee: adminUid, }); let assignee = await db.getObjectField('flag:1', 'assignee'); assert.strictEqual(adminUid, parseInt(assignee, 10)); await Flags.update(1, adminUid, { assignee: uid3, }); assignee = await db.getObjectField('flag:1', 'assignee'); assert.strictEqual(adminUid, parseInt(assignee, 10)); }); it('should allow assignment if user is a global mod and do nothing otherwise', async () => { await Groups.join('Global Moderators', uid3); await Flags.update(1, uid3, { assignee: uid3, }); let assignee = await db.getObjectField('flag:1', 'assignee'); assert.strictEqual(uid3, parseInt(assignee, 10)); await Flags.update(1, uid3, { assignee: uid1, }); assignee = await db.getObjectField('flag:1', 'assignee'); assert.strictEqual(uid3, parseInt(assignee, 10)); await Groups.leave('Global Moderators', uid3); }); it('should allow assignment if user is a mod of the category, do nothing otherwise', async () => { await Groups.join('cid:' + category.cid + ':privileges:moderate', uid3); await Flags.update(1, uid3, { assignee: uid3, }); let assignee = await db.getObjectField('flag:1', 'assignee'); assert.strictEqual(uid3, parseInt(assignee, 10)); await Flags.update(1, uid3, { assignee: uid1, }); assignee = await db.getObjectField('flag:1', 'assignee'); assert.strictEqual(uid3, parseInt(assignee, 10)); await Groups.leave('cid:' + category.cid + ':privileges:moderate', uid3); }); it('should do nothing when you attempt to set a bogus state', async () => { await Flags.update(1, adminUid, { state: 'hocus pocus', }); const state = await db.getObjectField('flag:1', 'state'); assert.strictEqual('wip', state); }); it('should rescind notification if flag is resolved', async () => { const SocketFlags = require('../src/socket.io/flags.js'); const result = await Topics.post({ cid: category.cid, uid: uid3, title: 'Topic to flag', content: 'This is flaggable content', }); const flagId = await SocketFlags.create({ uid: uid1 }, { type: 'post', id: result.postData.pid, reason: 'spam' }); await sleep(2000); let userNotifs = await User.notifications.getAll(adminUid); assert(userNotifs.includes('flag:post:' + result.postData.pid)); await Flags.update(flagId, adminUid, { state: 'resolved', }); userNotifs = await User.notifications.getAll(adminUid); assert(!userNotifs.includes('flag:post:' + result.postData.pid)); }); }); describe('.getTarget()', function () { it('should return a post\'s data if queried with type "post"', function (done) { Flags.getTarget('post', 1, 1, function (err, data) { assert.ifError(err); var compare = { uid: 1, pid: 1, content: 'This is flaggable content', }; for (var key in compare) { if (compare.hasOwnProperty(key)) { assert.ok(data[key]); assert.equal(data[key], compare[key]); } } done(); }); }); it('should return a user\'s data if queried with type "user"', function (done) { Flags.getTarget('user', 1, 1, function (err, data) { assert.ifError(err); var compare = { uid: 1, username: 'testUser', email: 'b@c.com', }; for (var key in compare) { if (compare.hasOwnProperty(key)) { assert.ok(data[key]); assert.equal(data[key], compare[key]); } } done(); }); }); it('should return a plain object with no properties if the target no longer exists', function (done) { Flags.getTarget('user', 15, 1, function (err, data) { assert.ifError(err); assert.strictEqual(0, Object.keys(data).length); done(); }); }); }); describe('.validate()', function () { it('should error out if type is post and post is deleted', function (done) { Posts.delete(1, 1, function (err) { if (err) { throw err; } Flags.validate({ type: 'post', id: 1, uid: 1, }, function (err) { assert.ok(err); assert.strictEqual('[[error:post-deleted]]', err.message); Posts.restore(1, 1, done); }); }); }); it('should not pass validation if flag threshold is set and user rep does not meet it', function (done) { Meta.configs.set('min:rep:flag', '50', function (err) { assert.ifError(err); Flags.validate({ type: 'post', id: 1, uid: 3, }, function (err) { assert.ok(err); assert.strictEqual('[[error:not-enough-reputation-to-flag]]', err.message); Meta.configs.set('min:rep:flag', 0, done); }); }); }); it('should not error if user blocked target', function (done) { var SocketFlags = require('../src/socket.io/flags.js'); var reporterUid; var reporteeUid; async.waterfall([ function (next) { User.create({ username: 'reporter' }, next); }, function (uid, next) { reporterUid = uid; User.create({ username: 'reportee' }, next); }, function (uid, next) { reporteeUid = uid; User.blocks.add(reporteeUid, reporterUid, next); }, function (next) { Topics.post({ cid: 1, uid: reporteeUid, title: 'Another topic', content: 'This is flaggable content', }, next); }, function (data, next) { SocketFlags.create({ uid: reporterUid }, { type: 'post', id: data.postData.pid, reason: 'spam' }, next); }, ], done); }); it('should send back error if reporter does not exist', function (done) { Flags.validate({ uid: 123123123, id: 1, type: 'post' }, function (err) { assert.equal(err.message, '[[error:no-user]]'); done(); }); }); }); describe('.appendNote()', function () { it('should add a note to a flag', function (done) { Flags.appendNote(1, 1, 'this is my note', function (err) { assert.ifError(err); db.getSortedSetRange('flag:1:notes', 0, -1, function (err, notes) { if (err) { throw err; } assert.strictEqual('[1,"this is my note"]', notes[0]); setTimeout(done, 10); }); }); }); it('should be a JSON string', function (done) { db.getSortedSetRange('flag:1:notes', 0, -1, function (err, notes) { if (err) { throw err; } try { JSON.parse(notes[0]); } catch (e) { assert.ifError(e); } done(); }); }); }); describe('.getNotes()', function () { before(function (done) { // Add a second note Flags.appendNote(1, 1, 'this is the second note', done); }); it('return should match a predefined spec', function (done) { Flags.getNotes(1, function (err, notes) { assert.ifError(err); var compare = { uid: 1, content: 'this is my note', }; var data = notes[1]; for (var key in compare) { if (compare.hasOwnProperty(key)) { assert.ok(data[key]); assert.strictEqual(data[key], compare[key]); } } done(); }); }); it('should retrieve a list of notes, from newest to oldest', function (done) { Flags.getNotes(1, function (err, notes) { assert.ifError(err); assert(notes[0].datetime > notes[1].datetime, notes[0].datetime + '-' + notes[1].datetime); assert.strictEqual('this is the second note', notes[0].content); done(); }); }); }); describe('.appendHistory()', function () { var entries; before(function (done) { db.sortedSetCard('flag:1:history', function (err, count) { entries = count; done(err); }); }); it('should add a new entry into a flag\'s history', function (done) { Flags.appendHistory(1, 1, { state: 'rejected', }, function (err) { assert.ifError(err); Flags.getHistory(1, function (err, history) { if (err) { throw err; } // 1 for the new event appended, 2 for username and email change assert.strictEqual(entries + 3, history.length); done(); }); }); }); }); describe('.getHistory()', function () { it('should retrieve a flag\'s history', function (done) { Flags.getHistory(1, function (err, history) { assert.ifError(err); assert.strictEqual(history[0].fields.state, '[[flags:state-rejected]]'); done(); }); }); }); describe('(websockets)', function () { var SocketFlags = require('../src/socket.io/flags.js'); var pid; before(function (done) { Topics.post({ cid: 1, uid: 1, title: 'Another topic', content: 'This is flaggable content', }, function (err, topic) { pid = topic.postData.pid; done(err); }); }); describe('.create()', function () { it('should create a flag with no errors', function (done) { SocketFlags.create({ uid: 2 }, { type: 'post', id: pid, reason: 'foobar', }, function (err) { assert.ifError(err); Flags.exists('post', pid, 1, function (err, exists) { assert.ifError(err); assert(true); done(); }); }); }); it('should not allow flagging post in private category', async function () { const category = await Categories.create({ name: 'private category' }); await Privileges.categories.rescind(['groups:topics:read'], category.cid, 'registered-users'); const result = await Topics.post({ cid: category.cid, uid: adminUid, title: 'private topic', content: 'private post', }); try { await SocketFlags.create({ uid: uid3 }, { type: 'post', id: result.postData.pid, reason: 'foobar' }); } catch (err) { assert.equal(err.message, '[[error:no-privileges]]'); } }); }); describe('.update()', function () { it('should update a flag\'s properties', function (done) { SocketFlags.update({ uid: 2 }, { flagId: 2, data: [{ name: 'state', value: 'wip', }], }, function (err, history) { assert.ifError(err); assert(Array.isArray(history)); assert(history[0].fields.hasOwnProperty('state')); assert.strictEqual('[[flags:state-wip]]', history[0].fields.state); done(); }); }); }); describe('.appendNote()', function () { it('should append a note to the flag', function (done) { SocketFlags.appendNote({ uid: 2 }, { flagId: 2, note: 'lorem ipsum dolor sit amet', }, function (err, data) { assert.ifError(err); assert(data.hasOwnProperty('notes')); assert(Array.isArray(data.notes)); assert.strictEqual('lorem ipsum dolor sit amet', data.notes[0].content); assert.strictEqual(2, data.notes[0].uid); assert(data.hasOwnProperty('history')); assert(Array.isArray(data.history)); assert.strictEqual(1, Object.keys(data.history[0].fields).length); assert(data.history[0].fields.hasOwnProperty('notes')); done(); }); }); }); }); });