feat: use Livechat Contacts as a reference for the MAC limit (#33816)

Author: matheusbsilva137

.changeset/slow-flies-hear.md

@@ -0,0 +1,8 @@
+---
+"@rocket.chat/meteor": minor
+"@rocket.chat/core-typings": minor
+"@rocket.chat/model-typings": minor
+---
+
+Replaces Livechat Visitors by Contacts on workspaces' MAC count.
+This allows a more accurate and potentially smaller MAC count in case Contact Identification is enabled, since multiple visitors may be associated to the same contact.

apps/meteor/app/cloud/server/functions/buildRegistrationData.ts

@@ -1,4 +1,4 @@
-import { LivechatRooms, Statistics, Users } from '@rocket.chat/models';
+import { LivechatContacts, Statistics, Users } from '@rocket.chat/models';
 import moment from 'moment';
 
 import { settings } from '../../../settings/server';
@@ -69,7 +69,7 @@ export async function buildWorkspaceRegistrationData<T extends string | undefine
 	const workspaceType = settings.get<string>('Server_Type');
 
 	const seats = await Users.getActiveLocalUserCount();
-	const [macs] = await LivechatRooms.getMACStatisticsForPeriod(moment.utc().format('YYYY-MM'));
+	const MAC = await LivechatContacts.countContactsOnPeriod(moment.utc().format('YYYY-MM'));
 
 	const license = settings.get<string>('Enterprise_License');
 
@@ -102,7 +102,7 @@ export async function buildWorkspaceRegistrationData<T extends string | undefine
 		setupComplete: setupWizardState === 'completed',
 		connectionDisable: false,
 		npsEnabled,
-		MAC: macs?.contactsCount ?? 0,
+		MAC,
 		// activeContactsBillingMonth: stats.omnichannelContactsBySource.contactsCount,
 		// activeContactsYesterday: stats.uniqueContactsOfYesterday.contactsCount,
 		statsToken: stats.statsToken,

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

@@ -1,7 +1,7 @@
 import type { IOmnichannelRoom, IMessage } from '@rocket.chat/core-typings';
 import { isEditedMessage, isMessageFromVisitor, isSystemMessage } from '@rocket.chat/core-typings';
 import type { Updater } from '@rocket.chat/models';
-import { LivechatRooms, LivechatVisitors, LivechatInquiry } from '@rocket.chat/models';
+import { LivechatRooms, LivechatContacts, LivechatInquiry } from '@rocket.chat/models';
 import moment from 'moment';
 
 import { callbacks } from '../../../../lib/callbacks';
@@ -17,11 +17,11 @@ export async function markRoomResponded(
 	}
 
 	const monthYear = moment().format('YYYY-MM');
-	const isVisitorActive = await LivechatVisitors.isVisitorActiveOnPeriod(room.v._id, monthYear);
+	const isContactActive = await LivechatContacts.isContactActiveOnPeriod({ visitorId: room.v._id, source: room.source }, monthYear);
 
 	// Case: agent answers & visitor is not active, we mark visitor as active
-	if (!isVisitorActive) {
-		await LivechatVisitors.markVisitorActiveForPeriod(room.v._id, monthYear);
+	if (!isContactActive) {
+		await LivechatContacts.markContactActiveForPeriod({ visitorId: room.v._id, source: room.source }, monthYear);
 	}
 
 	if (!room.v?.activity?.includes(monthYear)) {

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

@@ -87,13 +87,6 @@ export const prepareLivechatRoom = async (
 	const extraRoomInfo = await callbacks.run('livechat.beforeRoom', roomInfo, extraData);
 	const { _id, username, token, department: departmentId, status = 'online' } = guest;
 	const newRoomAt = new Date();
-
-	const { activity } = guest;
-	logger.debug({
-		msg: `Creating livechat room for visitor ${_id}`,
-		visitor: { _id, username, departmentId, status, activity },
-	});
-
 	const source = extraRoomInfo.source || roomInfo.source;
 
 	if (settings.get<string>('Livechat_Require_Contact_Verification') === 'always') {
@@ -103,14 +96,20 @@ export const prepareLivechatRoom = async (
 	const contactId = await migrateVisitorIfMissingContact(_id, source);
 	const contact =
 		contactId &&
-		(await LivechatContacts.findOneById<Pick<ILivechatContact, '_id' | 'name' | 'channels'>>(contactId, {
-			projection: { name: 1, channels: 1 },
+		(await LivechatContacts.findOneById<Pick<ILivechatContact, '_id' | 'name' | 'channels' | 'activity'>>(contactId, {
+			projection: { name: 1, channels: 1, activity: 1 },
 		}));
 	if (!contact) {
 		throw new Error('error-invalid-contact');
 	}
 	const verified = Boolean(contact.channels.some((channel) => isVerifiedChannelInSource(channel, _id, source)));
 
+	const activity = guest.activity || contact.activity;
+	logger.debug({
+		msg: `Creating livechat room for visitor ${_id}`,
+		visitor: { _id, username, departmentId, status, activity },
+	});
+
 	// TODO: Solve `u` missing issue
 	return {
 		_id: rid,
@@ -199,7 +198,11 @@ export const createLivechatInquiry = async ({
 
 	const extraInquiryInfo = await callbacks.run('livechat.beforeInquiry', extraData);
 
-	const { _id, username, token, department, status = UserStatus.ONLINE, activity } = guest;
+	const { _id, username, token, department, status = UserStatus.ONLINE } = guest;
+	const inquirySource = extraData?.source || { type: OmnichannelSourceType.OTHER };
+	const activity =
+		guest.activity ||
+		(await LivechatContacts.findOneByVisitor({ visitorId: guest._id, source: inquirySource }, { projection: { activity: 1 } }))?.activity;
 
 	const ts = new Date();
 

apps/meteor/app/livechat/server/lib/contacts/ContactMerger.ts

@@ -21,6 +21,7 @@ type ContactFields = {
 	username: string;
 	manager: ManagerValue;
 	channel: ILivechatContactChannel;
+	activity: string[];
 };
 
 type CustomFieldAndValue = { type: `customFields.${string}`; value: string };
@@ -29,6 +30,7 @@ export type FieldAndValue =
 	| { type: keyof Omit<ContactFields, 'manager' | 'channel'>; value: string }
 	| { type: 'manager'; value: ManagerValue }
 	| { type: 'channel'; value: ILivechatContactChannel }
+	| { type: 'activity'; value: string[] }
 	| CustomFieldAndValue;
 
 type ConflictHandlingMode = 'conflict' | 'overwrite' | 'ignore';
@@ -118,7 +120,7 @@ export class ContactMerger {
 	}
 
 	static getAllFieldsFromContact(contact: ILivechatContact): FieldAndValue[] {
-		const { customFields = {}, name, contactManager } = contact;
+		const { customFields = {}, name, contactManager, activity } = contact;
 
 		const fields = new Set<FieldAndValue>();
 
@@ -134,6 +136,10 @@ export class ContactMerger {
 			fields.add({ type: 'manager', value: { id: contactManager } });
 		}
 
+		if (activity) {
+			fields.add({ type: 'activity', value: activity });
+		}
+
 		Object.keys(customFields).forEach((key) =>
 			fields.add({ type: `customFields.${key}`, value: customFields[key] } as CustomFieldAndValue),
 		);
@@ -222,6 +228,7 @@ export class ContactMerger {
 		const newPhones = ContactMerger.getFieldValuesByType(newFields, 'phone');
 		const newEmails = ContactMerger.getFieldValuesByType(newFields, 'email');
 		const newChannels = ContactMerger.getFieldValuesByType(newFields, 'channel');
+		const newActivities = ContactMerger.getFieldValuesByType(newFields, 'activity');
 		const newNamesOnly = ContactMerger.getFieldValuesByType(newFields, 'name');
 		const newCustomFields = newFields.filter(({ type }) => type.startsWith('customFields.')) as CustomFieldAndValue[];
 		// Usernames are ignored unless the contact has no other name
@@ -254,6 +261,15 @@ export class ContactMerger {
 			}
 		}
 
+		if (newActivities.length) {
+			const newActivity = newActivities.shift();
+			if (newActivity) {
+				const distinctActivities = new Set([...newActivity, ...(contact.activity || [])]);
+				const latestActivities = Array.from(distinctActivities).sort().slice(-12);
+				dataToSet.activity = latestActivities;
+			}
+		}
+
 		const customFieldsPerName = new Map<string, CustomFieldAndValue[]>();
 		for (const customField of newCustomFields) {
 			if (!customFieldsPerName.has(customField.type)) {

apps/meteor/app/livechat/server/lib/contacts/registerContact.spec.ts

@@ -13,7 +13,6 @@ const modelsMock = {
 		upsertContact: sinon.stub(),
 		updateContact: sinon.stub(),
 		findContactMatchingVisitor: sinon.stub(),
-		findOneByVisitorId: sinon.stub(),
 	},
 	'LivechatRooms': {
 		findNewestByVisitorIdOrToken: sinon.stub(),

apps/meteor/ee/app/license/server/startup.ts

@@ -1,7 +1,7 @@
 import { api } from '@rocket.chat/core-services';
 import type { LicenseLimitKind } from '@rocket.chat/core-typings';
 import { applyLicense, applyLicenseOrRemove, License } from '@rocket.chat/license';
-import { Subscriptions, Users, Settings, LivechatVisitors } from '@rocket.chat/models';
+import { Subscriptions, Users, Settings, LivechatContacts } from '@rocket.chat/models';
 import { wrapExceptions } from '@rocket.chat/tools';
 import moment from 'moment';
 
@@ -110,7 +110,7 @@ export const startLicense = async () => {
 	License.setLicenseLimitCounter('roomsPerGuest', async (context) => (context?.userId ? Subscriptions.countByUserId(context.userId) : 0));
 	License.setLicenseLimitCounter('privateApps', () => getAppCount('private'));
 	License.setLicenseLimitCounter('marketplaceApps', () => getAppCount('marketplace'));
-	License.setLicenseLimitCounter('monthlyActiveContacts', () => LivechatVisitors.countVisitorsOnPeriod(moment.utc().format('YYYY-MM')));
+	License.setLicenseLimitCounter('monthlyActiveContacts', () => LivechatContacts.countContactsOnPeriod(moment.utc().format('YYYY-MM')));
 
 	return new Promise<void>((resolve) => {
 		// When settings are loaded, apply the current license if there is one.

apps/meteor/tests/end-to-end/api/livechat/09-visitors.ts

@@ -2,7 +2,6 @@ import { faker } from '@faker-js/faker';
 import type { ILivechatVisitor } from '@rocket.chat/core-typings';
 import { expect } from 'chai';
 import { before, describe, it, after } from 'mocha';
-import moment from 'moment';
 import { type Response } from 'supertest';
 
 import { getCredentials, api, request, credentials } from '../../../data/api-data';
@@ -484,27 +483,6 @@ describe('LIVECHAT - visitors', () => {
 				});
 		});
 
-		it('should return visitor activity field when visitor was active on month', async () => {
-			// Activity is determined by a conversation in which an agent has engaged (sent a message)
-			// For a visitor to be considered active, they must have had a conversation in the last 30 days
-			const period = moment().format('YYYY-MM');
-			const { visitor, room } = await startANewLivechatRoomAndTakeIt();
-			// agent should send a message on the room
-			await request
-				.post(api('chat.sendMessage'))
-				.set(credentials)
-				.send({
-					message: {
-						rid: room._id,
-						msg: 'test',
-					},
-				});
-
-			const activeVisitor = await getLivechatVisitorByToken(visitor.token);
-			expect(activeVisitor).to.have.property('activity');
-			expect(activeVisitor.activity).to.include(period);
-		});
-
 		it('should not affect MAC count when a visitor is removed via GDPR', async () => {
 			const { visitor, room } = await startANewLivechatRoomAndTakeIt();
 			// agent should send a message on the room

apps/meteor/tests/end-to-end/api/livechat/23-mac.ts

@@ -1,6 +1,6 @@
 import type { ILivechatVisitor } from '@rocket.chat/core-typings';
 import { expect } from 'chai';
-import { before, describe, it } from 'mocha';
+import { before, afterEach, after, describe, it } from 'mocha';
 import moment from 'moment';
 
 import { api, getCredentials, request, credentials } from '../../../data/api-data';
@@ -13,6 +13,7 @@ import {
 	getLivechatRoomInfo,
 	fetchInquiry,
 	closeOmnichannelRoom,
+	deleteVisitor,
 } from '../../../data/livechat/rooms';
 
 describe('MAC', () => {
@@ -25,14 +26,29 @@ describe('MAC', () => {
 
 	describe('MAC rooms', () => {
 		let visitor: ILivechatVisitor;
-		it('Should create an innactive room by default', async () => {
-			const visitor = await createVisitor();
+		let multipleContactsVisitor: ILivechatVisitor;
+
+		afterEach(() => deleteVisitor(visitor.token));
+
+		after(() => deleteVisitor(multipleContactsVisitor.token));
+
+		it('Should create an innactive room and contact by default', async () => {
+			visitor = await createVisitor();
 			const room = await createLivechatRoom(visitor.token);
 
 			expect(room).to.be.an('object');
 			expect(room.v.activity).to.be.undefined;
 		});
 
+		it('Should create an innactive contact by default', async () => {
+			visitor = await createVisitor();
+			const room = await createLivechatRoom(visitor.token);
+
+			const res = await request.get(api(`omnichannel/contacts.get`)).set(credentials).query({ contactId: room.contactId });
+			expect(res.body.contact.channels[0].visitor.visitorId).to.be.equal(visitor._id);
+			expect(res.body.contact).not.to.have.property('activity');
+		});
+
 		it('should mark room as active when agent sends a message', async () => {
 			visitor = await createVisitor();
 			const room = await createLivechatRoom(visitor.token);
@@ -44,50 +60,75 @@ describe('MAC', () => {
 			expect(updatedRoom).to.have.nested.property('v.activity').and.to.be.an('array');
 		});
 
-		it('should mark multiple rooms as active when they come from same visitor after an agent sends a message', async () => {
-			const room = await createLivechatRoom(visitor.token);
+		it('should mark contact as active when agent sends a message', async () => {
+			multipleContactsVisitor = await createVisitor();
+			const room = await createLivechatRoom(multipleContactsVisitor.token);
+
+			await sendAgentMessage(room._id);
+
+			const res = await request.get(api(`omnichannel/contacts.get`)).set(credentials).query({ contactId: room.contactId });
+			expect(res.body.contact.channels[0].visitor.visitorId).to.be.equal(multipleContactsVisitor._id);
+			expect(res.body.contact).to.have.property('activity').that.is.an('array').with.lengthOf(1);
+			expect(res.body.contact.activity[0]).to.equal(moment.utc().format('YYYY-MM'));
+		});
+
+		it('should mark multiple rooms as active when they come from same contact after an agent sends a message', async () => {
+			const room = await createLivechatRoom(multipleContactsVisitor.token);
 
 			await sendAgentMessage(room._id);
 
 			const updatedRoom = await getLivechatRoomInfo(room._id);
 
 			expect(updatedRoom).to.have.nested.property('v.activity').and.to.be.an('array');
+			await closeOmnichannelRoom(room._id);
+		});
+
+		it('should keep contact active when reusing it and an agent response is received', async () => {
+			const room = await createLivechatRoom(multipleContactsVisitor.token);
+
+			await sendAgentMessage(room._id);
 
+			const res = await request.get(api(`omnichannel/contacts.get`)).set(credentials).query({ contactId: room.contactId });
+			expect(res.body.contact.channels[0].visitor.visitorId).to.be.equal(multipleContactsVisitor._id);
+			expect(res.body.contact).to.have.property('activity').that.is.an('array').with.lengthOf(1);
+			expect(res.body.contact.activity[0]).to.equal(moment.utc().format('YYYY-MM'));
 			await closeOmnichannelRoom(room._id);
 		});
 
-		it('should mark room as active when it comes from same visitor on same period, even without agent interaction', async () => {
-			const room = await createLivechatRoom(visitor.token);
+		it('should mark room as active when it comes from same contact on same period, even without agent interaction', async () => {
+			const room = await createLivechatRoom(multipleContactsVisitor.token);
 
 			expect(room).to.have.nested.property('v.activity').and.to.be.an('array');
 			expect(room.v.activity?.includes(moment.utc().format('YYYY-MM'))).to.be.true;
-
 			await closeOmnichannelRoom(room._id);
 		});
 
-		it('should mark an inquiry as active when it comes from same visitor on same period, even without agent interaction', async () => {
-			const room = await createLivechatRoom(visitor.token);
+		it('should mark an inquiry as active when it comes from same contact on same period, even without agent interaction', async () => {
+			const room = await createLivechatRoom(multipleContactsVisitor.token);
 			const inquiry = await fetchInquiry(room._id);
 
 			expect(inquiry).to.have.nested.property('v.activity').and.to.be.an('array');
 			expect(inquiry.v.activity?.includes(moment.utc().format('YYYY-MM'))).to.be.true;
 			expect(room.v.activity?.includes(moment.utc().format('YYYY-MM'))).to.be.true;
-
 			await closeOmnichannelRoom(room._id);
 		});
 
-		it('visitor should be marked as active for period', async () => {
-			const { body } = await request
-				.get(api('livechat/visitors.info'))
-				.query({ visitorId: visitor._id })
-				.set(credentials)
-				.expect('Content-Type', 'application/json')
-				.expect(200);
-
-			expect(body).to.have.nested.property('visitor').and.to.be.an('object');
-			expect(body.visitor).to.have.nested.property('activity').and.to.be.an('array');
-			expect(body.visitor.activity).to.have.lengthOf(1);
-			expect(body.visitor.activity[0]).to.equal(moment.utc().format('YYYY-MM'));
+		it('contact should be marked as active for period', async () => {
+			visitor = await createVisitor();
+			const room = await createLivechatRoom(visitor.token);
+			await sendAgentMessage(room._id);
+			const res = await request.get(api(`omnichannel/contacts.get`)).set(credentials).query({ contactId: room.contactId });
+
+			expect(res.status).to.be.equal(200);
+			expect(res.body).to.have.property('success', true);
+			expect(res.body).to.have.nested.property('contact').and.to.be.an('object');
+			expect(res.body.contact.channels).to.be.an('array').with.lengthOf(1);
+			expect(res.body.contact.channels[0].name).to.be.equal('api');
+			expect(res.body.contact.channels[0].visitor.visitorId).to.be.equal(visitor._id);
+
+			expect(res.body.contact).to.have.nested.property('activity').and.to.be.an('array').with.lengthOf(1);
+			expect(res.body.contact.activity[0]).to.equal(moment.utc().format('YYYY-MM'));
+			await closeOmnichannelRoom(room._id);
 		});
 	});
 });