import type { Credentials } from '@rocket.chat/api-client'; import type { IOmnichannelRoom, IUser } from '@rocket.chat/core-typings'; import { expect } from 'chai'; import { after, before, describe, it } from 'mocha'; import { getCredentials, api, request, credentials } from '../../../data/api-data'; import { createVisitor, createLivechatRoom, sendMessage, sendAgentMessage, placeRoomOnHold, getLivechatRoomInfo, startANewLivechatRoomAndTakeIt, makeAgentAvailable, createAgent, closeOmnichannelRoom, fetchMessages, } from '../../../data/livechat/rooms'; import { sleep } from '../../../data/livechat/utils'; import { updateEESetting, updatePermission, updateSetting } from '../../../data/permissions.helper'; import { password } from '../../../data/user'; import { createUser, deleteUser, login } from '../../../data/users.helper'; import { IS_EE } from '../../../e2e/config/constants'; (IS_EE ? describe : describe.skip)('[EE] LIVECHAT - rooms', () => { before((done) => getCredentials(done)); let agent2: { user: IUser; credentials: Credentials }; before(async () => { await updateSetting('Livechat_enabled', true); await updateSetting('Livechat_Routing_Method', 'Manual_Selection'); await updateEESetting('Livechat_Require_Contact_Verification', 'never'); await createAgent(); await makeAgentAvailable(); }); before(async () => { const user = await createUser(); const userCredentials = await login(user.username, password); await createAgent(user.username); await updateSetting('Livechat_allow_manual_on_hold', true); agent2 = { user, credentials: userCredentials, }; }); after(async () => { await deleteUser(agent2.user); await updateSetting('Livechat_allow_manual_on_hold', false); await updateSetting('Livechat_allow_manual_on_hold_upon_agent_engagement_only', true); }); describe('livechat/room.onHold', () => { it('should fail if user doesnt have on-hold-livechat-room permission', async () => { await updatePermission('on-hold-livechat-room', []); const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: 'invalid-room-id', }) .expect(403); expect(response.body.success).to.be.false; await updatePermission('on-hold-livechat-room', ['livechat-manager', 'livechat-monitor', 'livechat-agent', 'admin']); }); it('should fail if roomId is invalid', async () => { const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: 'invalid-room-id', }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-invalid-room'); }); it('should fail if room is an empty string', async () => { const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: ' ', }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-invalid-room'); }); it('should fail if room is not a livechat room', async () => { const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: 'GENERAL', }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-invalid-room'); }); it('should fail if visitor is awaiting response (visitor sent last message)', async () => { const visitor = await createVisitor(); const room = await createLivechatRoom(visitor.token); await sendMessage(room._id, 'test', visitor.token); const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: room._id, }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-cannot-place-chat-on-hold'); }); it('should fail if room is closed', async () => { const visitor = await createVisitor(); const room = await createLivechatRoom(visitor.token); await closeOmnichannelRoom(room._id); const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: room._id, }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-room-already-closed'); }); it('should fail if user is not serving the chat and doesnt have on-hold-others-livechat-room permission', async () => { const { room } = await startANewLivechatRoomAndTakeIt(); await sendAgentMessage(room._id); const response = await request .post(api('livechat/room.onHold')) .set(agent2.credentials) .send({ roomId: room._id, }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('Not_authorized'); }); it('should put room on hold', async () => { const { room } = await startANewLivechatRoomAndTakeIt(); await sendAgentMessage(room._id); const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: room._id, }) .expect(200); expect(response.body.success).to.be.true; const updatedRoom = await getLivechatRoomInfo(room._id); expect(updatedRoom.onHold).to.be.true; }); it('Should put room on hold, even in the visitor sent the last message', async () => { const { room, visitor } = await startANewLivechatRoomAndTakeIt(); await updateSetting('Livechat_allow_manual_on_hold_upon_agent_engagement_only', false); await sendMessage(room._id, '-', visitor.token); const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: room._id, }) .expect(200); expect(response.body.success).to.be.true; const updatedRoom = await getLivechatRoomInfo(room._id); expect(updatedRoom.onHold).to.be.true; }); it('should not put room on hold when visitor sent the last message', async () => { const { room, visitor } = await startANewLivechatRoomAndTakeIt(); await updateSetting('Livechat_allow_manual_on_hold_upon_agent_engagement_only', true); await sendMessage(room._id, '-', visitor.token); const response = await request .post(api('livechat/room.onHold')) .set(credentials) .send({ roomId: room._id, }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-cannot-place-chat-on-hold'); }); }); describe('livechat/room.resumeOnHold', () => { it('should fail if user doesnt have view-l-room permission', async () => { await updatePermission('view-l-room', []); const response = await request .post(api('livechat/room.resumeOnHold')) .set(credentials) .send({ roomId: 'invalid-room-id', }) .expect(403); expect(response.body.success).to.be.false; }); it('should fail if roomId is invalid', async () => { await updatePermission('view-l-room', ['admin', 'livechat-manager', 'livechat-agent']); const response = await request .post(api('livechat/room.resumeOnHold')) .set(credentials) .send({ roomId: 'invalid-room-id', }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-invalid-room'); }); it('should fail if room is not a livechat room', async () => { const response = await request .post(api('livechat/room.resumeOnHold')) .set(credentials) .send({ roomId: 'GENERAL', }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-invalid-room'); }); it('should fail if room is not on hold', async () => { const { room } = await startANewLivechatRoomAndTakeIt(); const response = await request .post(api('livechat/room.resumeOnHold')) .set(credentials) .send({ roomId: room._id, }) .expect(400); expect(response.body.success).to.be.false; expect(response.body.error).to.be.equal('error-room-not-on-hold'); }); it('should resume room on hold', async () => { const { room } = await startANewLivechatRoomAndTakeIt(); await sendAgentMessage(room._id); await placeRoomOnHold(room._id); const response = await request .post(api('livechat/room.resumeOnHold')) .set(credentials) .send({ roomId: room._id, }) .expect(200); expect(response.body.success).to.be.true; const updatedRoom = await getLivechatRoomInfo(room._id); expect(updatedRoom).to.not.have.property('onHold'); }); it('should resume room on hold and send proper system message', async () => { const { room, visitor } = await startANewLivechatRoomAndTakeIt(); await sendAgentMessage(room._id); await placeRoomOnHold(room._id); const response = await request .post(api('livechat/room.resumeOnHold')) .set(credentials) .send({ roomId: room._id, }) .expect(200); expect(response.body.success).to.be.true; const messages = await fetchMessages(room._id, visitor.token); expect(messages).to.be.an('array'); expect(messages[0]).to.not.be.undefined; expect(messages[0]).to.have.property('t', 'omnichannel_on_hold_chat_resumed'); expect(messages[0]).to.have.property('comment', 'The chat was manually resumed from On Hold by RocketChat Internal Admin Test'); }); it('should resume chat automatically if visitor sent a message', async () => { const { room, visitor } = await startANewLivechatRoomAndTakeIt(); await sendAgentMessage(room._id); await placeRoomOnHold(room._id); await sendMessage(room._id, 'test', visitor.token); // wait for the room to be resumed since that logic is within callbacks await sleep(500); const updatedRoom = await getLivechatRoomInfo(room._id); expect(updatedRoom).to.not.have.property('onHold'); }); }); describe('visitor abandonment feature', () => { let room: IOmnichannelRoom; before(async () => { await updateSetting('Livechat_abandoned_rooms_action', 'Livechat_close_chat'); await updateSetting('Livechat_visitor_inactivity_timeout', 60); }); it('should set predictedVisitorAbandonmentAt when agent sends a message', async () => { const { room: newRoom } = await startANewLivechatRoomAndTakeIt(); room = newRoom; await sendAgentMessage(room._id); const updatedRoom = await getLivechatRoomInfo(room._id); const lastMessageTs = updatedRoom.responseBy?.lastMessageTs; const firstResponseTs = updatedRoom.responseBy?.firstResponseTs; const predictedVisitorAbandonmentAt = updatedRoom.omnichannel?.predictedVisitorAbandonmentAt; expect(predictedVisitorAbandonmentAt).to.not.be.undefined; expect(lastMessageTs).to.not.be.undefined; expect(firstResponseTs).to.not.be.undefined; // expect predictedVisitorAbandonmentAt to be 60 seconds after lastMessageTs const lastMessageTsDate = new Date(lastMessageTs as Date); const predictedVisitorAbandonmentAtDate = new Date(predictedVisitorAbandonmentAt as Date); const firstResponseTsDate = new Date(firstResponseTs as Date); expect(predictedVisitorAbandonmentAtDate.getTime()).to.be.equal(lastMessageTsDate.getTime() + 60000); expect(firstResponseTsDate.getTime()).to.be.equal(lastMessageTsDate.getTime()); }); it('should not update predictedVisitorAbandonmentAt when agent sends yet another message', async () => { await sendAgentMessage(room._id); const updatedRoom = await getLivechatRoomInfo(room._id); const lastMessageTs = updatedRoom.responseBy?.lastMessageTs; const firstResponseTs = updatedRoom.responseBy?.firstResponseTs; const predictedVisitorAbandonmentAt = updatedRoom.omnichannel?.predictedVisitorAbandonmentAt; expect(predictedVisitorAbandonmentAt).to.not.be.undefined; expect(lastMessageTs).to.not.be.undefined; // expect predictedVisitorAbandonmentAt to be 60 seconds after first message const lastMessageTsDate = new Date(lastMessageTs as Date); const predictedVisitorAbandonmentAtDate = new Date(predictedVisitorAbandonmentAt as Date); const firstResponseTsDate = new Date(firstResponseTs as Date); expect(predictedVisitorAbandonmentAtDate.getTime()).to.be.equal(firstResponseTsDate.getTime() + 60000); // lastMessageTs should be updated expect(lastMessageTsDate.getTime()).to.not.be.equal(firstResponseTsDate.getTime()); expect(lastMessageTsDate.getTime()).to.be.greaterThan(firstResponseTsDate.getTime()); }); after(async () => { await updateSetting('Livechat_abandoned_rooms_action', 'none'); await updateSetting('Livechat_visitor_inactivity_timeout', 3600); }); }); });