fix: Update Contact's custom fields when updating visitor custom fields

.changeset/young-kiwis-fly.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': patch
+---
+
+Fixes contact custom fields not being updated when updating a visitor's custom field

apps/meteor/app/livechat/server/api/v1/customField.ts

@@ -12,15 +12,12 @@ API.v1.addRoute(
 	{
 		async post() {
 			const { token, key, value, overwrite } = this.bodyParams;
-
 			const guest = await findGuest(token);
 			if (!guest) {
 				throw new Error('invalid-token');
 			}
 
-			if (!(await setCustomFields({ token, key, value, overwrite }))) {
-				return API.v1.failure();
-			}
+			await setCustomFields({ token, key, value, overwrite });
 
 			return API.v1.success({ field: { key, value, overwrite } });
 		},
@@ -46,9 +43,7 @@ API.v1.addRoute(
 						overwrite: boolean;
 					}): Promise<{ Key: string; value: string; overwrite: boolean }> => {
 						const data = Object.assign({ token }, customField);
-						if (!(await setCustomFields(data))) {
-							throw new Error('error-setting-custom-field');
-						}
+						await setCustomFields(data);
 
 						return { Key: customField.key, value: customField.value, overwrite: customField.overwrite };
 					},

apps/meteor/app/livechat/server/api/v1/visitor.ts

@@ -1,12 +1,12 @@
-import type { IRoom } from '@rocket.chat/core-typings';
-import { LivechatVisitors as VisitorsRaw, LivechatCustomField, LivechatRooms } from '@rocket.chat/models';
+import type { IRoom, ILivechatCustomField } from '@rocket.chat/core-typings';
+import { LivechatVisitors as VisitorsRaw, LivechatCustomField, LivechatRooms, LivechatContacts } from '@rocket.chat/models';
 import { Match, check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
 
 import { callbacks } from '../../../../../lib/callbacks';
 import { API } from '../../../../api/server';
 import { settings } from '../../../../settings/server';
-import { validateRequiredCustomFields } from '../../lib/custom-fields';
+import { updateContactsCustomFields, validateRequiredCustomFields } from '../../lib/custom-fields';
 import { registerGuest, removeGuest, notifyGuestStatusChanged } from '../../lib/guests';
 import { livechatLogger } from '../../lib/logger';
 import { saveRoomInfo } from '../../lib/rooms';
@@ -93,9 +93,9 @@ API.v1.addRoute(
 				).toArray();
 				validateRequiredCustomFields(keys, livechatCustomFields);
 
-				const matchingCustomFields = livechatCustomFields.filter((field) => keys.includes(field._id));
+				const matchingCustomFields = livechatCustomFields.filter((field: ILivechatCustomField) => keys.includes(field._id));
 				const processedKeys = await Promise.all(
-					matchingCustomFields.map(async (field) => {
+					matchingCustomFields.map(async (field: ILivechatCustomField) => {
 						const customField = customFields.find((f) => f.key === field._id);
 						if (!customField) {
 							return;
@@ -107,6 +107,12 @@ API.v1.addRoute(
 							errors.push(key);
 						}
 
+						// TODO deduplicate this code and the one at the function setCustomFields (apps/meteor/app/livechat/server/lib/custom-fields.ts)
+						const contacts = await LivechatContacts.findAllByVisitorId(visitor._id).toArray();
+						if (contacts.length > 0) {
+							await Promise.all(contacts.map((contact) => updateContactsCustomFields(contact, key, value, overwrite)));
+						}
+
 						return key;
 					}),
 				);

apps/meteor/app/livechat/server/lib/custom-fields.ts

@@ -1,5 +1,5 @@
-import type { ILivechatCustomField } from '@rocket.chat/core-typings';
-import { LivechatCustomField, LivechatRooms, LivechatVisitors } from '@rocket.chat/models';
+import type { ILivechatContact, ILivechatCustomField } from '@rocket.chat/core-typings';
+import { LivechatContacts, LivechatCustomField, LivechatRooms, LivechatVisitors } from '@rocket.chat/models';
 
 import { livechatLogger } from './logger';
 import { i18n } from '../../../utils/lib/i18n';
@@ -19,7 +19,31 @@ export const validateRequiredCustomFields = (customFields: string[], livechatCus
 	}
 };
 
-export async function setCustomFields({ token, key, value, overwrite }: { key: string; value: string; overwrite: boolean; token: string }) {
+export async function updateContactsCustomFields(contact: ILivechatContact, key: string, value: string, overwrite: boolean): Promise<void> {
+	if (overwrite || !contact.customFields || !contact.customFields[key]) {
+		contact.customFields ??= {};
+		contact.customFields[key] = value;
+	} else {
+		contact.conflictingFields ??= [];
+		contact.conflictingFields.push({ field: `customFields.${key}`, value });
+	}
+
+	await LivechatContacts.updateContact(contact._id, { customFields: contact.customFields, conflictingFields: contact.conflictingFields });
+
+	livechatLogger.debug({ msg: `Contact ${contact._id} updated with custom fields` });
+}
+
+export async function setCustomFields({
+	token,
+	key,
+	value,
+	overwrite,
+}: {
+	key: string;
+	value: string;
+	overwrite: boolean;
+	token: string;
+}): Promise<number> {
 	livechatLogger.debug(`Setting custom fields data for visitor with token ${token}`);
 
 	const customField = await LivechatCustomField.findOneById(key);
@@ -39,6 +63,14 @@ export async function setCustomFields({ token, key, value, overwrite }: { key: s
 		result = await LivechatRooms.updateDataByToken(token, key, value, overwrite);
 	} else {
 		result = await LivechatVisitors.updateLivechatDataByToken(token, key, value, overwrite);
+
+		const visitor = await LivechatVisitors.getVisitorByToken(token, { projection: { _id: 1 } });
+		if (visitor) {
+			const contacts = await LivechatContacts.findAllByVisitorId(visitor._id).toArray();
+			if (contacts.length > 0) {
+				await Promise.all(contacts.map((contact) => updateContactsCustomFields(contact, key, value, overwrite)));
+			}
+		}
 	}
 
 	if (typeof result === 'boolean') {