Node.js based forum software built for the modern web
feat: mark flag notifications read when the flag detail page is viewed (#14747)
palmoni54d155cc959f7
diff --git a/public/openapi/components/schemas/NotificationObject.yaml b/public/openapi/components/schemas/NotificationObject.yamlindex bf63bb3de9..ea5677191c 100644--- a/public/openapi/components/schemas/NotificationObject.yaml+++ b/public/openapi/components/schemas/NotificationObject.yaml@@ -36,7 +36,10 @@ NotificationObject:description: A post id, if the notification pertains to a posttid:type: number- description: A post id, if the notification pertains to a topic+ description: A topic id, if the notification pertains to a topic+ flagId:+ type: number+ description: A flag id, if the notification pertains to a flaguser:$ref: ./UserObject.yaml#/UserObjectTinysubject:diff --git a/src/controllers/mods.js b/src/controllers/mods.jsindex 433f1d7474..206e665374 100644--- a/src/controllers/mods.js+++ b/src/controllers/mods.js@@ -174,8 +174,12 @@ modsController.flags.detail = async function (req, res, next) {return await user.hidePrivateData(userData.filter(u => u && u.userslug), uid);}- const assignees = await getAssignees(results.flagData, req.uid);- results.flagData.history = await flags.getHistory(req.params.flagId);+ const [assignees, history] = await Promise.all([+ getAssignees(results.flagData, req.uid),+ flags.getHistory(req.params.flagId),+ flags.markNotificationsRead(req.params.flagId, req.uid),+ ]);+ results.flagData.history = history;if (results.flagData.type === 'user') {results.flagData.type_path = 'uid';diff --git a/src/flags.js b/src/flags.jsindex 5013097373..682d01a72c 100644--- a/src/flags.js+++ b/src/flags.js@@ -756,6 +756,7 @@ Flags.update = async function (flagId, uid, changeset) {type: 'my-flags',bodyShort: translator.compile('notifications:flag-assigned-to-you', flagId),path: `/flags/${flagId}`,+ flagId: flagId,nid: `flags:assign:${flagId}:uid:${assigneeId}`,from: uid,});@@ -943,6 +944,7 @@ Flags.notify = async function (flagObj, uid, notifySelf = false) {bodyLong: String(flagObj.target?.content || ''),pid: flagObj.targetId,path: `/flags/${flagObj.flagId}`,+ flagId: flagObj.flagId,nid: `flag:post:${flagObj.targetId}:${uid}`,from: uid,mergeId: `notifications:user-flagged-post-in|${flagObj.targetId}`,@@ -956,6 +958,7 @@ Flags.notify = async function (flagObj, uid, notifySelf = false) {bodyShort: translator.compile('notifications:user-flagged-user', displayname, targetDisplayname),bodyLong: await plugins.hooks.fire('filter:parse.raw', String(flagObj.description || '')),path: `/flags/${flagObj.flagId}`,+ flagId: flagObj.flagId,nid: `flag:user:${flagObj.targetId}:${uid}`,from: uid,mergeId: `notifications:user-flagged-user|${flagObj.targetId}`,@@ -976,6 +979,17 @@ Flags.notify = async function (flagObj, uid, notifySelf = false) {await notifications.push(notifObj, uids);};+Flags.markNotificationsRead = async function (flagId, uid) {+ if (!(parseInt(uid, 10) > 0)) {+ return;+ }+ const nids = await user.notifications.getUnreadByField(uid, 'flagId', [flagId]);+ if (nids.length) {+ await notifications.markReadMultiple(nids, uid);+ await user.notifications.pushCount(uid);+ }+};+async function mergeBanHistory(history, targetUid, uids) {return await mergeBanMuteHistory(history, uids, {set: `uid:${targetUid}:bans:timestamp`,diff --git a/src/notifications.js b/src/notifications.jsindex 342c28c84e..601c2e2585 100644--- a/src/notifications.js+++ b/src/notifications.js@@ -64,7 +64,7 @@ Notifications.privilegedTypes = [const notificationPruneCutoff = 2592000000; // one month-const intFields = ['datetime', 'from', 'importance', 'tid', 'pid', 'roomId'];+const intFields = ['datetime', 'from', 'importance', 'tid', 'pid', 'roomId', 'flagId'];Notifications.getAllNotificationTypes = async function () {const results = await plugins.hooks.fire('filter:user.notificationTypes', {diff --git a/test/flags.js b/test/flags.jsindex 8c292878fb..8e8f61ce81 100644--- a/test/flags.js+++ b/test/flags.js@@ -13,6 +13,7 @@ const Flags = require('../src/flags');const Categories = require('../src/categories');const Topics = require('../src/topics');const Posts = require('../src/posts');+const notifications = require('../src/notifications');const User = require('../src/user');const Groups = require('../src/groups');const Meta = require('../src/meta');@@ -651,6 +652,59 @@ describe('Flags', () => {});});+ describe('.markNotificationsRead()', () => {+ let result;+ let flagObj;+ let nid;+ let unreadSet;+ let readSet;++ beforeEach(async () => {+ result = await Topics.post({+ cid: category.cid,+ uid: uid3,+ title: 'Topic to flag',+ content: 'This is flaggable content',+ });+ flagObj = await api.flags.create({ uid: uid1 }, { type: 'post', id: result.postData.pid, reason: 'spam' });+ nid = `flag:post:${result.postData.pid}:${uid1}`;+ unreadSet = `uid:${adminUid}:notifications:unread`;+ readSet = `uid:${adminUid}:notifications:read`;+ await sleep(2000);+ });++ it('should store the flagId on the flag notification', async () => {+ const [notifObj] = await notifications.getMultiple([nid]);+ assert.strictEqual(notifObj.flagId, flagObj.flagId);+ });++ it('should mark the flag notification as read', async () => {+ assert(await db.isSortedSetMember(unreadSet, nid));++ await Flags.markNotificationsRead(flagObj.flagId, adminUid);++ assert(!await db.isSortedSetMember(unreadSet, nid));+ assert(await db.isSortedSetMember(readSet, nid));+ });++ it('should mark the flag notification as read when the flag detail page is viewed', async () => {+ const { jar: adminJar } = await helpers.loginUser('testUser2', 'abcdef');+ assert(await db.isSortedSetMember(unreadSet, nid));++ const { response } = await request.get(`${nconf.get('url')}/flags/${flagObj.flagId}`, { jar: adminJar });+ assert.strictEqual(response.statusCode, 200);++ assert(!await db.isSortedSetMember(unreadSet, nid));+ assert(await db.isSortedSetMember(readSet, nid));+ });++ it('should not touch notifications of a user who never received one', async () => {+ assert(!await db.isSortedSetMember(`uid:${uid3}:notifications:unread`, nid));+ await Flags.markNotificationsRead(flagObj.flagId, uid3);+ assert(!await db.isSortedSetMember(`uid:${uid3}:notifications:read`, nid));+ });+ });+describe('.getTarget()', () => {it('should return a post\'s data if queried with type "post"', (done) => {Flags.getTarget('post', 1, 1, (err, data) => {