Skip to content

Node.js based forum software built for the modern web

refactor: one owner for the custom user field keys (#14853)

palmoni589e6b358e17c
diff --git a/src/api/admin.js b/src/api/admin.js
index f8f13f2891..2803bf287c 100644
--- a/src/api/admin.js
+++ b/src/api/admin.js
@@ -9,7 +9,6 @@ const groups = require('../groups');
const plugins = require('../plugins');
const events = require('../events');
const postsCache = require('../posts/cache');
-const db = require('../database');
const user = require('../user');
const adminApi = module.exports;
@@ -45,18 +44,7 @@ adminApi.users.saveCustomFields = async (caller, { fields }) => {
throw new Error(`[[error:invalid-custom-user-field, ${field.key}]]`);
}
}
- const keys = await db.getSortedSetRange('user-custom-fields', 0, -1);
- await db.delete('user-custom-fields');
- await db.deleteAll(keys.map(k => `user-custom-field:${k}`));
-
- await db.sortedSetAdd(
- 'user-custom-fields',
- fields.map((f, i) => i),
- fields.map(f => f.key)
- );
- await db.setObjectBulk(
- fields.map(field => [`user-custom-field:${field.key}`, field])
- );
+ await user.customFields.setFields(fields);
await user.reloadCustomFieldWhitelist();
};
diff --git a/src/controllers/accounts/helpers.js b/src/controllers/accounts/helpers.js
index d87bc56bc8..cfd78a20a9 100644
--- a/src/controllers/accounts/helpers.js
+++ b/src/controllers/accounts/helpers.js
@@ -165,8 +165,7 @@ helpers.getCustomUserFields = async function (callerUID, userData) {
return fields;
}
- const keys = await db.getSortedSetRange('user-custom-fields', 0, -1);
- const allFields = (await db.getObjects(keys.map(k => `user-custom-field:${k}`))).filter(Boolean);
+ const allFields = await user.customFields.getFields();
const isSelf = String(callerUID) === String(userData.uid);
const [isAdmin, isModOfAny] = await Promise.all([
diff --git a/src/controllers/admin/users.js b/src/controllers/admin/users.js
index 8e2c352033..b2818421c9 100644
--- a/src/controllers/admin/users.js
+++ b/src/controllers/admin/users.js
@@ -97,7 +97,7 @@ async function getUsers(req, res) {
const [count, users, customUserFields] = await Promise.all([
getCount(set),
loadUserInfo(req.uid, uids),
- getCustomUserFields(),
+ user.customFields.getFields(),
]);
await render(req, res, {
@@ -111,11 +111,6 @@ async function getUsers(req, res) {
});
}
-async function getCustomUserFields() {
- const keys = await db.getSortedSetRange('user-custom-fields', 0, -1);
- return (await db.getObjects(keys.map(k => `user-custom-field:${k}`))).filter(Boolean);
-}
-
usersController.search = async function (req, res) {
const sortDirection = req.query.sortDirection || 'desc';
const reverse = sortDirection === 'desc';
@@ -257,8 +252,7 @@ usersController.getCSV = async function (req, res, next) {
};
usersController.customFields = async function (req, res) {
- const keys = await db.getSortedSetRange('user-custom-fields', 0, -1);
- const fields = (await db.getObjects(keys.map(k => `user-custom-field:${k}`))).filter(Boolean);
+ const fields = await user.customFields.getFields();
fields.forEach((field) => {
if (field['select-options']) {
field.selectOptionsFormatted = field['select-options'].trim().split('\n').join(', ');
diff --git a/src/user/admin.js b/src/user/admin.js
index 1314834e73..c0a64adeb2 100644
--- a/src/user/admin.js
+++ b/src/user/admin.js
@@ -54,7 +54,7 @@ module.exports = function (User) {
fields: fieldsToExport,
showIps: fieldsToExport.includes('ip'),
});
- const customUserFields = await db.getSortedSetRange('user-custom-fields', 0, -1);
+ const customUserFields = await User.customFields.getKeys();
if (!showIps && fields.includes('ip')) {
fields.splice(fields.indexOf('ip'), 1);
}
diff --git a/src/user/custom-fields.js b/src/user/custom-fields.js
new file mode 100644
index 0000000000..684c0979cf
--- /dev/null
+++ b/src/user/custom-fields.js
@@ -0,0 +1,29 @@
+'use strict';
+
+const db = require('../database');
+
+const CustomFields = module.exports;
+
+CustomFields.getKeys = async function () {
+ return await db.getSortedSetRange('user-custom-fields', 0, -1);
+};
+
+CustomFields.getFields = async function () {
+ const keys = await CustomFields.getKeys();
+ return (await db.getObjects(keys.map(k => `user-custom-field:${k}`))).filter(Boolean);
+};
+
+CustomFields.setFields = async function (fields) {
+ const keys = await CustomFields.getKeys();
+ await db.delete('user-custom-fields');
+ await db.deleteAll(keys.map(k => `user-custom-field:${k}`));
+
+ await db.sortedSetAdd(
+ 'user-custom-fields',
+ fields.map((f, i) => i),
+ fields.map(f => f.key)
+ );
+ await db.setObjectBulk(
+ fields.map(field => [`user-custom-field:${field.key}`, field])
+ );
+};
diff --git a/src/user/data.js b/src/user/data.js
index 99749786d4..6c4f53a04d 100644
--- a/src/user/data.js
+++ b/src/user/data.js
@@ -67,7 +67,7 @@ module.exports = function (User) {
let iconBackgrounds;
User.reloadCustomFieldWhitelist = async () => {
- customFieldWhiteList = await db.getSortedSetRange('user-custom-fields', 0, -1);
+ customFieldWhiteList = await User.customFields.getKeys();
};
User.getUserFieldWhitelist = async function () {
diff --git a/src/user/index.js b/src/user/index.js
index bd25667f54..78259c0dec 100644
--- a/src/user/index.js
+++ b/src/user/index.js
@@ -19,6 +19,7 @@ User.notifications = require('./notifications');
User.reset = require('./reset');
User.digest = require('./digest');
User.interstitials = require('./interstitials');
+User.customFields = require('./custom-fields');
require('./data')(User);
require('./auth')(User);
diff --git a/src/user/profile.js b/src/user/profile.js
index eba92093d8..8a36d61012 100644
--- a/src/user/profile.js
+++ b/src/user/profile.js
@@ -19,7 +19,7 @@ module.exports = function (User) {
let fields = [
'username', 'email', 'fullname',
'groupTitle', 'birthday', 'signature', 'aboutme',
- ...await db.getSortedSetRange('user-custom-fields', 0, -1),
+ ...await User.customFields.getKeys(),
];
if (Array.isArray(extraFields)) {
fields = fields.concat(extraFields);
@@ -89,8 +89,7 @@ module.exports = function (User) {
}
async function validateCustomFields(data) {
- const keys = await db.getSortedSetRange('user-custom-fields', 0, -1);
- const fields = (await db.getObjects(keys.map(k => `user-custom-field:${k}`))).filter(Boolean);
+ const fields = await User.customFields.getFields();
const reputation = await User.getUserField(data.uid, 'reputation');
fields.forEach((field) => {