[NEW]Add new endpoint to change Omnichannel room's visitor (#18528)

* add new endpoint to change room visitor

* Apply suggestions from code review

Co-authored-by: Renato Becker <[email protected]>

* fix errors in previous commit

* modify livechat.config endpoint to support new param - roomId

* Apply suggestions from code review

Co-authored-by: Renato Becker <[email protected]>

* remove changes to livechat-config endpoint

* move permission check into Livechat lib

* refactor code

* Apply suggestions from code review

Co-authored-by: Renato Becker <[email protected]>

* query optimization and fix return value

* return whole room object

* limit room fields from while loading from DB

* Remove unecessary promise statement.

Co-authored-by: Renato Becker <[email protected]>

app/authorization/server/startup.js

@@ -24,6 +24,7 @@ Meteor.startup(function() {
 		{ _id: 'assign-roles',                       roles: ['admin'] },
 		{ _id: 'ban-user',                           roles: ['admin', 'owner', 'moderator'] },
 		{ _id: 'bulk-register-user',                 roles: ['admin'] },
+		{ _id: 'change-livechat-room-visitor',       roles: ['admin', 'livechat-manager', 'livechat-agent'] },
 		{ _id: 'create-c',                           roles: ['admin', 'user', 'bot', 'app'] },
 		{ _id: 'create-d',                           roles: ['admin', 'user', 'bot', 'app'] },
 		{ _id: 'create-p',                           roles: ['admin', 'user', 'bot', 'app'] },

app/livechat/server/api/v1/room.js

@@ -9,6 +9,7 @@ import { API } from '../../../../api/server';
 import { findGuest, findRoom, getRoom, settings, findAgent, onCheckRoomParams } from '../lib/livechat';
 import { Livechat } from '../../lib/Livechat';
 import { normalizeTransferredByData } from '../../lib/Helper';
+import { findVisitorInfo } from '../lib/visitors';
 
 API.v1.addRoute('livechat/room', {
 	get() {
@@ -179,3 +180,38 @@ API.v1.addRoute('livechat/room.forward', { authRequired: true }, {
 		API.v1.success(Meteor.runAsUser(this.userId, () => Meteor.call('livechat:transfer', this.bodyParams)));
 	},
 });
+
+API.v1.addRoute('livechat/room.visitor', { authRequired: true }, {
+	put() {
+		try {
+			check(this.bodyParams, {
+				rid: String,
+				oldVisitorId: String,
+				newVisitorId: String,
+			});
+
+			const { rid, newVisitorId, oldVisitorId } = this.bodyParams;
+
+			const { visitor } = Promise.await(findVisitorInfo({ userId: this.userId, visitorId: newVisitorId }));
+			if (!visitor) {
+				throw new Meteor.Error('invalid-visitor');
+			}
+
+			let room = LivechatRooms.findOneById(rid, { _id: 1 });
+			if (!room) {
+				throw new Meteor.Error('invalid-room');
+			}
+
+			const { v: { _id: roomVisitorId } = {} } = room;
+			if (roomVisitorId !== oldVisitorId) {
+				throw new Meteor.Error('invalid-room-visitor');
+			}
+
+			room = Livechat.changeRoomVisitor(this.userId, rid, visitor);
+
+			return API.v1.success({ room });
+		} catch (e) {
+			return API.v1.failure(e);
+		}
+	},
+});

app/livechat/server/lib/Livechat.js

@@ -29,7 +29,7 @@ import {
 	LivechatInquiry,
 } from '../../../models';
 import { Logger } from '../../../logger';
-import { addUserRoles, hasPermission, hasRole, removeUserFromRoles } from '../../../authorization';
+import { addUserRoles, hasPermission, hasRole, removeUserFromRoles, canAccessRoom } from '../../../authorization';
 import * as Mailer from '../../../mailer';
 import { sendMessage } from '../../../lib/server/functions/sendMessage';
 import { updateMessage } from '../../../lib/server/functions/updateMessage';
@@ -1119,6 +1119,39 @@ export const Livechat = {
 
 		return Promise.await(businessHourManager.allowAgentChangeServiceStatus(agentId));
 	},
+
+	notifyRoomVisitorChange(roomId, visitor) {
+		Livechat.stream.emit(roomId, {
+			type: 'visitorData',
+			visitor,
+		});
+	},
+
+	changeRoomVisitor(userId, roomId, visitor) {
+		const user = Promise.await(Users.findOneById(userId));
+		if (!user) {
+			throw new Error('error-user-not-found');
+		}
+
+		if (!hasPermission(userId, 'change-livechat-room-visitor')) {
+			throw new Error('error-not-authorized');
+		}
+
+		const room = Promise.await(LivechatRooms.findOneById(roomId, { _id: 1, t: 1 }));
+		if (!room) {
+			throw new Meteor.Error('invalid-room');
+		}
+
+		if (!canAccessRoom(room, user)) {
+			throw new Error('error-not-allowed');
+		}
+
+		LivechatRooms.changeVisitorByRoomId(room._id, visitor);
+
+		Livechat.notifyRoomVisitorChange(room._id, visitor);
+
+		return LivechatRooms.findOneById(roomId);
+	},
 };
 
 Livechat.stream = new Meteor.Streamer('livechat-room');

app/models/server/models/LivechatRooms.js

@@ -651,6 +651,22 @@ export class LivechatRooms extends Base {
 
 		return this.update(query, update);
 	}
+
+	changeVisitorByRoomId(roomId, { _id, username, token }) {
+		const query = {
+			_id: roomId,
+			t: 'l',
+		};
+		const update = {
+			$set: {
+				'v._id': _id,
+				'v.username': username,
+				'v.token': token,
+			},
+		};
+
+		return this.update(query, update);
+	}
 }
 
 export default new LivechatRooms(Rooms.model, true);