[NEW] Capability to search visitors by custom fields

apps/meteor/app/livechat/imports/server/rest/visitors.js

@@ -8,7 +8,7 @@ import {
 	findChatHistory,
 	searchChats,
 	findVisitorsToAutocomplete,
-	findVisitorsByEmailOrPhoneOrNameOrUsername,
+	findVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField,
 } from '../../../server/api/lib/visitors';
 
 API.v1.addRoute(
@@ -144,7 +144,7 @@ API.v1.addRoute(
 			const nameOrUsername = new RegExp(escapeRegExp(term), 'i');
 
 			return API.v1.success(
-				await findVisitorsByEmailOrPhoneOrNameOrUsername({
+				await findVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField({
 					userId: this.userId,
 					emailOrPhone: term,
 					nameOrUsername,

apps/meteor/app/livechat/server/api/lib/rooms.js

@@ -35,7 +35,7 @@ export async function findRooms({
 	const departmentsIds = [...new Set(rooms.map((room) => room.departmentId).filter(Boolean))];
 	if (departmentsIds.length) {
 		const departments = await LivechatDepartment.findInIds(departmentsIds, {
-			fields: { name: 1 },
+			projection: { name: 1 },
 		}).toArray();
 
 		rooms.forEach((room) => {

apps/meteor/app/livechat/server/api/lib/visitors.js

@@ -1,4 +1,4 @@
-import { LivechatVisitors, Messages, LivechatRooms } from '@rocket.chat/models';
+import { LivechatVisitors, Messages, LivechatRooms, LivechatCustomField } from '@rocket.chat/models';
 
 import { canAccessRoomAsync } from '../../../../authorization/server/functions/canAccessRoom';
 
@@ -129,20 +129,33 @@ export async function findVisitorsToAutocomplete({ selector }) {
 	};
 }
 
-export async function findVisitorsByEmailOrPhoneOrNameOrUsername({ emailOrPhone, nameOrUsername, pagination: { offset, count, sort } }) {
-	const { cursor, totalCount } = LivechatVisitors.findPaginatedVisitorsByEmailOrPhoneOrNameOrUsername(emailOrPhone, nameOrUsername, {
-		sort: sort || { ts: -1 },
-		skip: offset,
-		limit: count,
-		projection: {
-			username: 1,
-			name: 1,
-			phone: 1,
-			livechatData: 1,
-			visitorEmails: 1,
-			lastChat: 1,
+export async function findVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField({
+	emailOrPhone,
+	nameOrUsername,
+	pagination: { offset, count, sort },
+}) {
+	const allowedCF = await LivechatCustomField.findMatchingCustomFields('visitor', true, { projection: { _id: 1 } })
+		.map((cf) => cf._id)
+		.toArray();
+
+	const { cursor, totalCount } = await LivechatVisitors.findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField(
+		emailOrPhone,
+		nameOrUsername,
+		allowedCF,
+		{
+			sort: sort || { ts: -1 },
+			skip: offset,
+			limit: count,
+			projection: {
+				username: 1,
+				name: 1,
+				phone: 1,
+				livechatData: 1,
+				visitorEmails: 1,
+				lastChat: 1,
+			},
 		},
-	});
+	);
 
 	const [visitors, total] = await Promise.all([cursor.toArray(), totalCount]);
 

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

@@ -1,6 +1,7 @@
 import { Match, check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
-import { LivechatVisitors } from '@rocket.chat/models';
+import { LivechatCustomField, LivechatVisitors } from '@rocket.chat/models';
+import { escapeRegExp } from '@rocket.chat/string-helpers';
 
 import { API } from '../../../../api/server';
 import { Contacts } from '../../lib/Contacts';
@@ -47,23 +48,36 @@ API.v1.addRoute(
 			check(this.queryParams, {
 				email: Match.Maybe(String),
 				phone: Match.Maybe(String),
+				custom: Match.Maybe(String),
 			});
+			const { email, phone, custom } = this.queryParams;
 
-			const { email, phone } = this.queryParams;
+			let customCF: { [k: string]: string } = {};
+			try {
+				customCF = custom && JSON.parse(custom);
+			} catch (e) {
+				throw new Meteor.Error('error-invalid-params-custom');
+			}
 
-			if (!email && !phone) {
+			if (!email && !phone && !Object.keys(customCF).length) {
 				throw new Meteor.Error('error-invalid-params');
 			}
 
-			const query = Object.assign(
-				{},
-				{
-					...(email && { visitorEmails: { address: email } }),
-					...(phone && { phone: { phoneNumber: phone } }),
-				},
-			);
+			const foundCF = await (async () => {
+				if (!custom) {
+					return {};
+				}
+
+				const cfIds = Object.keys(customCF);
+
+				const customFields = await LivechatCustomField.findMatchingCustomFieldsByIds(Object.keys(cfIds), 'visitor', true, {
+					projection: { _id: 1 },
+				}).toArray();
+
+				return Object.fromEntries(customFields.map(({ _id }) => [`livechatData.${_id}`, new RegExp(escapeRegExp(customCF[_id]), 'i')]));
+			})();
 
-			const contact = await LivechatVisitors.findOne(query);
+			const contact = await LivechatVisitors.findOneByEmailAndPhoneAndCustomField(email, phone, foundCF);
 			return API.v1.success({ contact });
 		},
 	},

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

@@ -24,6 +24,7 @@ Meteor.methods({
 				scope: String,
 				visibility: String,
 				regexp: String,
+				searchable: Boolean,
 			}),
 		);
 

apps/meteor/app/models/server/models/LivechatRooms.js

@@ -33,6 +33,7 @@ export class LivechatRooms extends Base {
 				},
 			},
 		);
+		this.tryEnsureIndex({ 'livechatData.$**': 1 });
 	}
 
 	findOneByIdOrName(_idOrName, options) {

apps/meteor/client/views/omnichannel/customFields/CustomFieldsForm.js

@@ -5,9 +5,9 @@ import React, { useMemo } from 'react';
 const CustomFieldsForm = ({ values = {}, handlers = {}, className }) => {
 	const t = useTranslation();
 
-	const { id, field, label, scope, visibility, regexp } = values;
+	const { id, field, label, scope, visibility, searchable, regexp } = values;
 
-	const { handleField, handleLabel, handleScope, handleVisibility, handleRegexp } = handlers;
+	const { handleField, handleLabel, handleScope, handleVisibility, handleSearchable, handleRegexp } = handlers;
 
 	const scopeOptions = useMemo(
 		() => [
@@ -45,6 +45,14 @@ const CustomFieldsForm = ({ values = {}, handlers = {}, className }) => {
 					</Field.Row>
 				</Box>
 			</Field>
+			<Field className={className}>
+				<Box display='flex' flexDirection='row'>
+					<Field.Label htmlFor='searchable'>{t('Searchable')}</Field.Label>
+					<Field.Row>
+						<ToggleSwitch id='searchable' checked={searchable} onChange={handleSearchable} />
+					</Field.Row>
+				</Box>
+			</Field>
 			<Field className={className}>
 				<Field.Label>{t('Validation')}</Field.Label>
 				<Field.Row>

apps/meteor/client/views/omnichannel/customFields/CustomFieldsRoute.js

@@ -16,7 +16,6 @@ const sortDir = (sortDir) => (sortDir === 'asc' ? 1 : -1);
 const useQuery = ({ text, itemsPerPage, current }, [column, direction]) =>
 	useMemo(
 		() => ({
-			fields: JSON.stringify({ label: 1 }),
 			text,
 			sort: JSON.stringify({ [column]: sortDir(direction) }),
 			...(itemsPerPage && { count: itemsPerPage }),

apps/meteor/client/views/omnichannel/customFields/EditCustomFieldsPage.js

@@ -14,6 +14,7 @@ const getInitialValues = (cf) => ({
 	label: cf.label,
 	scope: cf.scope,
 	visibility: cf.visibility === 'visible',
+	searchable: !!cf.searchable,
 	regexp: cf.regexp,
 });
 

apps/meteor/client/views/omnichannel/customFields/NewCustomFieldsPage.js

@@ -14,6 +14,7 @@ const initialValues = {
 	scope: 'visitor',
 	visibility: true,
 	regexp: '',
+	searchable: true,
 };
 
 const NewCustomFieldsPage = ({ reload }) => {

apps/meteor/packages/rocketchat-i18n/i18n/en.i18n.json

@@ -4128,6 +4128,7 @@
   "Script": "Script",
   "Script_Enabled": "Script Enabled",
   "Search": "Search",
+  "Searchable": "Searchable",
   "Search_Apps": "Search Apps",
   "Search_by_file_name": "Search by file name",
   "Search_by_username": "Search by username",

apps/meteor/packages/rocketchat-i18n/i18n/pt-BR.i18n.json

@@ -3822,6 +3822,7 @@
   "Screen_Share": "Compartilhamento de tela",
   "Script_Enabled": "Script ativado",
   "Search": "Pesquisar",
+  "Searchable": "Pesquisável",
   "Search_Apps": "Pesquisar aplicativos",
   "Search_by_file_name": "Pesquisar por nome de arquivo",
   "Search_by_username": "Pesquisar por nome de usuário",

apps/meteor/server/models/raw/BaseRaw.ts

@@ -159,7 +159,7 @@ export abstract class BaseRaw<T, C extends DefaultFields<T> = undefined> impleme
 
 	find(query?: Filter<T>): FindCursor<ResultFields<T, C>>;
 
-	find<P = T>(query: Filter<T>, options: FindOptions<P extends T ? T : P>): FindCursor<P>;
+	find<P = T>(query: Filter<T>, options?: FindOptions<P extends T ? T : P>): FindCursor<P>;
 
 	find<P>(query: Filter<T> | undefined = {}, options?: FindOptions<P extends T ? T : P>): FindCursor<WithId<P>> | FindCursor<WithId<T>> {
 		const optionsDef = this.doNotMixInclusionAndExclusionFields(options);

apps/meteor/server/models/raw/LivechatCustomField.ts

@@ -17,6 +17,34 @@ export class LivechatCustomFieldRaw extends BaseRaw<ILivechatCustomField> implem
 		return this.find({ scope }, options || {});
 	}
 
+	findMatchingCustomFields(
+		scope: ILivechatCustomField['scope'],
+		searchable = true,
+		options?: FindOptions<ILivechatCustomField>,
+	): FindCursor<ILivechatCustomField> {
+		const query = {
+			scope,
+			searchable,
+		};
+
+		return this.find(query, options);
+	}
+
+	findMatchingCustomFieldsByIds(
+		ids: ILivechatCustomField['_id'][],
+		scope: ILivechatCustomField['scope'],
+		searchable = true,
+		options?: FindOptions<ILivechatCustomField>,
+	): FindCursor<ILivechatCustomField> {
+		const query = {
+			_id: { $in: ids },
+			scope,
+			searchable,
+		};
+
+		return this.find(query, options);
+	}
+
 	async createOrUpdateCustomField(
 		_id: string,
 		field: string,

apps/meteor/server/models/raw/LivechatVisitors.ts

@@ -31,6 +31,7 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 			{ key: { name: 1 }, sparse: true },
 			{ key: { username: 1 } },
 			{ key: { 'contactMananger.username': 1 }, sparse: true },
+			{ key: { 'livechatData.$**': 1 } },
 		];
 	}
 
@@ -158,11 +159,12 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 	/**
 	 * Find visitors by their email or phone or username or name
 	 */
-	findPaginatedVisitorsByEmailOrPhoneOrNameOrUsername(
+	async findPaginatedVisitorsByEmailOrPhoneOrNameOrUsernameOrCustomField(
 		emailOrPhone: string,
 		nameOrUsername: RegExp,
-		options: FindOptions<ILivechatVisitor>,
-	): FindPaginated<FindCursor<ILivechatVisitor>> {
+		allowedCustomFields: string[] = [],
+		options?: FindOptions<ILivechatVisitor>,
+	): Promise<FindPaginated<FindCursor<ILivechatVisitor>>> {
 		const query = {
 			$or: [
 				{
@@ -177,12 +179,35 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 				{
 					username: nameOrUsername,
 				},
+				// nameorusername is a clean regex, so we should be good
+				...allowedCustomFields.map((c: string) => ({ [`livechatData.${c}`]: nameOrUsername })),
 			],
 		};
 
 		return this.findPaginated(query, options);
 	}
 
+	async findOneByEmailAndPhoneAndCustomField(
+		email: string | null | undefined,
+		phone: string | null | undefined,
+		customFields?: { [key: string]: RegExp },
+	): Promise<ILivechatVisitor | null> {
+		const query = Object.assign(
+			{},
+			{
+				...(email && { visitorEmails: { address: email } }),
+				...(phone && { phone: { phoneNumber: phone } }),
+				...customFields,
+			},
+		);
+
+		if (Object.keys(query).length === 0) {
+			return null;
+		}
+
+		return this.findOne(query);
+	}
+
 	async updateLivechatDataByToken(
 		token: string,
 		key: string,

apps/meteor/tests/data/livechat/custom-fields.ts

@@ -0,0 +1,52 @@
+import type { Response } from 'supertest';
+import { ILivechatCustomField } from '@rocket.chat/core-typings';
+import { credentials, request, methodCall, api } from './../api-data';
+
+export const createCustomField = (customField: ILivechatCustomField) => new Promise((resolve, reject) => {
+    request
+        .get(api('livechat/custom-fields/'+customField.label))
+        .set(credentials)
+        .send()
+        .end((err: Error, res:Response) => {
+            if (err) {
+                reject(err);
+            } else {
+                if (res.body.customField != null && res.body.customField != undefined) {
+                    resolve(res.body.customField);
+                }else{
+                    request
+                    .post(methodCall('livechat:saveCustomField'))
+                    .send({
+                        message: JSON.stringify({
+                            method: 'livechat:saveCustomField',
+                            params: [null,customField],
+                            id: 'id',
+                            msg: 'method',
+                        }),
+                    })
+                    .set(credentials)
+                    .end((err: Error, res: Response): void => {
+                        if (err) {
+                            return reject(err);
+                        }
+                        resolve(res.body);
+                    });
+                }
+            }
+    });
+
+});
+
+export const deleteCustomField = (customFieldID: string) => new Promise((resolve, reject) => {
+    request
+        .post(methodCall('livechat:saveCustomField'))
+        .send(customFieldID)
+        .set(credentials)
+        .end((err: Error, res: Response): void => {
+            if (err) {
+                return reject(err);
+            }
+            resolve(res.body);
+        });
+});
+