enhance ws connection, add ws closures

Author: nazabucciarelli

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

@@ -93,6 +93,7 @@ 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`;
@@ -108,6 +109,7 @@ export const createAnAwayAgent = async (): Promise<{
 	return {
 		credentials: createdUserCredentials,
 		user: agent,
+		ws,
 	};
 };
 

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

@@ -175,35 +175,26 @@ export const setUserAway = (overrideCredentials = credentials, config?: IRequest
 export const ddpLogin = (resume: string): Promise<WebSocket> =>
 	new Promise((resolve, reject) => {
 		const ws = new WebSocket('ws://localhost:4000/websocket');
+		const loginId = `login-${Date.now()}-${Math.random()}`;
 
-		ws.onopen = () => {
-			ws.send(
-				JSON.stringify({
-					msg: 'connect',
-					version: '1',
-					support: ['1'],
-				}),
-			);
-		};
-
-		ws.onmessage = (event) => {
+		const handler = (event: MessageEvent) => {
 			const data = JSON.parse(event.data);
 
 			switch (data.msg) {
 				case 'connected':
 					ws.send(
 						JSON.stringify({
 							msg: 'method',
-							id: 'login-1',
+							id: loginId,
 							method: 'login',
 							params: [{ resume }],
 						}),
 					);
 					break;
 
 				case 'result':
-					if (data.id === 'login-1') {
-						// NO cerrar el websocket
+					if (data.id === loginId) {
+						ws.removeEventListener('message', handler);
 						resolve(ws);
 					}
 					break;
@@ -213,17 +204,30 @@ export const ddpLogin = (resume: string): Promise<WebSocket> =>
 					break;
 
 				case 'error':
+					ws.removeEventListener('message', handler);
 					reject(data);
 					break;
 			}
 		};
 
+		ws.addEventListener('message', handler);
+
+		ws.onopen = () => {
+			ws.send(
+				JSON.stringify({
+					msg: 'connect',
+					version: '1',
+					support: ['1'],
+				}),
+			);
+		};
+
 		ws.onerror = reject;
 	});
 
 export const setUserAwayWS = (ws: WebSocket): Promise<void> =>
 	new Promise((resolve, reject) => {
-		const id = 'away-1';
+		const id = `away-${Date.now()}-${Math.random()}`;
 
 		const handler = (event: MessageEvent) => {
 			const data = JSON.parse(event.data);

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

@@ -1547,7 +1547,7 @@ 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 } = await createDepartmentWithAnAwayAgent({
 					allowReceiveForwardOffline: true,
 				});
 
@@ -1582,6 +1582,8 @@ describe('LIVECHAT - rooms', () => {
 						expect(res.body).to.have.property('count');
 					});
 
+				ws.close();
+
 				await Promise.all([
 					deleteDepartment(initialDepartment._id),
 					deleteDepartment(forwardToOfflineDepartment._id),
@@ -1675,7 +1677,7 @@ 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 } = await createDepartmentWithAnAwayAgent({ allowReceiveForwardOffline: true });
 
 				const newVisitor = await createVisitor(initialDepartment._id);
 				const newRoom = await createLivechatRoom(newVisitor.token);
@@ -1698,6 +1700,8 @@ describe('LIVECHAT - rooms', () => {
 				expect(inquiry.status).to.equal('queued');
 				expect(inquiry.department).to.equal(forwardToOfflineDepartment._id);
 
+				ws.close();
+
 				await Promise.all([
 					deleteDepartment(initialDepartment._id),
 					deleteDepartment(forwardToOfflineDepartment._id),
@@ -1714,7 +1718,7 @@ 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 } = await createDepartmentWithAnAwayAgent({ allowReceiveForwardOffline: false });
 
 				const newVisitor = await createVisitor(initialDepartment._id);
 				const newRoom = await createLivechatRoom(newVisitor.token);
@@ -1735,6 +1739,8 @@ describe('LIVECHAT - rooms', () => {
 				expect(res.status).to.equal(400);
 				expect(res.body).to.have.property('error', 'error-no-agents-available-for-service-on-department');
 
+				ws.close();
+
 				await Promise.all([
 					deleteDepartment(initialDepartment._id),
 					deleteDepartment(forwardToOfflineDepartment._id),
@@ -1791,7 +1797,11 @@ 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,
+				} = await createDepartmentWithAnAwayAgent({
 					allowReceiveForwardOffline: true,
 				});
 
@@ -1814,6 +1824,8 @@ describe('LIVECHAT - rooms', () => {
 				expect(roomInfo.servedBy).to.have.property('_id', agent.user._id);
 				expect(roomInfo.departmentId).to.be.equal(forwardToOfflineDepartment._id);
 
+				ws.close();
+
 				await Promise.all([
 					deleteDepartment(initialDepartment._id),
 					deleteDepartment(forwardToOfflineDepartment._id),

apps/meteor/tests/end-to-end/api/livechat/24-routing.ts

@@ -227,6 +227,7 @@ import { IS_EE } from '../../../e2e/config/constants';
 		let testUser3: { user: IUser; credentials: Credentials };
 		let testDepartment: ILivechatDepartment;
 		let visitorEmail: string;
+		const sockets: WebSocket[] = [];
 
 		before(async () => {
 			const user = await createUser();
@@ -280,14 +281,20 @@ import { IS_EE } from '../../../e2e/config/constants';
 				});
 		});
 
-		after(async () =>
-			Promise.all([
+		after(async () => {
+			await Promise.all([
 				deleteUser(testUser.user),
 				deleteUser(testUser2.user),
 				deleteUser(testUser3.user),
 				updateSetting('Livechat_enabled_when_agent_idle', true),
-			]),
-		);
+			]);
+
+			for (const ws of sockets) {
+				if (ws.readyState === WebSocket.OPEN || ws.readyState === WebSocket.CONNECTING) {
+					ws.close();
+				}
+			}
+		});
 
 		it('should route a room to an available agent', async () => {
 			const visitor = await createVisitor(testDepartment._id);
@@ -370,9 +377,11 @@ import { IS_EE } from '../../../e2e/config/constants';
 			await updateSetting('Livechat_enabled_when_agent_idle', false);
 			await setUserStatus(testUser.credentials, UserStatus.AWAY);
 			const ws1 = await ddpLogin(testUser.credentials['X-Auth-Token']);
+			sockets.push(ws1);
 			await setUserAwayWS(ws1);
 			await setUserStatus(testUser3.credentials, UserStatus.AWAY);
 			const ws2 = await ddpLogin(testUser3.credentials['X-Auth-Token']);
+			sockets.push(ws2);
 			await setUserAwayWS(ws2);
 			// Agent is available but should be ignored
 			await switchLivechatStatus('available', testUser.credentials);