chore: Calculate & Store MAC stats (#30439)

RocketChat · Oct 4, 2023 · 1d2c83b · 1d2c83b
1 parent eb416f7
commit 1d2c83b
Show file tree

Hide file tree

Showing 13 changed files with 207 additions and 1 deletion.
diff --git a/.changeset/brown-comics-cheat.md b/.changeset/brown-comics-cheat.md
@@ -0,0 +1,8 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/core-typings": patch
+"@rocket.chat/model-typings": patch
+---
+
+chore: Calculate & Store MAC stats
+Added new info to the stats: `omnichannelContactsBySource`, `uniqueContactsOfLastMonth`, `uniqueContactsOfLastWeek`, `uniqueContactsOfYesterday`
diff --git a/apps/meteor/app/cloud/server/functions/buildRegistrationData.ts b/apps/meteor/app/cloud/server/functions/buildRegistrationData.ts
@@ -31,6 +31,8 @@ type WorkspaceRegistrationData<T> = {
 	setupComplete: boolean;
 	connectionDisable: boolean;
 	npsEnabled: SettingValue;
+	activeContactsBillingMonth: unknown;
+	activeContactsYesterday: unknown;
 };
 
 export async function buildWorkspaceRegistrationData<T extends string | undefined>(contactEmail: T): Promise<WorkspaceRegistrationData<T>> {
@@ -78,5 +80,7 @@ export async function buildWorkspaceRegistrationData<T extends string | undefine
 		setupComplete: setupWizardState === 'completed',
 		connectionDisable: !registerServer,
 		npsEnabled,
+		activeContactsBillingMonth: stats.omnichannelContactsBySource.contactsCount,
+		activeContactsYesterday: stats.uniqueContactsOfYesterday.contactsCount,
 	};
 }
diff --git a/apps/meteor/app/statistics/server/lib/statistics.ts b/apps/meteor/app/statistics/server/lib/statistics.ts
@@ -24,8 +24,10 @@ import {
 	LivechatCustomField,
 	Subscriptions,
 	Users,
+	LivechatRooms,
 } from '@rocket.chat/models';
 import { MongoInternals } from 'meteor/mongo';
+import moment from 'moment';
 
 import { getStatistics as getEnterpriseStatistics } from '../../../../ee/app/license/server';
 import { readSecondaryPreferred } from '../../../../server/database/readSecondaryPreferred';
@@ -259,6 +261,36 @@ export const statistics = {
 			}),
 		);
 
