feat: update Livechat_enabled_when_agent_idle setting to not include offline agents in the query

.changeset/purple-boxes-shout.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/models': minor
+'@rocket.chat/meteor': minor
+---
+
+Updates the behavior of the `Livechat_enabled_when_agent_idle` setting. When enabled, the routing query now excludes `offline` agents, ensuring no new conversations are assigned to them.

.github/workflows/ci-test-e2e.yml

@@ -65,6 +65,7 @@ env:
   TOOL_NODE_FLAGS: ${{ vars.TOOL_NODE_FLAGS }}
   LOWERCASE_REPOSITORY: ${{ inputs.lowercase-repo }}
   DOCKER_TAG: ${{ inputs.gh-docker-tag }}-amd64
+  DDP_LOGIN_PORT: 3000
 
 jobs:
   test:

apps/meteor/tests/data/livechat/department.ts

@@ -175,8 +175,9 @@ export const createDepartmentWithAnAwayAgent = async ({
 		credentials: Credentials;
 		user: WithRequiredProperty<IUser, 'username'>;
 	};
+	ws: WebSocket;
 }> => {
-	const { user, credentials } = await createAnAwayAgent();
+	const { user, credentials, ws } = await createAnAwayAgent();
 
 	const department = (await createDepartment({
 		allowReceiveForwardOffline,
@@ -192,6 +193,7 @@ export const createDepartmentWithAnAwayAgent = async ({
 			credentials,
 			user,
 		},
+		ws,
 	};
 };
 

apps/meteor/tests/data/livechat/users.ts

@@ -5,7 +5,7 @@ import { Random } from '@rocket.chat/random';
 
 import { api, credentials, request } from '../api-data';
 import { password } from '../user';
-import { createUser, login, setUserAway, setUserStatus } from '../users.helper';
+import { createUser, login, setUserAwayWS, ddpLogin, setUserStatus } from '../users.helper';
 import { createAgent, makeAgentAvailable, makeAgentUnavailable } from './rooms';
 
 export const createBotAgent = async (): Promise<{
@@ -93,20 +93,23 @@ export const createAnOfflineAgent = async (): Promise<{
 export const createAnAwayAgent = async (): Promise<{
 	credentials: Credentials;
 	user: IUser & { username: string };
+	ws: WebSocket;
 }> => {
 	const username = `user.test.${Date.now()}.away`;
 	const email = `${username}.offline@rocket.chat`;
 	const { body } = await request.post(api('users.create')).set(credentials).send({ email, name: username, username, password });
 	const agent = body.user;
 	const createdUserCredentials = await login(agent.username, password);
+	const ws = await ddpLogin(createdUserCredentials['X-Auth-Token']);
 	await createAgent(agent.username);
 	await makeAgentAvailable(createdUserCredentials);
 	await setUserStatus(createdUserCredentials, UserStatus.AWAY);
-	await setUserAway(createdUserCredentials);
+	await setUserAwayWS(ws);
 
 	return {
 		credentials: createdUserCredentials,
 		user: agent,
+		ws,
 	};
 };
 

apps/meteor/tests/data/users.helper.ts

@@ -172,6 +172,92 @@ export const setUserAway = (overrideCredentials = credentials, config?: IRequest
 		});
 };
 
+const connectWS = (port: string): Promise<WebSocket> =>
+	new Promise((resolve, reject) => {
+		const ws = new WebSocket(`ws://localhost:${port}/websocket`);
+
+		ws.onopen = () => {
+			ws.addEventListener('message', (event: MessageEvent) => {
+				const data = JSON.parse(event.data);
+				if (data.msg === 'ping') {
+					ws.send(JSON.stringify({ msg: 'pong' }));
+				}
+			});
+			resolve(ws);
+		};
+		ws.onerror = () => reject(new Error(`WS connection failed on ${port}`));
+	});
+
+const waitForDDP = (ws: WebSocket, id: string | 'handshake', stringifiedJsonPayload: string): Promise<any> => {
+	return new Promise((resolve, reject) => {
+		const timeout = setTimeout(() => {
+			cleanup();
+			ws.close();
+			reject(new Error(`Timeout waiting for DDP id: ${id}`));
+		}, 5000);
+
+		const cleanup = () => {
+			clearTimeout(timeout);
+			ws.removeEventListener('message', handler);
+			ws.removeEventListener('close', onClose);
+			ws.removeEventListener('error', onError);
+		};
+
+		const onClose = () => {
+			cleanup();
+			reject(new Error(`WS closed while waiting for id: ${id}`));
+		};
+
+		const onError = (error: any) => {
+			cleanup();
+			ws.close();
+			reject(error || new Error(`WS error during operation id: ${id}`));
+		};
+
+		const handler = (event: MessageEvent) => {
+			try {
+				const data = JSON.parse(event.data);
+				const isHandshake = id === 'handshake' && data.msg === 'connected';
+				const isResult = data.id === id && (data.msg === 'result' || data.msg === 'error');
+
+				if (isHandshake || isResult) {
+					cleanup();
+					if (data.error) {
+						ws.close();
+						return reject(data.error);
+					}
+					resolve(data);
+				}
+			} catch (e) {
+				// Ignore no JSON message
+			}
+		};
+
+		ws.addEventListener('message', handler);
+		ws.addEventListener('close', onClose);
+		ws.addEventListener('error', onError);
+
+		ws.send(stringifiedJsonPayload);
+	});
+};
+
+export const ddpLogin = async (resume: string): Promise<WebSocket> => {
+	const ws = await connectWS(process.env.DDP_LOGIN_PORT || '3000');
+	const loginId = `login-${Date.now()}`;
+
+	await waitForDDP(ws, 'handshake', JSON.stringify({ msg: 'connect', version: '1', support: ['1'] }));
+
+	await waitForDDP(ws, loginId, JSON.stringify({ msg: 'method', id: loginId, method: 'login', params: [{ resume }] }));
+
+	return ws;
+};
+
+export const setUserAwayWS = async (ws: WebSocket): Promise<void> => {
+	const id = `away-${Date.now()}`;
+
+	await waitForDDP(ws, id, JSON.stringify({ msg: 'method', method: 'UserPresence:away', params: [], id }));
+};
+
 export const setUserOnline = (overrideCredentials = credentials, config?: IRequestConfig) => {
 	const requestInstance = config?.request || request;
 	return requestInstance

apps/meteor/tests/e2e/omnichannel/omnichannel-assign-room-tags.spec.ts

@@ -1,3 +1,4 @@
+import { ddpLogin } from '../../data/users.helper';
 import { createFakeVisitor } from '../../mocks/data';
 import { IS_EE } from '../config/constants';
 import { Users } from '../fixtures/userStates';
@@ -26,6 +27,7 @@ test.describe('OC - Tags Visibility', () => {
 	let tagB: Awaited<ReturnType<typeof createTag>>;
 	let globalTag: Awaited<ReturnType<typeof createTag>>;
 	let sharedTag: Awaited<ReturnType<typeof createTag>>;
+	let ws: WebSocket;
 
 	test.beforeAll('Create departments', async ({ api }) => {
 		expect((await setSettingValueById(api, 'Omnichannel_enable_department_removal', true)).status()).toBe(200);
@@ -35,6 +37,7 @@ test.describe('OC - Tags Visibility', () => {
 
 	test.beforeAll('Create agent', async ({ api }) => {
 		agent = await createAgent(api, 'user1');
+		ws = await ddpLogin(Users.user1.data.loginToken);
 	});
 
 	test.beforeAll('Add agents to departments', async ({ api }) => {
@@ -71,6 +74,7 @@ test.describe('OC - Tags Visibility', () => {
 		await agent.delete();
 		await departmentA.delete();
 		await departmentB.delete();
+		ws.close();
 		expect((await setSettingValueById(api, 'Omnichannel_enable_department_removal', false)).status()).toBe(200);
 	});
 

apps/meteor/tests/e2e/omnichannel/omnichannel-custom-field-usage.spec.ts

@@ -1,5 +1,6 @@
 import { faker } from '@faker-js/faker';
 
+import { ddpLogin } from '../../data/users.helper';
 import { createFakeVisitor } from '../../mocks/data';
 import { Users } from '../fixtures/userStates';
 import { HomeOmnichannel } from '../page-objects';
@@ -30,9 +31,14 @@ test.describe.serial('OC - Custom fields usage, scope : room and visitor', () =>
 	let conversation: Awaited<ReturnType<typeof createConversation>>;
 	let roomCustomField: Awaited<ReturnType<typeof createCustomField>>;
 	let visitorCustomField: Awaited<ReturnType<typeof createCustomField>>;
+	let ws: WebSocket;
 
 	test.beforeAll('Set up agent, manager and custom fields', async ({ api }) => {
-		[agent, manager] = await Promise.all([createAgent(api, 'user1'), createManager(api, 'user1')]);
+		[agent, manager, ws] = await Promise.all([
+			createAgent(api, 'user1'),
+			createManager(api, 'user1'),
+			ddpLogin(Users.user1.data.loginToken),
+		]);
 
 		[roomCustomField, visitorCustomField, conversation] = await Promise.all([
 			createCustomField(api, {
@@ -67,6 +73,7 @@ test.describe.serial('OC - Custom fields usage, scope : room and visitor', () =>
 
 	test.afterAll('Remove agent, manager, custom fields and conversation', async () => {
 		await Promise.all([agent.delete(), manager.delete(), roomCustomField.delete(), visitorCustomField.delete(), conversation.delete()]);
+		ws?.close();
 	});
 
 	test('Should be allowed to set room custom field for a conversation', async () => {

apps/meteor/tests/e2e/omnichannel/omnichannel-livechat.spec.ts

@@ -1,5 +1,6 @@
 import type { Page } from 'playwright-core';
 
+import { ddpLogin } from '../../data/users.helper';
 import { createFakeVisitor } from '../../mocks/data';
 import { createAuxContext } from '../fixtures/createAuxContext';
 import { Users } from '../fixtures/userStates';
@@ -264,9 +265,11 @@ test.describe('OC - Livechat - Resume chat after closing', () => {
 test.describe('OC - Livechat - Close chat using widget', () => {
 	let poLiveChat: OmnichannelLiveChat;
 	let agent: Awaited<ReturnType<typeof createAgent>>;
+	let ws: WebSocket;
 
 	test.beforeAll(async ({ api }) => {
 		agent = await createAgent(api, 'user1');
+		ws = await ddpLogin(Users.user1.data.loginToken);
 	});
 
 	test.beforeEach(async ({ page, api }) => {
@@ -277,6 +280,7 @@ test.describe('OC - Livechat - Close chat using widget', () => {
 
 	test.afterAll(async () => {
 		await agent.delete();
+		ws.close();
 	});
 
 	test('OC - Livechat - Close Chat', async () => {

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

@@ -84,6 +84,7 @@ describe('LIVECHAT - rooms', () => {
 	let visitor: ILivechatVisitor;
 	let room: IOmnichannelRoom;
 	let appId: string;
+	const sockets: WebSocket[] = [];
 
 	before((done) => getCredentials(done));
 
@@ -129,6 +130,11 @@ describe('LIVECHAT - rooms', () => {
 				.set(credentials)
 				.expect(200);
 		}
+		for (const ws of sockets) {
+			if (ws.readyState === WebSocket.OPEN || ws.readyState === WebSocket.CONNECTING) {
+				ws.close();
+			}
+		}
 	});
 
 	describe('livechat/room', () => {
@@ -1547,9 +1553,10 @@ describe('LIVECHAT - rooms', () => {
 				await updateSetting('Livechat_Routing_Method', 'Manual_Selection');
 				await updateSetting('Livechat_enabled_when_agent_idle', false);
 				const { department: initialDepartment } = await createDepartmentWithAnOnlineAgent();
-				const { department: forwardToOfflineDepartment } = await createDepartmentWithAnAwayAgent({
+				const { department: forwardToOfflineDepartment, ws: awayAgentWebSocket } = await createDepartmentWithAnAwayAgent({
 					allowReceiveForwardOffline: true,
 				});
+				sockets.push(awayAgentWebSocket);
 
 				const newVisitor = await createVisitor(initialDepartment._id);
 				const newRoom = await createLivechatRoom(newVisitor.token);
@@ -1675,7 +1682,10 @@ describe('LIVECHAT - rooms', () => {
 			async () => {
 				await updateSetting('Livechat_Routing_Method', 'Auto_Selection');
 				const { department: initialDepartment } = await createDepartmentWithAnOnlineAgent();
-				const { department: forwardToOfflineDepartment } = await createDepartmentWithAnAwayAgent({ allowReceiveForwardOffline: true });
+				const { department: forwardToOfflineDepartment, ws: awayAgentWebSocket } = await createDepartmentWithAnAwayAgent({
+					allowReceiveForwardOffline: true,
+				});
+				sockets.push(awayAgentWebSocket);
 
 				const newVisitor = await createVisitor(initialDepartment._id);
 				const newRoom = await createLivechatRoom(newVisitor.token);
@@ -1714,7 +1724,10 @@ describe('LIVECHAT - rooms', () => {
 			async () => {
 				await updateSetting('Livechat_Routing_Method', 'Auto_Selection');
 				const { department: initialDepartment } = await createDepartmentWithAnOnlineAgent();
-				const { department: forwardToOfflineDepartment } = await createDepartmentWithAnAwayAgent({ allowReceiveForwardOffline: false });
+				const { department: forwardToOfflineDepartment, ws: awayAgentWebSocket } = await createDepartmentWithAnAwayAgent({
+					allowReceiveForwardOffline: false,
+				});
+				sockets.push(awayAgentWebSocket);
 
 				const newVisitor = await createVisitor(initialDepartment._id);
 				const newRoom = await createLivechatRoom(newVisitor.token);
@@ -1791,10 +1804,14 @@ describe('LIVECHAT - rooms', () => {
 				await updateSetting('Livechat_Routing_Method', 'Auto_Selection');
 				await updateSetting('Livechat_enabled_when_agent_idle', true);
 				const { department: initialDepartment } = await createDepartmentWithAnOnlineAgent();
-				const { department: forwardToOfflineDepartment, agent } = await createDepartmentWithAnAwayAgent({
+				const {
+					department: forwardToOfflineDepartment,
+					agent,
+					ws: awayAgentWebSocket,
+				} = await createDepartmentWithAnAwayAgent({
 					allowReceiveForwardOffline: true,
 				});
-
+				sockets.push(awayAgentWebSocket);
 				const newVisitor = await createVisitor(initialDepartment._id);
 				const newRoom = await createLivechatRoom(newVisitor.token);
 
@@ -1810,7 +1827,6 @@ describe('LIVECHAT - rooms', () => {
 				});
 
 				const roomInfo = await getLivechatRoomInfo(newRoom._id);
-
 				expect(roomInfo.servedBy).to.have.property('_id', agent.user._id);
 				expect(roomInfo.departmentId).to.be.equal(forwardToOfflineDepartment._id);