chore: Adds deprecation warning on livechat:saveCustomField with new endpoint replacing it (RocketChat#36971)

Author: lucas-a-pelegrino

.changeset/twelve-cougars-suffer.md

@@ -0,0 +1,6 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/rest-typings": patch
+---
+
+Adds deprecation warning on `livechat:saveCustomField` with new endpoint replacing it; `livechat/custom-fields.save`

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

@@ -4,8 +4,11 @@ import {
 	isPOSTLivechatCustomFieldParams,
 	isPOSTLivechatCustomFieldsParams,
 	isPOSTLivechatRemoveCustomFields,
+	isPOSTLivechatSaveCustomFieldsParams,
 	POSTLivechatRemoveCustomFieldSuccess,
+	POSTLivechatSaveCustomFieldSuccess,
 	validateBadRequestErrorResponse,
+	validateForbiddenErrorResponse,
 	validateUnauthorizedErrorResponse,
 } from '@rocket.chat/rest-typings';
 
@@ -91,29 +94,73 @@ API.v1.addRoute(
 	},
 );
 
-const livechatCustomFieldsEndpoints = API.v1.post(
-	'livechat/custom-fields.delete',
-	{
-		response: {
-			200: POSTLivechatRemoveCustomFieldSuccess,
-			400: validateBadRequestErrorResponse,
-			401: validateUnauthorizedErrorResponse,
+const livechatCustomFieldsEndpoints = API.v1
+	.post(
+		'livechat/custom-fields.save',
+		{
+			response: {
+				200: POSTLivechatSaveCustomFieldSuccess,
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+				403: validateForbiddenErrorResponse,
+			},
+			authRequired: true,
+			permissionsRequired: ['view-livechat-manager'], // is this permission appropriate for the targeted action?
+			body: isPOSTLivechatSaveCustomFieldsParams,
 		},
-		authRequired: true,
-		permissionsRequired: ['view-livechat-manager'], // is this permission appropriate for the targeted action?
-		body: isPOSTLivechatRemoveCustomFields,
-	},
-	async function action() {
-		const { customFieldId } = this.bodyParams;
+		async function action() {
+			const { customFieldId, customFieldData } = this.bodyParams;
 
-		const result = await LivechatCustomField.removeById(customFieldId);
-		if (result.deletedCount === 0) {
-			return API.v1.failure('Custom field not found');
-		}
+			if (!/^[0-9a-zA-Z-_]+$/.test(customFieldId)) {
+				return API.v1.failure('Invalid custom field name. Use only letters, numbers, hyphens and underscores.');
+			}
 
-		return API.v1.success();
-	},
-);
+			if (customFieldId) {
+				const customField = await LivechatCustomField.findOneById(customFieldId);
+				if (!customField) {
+					return API.v1.failure('Custom Field Not found');
+				}
+			}
+
+			if (!customFieldId) {
+				const customField = await LivechatCustomField.findOneById(customFieldData.field);
+				if (customField) {
+					return API.v1.failure('Custom Field already exists');
+				}
+			}
+
+			const { field, label, scope, visibility, ...extraData } = customFieldData;
+			const result = await LivechatCustomField.createOrUpdateCustomField(customFieldId, field, label, scope, visibility, {
+				...extraData,
+			});
+
+			return API.v1.success({ customField: result });
+		},
+	)
+	.post(
+		'livechat/custom-fields.delete',
+		{
+			response: {
+				200: POSTLivechatRemoveCustomFieldSuccess,
+				400: validateBadRequestErrorResponse,
+				401: validateUnauthorizedErrorResponse,
+				403: validateForbiddenErrorResponse,
+			},
+			authRequired: true,
+			permissionsRequired: ['view-livechat-manager'], // is this permission appropriate for the targeted action?
+			body: isPOSTLivechatRemoveCustomFields,
+		},
+		async function action() {
+			const { customFieldId } = this.bodyParams;
+
+			const result = await LivechatCustomField.removeById(customFieldId);
+			if (result.deletedCount === 0) {
+				return API.v1.failure('Custom field not found');
+			}
+
+			return API.v1.success();
+		},
+	);
 
 type LivechatCustomFieldsEndpoints = ExtractRoutesFromAPI<typeof livechatCustomFieldsEndpoints>;
 

apps/meteor/app/livechat/server/methods/saveCustomField.ts

@@ -5,6 +5,7 @@ import { Match, check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
 
 import { hasPermissionAsync } from '../../../authorization/server/functions/hasPermission';
+import { methodDeprecationLogger } from '../../../lib/server/lib/deprecationWarningLogger';
 
 declare module '@rocket.chat/ddp-client' {
 	// eslint-disable-next-line @typescript-eslint/naming-convention
@@ -25,6 +26,7 @@ declare module '@rocket.chat/ddp-client' {
 
 Meteor.methods<ServerMethods>({
 	async 'livechat:saveCustomField'(_id, customFieldData) {
+		methodDeprecationLogger.method('livechat:saveCustomField', '8.0.0', '/v1/livechat/custom-fields.save');
 		const uid = Meteor.userId();
 		if (!uid || !(await hasPermissionAsync(uid, 'view-livechat-manager'))) {
 			throw new Meteor.Error('error-not-allowed', 'Not allowed', {

apps/meteor/client/views/omnichannel/customFields/EditCustomFields.tsx

@@ -14,7 +14,7 @@ import {
 	Box,
 } from '@rocket.chat/fuselage';
 import { useEffectEvent } from '@rocket.chat/fuselage-hooks';
-import { useToastMessageDispatch, useMethod, useTranslation } from '@rocket.chat/ui-contexts';
+import { useToastMessageDispatch, useTranslation, useEndpoint } from '@rocket.chat/ui-contexts';
 import { useQueryClient } from '@tanstack/react-query';
 import { useId, useMemo } from 'react';
 import { FormProvider, useForm, Controller } from 'react-hook-form';
@@ -72,13 +72,16 @@ const EditCustomFields = ({ customFieldData, onClose }: { customFieldData?: Seri
 		formState: { isDirty, errors },
 	} = methods;
 
-	const saveCustomField = useMethod('livechat:saveCustomField');
+	const saveCustomField = useEndpoint('POST', '/v1/livechat/custom-fields.save');
 
 	const handleSave = useEffectEvent(async ({ visibility, ...data }: EditCustomFieldsFormData) => {
 		try {
-			await saveCustomField(customFieldData?._id as unknown as string, {
-				visibility: visibility ? 'visible' : 'hidden',
-				...data,
+			await saveCustomField({
+				customFieldId: customFieldData?._id as unknown as string,
+				customFieldData: {
+					visibility: visibility ? 'visible' : 'hidden',
+					...data,
+				},
 			});
 
 			dispatchToastMessage({ type: 'success', message: t('Saved') });

apps/meteor/tests/e2e/utils/omnichannel/custom-field.ts

@@ -1,50 +1,39 @@
 import type { ILivechatCustomField } from '@rocket.chat/core-typings';
 
-import { parseMeteorResponse } from '../parseMeteorResponse';
 import type { BaseTest } from '../test';
 
 type CustomField = Omit<ILivechatCustomField, '_id' | '_updatedAt'> & { field: string };
 
 export const removeCustomField = (api: BaseTest['api'], id: string) => {
-	return api.post('/method.call/livechat:deleteCustomField', {
-		method: 'livechat:saveCustomField',
-		params: [id],
-		id: 'id',
-		msg: 'method',
+	return api.post('/livechat/custom-fields.delete', {
+		customFieldId: id,
 	});
 };
 
-export const createCustomField = async (api: BaseTest['api'], overwrides: Partial<CustomField>) => {
-	const response = await api.post('/method.call/livechat:saveCustomField', {
-		message: JSON.stringify({
-			method: 'livechat:saveCustomField',
-			params: [
-				null,
-				{
-					field: overwrides.field,
-					label: overwrides.label || overwrides.field,
-					visibility: 'visible',
-					scope: 'visitor',
-					searchable: false,
-					regexp: '',
-					type: 'input',
-					required: false,
-					defaultValue: '',
-					options: '',
-					public: false,
-					...overwrides,
-				},
-			],
-			id: 'id',
-			msg: 'method',
-		}),
+export const createCustomField = async (api: BaseTest['api'], overwrites: Partial<CustomField>) => {
+	const response = await api.post('/livechat/custom-fields.save', {
+		customFieldId: null,
+		customFieldData: {
+			field: overwrites.field,
+			label: overwrites.label || overwrites.field,
+			visibility: 'visible',
+			scope: 'visitor',
+			searchable: false,
+			regexp: '',
+			type: 'input',
+			required: false,
+			defaultValue: '',
+			options: '',
+			public: false,
+			...overwrites,
+		},
 	});
 
 	if (!response.ok()) {
 		throw new Error(`Failed to create custom field [http status: ${response.status()}]`);
 	}
 
-	const customField = await parseMeteorResponse<CustomField & { _id: string }>(response);
+	const { customField } = await response.json();
 
 	return {
 		response,

apps/meteor/tests/end-to-end/api/livechat/00-rooms.ts

@@ -2838,30 +2838,23 @@ describe('LIVECHAT - rooms', () => {
 			});
 			it('should throw an error if a valid custom field fails the check', async () => {
 				await request
-					.post(methodCall('livechat:saveCustomField'))
+					.post(api('livechat/custom-fields.save'))
 					.set(credentials)
 					.send({
-						message: JSON.stringify({
-							method: 'livechat:saveCustomField',
-							params: [
-								null,
-								{
-									field: 'intfield',
-									label: 'intfield',
-									scope: 'room',
-									visibility: 'visible',
-									regexp: '\\d+',
-									searchable: true,
-									type: 'input',
-									required: false,
-									defaultValue: '0',
-									options: '',
-									public: false,
-								},
-							],
-							id: 'id',
-							msg: 'method',
-						}),
+						customFieldId: null,
+						customFieldData: {
+							field: 'intfield',
+							label: 'intfield',
+							scope: 'room',
+							visibility: 'visible',
+							regexp: '\\d+',
+							searchable: true,
+							type: 'input',
+							required: false,
+							defaultValue: '0',
+							options: '',
+							public: false,
+						},
 					})
 					.expect(200);