+		const defaultValue = { contactsCount: 0, conversationsCount: 0, sources: [] };
+		const billablePeriod = moment.utc().format('YYYY-MM');
+		statsPms.push(
+			LivechatRooms.getMACStatisticsForPeriod(billablePeriod).then(([result]) => {
+				statistics.omnichannelContactsBySource = result || defaultValue;
+			}),
+		);
+
+		const monthAgo = moment.utc().subtract(30, 'days').toDate();
+		const today = moment.utc().toDate();
+		statsPms.push(
+			LivechatRooms.getMACStatisticsBetweenDates(monthAgo, today).then(([result]) => {
+				statistics.uniqueContactsOfLastMonth = result || defaultValue;
+			}),
+		);
+
+		const weekAgo = moment.utc().subtract(7, 'days').toDate();
+		statsPms.push(
+			LivechatRooms.getMACStatisticsBetweenDates(weekAgo, today).then(([result]) => {
+				statistics.uniqueContactsOfLastWeek = result || defaultValue;
+			}),
+		);
+
+		const yesterday = moment.utc().subtract(1, 'days').toDate();
+		statsPms.push(
+			LivechatRooms.getMACStatisticsBetweenDates(yesterday, today).then(([result]) => {
+				statistics.uniqueContactsOfYesterday = result || defaultValue;
+			}),
+		);
+
 		// Message statistics
 		statistics.totalChannelMessages = (await Rooms.findByType('c', { projection: { msgs: 1 } }).toArray()).reduce(
 			function _countChannelMessages(num: number, room: IRoom) {

diff --git a/apps/meteor/client/views/admin/info/DeploymentCard.stories.tsx b/apps/meteor/client/views/admin/info/DeploymentCard.stories.tsx
@@ -170,6 +170,10 @@ export default {
 			uniqueOSOfYesterday: { data: [], day: 0, month: 0, year: 0 },
 			uniqueOSOfLastWeek: { data: [], day: 0, month: 0, year: 0 },
 			uniqueOSOfLastMonth: { data: [], day: 0, month: 0, year: 0 },
+			omnichannelContactsBySource: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfLastMonth: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfLastWeek: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfYesterday: { contactsCount: 0, conversationsCount: 0, sources: [] },
 			apps: {
 				engineVersion: 'x.y.z',
 				enabled: false,

diff --git a/apps/meteor/client/views/admin/info/InformationPage.stories.tsx b/apps/meteor/client/views/admin/info/InformationPage.stories.tsx
@@ -200,6 +200,10 @@ export default {
 			uniqueOSOfYesterday: { data: [], day: 0, month: 0, year: 0 },
 			uniqueOSOfLastWeek: { data: [], day: 0, month: 0, year: 0 },
 			uniqueOSOfLastMonth: { data: [], day: 0, month: 0, year: 0 },
+			omnichannelContactsBySource: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfLastMonth: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfLastWeek: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfYesterday: { contactsCount: 0, conversationsCount: 0, sources: [] },
 			apps: {
 				engineVersion: 'x.y.z',
 				enabled: false,

diff --git a/apps/meteor/client/views/admin/info/UsageCard.stories.tsx b/apps/meteor/client/views/admin/info/UsageCard.stories.tsx
@@ -148,6 +148,10 @@ export default {
 			uniqueOSOfYesterday: { data: [], day: 0, month: 0, year: 0 },
 			uniqueOSOfLastWeek: { data: [], day: 0, month: 0, year: 0 },
 			uniqueOSOfLastMonth: { data: [], day: 0, month: 0, year: 0 },
+			omnichannelContactsBySource: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfLastMonth: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfLastWeek: { contactsCount: 0, conversationsCount: 0, sources: [] },
+			uniqueContactsOfYesterday: { contactsCount: 0, conversationsCount: 0, sources: [] },
 			apps: {
 				engineVersion: 'x.y.z',
 				enabled: false,

diff --git a/apps/meteor/server/models/raw/LivechatRooms.ts b/apps/meteor/server/models/raw/LivechatRooms.ts
@@ -8,6 +8,7 @@ import type {
 	ILivechatPriority,
 	IOmnichannelServiceLevelAgreements,
 	ReportResult,
+	MACStats,
 } from '@rocket.chat/core-typings';
 import { UserStatus } from '@rocket.chat/core-typings';
 import type { ILivechatRoomsModel } from '@rocket.chat/model-typings';
@@ -74,6 +75,7 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 			{ key: { departmentId: 1, ts: 1 }, partialFilterExpression: { departmentId: { $exists: true }, t: 'l' } },
 			{ key: { 'tags.0': 1, 'ts': 1 }, partialFilterExpression: { 'tags.0': { $exists: true }, 't': 'l' } },
 			{ key: { servedBy: 1, ts: 1 }, partialFilterExpression: { servedBy: { $exists: true }, t: 'l' } },
+			{ key: { 'v.activity': 1, 'ts': 1 }, partialFilterExpression: { 'v.activity': { $exists: true }, 't': 'l' } },
 		];
 	}
 
@@ -2462,6 +2464,126 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 		return this.updateOne(query, update);
 	}
 
+	async getMACStatisticsForPeriod(period: string): Promise<MACStats[]> {
+		return this.col
+			.aggregate<MACStats>([
+				{
+					$match: {
+						't': 'l',
+						'v.activity': period,
+					},
+				},
+				{
+					$group: {
+						_id: {
+							source: {
+								$ifNull: ['$source.alias', '$source.type'],
+							},
+						},
+						contactsCount: {
+							$addToSet: '$v._id',
+						},
+						conversationsCount: {
+							$sum: 1,
+						},
+					},
+				},
+				{
+					$group: {
+						_id: null,
+						sources: {
+							$push: {
+								source: '$_id.source',
+								contactsCount: {
+									$size: '$contactsCount',
+								},
+								conversationsCount: '$conversationsCount',
+							},
+						},
+						totalContactsCount: {
+							$sum: {
+								$size: '$contactsCount',
+							},
+						},
+						totalConversationsCount: {
+							$sum: '$conversationsCount',
+						},
+					},
+				},
+				{
+					$project: {
+						_id: 0,
+						contactsCount: '$totalContactsCount',
+						conversationsCount: '$totalConversationsCount',
+						sources: 1,
+					},
+				},
+			])
+			.toArray();
+	}
+
+	async getMACStatisticsBetweenDates(start: Date, end: Date): Promise<MACStats[]> {
+		return this.col
+			.aggregate<MACStats>([
+				{
+					$match: {
+						't': 'l',
+						'v.activity': { $exists: true },
+						'ts': {
+							$gte: start,
+							$lt: end,
+						},
+					},
+				},
+				{
+					$group: {
+						_id: {
+							source: {
+								$ifNull: ['$source.alias', '$source.type'],
+							},
+						},
+						contactsCount: {
+							$addToSet: '$v._id',
+						},
+						conversationsCount: {
+							$sum: 1,
+						},
+					},
+				},
+				{
+					$group: {
+						_id: null,
+						sources: {
+							$push: {
+								source: '$_id.source',
+								contactsCount: {
+									$size: '$contactsCount',
+								},
+								conversationsCount: '$conversationsCount',
+							},
+						},
+						totalContactsCount: {
+							$sum: {
+								$size: '$contactsCount',
+							},
+						},
+						totalConversationsCount: {
+							$sum: '$conversationsCount',
+						},
+					},
+				},
+				{
+					$project: {
+						_id: 0,
+						contactsCount: '$totalContactsCount',
+						conversationsCount: '$totalConversationsCount',
+						sources: 1,
+					},
+				},
+			])
+			.toArray();
+	}
+
 	async unsetAllPredictedVisitorAbandonment(): Promise<void> {
 		throw new Error('Method not implemented.');
 	}

diff --git a/apps/meteor/server/models/raw/LivechatVisitors.ts b/apps/meteor/server/models/raw/LivechatVisitors.ts
@@ -439,6 +439,12 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 			},
 		);
 	}
+
+	countVisitorsOnPeriod(period: string): Promise<number> {
+		return this.countDocuments({
+			activity: period,
+		});
+	}
 }
 
 type DeepWriteable<T> = { -readonly [P in keyof T]: DeepWriteable<T[P]> };
diff --git a/packages/core-typings/src/IStats.ts b/packages/core-typings/src/IStats.ts
@@ -3,6 +3,7 @@ import type { CpuInfo } from 'os';
 import type { DeviceSessionAggregationResult, OSSessionAggregationResult, UserSessionAggregationResult } from './ISession';
 import type { ISettingStatisticsObject } from './ISetting';
 import type { ITeamStats } from './ITeam';
+import type { MACStats } from './omnichannel';
 
 export interface IStats {
 	_id: string;
@@ -85,6 +86,10 @@ export interface IStats {
 	mongoStorageEngine: string;
 	pushQueue: number;
 	omnichannelSources: { [key: string]: number | string }[];
+	omnichannelContactsBySource: MACStats;
+	uniqueContactsOfLastMonth: MACStats;
+	uniqueContactsOfLastWeek: MACStats;
+	uniqueContactsOfYesterday: MACStats;
 	departments: number;
 	archivedDepartments: number;
 	routingAlgorithm: string;

diff --git a/packages/core-typings/src/omnichannel/index.ts b/packages/core-typings/src/omnichannel/index.ts
@@ -2,3 +2,4 @@ export * from './sms';
 export * from './routing';
 export * from './queue';
 export * from './reports';
+export * from './mac';
diff --git a/packages/core-typings/src/omnichannel/mac.ts b/packages/core-typings/src/omnichannel/mac.ts
@@ -0,0 +1,5 @@
+export type MACStats = {
+	contactsCount: number;
+	conversationsCount: number;
+	sources: { source: string; contactsCount: number; conversationsCount: number }[];
+};
diff --git a/packages/model-typings/src/models/ILivechatRoomsModel.ts b/packages/model-typings/src/models/ILivechatRoomsModel.ts
@@ -1,4 +1,11 @@
-import type { IMessage, IOmnichannelRoom, IOmnichannelRoomClosingInfo, ISetting, ILivechatVisitor } from '@rocket.chat/core-typings';
+import type {
+	IMessage,
+	IOmnichannelRoom,
+	IOmnichannelRoomClosingInfo,
+	ISetting,
+	ILivechatVisitor,
+	MACStats,
+} from '@rocket.chat/core-typings';
 import type { FindCursor, UpdateResult, AggregationCursor, Document, FindOptions, DeleteResult, Filter } from 'mongodb';
 
 import type { FindPaginated } from '..';
@@ -235,4 +242,6 @@ export interface ILivechatRoomsModel extends IBaseModel<IOmnichannelRoom> {
 	changeVisitorByRoomId(roomId: string, visitor: { _id: string; username: string; token: string }): Promise<UpdateResult>;
 	unarchiveOneById(roomId: string): Promise<UpdateResult>;
 	markVisitorActiveForPeriod(rid: string, period: string): Promise<UpdateResult>;
+	getMACStatisticsForPeriod(period: string): Promise<MACStats[]>;
+	getMACStatisticsBetweenDates(start: Date, end: Date): Promise<MACStats[]>;
 }
diff --git a/packages/model-typings/src/models/ILivechatVisitorsModel.ts b/packages/model-typings/src/models/ILivechatVisitorsModel.ts
@@ -58,4 +58,6 @@ export interface ILivechatVisitorsModel extends IBaseModel<ILivechatVisitor> {
 	disableById(_id: string): Promise<UpdateResult>;
 
 	findEnabled(query: Filter<ILivechatVisitor>, options?: FindOptions<ILivechatVisitor>): FindCursor<ILivechatVisitor>;
+
+	countVisitorsOnPeriod(period: string): Promise<number>;
 }