feat: Adds setting to ignore automatic messages on metrics

.changeset/funny-turtles-hunt.md

@@ -0,0 +1,6 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/i18n": patch
+---
+
+Adds a new setting that if enabled, will not count bot messages in the average response time metrics

apps/meteor/app/livechat/server/hooks/markRoomResponded.ts

@@ -6,13 +6,20 @@ import moment from 'moment';
 
 import { callbacks } from '../../../../lib/callbacks';
 import { notifyOnLivechatInquiryChanged } from '../../../lib/server/lib/notifyListener';
+import { settings } from '../../../settings/server';
+import { isMessageFromBot } from '../lib/isMessageFromBot';
 
 export async function markRoomResponded(
 	message: IMessage,
 	room: IOmnichannelRoom,
 	roomUpdater: Updater<IOmnichannelRoom>,
 ): Promise<IOmnichannelRoom['responseBy'] | undefined> {
-	if (isSystemMessage(message) || isEditedMessage(message) || isMessageFromVisitor(message)) {
+	if (
+		isSystemMessage(message) ||
+		isEditedMessage(message) ||
+		isMessageFromVisitor(message) ||
+		(settings.get<boolean>('Omnichannel_Metrics_Ignore_Automatic_Messages') && (await isMessageFromBot(message)))
+	) {
 		return;
 	}
 

apps/meteor/app/livechat/server/hooks/saveAnalyticsData.ts

@@ -3,7 +3,9 @@ import type { IOmnichannelRoom } from '@rocket.chat/core-typings';
 import { LivechatRooms } from '@rocket.chat/models';
 
 import { callbacks } from '../../../../lib/callbacks';
+import { settings } from '../../../settings/server';
 import { normalizeMessageFileUpload } from '../../../utils/server/functions/normalizeMessageFileUpload';
+import { isMessageFromBot } from '../lib/isMessageFromBot';
 
 const getMetricValue = <T>(metric: T | undefined, defaultValue: T): T => metric ?? defaultValue;
 const calculateTimeDifference = <T extends Date | number>(startTime: T, now: Date): number =>
@@ -73,6 +75,10 @@ callbacks.add(
 		if (isMessageFromVisitor(message)) {
 			LivechatRooms.getAnalyticsUpdateQueryBySentByVisitor(room, message, roomUpdater);
 		} else {
+			if (settings.get<boolean>('Omnichannel_Metrics_Ignore_Automatic_Messages') && (await isMessageFromBot(message))) {
+				return message;
+			}
+
 			const analyticsData = getAnalyticsData(room, new Date());
 			LivechatRooms.getAnalyticsUpdateQueryBySentByAgent(room, message, analyticsData, roomUpdater);
 		}

apps/meteor/app/livechat/server/lib/isMessageFromBot.ts

@@ -0,0 +1,12 @@
+import type { IMessage, IUser } from '@rocket.chat/core-typings';
+import { Users } from '@rocket.chat/models';
+
+export async function isMessageFromBot(message: IMessage): Promise<boolean> {
+	const user = await Users.findOneById<Pick<IUser, 'roles'>>(message.u._id, { projection: { roles: 1 } });
+
+	if (!user) {
+		throw new Error('User not found');
+	}
+
+	return !!user.roles.includes('bot');
+}

apps/meteor/server/settings/omnichannel.ts

@@ -673,6 +673,14 @@ export const createOmniSettings = () =>
 			i18nLabel: 'Call_provider',
 			enableQuery: omnichannelEnabledQuery,
 		});
+
+		await this.add('Omnichannel_Metrics_Ignore_Automatic_Messages', false, {
+			type: 'boolean',
+			public: true,
+			group: 'Omnichannel',
+			section: 'Analytics',
+			i18nLabel: 'Omnichannel_Ignore_automatic_responses_for_performance_metrics',
+		});
 	});
 await settingsRegistry.addGroup('SMS', async function () {
 	await this.add('SMS_Enabled', false, {

apps/meteor/tests/end-to-end/api/livechat/04-dashboards.ts

@@ -16,7 +16,7 @@ import {
 	sendMessage,
 	startANewLivechatRoomAndTakeIt,
 } from '../../../data/livechat/rooms';
-import { createAnOnlineAgent } from '../../../data/livechat/users';
+import { createAnOnlineAgent, createBotAgent } from '../../../data/livechat/users';
 import { sleep } from '../../../data/livechat/utils';
 import { removePermissionFromAllRoles, restorePermissionToRoles, updateEESetting, updateSetting } from '../../../data/permissions.helper';
 import { deleteUser } from '../../../data/users.helper';
@@ -923,6 +923,7 @@ describe('LIVECHAT - dashboards', function () {
 	describe('[livechat/analytics/agent-overview] - Average first response time', () => {
 		let agent: { credentials: Credentials; user: IUser & { username: string } };
 		let forwardAgent: { credentials: Credentials; user: IUser & { username: string } };
+		let botAgent: { credentials: Credentials; user: IUser };
 		let originalFirstResponseTimeInSeconds: number;
 		let roomId: string;
 		const firstDelayInSeconds = 4;
@@ -931,6 +932,7 @@ describe('LIVECHAT - dashboards', function () {
 		before(async () => {
 			agent = await createAnOnlineAgent();
 			forwardAgent = await createAnOnlineAgent();
+			botAgent = await createBotAgent();
 		});
 
 		after(async () => Promise.all([deleteUser(agent.user), deleteUser(forwardAgent.user)]));
@@ -984,6 +986,36 @@ describe('LIVECHAT - dashboards', function () {
 			expect(originalFirstResponseTimeInSeconds).to.be.greaterThanOrEqual(firstDelayInSeconds);
 		});
 
+		it("should not consider bot messages in agent's first response time metric if setting is enabled", async () => {
+			await updateSetting('Omnichannel_Metrics_Ignore_Automatic_Messages', true);
+
+			const response = await startANewLivechatRoomAndTakeIt({ agent: botAgent.credentials });
+
+			roomId = response.room._id;
+
+			await sleep(firstDelayInSeconds * 1000);
+
+			await sendAgentMessage(roomId, 'first response from agent', botAgent.credentials);
+
+			const today = moment().startOf('day').format('YYYY-MM-DD');
+			const result = await request
+				.get(api('livechat/analytics/agent-overview'))
+				.query({ from: today, to: today, name: 'Avg_first_response_time' })
+				.set(credentials)
+				.expect('Content-Type', 'application/json')
+				.expect(200);
+
+			expect(result.body).to.have.property('success', true);
+			expect(result.body).to.have.property('head');
+			expect(result.body).to.have.property('data');
+			expect(result.body.data).to.be.an('array');
+
+			const agentData = result.body.data.find(
+				(agentOverviewData: { name: string; value: string }) => agentOverviewData.name === botAgent.user.username,
+			);
+			expect(agentData).to.be.undefined;
+		});
+
 		it('should correctly associate the first response time to the first agent who responded the room', async () => {
 			const response = await startANewLivechatRoomAndTakeIt({ agent: forwardAgent.credentials });
 			roomId = response.room._id;
@@ -1284,12 +1316,12 @@ describe('LIVECHAT - dashboards', function () {
 			expect(result.body).to.be.an('array');
 
 			const expectedResult = [
-				{ title: 'Total_conversations', value: 15 },
-				{ title: 'Open_conversations', value: 12 },
+				{ title: 'Total_conversations', value: 16 },
+				{ title: 'Open_conversations', value: 13 },
 				{ title: 'On_Hold_conversations', value: 1 },
 				// { title: 'Total_messages', value: 6 },
 				// { title: 'Busiest_day', value: moment().format('dddd') },
-				{ title: 'Conversations_per_day', value: '7.50' },
+				{ title: 'Conversations_per_day', value: '8.00' },
 				// { title: 'Busiest_time', value: '' },
 			];
 

apps/meteor/tests/unit/app/livechat/server/lib/isMessageFromBot.spec.ts

@@ -0,0 +1,43 @@
+import { expect } from 'chai';
+import p from 'proxyquire';
+import sinon from 'sinon';
+
+import { createFakeMessage, createFakeUser } from '../../../../../mocks/data';
+
+const modelsMock = {
+	Users: {
+		findOneById: sinon.stub(),
+	},
+};
+
+const { isMessageFromBot } = p.noCallThru().load('../../../../../../app/livechat/server/lib/isMessageFromBot', {
+	'@rocket.chat/models': modelsMock,
+});
+
+describe('isMessageFromBot', () => {
+	const mockUser = createFakeUser({ roles: ['bot'] });
+	const mockMessage = createFakeMessage();
+
+	beforeEach(() => {
+		modelsMock.Users.findOneById.reset();
+	});
+
+	it('Should return true if user has bot role', async () => {
+		modelsMock.Users.findOneById.resolves(mockUser);
+		const result = await isMessageFromBot(mockMessage);
+		expect(result).to.be.true;
+	});
+
+	it('Should return false if user does not have bot role', async () => {
+		mockUser.roles = ['user'];
+		modelsMock.Users.findOneById.resolves(mockUser);
+		const result = await isMessageFromBot(mockMessage);
+		expect(result).to.be.false;
+	});
+
+	it('Should throw error when user is not found', async () => {
+		modelsMock.Users.findOneById.resolves(null);
+
+		await expect(isMessageFromBot(mockMessage)).to.be.rejectedWith(Error, 'User not found');
+	});
+});

apps/meteor/tests/unit/server/livechat/hooks/markRoomResponded.spec.ts

@@ -3,6 +3,8 @@ import { describe, it, beforeEach } from 'mocha';
 import proxyquire from 'proxyquire';
 import Sinon from 'sinon';
 
+import { createFakeMessage, createFakeUser } from '../../../../mocks/data';
+
 const models = {
 	LivechatVisitors: { isVisitorActiveOnPeriod: Sinon.stub(), markVisitorActiveForPeriod: Sinon.stub() },
 	LivechatInquiry: { markInquiryActiveForPeriod: Sinon.stub() },
@@ -13,10 +15,18 @@ const models = {
 	},
 };
 
-const { markRoomResponded } = proxyquire.load('../../../../../app/livechat/server/hooks/markRoomResponded.ts', {
+const settingsGetMock = {
+	get: Sinon.stub(),
+};
+
+const isMessageFromBotMock = { isMessageFromBot: Sinon.stub() };
+
+const { markRoomResponded } = proxyquire.noCallThru().load('../../../../../app/livechat/server/hooks/markRoomResponded.ts', {
 	'../../../../lib/callbacks': { callbacks: { add: Sinon.stub(), priority: { HIGH: 'high' } } },
 	'../../../lib/server/lib/notifyListener': { notifyOnLivechatInquiryChanged: Sinon.stub() },
 	'@rocket.chat/models': models,
+	'../../../settings/server': { settings: settingsGetMock },
+	'../lib/isMessageFromBot': isMessageFromBotMock,
 });
 
 describe('markRoomResponded', () => {
@@ -27,6 +37,8 @@ describe('markRoomResponded', () => {
 		models.LivechatRooms.getVisitorActiveForPeriodUpdateQuery.reset();
 		models.LivechatRooms.getAgentLastMessageTsUpdateQuery.reset();
 		models.LivechatRooms.getResponseByRoomIdUpdateQuery.reset();
+
+		settingsGetMock.get.reset();
 	});
 
 	it('should return void if message is system message', async () => {
@@ -66,6 +78,21 @@ describe('markRoomResponded', () => {
 		expect(res).to.be.undefined;
 	});
 
+	it('should return void if message is from bot and setting is enabled', async () => {
+		settingsGetMock.get.withArgs('Omnichannel_Metrics_Ignore_Automatic_Messages').resolves(true);
+
+		const user = createFakeUser({ roles: ['bot'] });
+
+		isMessageFromBotMock.isMessageFromBot.resolves(user);
+
+		const message = createFakeMessage();
+		const room = {};
+
+		const res = await markRoomResponded(message, room, user);
+
+		expect(res).to.be.undefined;
+	});
+
 	it('should try to mark visitor as active for current period', async () => {
 		const message = {};
 		const room = { v: { _id: '1234' } };

packages/i18n/src/locales/en.i18n.json

@@ -407,8 +407,8 @@
   "Agree": "Agree",
   "AI_Actions": "AI actions",
   "AirGapped_Restriction_Warning": "**Your air-gapped workspace will enter read-only mode in {{remainingDays}} days.** \n Users will still be able to access rooms and read existing messages but will be unable to send new messages. \n Reconnect it to the internet or [upgrade to a premium license](https://go.rocket.chat/i/air-gapped) to prevent this.",
-  "Airgapped_workspace_warning": "This air-gapped workspace will enter read-only mode in {{remainingDays}} days. <1>Connect it to the internet or upgrade to a premium plan to prevent this.</1>",
-  "Airgapped_workspace_restriction": "This air-gapped workspace is in read-only mode. <1>Connect it to the internet or upgrade to a premium plan to restore full functionality.</1>",
+  "Airgapped_workspace_warning": "This air-gapped workspace will enter read-only mode in {{remainingDays}} days. <2>Connect it to the internet or upgrade to a premium plan to prevent this.</1>",
+  "Airgapped_workspace_restriction": "This air-gapped workspace is in read-only mode. <2>Connect it to the internet or upgrade to a premium plan to restore full functionality.</1>",
   "Alerts": "Alerts",
   "Alias": "Alias",
   "Alias_Format": "Alias Format",
@@ -3374,9 +3374,7 @@
   "Omnichannel_placed_chat_on_hold": "Chat On Hold: {{comment}}",
   "Omnichannel_hide_conversation_after_closing": "Hide conversation after closing",
   "Omnichannel_hide_conversation_after_closing_description": "After closing the conversation you will be redirected to Home.",
-  "Omnichannel_allow_force_close_conversations": "Force close conversation API",
-  "Omnichannel_allow_force_close_conversations_Description": "Allow agents and managers to force close conversations via API.",
-  "Omnichannel_allow_force_close_conversations_alert": "Only enable if your workspace has issues with rooms with invalid states.",
+  "Omnichannel_Ignore_automatic_responses_for_performance_metrics": "Ignore bots activities for performance metrics",
   "Livechat_Block_Unknown_Contacts": "Block unknown contacts",
   "Livechat_Block_Unknown_Contacts_Description": "Conversations from people who are not on the contact list will not be able to be taken.",
   "Livechat_Block_Unverified_Contacts": "Block unverified contacts",
@@ -5519,9 +5517,7 @@
   "This_is_a_desktop_notification": "This is a desktop notification",
   "This_is_a_deprecated_feature_alert": "This is a deprecated feature. It may not work as expected and will not get new updates.",
   "Zapier_integration_has_been_deprecated": "The Zapier integration has been deprecated, may not work as expected and will not receive updates",
-  "Zapier_integration_is_not_available": "The Zapier integration has been deprecated and is no longer available for new Rocket.Chat workspaces",
   "Install_Zapier_from_marketplace": "Install the Zapier app from Marketplace to avoid disruptions",
-  "Install_Zapier_from_marketplace_new_workspaces": "Install the Zapier app from Marketplace to configure new integrations",
   "Input": "Input",
   "This_is_a_push_test_messsage": "This is a push test message",
   "This_message_was_rejected_by__peer__peer": "This message was rejected by <em>{{peer}}</em> peer.",