From f1d856304a233c857ab13c38c10c89e820cd0407 Mon Sep 17 00:00:00 2001
From: Renato Becker <renato.augusto.becker@gmail.com>
Date: Thu, 19 Mar 2020 18:06:28 -0300
Subject: [PATCH] [IMPROVE] Replace the Department select component by an
 Autocomplete input in Omnichannel UI (#16669)

---
 .../views/app/livechatCurrentChats.html       | 31 ++++++-----
 .../client/views/app/livechatCurrentChats.js  | 46 ++++++++++++----
 .../views/app/tabbar/visitorForward.html      | 32 +++++++----
 .../client/views/app/tabbar/visitorForward.js | 54 +++++++++++++------
 .../imports/server/rest/departments.js        | 16 +++++-
 app/livechat/server/api/lib/departments.js    | 23 ++++++++
 app/models/server/raw/LivechatDepartment.js   | 20 +++++++
 packages/rocketchat-i18n/i18n/en.i18n.json    |  1 +
 packages/rocketchat-i18n/i18n/pt-BR.i18n.json |  1 +
 9 files changed, 174 insertions(+), 50 deletions(-)

diff --git a/app/livechat/client/views/app/livechatCurrentChats.html b/app/livechat/client/views/app/livechatCurrentChats.html
index 9ab5d338a425..c45ad535ab1b 100644
--- a/app/livechat/client/views/app/livechatCurrentChats.html
+++ b/app/livechat/client/views/app/livechatCurrentChats.html
@@ -46,18 +46,25 @@
 								</label>
 							</div>
 							<div class="form-group">
-								<label class="rc-input__label">
-									<div class="rc-input__title">{{_ "Department"}}</div>
-									<div class="rc-select">
-										<select class="rc-select__element" id="department" name="department">
-											<option class="rc-select__option" value="">{{_ "Select_a_department"}}</option>
-											{{#each departments}}
-												<option class="rc-select__option" value="{{_id}}">{{name}}</option>
-											{{/each}}
-										</select>
-										{{> icon block="rc-select__arrow" icon="arrow-down" }}
-									</div>
-								</label>
+								{{> livechatAutocompleteUser
+									onClickTag=onClickTagDepartment
+									list=selectedDepartments
+									onSelect=onSelectDepartments
+									collection='CachedDepartmentList'
+									endpoint='livechat/department.autocomplete'
+									field='name'
+									sort='name'
+									label="Department"
+									placeholder="Enter_a_department_name"
+									name="department"
+									icon="queue"
+									noMatchTemplate="userSearchEmpty"
+									templateItem="popupList_item_channel"
+									template="roomSearch"
+									noMatchTemplate="roomSearchEmpty"
+									modifier=departmentModifier
+									showLabel=true
+								}}
 							</div>
 							<div class="form-group input-daterange">
 								<label class="rc-input__label">
diff --git a/app/livechat/client/views/app/livechatCurrentChats.js b/app/livechat/client/views/app/livechatCurrentChats.js
index 36110f432790..d5e017721360 100644
--- a/app/livechat/client/views/app/livechatCurrentChats.js
+++ b/app/livechat/client/views/app/livechatCurrentChats.js
@@ -84,12 +84,24 @@ Template.livechatCurrentChats.helpers({
 	tagFilters() {
 		return Template.instance().tagFilters.get();
 	},
-	departments() {
-		return Template.instance().departments.get();
-	},
 	tagId() {
 		return this;
 	},
+	departmentModifier() {
+		return (filter, text = '') => {
+			const f = filter.get();
+			return `${ f.length === 0 ? text : text.replace(new RegExp(filter.get(), 'i'), (part) => `<strong>${ part }</strong>`) }`;
+		};
+	},
+	onClickTagDepartment() {
+		return Template.instance().onClickTagDepartment;
+	},
+	selectedDepartments() {
+		return Template.instance().selectedDepartments.get();
+	},
+	onSelectDepartments() {
+		return Template.instance().onSelectDepartments;
+	},
 });
 
 Template.livechatCurrentChats.events({
@@ -302,6 +314,11 @@ Template.livechatCurrentChats.events({
 			filter.agents = [agents[0]];
 		}
 
+		const departments = instance.selectedDepartments.get();
+		if (departments && departments.length > 0) {
+			filter.department = [departments[0]];
+		}
+
 		instance.filter.set(filter);
 		instance.offset.set(0);
 		storeFilters(filter);
@@ -353,7 +370,16 @@ Template.livechatCurrentChats.onCreated(async function() {
 	this.customFilters = new ReactiveVar([]);
 	this.customFields = new ReactiveVar([]);
 	this.tagFilters = new ReactiveVar([]);
-	this.departments = new ReactiveVar([]);
+	this.selectedDepartments = new ReactiveVar([]);
+
+	this.onSelectDepartments = ({ item: department }) => {
+		department.text = department.name;
+		this.selectedDepartments.set([department]);
+	};
+
+	this.onClickTagDepartment = () => {
+		this.selectedDepartments.set([]);
+	};
 
 	const mountArrayQueryParameters = (label, items, index) => items.reduce((acc, item) => {
 		const isTheLastElement = index === items.length - 1;
@@ -368,8 +394,8 @@ Template.livechatCurrentChats.onCreated(async function() {
 		if (status) {
 			url += `&open=${ status === 'opened' }`;
 		}
-		if (department) {
-			url += `&departmentId=${ department }`;
+		if (department && Array.isArray(department) && department.length) {
+			url += `&departmentId=${ department[0]._id }`;
 		}
 		if (from) {
 			dateRange.start = `${ moment(new Date(from)).utc().format('YYYY-MM-DDTHH:mm:ss') }Z`;
@@ -407,6 +433,8 @@ Template.livechatCurrentChats.onCreated(async function() {
 			switch (key) {
 				case 'agents':
 					return this.selectedAgents.set(value);
+				case 'department':
+					return this.selectedDepartments.set(value);
 				case 'from':
 				case 'to':
 					return $(`#${ key }`).datepicker('setDate', new Date(value));
@@ -420,6 +448,7 @@ Template.livechatCurrentChats.onCreated(async function() {
 		removeStoredFilters();
 		$('#form-filters').get(0).reset();
 		this.selectedAgents.set([]);
+		this.selectedDepartments.set([]);
 		this.filter.set({});
 	};
 
@@ -449,16 +478,13 @@ Template.livechatCurrentChats.onCreated(async function() {
 		this.loadRooms(filter, offset);
 	});
 
-	const { departments } = await APIClient.v1.get('livechat/department?sort={"name": 1}');
-	this.departments.set(departments);
-
 	Meteor.call('livechat:getCustomFields', (err, customFields) => {
 		if (customFields) {
 			this.customFields.set(customFields);
 		}
 	});
 
-	setTimeout(this.loadDefaultFilters, 500);
+	this.loadDefaultFilters();
 });
 
 Template.livechatCurrentChats.onRendered(function() {
diff --git a/app/livechat/client/views/app/tabbar/visitorForward.html b/app/livechat/client/views/app/tabbar/visitorForward.html
index edcdd262f136..91831f9f3eba 100644
--- a/app/livechat/client/views/app/tabbar/visitorForward.html
+++ b/app/livechat/client/views/app/tabbar/visitorForward.html
@@ -11,22 +11,34 @@ <h3>{{_ "Forward_chat"}}</h3>
 			<form>
 				{{#if hasDepartments}}
 					<div class="input-line">
-						<label for="forwardDepartment">{{_ "Forward_to_department"}}</label>
-						<div class="rc-select">
-							<select class="rc-select__element" name="forwardDepartment" id="forwardDepartment">
-								<option class="rc-select__option" value="">{{_ "Select_a_department"}}</option>
-								{{#each departments}}
-									<option class="rc-select__option" value="{{_id}}">{{name}}</option>
-								{{/each}}
-							</select>
-							{{> icon block="rc-select__arrow" icon="arrow-down" }}
+						<label for="name">{{_ "Forward_to_department"}}</label>
+						<div class="form-group">
+							{{> livechatAutocompleteUser
+								onClickTag=onClickTagDepartment
+								list=selectedDepartments
+								onSelect=onSelectDepartments
+								collection='CachedDepartmentList'
+								endpoint='livechat/department.autocomplete'
+								field='name'
+								sort='name'
+								icon="queue"
+								label="Enter_a_department_name"
+								placeholder="Enter_a_department_name"
+								name="department"
+								noMatchTemplate="userSearchEmpty"
+								templateItem="popupList_item_channel"
+								template="roomSearch"
+								noMatchTemplate="roomSearchEmpty"
+								modifier=departmentModifier
+								conditions=departmentConditions
+							}}
 						</div>
 					</div>
-
 					<div class="form-divisor">
 						<span>{{_ "or"}}</span>
 					</div>
 				{{/if}}
+
 				<div class="input-line">
 					<label for="agent">{{_ "Forward_to_user"}}</label>
 					<div class="form-group">
diff --git a/app/livechat/client/views/app/tabbar/visitorForward.js b/app/livechat/client/views/app/tabbar/visitorForward.js
index 82af28381019..553072de6660 100644
--- a/app/livechat/client/views/app/tabbar/visitorForward.js
+++ b/app/livechat/client/views/app/tabbar/visitorForward.js
@@ -16,9 +16,6 @@ Template.visitorForward.helpers({
 	hasDepartments() {
 		return Template.instance().departments.get().filter((department) => department.enabled === true).length > 0;
 	},
-	departments() {
-		return Template.instance().departments.get().filter((department) => department.enabled === true);
-	},
 	agentName() {
 		return this.name || this.username;
 	},
@@ -43,6 +40,24 @@ Template.visitorForward.helpers({
 	onClickTagAgent() {
 		return Template.instance().onClickTagAgent;
 	},
+	departmentModifier() {
+		return (filter, text = '') => {
+			const f = filter.get();
+			return `${ f.length === 0 ? text : text.replace(new RegExp(filter.get(), 'i'), (part) => `<strong>${ part }</strong>`) }`;
+		};
+	},
+	onClickTagDepartment() {
+		return Template.instance().onClickTagDepartment;
+	},
+	selectedDepartments() {
+		return Template.instance().selectedDepartments.get();
+	},
+	onSelectDepartments() {
+		return Template.instance().onSelectDepartments;
+	},
+	departmentConditions() {
+		return { enabled: true, numAgents: { $gt: 0 } };
+	},
 });
 
 Template.visitorForward.onCreated(async function() {
@@ -50,9 +65,21 @@ Template.visitorForward.onCreated(async function() {
 	this.room = new ReactiveVar();
 	this.departments = new ReactiveVar([]);
 	this.selectedAgents = new ReactiveVar([]);
+	this.selectedDepartments = new ReactiveVar([]);
+
+	this.onSelectDepartments = ({ item: department }) => {
+		department.text = department.name;
+		this.selectedDepartments.set([department]);
+		this.selectedAgents.set([]);
+	};
+
+	this.onClickTagDepartment = () => {
+		this.selectedDepartments.set([]);
+	};
 
 	this.onSelectAgents = ({ item: agent }) => {
 		this.selectedAgents.set([agent]);
+		this.selectedDepartments.set([]);
 	};
 
 	this.onClickTagAgent = ({ username }) => {
@@ -83,8 +110,13 @@ Template.visitorForward.events({
 		const [user] = instance.selectedAgents.get();
 		if (user) {
 			transferData.userId = user._id;
-		} else if (instance.find('#forwardDepartment').value) {
-			transferData.departmentId = instance.find('#forwardDepartment').value;
+		} else if (instance.selectedDepartments.get()) {
+			const [department] = instance.selectedDepartments.get();
+			transferData.departmentId = department && department._id;
+		}
+
+		if (!transferData.userId && !transferData.departmentId) {
+			return;
 		}
 
 		Meteor.call('livechat:transfer', transferData, (error, result) => {
@@ -100,18 +132,6 @@ Template.visitorForward.events({
 		});
 	},
 
-	'change #forwardDepartment, blur #forwardDepartment'(event, instance) {
-		if (event.currentTarget.value) {
-			instance.find('#forwardUser').value = '';
-		}
-	},
-
-	'change #forwardUser, blur #forwardUser'(event, instance) {
-		if (event.currentTarget.value && instance.find('#forwardDepartment')) {
-			instance.find('#forwardDepartment').value = '';
-		}
-	},
-
 	'click .cancel'(event) {
 		event.preventDefault();
 
diff --git a/app/livechat/imports/server/rest/departments.js b/app/livechat/imports/server/rest/departments.js
index 18fa8bf89121..315fbcb30772 100644
--- a/app/livechat/imports/server/rest/departments.js
+++ b/app/livechat/imports/server/rest/departments.js
@@ -4,7 +4,7 @@ import { API } from '../../../../api';
 import { hasPermission } from '../../../../authorization';
 import { LivechatDepartment, LivechatDepartmentAgents } from '../../../../models';
 import { Livechat } from '../../../server/lib/Livechat';
-import { findDepartments, findDepartmentById } from '../../../server/api/lib/departments';
+import { findDepartments, findDepartmentById, findDepartmentsToAutocomplete } from '../../../server/api/lib/departments';
 
 API.v1.addRoute('livechat/department', { authRequired: true }, {
 	get() {
@@ -133,3 +133,17 @@ API.v1.addRoute('livechat/department/:_id', { authRequired: true }, {
 		}
 	},
 });
+
+API.v1.addRoute('livechat/department.autocomplete', { authRequired: true }, {
+	get() {
+		const { selector } = this.queryParams;
+		if (!selector) {
+			return API.v1.failure('The \'selector\' param is required');
+		}
+
+		return API.v1.success(Promise.await(findDepartmentsToAutocomplete({
+			uid: this.userId,
+			selector: JSON.parse(selector),
+		})));
+	},
+});
diff --git a/app/livechat/server/api/lib/departments.js b/app/livechat/server/api/lib/departments.js
index b404a2e200b0..b9b73947937a 100644
--- a/app/livechat/server/api/lib/departments.js
+++ b/app/livechat/server/api/lib/departments.js
@@ -44,3 +44,26 @@ export async function findDepartmentById({ userId, departmentId, includeAgents =
 
 	return result;
 }
+
+export async function findDepartmentsToAutocomplete({ uid, selector }) {
+	if (!await hasPermissionAsync(uid, 'view-livechat-departments') && !await hasPermissionAsync(uid, 'view-l-room')) {
+		return { items: [] };
+	}
+	const { exceptions = [], conditions = {} } = selector;
+
+	const options = {
+		fields: {
+			_id: 1,
+			name: 1,
+		},
+		limit: 10,
+		sort: {
+			name: 1,
+		},
+	};
+
+	const items = await LivechatDepartment.findByNameRegexWithExceptionsAndConditions(selector.term, exceptions, conditions, options).toArray();
+	return {
+		items,
+	};
+}
diff --git a/app/models/server/raw/LivechatDepartment.js b/app/models/server/raw/LivechatDepartment.js
index 1b103c034442..68ace2e34587 100644
--- a/app/models/server/raw/LivechatDepartment.js
+++ b/app/models/server/raw/LivechatDepartment.js
@@ -1,3 +1,5 @@
+import s from 'underscore.string';
+
 import { BaseRaw } from './BaseRaw';
 
 export class LivechatDepartmentRaw extends BaseRaw {
@@ -5,4 +7,22 @@ export class LivechatDepartmentRaw extends BaseRaw {
 		const query = { _id: { $in: departmentsIds } };
 		return this.find(query, options);
 	}
+
+	findByNameRegexWithExceptionsAndConditions(searchTerm, exceptions = [], conditions = {}, options = {}) {
+		if (!Array.isArray(exceptions)) {
+			exceptions = [exceptions];
+		}
+
+		const nameRegex = new RegExp(`^${ s.escapeRegExp(searchTerm).trim() }`, 'i');
+
+		const query = {
+			name: nameRegex,
+			_id: {
+				$nin: exceptions,
+			},
+			...conditions,
+		};
+
+		return this.find(query, options);
+	}
 }
diff --git a/packages/rocketchat-i18n/i18n/en.i18n.json b/packages/rocketchat-i18n/i18n/en.i18n.json
index 1932dbd50e57..e08e476ce934 100644
--- a/packages/rocketchat-i18n/i18n/en.i18n.json
+++ b/packages/rocketchat-i18n/i18n/en.i18n.json
@@ -1284,6 +1284,7 @@
   "End_OTR": "End OTR",
   "Enter_a_name": "Enter a name",
   "Enter_a_regex": "Enter a regex",
+  "Enter_a_department_name": "Enter a department name",
   "Enter_a_room_name": "Enter a room name",
   "Enter_a_username": "Enter a username",
   "Enter_a_tag": "Enter a tag",
diff --git a/packages/rocketchat-i18n/i18n/pt-BR.i18n.json b/packages/rocketchat-i18n/i18n/pt-BR.i18n.json
index 95d1e3091854..7911dd0ea698 100644
--- a/packages/rocketchat-i18n/i18n/pt-BR.i18n.json
+++ b/packages/rocketchat-i18n/i18n/pt-BR.i18n.json
@@ -1190,6 +1190,7 @@
   "End_OTR": "Finalizar OTR",
   "Enter_a_name": "Insira o nome aqui",
   "Enter_a_regex": "Introduza um regex",
+  "Enter_a_department_name": "Digite um nome de departmento",
   "Enter_a_room_name": "Digite um nome de sala",
   "Enter_a_username": "Nome de usuário",
   "Enter_a_tag": "Insira uma tag",