test: create tests for omnichannel queue management (#33149)

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

@@ -0,0 +1,120 @@
+import { createFakeVisitor } from '../../mocks/data';
+import { IS_EE } from '../config/constants';
+import { createAuxContext } from '../fixtures/createAuxContext';
+import { Users } from '../fixtures/userStates';
+import { HomeOmnichannel, OmnichannelLiveChat } from '../page-objects';
+import { test, expect } from '../utils/test';
+
+const firstVisitor = createFakeVisitor();
+
+const secondVisitor = createFakeVisitor();
+
+test.use({ storageState: Users.user1.state });
+
+test.describe('OC - Livechat - Queue Management', () => {
+	test.skip(!IS_EE, 'Enterprise Only');
+
+	let poHomeOmnichannel: HomeOmnichannel;
+	let poLiveChat: OmnichannelLiveChat;
+
+	const waitingQueueMessage = 'This is a message from Waiting Queue';
+	const queuePosition1 = 'Your spot is #1';
+	const queuePosition2 = 'Your spot is #2';
+
+	test.beforeAll(async ({ api, browser }) => {
+		await Promise.all([
+			api.post('/settings/Livechat_Routing_Method', { value: 'Manual_Selection' }),
+			api.post('/settings/Livechat_waiting_queue', { value: true }),
+			api.post('/settings/Livechat_waiting_queue_message', { value: waitingQueueMessage }),
+			api.post('/livechat/users/agent', { username: 'user1' }),
+		]);
+
+		const { page: omniPage } = await createAuxContext(browser, Users.user1, '/', true);
+		poHomeOmnichannel = new HomeOmnichannel(omniPage);
+	});
+
+	test.beforeEach(async ({ browser, api }) => {
+		const context = await browser.newContext();
+		const page2 = await context.newPage();
+
+		poLiveChat = new OmnichannelLiveChat(page2, api);
+		await poLiveChat.page.goto('/livechat');
+	});
+
+	test.afterAll(async ({ api }) => {
+		await Promise.all([
+			api.post('/settings/Livechat_Routing_Method', { value: 'Auto_Selection' }),
+			api.post('/settings/Livechat_waiting_queue', { value: false }),
+			api.post('/settings/Livechat_waiting_queue_message', { value: '' }),
+			api.delete('/livechat/users/agent/user1'),
+		]);
+		await poHomeOmnichannel.page.close();
+	});
+
+	test.afterEach(async () => {
+		await poLiveChat.closeChat();
+		await poLiveChat.page.close();
+	});
+
+	test('OC - Queue Management - Waiting Queue Message enabled', async () => {
+		await test.step('should start livechat session', async () => {
+			await poLiveChat.openAnyLiveChatAndSendMessage({
+				liveChatUser: firstVisitor,
+				message: 'Test message',
+				isOffline: false,
+			});
+		});
+		await test.step('expect to receive Waiting Queue message on chat', async () => {
+			await expect(poLiveChat.page.locator(`div >> text=${waitingQueueMessage}`)).toBeVisible();
+		});
+	});
+
+	test.describe('OC - Queue Management - Update Queue Position', () => {
+		let poLiveChat2: OmnichannelLiveChat;
+
+		test.beforeEach(async ({ browser, api }) => {
+			const context = await browser.newContext();
+			const page = await context.newPage();
+			poLiveChat2 = new OmnichannelLiveChat(page, api);
+			await poLiveChat2.page.goto('/livechat');
+		});
+
+		test.afterEach(async () => {
+			await poLiveChat2.closeChat();
+			await poLiveChat2.page.close();
+		});
+
+		test('Update user position on Queue', async () => {
+			await test.step('should start secondary livechat session', async () => {
+				await poLiveChat2.openAnyLiveChatAndSendMessage({
+					liveChatUser: secondVisitor,
+					message: 'Test message',
+					isOffline: false,
+				});
+			});
+
+			await test.step('should start primary livechat session', async () => {
+				await poLiveChat.openAnyLiveChatAndSendMessage({
+					liveChatUser: firstVisitor,
+					message: 'Test message',
+					isOffline: false,
+				});
+			});
+
+			await test.step('should verify the queue position of the primary user', async () => {
+				await expect(poLiveChat.page.locator(`div[role='alert'] >> text=${queuePosition2}`)).toBeVisible();
+			});
+
+			await test.step('should allow the agent to take the secondary user chat', async () => {
+				await poHomeOmnichannel.sidenav.getQueuedChat(secondVisitor.name).click();
+				await expect(poHomeOmnichannel.content.btnTakeChat).toBeVisible();
+				await poHomeOmnichannel.content.btnTakeChat.click();
+				await expect(poHomeOmnichannel.content.lastSystemMessageBody).toHaveText('joined the channel');
+			});
+
+			await test.step('expect the queue position of the primary user to update after the secondary users chat is taken', async () => {
+				await expect(poLiveChat.page.locator(`div[role='alert'] >> text=${queuePosition1}`)).toBeVisible();
+			});
+		});
+	});
+});

apps/meteor/tests/e2e/page-objects/omnichannel-livechat.ts

@@ -88,6 +88,19 @@ export class OmnichannelLiveChat {
 		await this.btnNewChat.click();
 	}
 
+	async openAnyLiveChatAndSendMessage(params: {
+		liveChatUser: { name: string; email: string };
+		message: string;
+		isOffline?: boolean;
+		department?: string;
+	}): Promise<void> {
+		const { liveChatUser, message, isOffline, department } = params;
+		await this.openAnyLiveChat();
+		await this.sendMessage(liveChatUser, isOffline, department);
+		await this.onlineAgentMessage.fill(message);
+		await this.btnSendMessageToOnlineAgent.click();
+	}
+
 	unreadMessagesBadge(count: number): Locator {
 		const name = count === 1 ? `${count} unread message` : `${count} unread messages`;