Chore: Add tests for omni-jobs & add more context in system messages for jobs

apps/meteor/app/livechat/lib/messageTypes.ts

@@ -48,8 +48,9 @@ MessageTypes.registerType({
 					...(comment && { comment }),
 				}),
 			queue: (): string =>
-				TAPi18n.__('Livechat_transfer_return_to_the_queue', {
+				TAPi18n.__(`Livechat_transfer_return_to_the_queue${commentLabel}`, {
 					from,
+					...(comment && { comment }),
 				}),
 		};
 		return {

apps/meteor/app/livechat/server/lib/Livechat.js

@@ -750,7 +750,7 @@ export const Livechat = {
 		return RoutingManager.transferRoom(room, guest, transferData);
 	},
 
-	returnRoomAsInquiry(rid, departmentId) {
+	returnRoomAsInquiry(rid, departmentId, comment = '') {
 		Livechat.logger.debug(`Transfering room ${rid} to ${departmentId ? 'department' : ''} queue`);
 		const room = LivechatRooms.findOneById(rid);
 		if (!room) {
@@ -790,7 +790,7 @@ export const Livechat = {
 
 		const transferredBy = normalizeTransferredByData(user, room);
 		Livechat.logger.debug(`Transfering room ${room._id} by user ${transferredBy._id}`);
-		const transferData = { roomId: rid, scope: 'queue', departmentId, transferredBy };
+		const transferData = { roomId: rid, scope: 'queue', departmentId, transferredBy, ...(comment && { comment }) };
 		try {
 			this.saveTransferHistory(room, transferData);
 			RoutingManager.unassignAgent(inquiry, departmentId);

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

@@ -832,45 +832,6 @@ export class LivechatRooms extends Base {
 		return this.update(query, update);
 	}
 
-	setAutoTransferredAtById(roomId) {
-		const query = {
-			_id: roomId,
-		};
-		const update = {
-			$set: {
-				autoTransferredAt: new Date(),
-			},
-		};
-
-		return this.update(query, update);
-	}
-
-	setAutoTransferOngoingById(roomId) {
-		const query = {
-			_id: roomId,
-		};
-		const update = {
-			$set: {
-				autoTransferOngoing: true,
-			},
-		};
-
-		return this.update(query, update);
-	}
-
-	unsetAutoTransferOngoingById(roomId) {
-		const query = {
-			_id: roomId,
-		};
-		const update = {
-			$unset: {
-				autoTransferOngoing: 1,
-			},
-		};
-
-		return this.update(query, update);
-	}
-
 	changeVisitorByRoomId(roomId, { _id, username, token }) {
 		const query = {
 			_id: roomId,

apps/meteor/client/sidebar/sections/actions/OmnichannelLivechatToggle.tsx

@@ -21,6 +21,7 @@ export const OmnichannelLivechatToggle = (): ReactElement => {
 
 	return (
 		<Sidebar.TopBar.Action
+			id={'omnichannel-status-toggle'}
 			data-tooltip={agentAvailable ? t('Turn_off_answer_chats') : t('Turn_on_answer_chats')}
 			color={agentAvailable ? 'success' : undefined}
 			icon={agentAvailable ? 'message' : 'message-disabled'}

apps/meteor/ee/app/livechat-enterprise/server/hooks/afterOnHold.ts

@@ -5,10 +5,7 @@ import { settings } from '../../../../../app/settings/server';
 import { AutoCloseOnHoldScheduler } from '../lib/AutoCloseOnHoldScheduler';
 import { cbLogger } from '../lib/logger';
 
-const DEFAULT_CLOSED_MESSAGE = TAPi18n.__('Closed_automatically');
-
 let autoCloseOnHoldChatTimeout = 0;
-let customCloseMessage = DEFAULT_CLOSED_MESSAGE;
 
 const handleAfterOnHold = async (room: any = {}): Promise<any> => {
 	const { _id: rid } = room;
@@ -23,7 +20,12 @@ const handleAfterOnHold = async (room: any = {}): Promise<any> => {
 	}
 
 	cbLogger.debug(`Scheduling room ${rid} to be closed in ${autoCloseOnHoldChatTimeout} seconds`);
-	await AutoCloseOnHoldScheduler.scheduleRoom(room._id, autoCloseOnHoldChatTimeout, customCloseMessage);
+	const closeComment =
+		settings.get<string>('Livechat_auto_close_on_hold_chats_custom_message') ||
+		TAPi18n.__('Closed_automatically_because_chat_was_onhold_for_seconds', {
+			onHoldTime: autoCloseOnHoldChatTimeout,
+		});
+	await AutoCloseOnHoldScheduler.scheduleRoom(room._id, autoCloseOnHoldChatTimeout, closeComment);
 };
 
 settings.watch('Livechat_auto_close_on_hold_chats_timeout', (value) => {
@@ -33,7 +35,3 @@ settings.watch('Livechat_auto_close_on_hold_chats_timeout', (value) => {
 	}
 	callbacks.add('livechat:afterOnHold', handleAfterOnHold, callbacks.priority.HIGH, 'livechat-auto-close-on-hold');
 });
-
-settings.watch('Livechat_auto_close_on_hold_chats_custom_message', (value) => {
-	customCloseMessage = (value as string) || DEFAULT_CLOSED_MESSAGE;
-});

apps/meteor/ee/app/livechat-enterprise/server/lib/AutoCloseOnHoldScheduler.ts

@@ -2,16 +2,18 @@ import { Agenda } from '@rocket.chat/agenda';
 import { MongoInternals } from 'meteor/mongo';
 import { Meteor } from 'meteor/meteor';
 import moment from 'moment';
+import { LivechatRooms, Users } from '@rocket.chat/models';
+import type { IUser } from '@rocket.chat/core-typings';
 
 import { Livechat } from '../../../../../app/livechat/server';
-import { LivechatRooms, Users } from '../../../../../app/models/server';
 
-const schedulerUser = Users.findOneById('rocket.cat');
 const SCHEDULER_NAME = 'omnichannel_auto_close_on_hold_scheduler';
 
 class AutoCloseOnHoldSchedulerClass {
 	scheduler: Agenda;
 
+	schedulerUser: IUser;
+
 	running: boolean;
 
 	public init(): void {
@@ -48,15 +50,27 @@ class AutoCloseOnHoldSchedulerClass {
 		const { roomId, comment } = data;
 
 		const payload = {
-			user: schedulerUser,
-			room: LivechatRooms.findOneById(roomId),
+			user: await this.getSchedulerUser(),
+			room: await LivechatRooms.findOneById(roomId),
 			comment,
 			options: {},
 			visitor: undefined,
 		};
 
 		Livechat.closeRoom(payload);
 	}
+
+	private async getSchedulerUser(): Promise<IUser> {
+		if (!this.schedulerUser) {
+			const schedulerUser = await Users.findOneById('rocket.cat');
+			if (!schedulerUser) {
+				throw new Error('Scheduler user not found');
+			}
+			this.schedulerUser = schedulerUser;
+		}
+
+		return this.schedulerUser;
+	}
 }
 
 export const AutoCloseOnHoldScheduler = new AutoCloseOnHoldSchedulerClass();

apps/meteor/ee/app/livechat-enterprise/server/lib/AutoTransferChatScheduler.ts

@@ -1,12 +1,15 @@
 import { Agenda } from '@rocket.chat/agenda';
 import { MongoInternals } from 'meteor/mongo';
 import { Meteor } from 'meteor/meteor';
+import { LivechatRooms } from '@rocket.chat/models';
 import type { IUser } from '@rocket.chat/core-typings';
+import { TAPi18n } from 'meteor/rocketchat:tap-i18n';
 
-import { LivechatRooms, Users } from '../../../../../app/models/server';
+import { Users } from '../../../../../app/models/server';
 import { Livechat } from '../../../../../app/livechat/server';
 import { RoutingManager } from '../../../../../app/livechat/server/lib/RoutingManager';
 import { forwardRoomToAgent } from '../../../../../app/livechat/server/lib/Helper';
+import { settings } from '../../../../../app/settings/server';
 
 const schedulerUser = Users.findOneById('rocket.cat');
 const SCHEDULER_NAME = 'omnichannel_scheduler';
@@ -53,7 +56,7 @@ class AutoTransferChatSchedulerClass {
 	}
 
 	private async transferRoom(roomId: string): Promise<boolean> {
-		const room = LivechatRooms.findOneById(roomId, {
+		const room = await LivechatRooms.findOneById(roomId, {
 			_id: 1,
 			v: 1,
 			servedBy: 1,
@@ -69,8 +72,12 @@ class AutoTransferChatSchedulerClass {
 			servedBy: { _id: ignoreAgentId },
 		} = room;
 
+		const comment = TAPi18n.__('Livechat_auto_transfer_unanswered_chats_comment', {
+			duration: settings.get('Livechat_auto_transfer_chat_timeout'),
+		});
+
 		if (!RoutingManager.getConfig().autoAssignAgent) {
-			return Livechat.returnRoomAsInquiry(room._id, departmentId);
+			return Livechat.returnRoomAsInquiry(room._id, departmentId, comment);
 		}
 
 		const agent = await RoutingManager.getNextAgent(departmentId, ignoreAgentId);
@@ -79,6 +86,7 @@ class AutoTransferChatSchedulerClass {
 				userId: agent.agentId,
 				transferredBy: schedulerUser,
 				transferredTo: agent,
+				comment,
 			});
 		}
 
@@ -89,7 +97,7 @@ class AutoTransferChatSchedulerClass {
 		const { roomId } = data;
 
 		if (await this.transferRoom(roomId)) {
-			LivechatRooms.setAutoTransferredAtById(roomId);
+			await LivechatRooms.setAutoTransferredAtById(roomId);
 		}
 
 		await this.unscheduleRoom(roomId);

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

@@ -983,6 +983,7 @@
   "Closed": "Closed",
   "Closed_At": "Closed at",
   "Closed_automatically": "Closed automatically by the system",
+  "Closed_automatically_because_chat_was_onhold_for_seconds": "Closed automatically because chat was On Hold for __onHoldTime__ seconds",
   "Closed_automatically_chat_queued_too_long": "Closed automatically by the system (queue maximum time exceeded)",
   "Closed_by_visitor": "Closed by visitor",
   "Closing_chat": "Closing chat",
@@ -2919,6 +2920,7 @@
   "Omnichannel_quick_actions": "Omnichannel Quick Actions",
   "Livechat_online": "Omnichannel on-line",
   "Omnichannel_placed_chat_on_hold": "Chat On Hold: __comment__",
+  "Livechat_auto_transfer_unanswered_chats_comment": "Chat auto transferred since it was unanswered for __duration__ seconds",
   "Livechat_Queue": "Omnichannel Queue",
   "Livechat_registration_form": "Registration Form",
   "Livechat_registration_form_message": "Registration Form Message",
@@ -2933,6 +2935,7 @@
   "Livechat_transcript_request_has_been_canceled": "The chat transcription request has been canceled.",
   "Livechat_transcript_sent": "Omnichannel transcript sent",
   "Livechat_transfer_return_to_the_queue": "__from__ returned the chat to the queue",
+  "Livechat_transfer_return_to_the_queue_with_a_comment": "__from__ returned the chat to the queue with a comment: __comment__",
   "Livechat_transfer_to_agent": "__from__ transferred the chat to __to__",
   "Livechat_transfer_to_agent_with_a_comment": "__from__ transferred the chat to __to__ with a comment: __comment__",
   "Livechat_transfer_to_department": "__from__ transferred the chat to the department __to__",

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

@@ -1190,10 +1190,49 @@ export class LivechatRoomsRaw extends BaseRaw {
 	}
 
 	setDepartmentByRoomId(roomId, departmentId) {
-		return this.update({ _id: roomId }, { $set: { departmentId } });
+		return this.updateOne({ _id: roomId }, { $set: { departmentId } });
 	}
 
 	findOpen() {
 		return this.find({ t: 'l', open: true });
 	}
+
+	setAutoTransferOngoingById(roomId) {
+		const query = {
+			_id: roomId,
+		};
+		const update = {
+			$set: {
+				autoTransferOngoing: true,
+			},
+		};
+
+		return this.updateOne(query, update);
+	}
+
+	unsetAutoTransferOngoingById(roomId) {
+		const query = {
+			_id: roomId,
+		};
+		const update = {
+			$unset: {
+				autoTransferOngoing: 1,
+			},
+		};
+
+		return this.updateOne(query, update);
+	}
+
+	setAutoTransferredAtById(roomId) {
+		const query = {
+			_id: roomId,
+		};
+		const update = {
+			$set: {
+				autoTransferredAt: new Date(),
+			},
+		};
+
+		return this.updateOne(query, update);
+	}
 }