Added initial clear chat flags tests

test/api/v3/integration/chat/POST-groups_id_chat_id_clear_flags.test.js

@@ -0,0 +1,101 @@
+import {
+  createAndPopulateGroup,
+  generateUser,
+  translate as t,
+} from '../../../../helpers/api-v3-integration.helper';
+import { v4 as generateUUID } from 'uuid';
+
+describe('POST /groups/:id/chat/:id/clearflags', () => {
+  let groupWithChat, message, author, nonAdmin, admin;
+
+  before(async () => {
+    let { group, groupLeader, members } = await createAndPopulateGroup({
+      groupDetails: {
+        type: 'guild',
+        privacy: 'public',
+      },
+      members: 1,
+    });
+
+    groupWithChat = group;
+    author = groupLeader;
+    nonAdmin = members[0];
+    admin = await generateUser({'contributor.admin': true});
+
+    message = await author.post(`/groups/${groupWithChat._id}/chat`, { message: 'Some message' });
+    message = message.message;
+    admin.post(`/groups/${groupWithChat._id}/chat/${message.id}/flag`);
+  });
+
+  context('Single Message', () => {
+    it('returns error when non-admin attempts to clear flags', async () => {
+      return expect(nonAdmin.post(`/groups/${groupWithChat._id}/chat/${message.id}/clearflags`))
+        .to.eventually.be.rejected.and.eql({
+          code: 401,
+          error: 'NotAuthorized',
+          message: t('messageGroupChatAdminClearFlagCount'),
+        });
+    });
+
+    it('returns error if message does not exist', async () => {
+      let fakeMessageID = generateUUID();
+
+      await expect(admin.post(`/groups/${groupWithChat._id}/chat/${fakeMessageID}/clearflags`))
+        .to.eventually.be.rejected.and.eql({
+          code: 404,
+          error: 'NotFound',
+          message: t('messageGroupChatNotFound'),
+        });
+    });
+
+    it('clears flags and leaves old flags on the flag object', async () => {
+      await admin.post(`/groups/${groupWithChat._id}/chat/${message.id}/clearflags`);
+      let messages = await admin.get(`/groups/${groupWithChat._id}/chat`);
+      expect(messages[0].flagCount).to.eql(0);
+      expect(messages[0].flags).to.have.property(admin._id, true);
+    });
+  });
+
+  context('admin user, group with multiple messages', () => {
+    let message2, message3, message4;
+
+    before(async () => {
+      message2 = await author.post(`/groups/${groupWithChat._id}/chat`, { message: 'Some message 2' });
+      message2 = message2.message;
+      await admin.post(`/groups/${groupWithChat._id}/chat/${message2.id}/flag`);
+
+      message3 = await author.post(`/groups/${groupWithChat._id}/chat`, { message: 'Some message 3' });
+      message3 = message3.message;
+      await admin.post(`/groups/${groupWithChat._id}/chat/${message3.id}/flag`);
+      await nonAdmin.post(`/groups/${groupWithChat._id}/chat/${message3.id}/flag`);
+
+      message4 = await author.post(`/groups/${groupWithChat._id}/chat`, { message: 'Some message 4' });
+      message4 = message4.message;
+    });
+
+    it('changes only the message that is flagged', async () => {
+      await admin.post(`/groups/${groupWithChat._id}/chat/${message.id}/clearflags`);
+      let messages = await admin.get(`/groups/${groupWithChat._id}/chat`);
+
+      expect(messages).to.have.lengthOf(4);
+
+      let messageThatWasUnflagged = messages[3];
+      let messageWith1Flag = messages[2];
+      let messageWith2Flag = messages[1];
+      let messageWithoutFlags = messages[0];
+
+      expect(messageThatWasUnflagged.flagCount).to.eql(0);
+      expect(messageThatWasUnflagged.flags).to.have.property(admin._id, true);
+
+      expect(messageWith1Flag.flagCount).to.eql(5);
+      expect(messageWith1Flag.flags).to.have.property(admin._id, true);
+
+      expect(messageWith2Flag.flagCount).to.eql(6);
+      expect(messageWith2Flag.flags).to.have.property(admin._id, true);
+      expect(messageWith2Flag.flags).to.have.property(nonAdmin._id, true);
+
+      expect(messageWithoutFlags.flagCount).to.eql(0);
+      expect(messageWithoutFlags.flags).to.eql({});
+    });
+  });
+});

website/src/controllers/api-v3/chat.js

@@ -4,6 +4,7 @@ import { model as Group } from '../../models/group';
 import { model as User } from '../../models/user';
 import {
   NotFound,
+  NotAuthorized,
 } from '../../libs/api-v3/errors';
 import _ from 'lodash';
 import { sendTxn } from '../../libs/api-v3/email';
@@ -256,4 +257,51 @@ api.flagChat = {
   },
 };
 
+/**
+ * @api {post} /groups/:groupId/chat/:chatId/clear-flags Clear a group chat message's flags
+ * @apiVersion 3.0.0
+ * @apiName ClearFlags
+ * @apiGroup Chat
+ *
+ * @apiParam {groupId} groupId The group _id
+ * @apiParam {chatId} chatId The chat message _id
+ *
+ * @apiSuccess {Object} An empty object
+ */
+api.clearChatFlags = {
+  method: 'Post',
+  url: '/groups/:groupId/chat/:chatId/clearflags',
+  middlewares: [authWithHeaders(), cron],
+  async handler (req, res) {
+    let user = res.locals.user;
+    let groupId = req.params.groupId;
+    let chatId = req.params.chatId;
+
+    req.checkParams('groupId', res.t('groupIdRequired')).notEmpty();
+    req.checkParams('chatId', res.t('chatIdRequired')).notEmpty();
+
+    let validationErrors = req.validationErrors();
+    if (validationErrors) throw validationErrors;
+
+    if (!user.contributor.admin) {
+      throw new NotAuthorized(res.t('messageGroupChatAdminClearFlagCount'));
+    }
+
+    let group = await Group.getGroup({user, groupId});
+    if (!group) throw new NotFound(res.t('groupNotFound'));
+
+    let message = _.find(group.chat, {id: chatId});
+    if (!message) throw new NotFound(res.t('messageGroupChatNotFound'));
+
+    message.flagCount = 0;
+
+    await Group.update(
+      {_id: group._id, 'chat.id': message.id},
+      {$set: {'chat.$.flagCount': message.flagCount}}
+    );
+
+    res.respond(200, {});
+  },
+};
+
 export default api;