Skip to content

Node.js based forum software built for the modern web

refactor(activitypub): add action:userRemote.create/delete hooks and static:users.search short-circuit

Julian Lam0f983531077d
diff --git a/src/activitypub/actors.js b/src/activitypub/actors.js
index 613f321a5d..cfea26d503 100644
--- a/src/activitypub/actors.js
+++ b/src/activitypub/actors.js
@@ -10,6 +10,7 @@ const batch = require('../batch');
const categories = require('../categories');
const user = require('../user');
const utils = require('../utils');
+const plugins = require('../plugins');
const TTLCache = require('../cache/ttl');
const failedWebfingerCache = TTLCache({
@@ -270,6 +271,10 @@ Actors.assert = async (ids, options = {}) => {
db.setObject('handle:uid', queries.handleAdd),
]);
+ if (profiles.length) {
+ await plugins.hooks.fire('action:userRemote.create', { profiles });
+ }
+
// Handle any actors that should be asserted as a group instead
if (categories.size) {
const assertion = await Actors.assertGroup(Array.from(categories), options);
@@ -543,6 +548,8 @@ Actors.remove = async (id) => {
db.delete(`userRemote:${id}`),
db.sortedSetRemove('usersRemote:lastCrawled', id),
]);
+
+ await plugins.hooks.fire('action:userRemote.delete', { id });
};
Actors.removeGroup = async (id) => {
diff --git a/src/user/search.js b/src/user/search.js
index 8d1a7b0508..93c58a225b 100644
--- a/src/user/search.js
+++ b/src/user/search.js
@@ -59,20 +59,31 @@ module.exports = function (User) {
}
if (!uids.length) {
- const searchMethod = data.findUids || findUids;
- const promises = [
- searchMethod(query, searchBy, data.hardCap),
- ];
-
- const mapping = {
- username: 'ap.preferredUsername',
- fullname: 'ap.name',
- };
- if (meta.config.activitypubEnabled && Object.hasOwn(mapping, searchBy)) {
- promises.push(searchMethod(query, mapping[searchBy], data.hardCap));
- }
- uids = (await Promise.all(promises)).flat();
+ uids = await (data.findUids || findUids)(query, searchBy, data.hardCap);
+ }
+ }
+
+ // Allow plugins to short-circuit with their own results
+ const hookResult = await plugins.hooks.fire('static:users.search', {
+ query, searchBy, uids, uid, hardCap: data.hardCap,
+ });
+ uids = hookResult.uids;
+
+ // Only run fallback if still empty
+ if (!uids.length) {
+ const searchMethod = data.findUids || findUids;
+ const promises = [
+ searchMethod(query, searchBy, data.hardCap),
+ ];
+
+ const mapping = {
+ username: 'ap.preferredUsername',
+ fullname: 'ap.name',
+ };
+ if (meta.config.activitypubEnabled && Object.hasOwn(mapping, searchBy)) {
+ promises.push(searchMethod(query, mapping[searchBy], data.hardCap));
}
+ uids = (await Promise.all(promises)).flat();
}
uids = await filterAndSortUids(uids, data);