feat(messages): Allow Custom Fields in Messages

.changeset/four-eyes-sniff.md

@@ -0,0 +1,7 @@
+---
+"@rocket.chat/meteor": minor
+"@rocket.chat/core-typings": minor
+"@rocket.chat/i18n": minor
+---
+
+Allow Custom Fields in Messages. API-only feature. It can be enabled and configured in Workspace Settings.

apps/meteor/app/api/server/v1/chat.ts

@@ -312,6 +312,7 @@ API.v1.addRoute(
 					roomId: String,
 					msgId: String,
 					text: String, // Using text to be consistant with chat.postMessage
+					customFields: Match.Maybe(Object),
 					previewUrls: Match.Maybe([String]),
 				}),
 			);
@@ -328,7 +329,16 @@ API.v1.addRoute(
 			}
 
 			// Permission checks are already done in the updateMessage method, so no need to duplicate them
-			await executeUpdateMessage(this.userId, { _id: msg._id, msg: this.bodyParams.text, rid: msg.rid }, this.bodyParams.previewUrls);
+			await executeUpdateMessage(
+				this.userId,
+				{
+					_id: msg._id,
+					msg: this.bodyParams.text,
+					rid: msg.rid,
+					customFields: this.bodyParams.customFields as Record<string, any> | undefined,
+				},
+				this.bodyParams.previewUrls,
+			);
 
 			const updatedMessage = await Messages.findOneById(msg._id);
 			const [message] = await normalizeMessagesForUser(updatedMessage ? [updatedMessage] : [], this.userId);

apps/meteor/app/lib/server/functions/processWebhookMessage.ts

@@ -25,6 +25,7 @@ type Payload = {
 	bot?: IMessage['bot'];
 	groupable?: IMessage['groupable'];
 	tmid?: IMessage['tmid'];
+	customFields?: IMessage['customFields'];
 };
 
 type DefaultValues = {
@@ -109,6 +110,7 @@ export const processWebhookMessage = async function (
 			bot: messageObj.bot,
 			groupable: messageObj.groupable !== undefined ? messageObj.groupable : false,
 			tmid: messageObj.tmid,
+			customFields: messageObj.customFields,
 		};
 
 		if (!_.isEmpty(messageObj.icon_url) || !_.isEmpty(messageObj.avatar)) {

apps/meteor/app/lib/server/functions/sendMessage.ts

@@ -12,6 +12,7 @@ import { hasPermissionAsync } from '../../../authorization/server/functions/hasP
 import { FileUpload } from '../../../file-upload/server';
 import notifications from '../../../notifications/server/lib/Notifications';
 import { settings } from '../../../settings/server';
+import { validateCustomMessageFields } from '../lib/validateCustomMessageFields';
 import { parseUrlsInMessage } from './parseUrlsInMessage';
 
 // TODO: most of the types here are wrong, but I don't want to change them now
@@ -172,6 +173,14 @@ export const validateMessage = async (message: any, room: any, user: any) => {
 	if (Array.isArray(message.attachments) && message.attachments.length) {
 		validateBodyAttachments(message.attachments);
 	}
+
+	if (message.customFields) {
+		validateCustomMessageFields({
+			customFields: message.customFields,
+			messageCustomFieldsEnabled: settings.get<boolean>('Message_CustomFields_Enabled'),
+			messageCustomFields: settings.get<string>('Message_CustomFields'),
+		});
+	}
 };
 
 export function prepareMessageObject(

apps/meteor/app/lib/server/functions/updateMessage.ts

@@ -7,6 +7,7 @@ import { Meteor } from 'meteor/meteor';
 import { callbacks } from '../../../../lib/callbacks';
 import { broadcastMessageFromData } from '../../../../server/modules/watchers/lib/messages';
 import { settings } from '../../../settings/server';
+import { validateCustomMessageFields } from '../lib/validateCustomMessageFields';
 import { parseUrlsInMessage } from './parseUrlsInMessage';
 
 export const updateMessage = async function (
@@ -59,6 +60,14 @@ export const updateMessage = async function (
 
 	messageData = await Message.beforeSave({ message: messageData, room, user });
 
+	if (messageData.customFields) {
+		validateCustomMessageFields({
+			customFields: messageData.customFields,
+			messageCustomFieldsEnabled: settings.get<boolean>('Message_CustomFields_Enabled'),
+			messageCustomFields: settings.get<string>('Message_CustomFields'),
+		});
+	}
+
 	const { _id, ...editedMessage } = messageData;
 
 	if (!editedMessage.msg) {

apps/meteor/app/lib/server/lib/validateCustomMessageFields.ts

@@ -0,0 +1,41 @@
+import Ajv from 'ajv';
+import mem from 'mem';
+
+const ajv = new Ajv();
+
+const customFieldsValidate = mem((customFieldsSetting: string) => {
+	const schema = JSON.parse(customFieldsSetting);
+
+	if (schema.type && schema.type !== 'object') {
+		throw new Error('Invalid custom fields config');
+	}
+
+	return ajv.compile({
+		...schema,
+		type: 'object',
+		additionalProperties: false,
+	});
+});
+
+export const validateCustomMessageFields = ({
+	customFields,
+	messageCustomFieldsEnabled,
+	messageCustomFields,
+}: {
+	customFields: Record<string, any>;
+	messageCustomFieldsEnabled: boolean;
+	messageCustomFields: string;
+}) => {
+	// get the json schema for the custom fields of the message and validate it using ajv
+	// if the validation fails, throw an error
+	// if there are no custom fields, the message object remains unchanged
+
+	if (messageCustomFieldsEnabled !== true) {
+		throw new Error('Custom fields not enabled');
+	}
+
+	const validate = customFieldsValidate(messageCustomFields);
+	if (!validate(customFields)) {
+		throw new Error('Invalid custom fields');
+	}
+};

apps/meteor/app/lib/server/methods/updateMessage.ts

@@ -10,7 +10,7 @@ import { hasPermissionAsync } from '../../../authorization/server/functions/hasP
 import { settings } from '../../../settings/server';
 import { updateMessage } from '../functions/updateMessage';
 
-const allowedEditedFields = ['tshow', 'alias', 'attachments', 'avatar', 'emoji', 'msg'];
+const allowedEditedFields = ['tshow', 'alias', 'attachments', 'avatar', 'emoji', 'msg', 'customFields'];
 
 export async function executeUpdateMessage(uid: IUser['_id'], message: AtLeast<IMessage, '_id' | 'rid' | 'msg'>, previewUrls?: string[]) {
 	const originalMessage = await Messages.findOneById(message._id);

apps/meteor/server/settings/message.ts

@@ -385,4 +385,35 @@ export const createMessageSettings = () =>
 			type: 'boolean',
 			public: true,
 		});
+
+		await this.add('Message_CustomFields_Enabled', false, {
+			type: 'boolean',
+		});
+		await this.add(
+			'Message_CustomFields',
+			`
+{
+	"properties": {
+		"priority": {
+			"type": "string",
+			"nullable": false,
+			"enum": ["low", "medium", "high"]
+		}
+	},
+	"required": ["priority"]
+}
+		`,
+			{
+				type: 'code',
+				code: 'application/json',
+				invalidValue: '',
+				multiline: true,
+				enableQuery: [
+					{
+						_id: 'Message_CustomFields_Enabled',
+						value: true,
+					},
+				],
+			},
+		);
 	});