Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-11-14 09:55:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(topic-events): support for uids in topic event payloads

Browse Source
This commit is contained in:
Julian Lam
2021-01-04 22:27:56 -05:00
parent 425eca145b
commit 611d1f872d
3 changed files with 46 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/topics/events.js
View File

@@ -1,38 +1,44 @@
'use strict';
const db = require('../database');
const user = require('../user');
const plugins = require('../plugins');
const Events = module.exports;
/**
* Note: Plugins!
*
* You are able to define additional topic event types here.
* Register to hook `filter:topicEvents.init` and append your custom type to the `types` object.
* You can then log a custom topic event by calling `topics.events.log(tid, { type, uid });`
* `uid` is optional; if you pass in a valid uid in the payload, the user avatar/username will be rendered as part of the event text
*
*/
Events._types = {
pin: {
icon: 'fa-thumb-tack',
text: '[[topic:pinned]]',
},
pin_expiry: {
icon: 'fa-thumb-tack',
text: '[[topic:pinned-with-expiry]]',
text: '[[topic:pinned-by]]',
},
unpin: {
icon: 'fa-thumb-tack',
text: '[[topic:unpinned]]',
text: '[[topic:unpinned-by]]',
},
lock: {
icon: 'fa-lock',
text: '[[topic:locked]]',
text: '[[topic:locked-by]]',
},
unlock: {
icon: 'fa-unlock',
text: '[[topic:unlocked]]',
text: '[[topic:unlocked-by]]',
},
delete: {
icon: 'fa-trash',
text: '[[topic:deleted]]',
text: '[[topic:deleted-by]]',
},
restore: {
icon: 'fa-trash-o',
text: '[[topic:restored]]',
text: '[[topic:restored-by]]',
},
};
Events._ready = false;
@@ -57,11 +63,20 @@ Events.get = async (tid) => {
const eventIds = await db.getSortedSetRangeWithScores(`topic:${tid}:events`, 0, -1);
const keys = eventIds.map(obj => `topicEvent:${obj.value}`);
const timestamps = eventIds.map(obj => obj.score);
const events = await db.getObjects(keys);
let events = await db.getObjects(keys);
const users = await getUserInfo(events.map(event => event.uid).filter(Boolean));
// Remove events whose types no longer exist (e.g. plugin uninstalled)
events = events.filter(event => Events._types.hasOwnProperty(event.type));
// Add user & metadata
events.forEach((event, idx) => {
event.id = parseInt(eventIds[idx].value, 10);
event.timestamp = timestamps[idx];
event.timestampISO = new Date(timestamps[idx]).toISOString();
if (event.hasOwnProperty('uid')) {
event.user = users.get(event.uid === 'system' ? 'system' : parseInt(event.uid, 10));
}
Object.assign(event, Events._types[event.type]);
});
@@ -69,6 +84,17 @@ Events.get = async (tid) => {
return events;
};
async function getUserInfo(uids) {
uids = uids.filter((uid, idx) => !isNaN(parseInt(uid, 10)) && uids.indexOf(uid) === idx);
const userData = await user.getUsersFields(uids, ['picture', 'username', 'userslug']);
const userMap = userData.reduce((memo, cur) => memo.set(cur.uid, cur), new Map());
userMap.set('system', {
system: true,
});
return userMap;
}
Events.log = async (tid, payload) => {
await Events.init();
const topics = require('.');