chore(perf): optimize model aggregation pipelines and remove dead ones

.changeset/model-aggregations-perf.md

@@ -0,0 +1,7 @@
+---
+'@rocket.chat/meteor': patch
+'@rocket.chat/models': patch
+'@rocket.chat/model-typings': patch
+---
+
+Improved loading time of the Omnichannel Analytics dashboards and Engagement Dashboard "users by time of day" charts on workspaces with large message/session volumes, and sped up encrypted-room key distribution when a user resets their E2EE keys.

apps/meteor/ee/server/models/startup.ts

@@ -17,5 +17,4 @@ void License.onLicense('livechat-enterprise', () => {
 	import('./LivechatInquiry');
 	import('./LivechatDepartment');
 	import('./Users');
-	import('./LivechatDepartmentAgents');
 });

packages/model-typings/src/models/ILivechatDepartmentAgentsModel.ts

@@ -40,7 +40,6 @@ export interface ILivechatDepartmentAgentsModel extends IBaseModel<ILivechatDepa
 	): FindPaginated<FindCursor<ILivechatDepartmentAgents>>;
 
 	findByDepartmentIds(departmentIds: string[], options?: Record<string, any>): FindCursor<ILivechatDepartmentAgents>;
-	findAgentsByAgentIdAndBusinessHourId(_agentId: string, _businessHourId: string): Promise<ILivechatDepartmentAgents[]>;
 	setDepartmentEnabledByDepartmentId(departmentId: string, departmentEnabled: boolean): Promise<Document | UpdateResult>;
 	removeByDepartmentId(departmentId: string): Promise<DeleteResult>;
 	findByDepartmentId(departmentId: string, options?: FindOptions<ILivechatDepartmentAgents>): FindCursor<ILivechatDepartmentAgents>;

packages/model-typings/src/models/ILivechatRoomsModel.ts

@@ -53,8 +53,6 @@ export interface ILivechatRoomsModel extends IBaseModel<IOmnichannelRoom> {
 
 	findAllServiceTime(params: Period & WithDepartment & WithOnlyCount & WithOptions): any;
 
-	findAllNumberOfTransferredRooms(params: Period & WithDepartment & WithOptions): any;
-
 	countAllOpenChatsBetweenDate(params: Period & WithDepartment): any;
 
 	countAllClosedChatsBetweenDate(params: Period & WithDepartment): any;

packages/model-typings/src/models/IMessagesModel.ts

@@ -90,8 +90,6 @@ export interface IMessagesModel extends IBaseModel<IMessage> {
 
 	unsetFederationReactionEventId(federationEventId: string, _id: string, reaction: string): Promise<void>;
 
-	findOneByFederationIdAndUsernameOnReactions(federationEventId: string, username: string): Promise<IMessage | null>;
-
 	findOneByFederationId(federationEventId: string): Promise<IMessage | null>;
 
 	findLatestFederationThreadMessageByTmid(tmid: string, messageId: IMessage['_id']): Promise<IMessage | null>;

packages/model-typings/src/models/IRoomsModel.ts

@@ -123,15 +123,6 @@ export interface IRoomsModel extends IBaseModel<IRoom> {
 
 	setTeamDefaultById(rid: IRoom['_id'], teamDefault: NonNullable<IRoom['teamDefault']>, options?: UpdateOptions): Promise<UpdateResult>;
 
-	findChannelsByTypesWithNumberOfMessagesBetweenDate(params: {
-		types: Array<IRoom['t']>;
-		start: number;
-		end: number;
-		startOfLastWeek: number;
-		endOfLastWeek: number;
-		options?: any;
-	}): AggregationCursor<IChannelsWithNumberOfMessagesBetweenDate>;
-
 	findOneByName(name: NonNullable<IRoom['name']>, options?: FindOptions<IRoom>): Promise<IRoom | null>;
 
 	findDefaultRoomsForTeam(teamId: any): FindCursor<IRoom>;

packages/model-typings/src/models/ISessionsModel.ts

@@ -51,7 +51,6 @@ export interface ISessionsModel extends IBaseModel<ISession> {
 		count?: number;
 	}): Promise<{ sessions: Array<DeviceManagementSession>; count: number; offset: number; total: number }>;
 
-	getActiveUsersBetweenDates({ start, end }: DestructuredRange): Promise<ISession[]>;
 	findLastLoginByIp(ip: string): Promise<ISession | null>;
 	findOneBySessionId(sessionId: string): Promise<ISession | null>;
 	findOneBySessionIdAndUserId(sessionId: string, userId: string): Promise<ISession | null>;

packages/models/src/models/LivechatDepartmentAgents.ts

@@ -116,10 +116,6 @@ export class LivechatDepartmentAgentsRaw extends BaseRaw<ILivechatDepartmentAgen
 		return this.find({ departmentId: { $in: departmentIds } }, options);
 	}
 
-	async findAgentsByAgentIdAndBusinessHourId(_agentId: string, _businessHourId: string): Promise<ILivechatDepartmentAgents[]> {
-		return [];
-	}
-
 	setDepartmentEnabledByDepartmentId(departmentId: string, departmentEnabled: boolean): Promise<Document | UpdateResult> {
 		return this.updateMany({ departmentId }, { $set: { departmentEnabled } });
 	}

packages/models/src/models/LivechatInquiry.ts

@@ -63,6 +63,7 @@ export class LivechatInquiryRaw extends BaseRaw<ILivechatInquiryRecord> implemen
 			{
 				key: {
 					status: 1,
+					department: 1,
 				},
 			},
 			{
@@ -284,6 +285,7 @@ export class LivechatInquiryRaw extends BaseRaw<ILivechatInquiryRecord> implemen
 		return this.col
 			.aggregate<Pick<ILivechatInquiryRecord, '_id' | 'rid' | 'name' | 'ts' | 'status' | 'department'> & { position: number }>(filter, {
 				readPreference: readSecondaryPreferred(),
+				allowDiskUse: true,
 			})
 			.toArray();
 	}

packages/models/src/models/LivechatRooms.ts

@@ -592,135 +592,6 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 		return this.col.aggregate(params, { readPreference: readSecondaryPreferred() });
 	}
 
-	findAllNumberOfTransferredRooms({
-		start,
-		end,
-		departmentId,
-		options = {},
-	}: {
-		start: Date;
-		end: Date;
-		departmentId?: string;
-		options?: { offset?: number; count?: number; sort?: { [k: string]: number } };
-	}) {
-		const match: Document = {
-			$match: {
-				t: 'l',
-				ts: { $gte: new Date(start), $lte: new Date(end) },
-			},
-		};
-		const departmentsLookup = {
-			$lookup: {
-				from: 'rocketchat_livechat_department',
-				localField: 'departmentId',
-				foreignField: '_id',
-				as: 'departments',
-			},
-		};
-		const departmentsUnwind = {
-			$unwind: {
-				path: '$departments',
-				preserveNullAndEmptyArrays: true,
-			},
-		};
-		const departmentsGroup = {
-			$group: {
-				_id: {
-					_id: null,
-					departmentId: '$departments._id',
-					name: '$departments.name',
-				},
-				rooms: { $push: '$$ROOT' },
-			},
-		};
-		const departmentsProject = {
-			$project: {
-				_id: '$_id.departmentId',
-				name: '$_id.name',
-				rooms: 1,
-			},
-		};
-		const roomsUnwind = {
-			$unwind: {
-				path: '$rooms',
-				preserveNullAndEmptyArrays: true,
-			},
-		};
-		const messagesLookup = {
-			$lookup: {
-				from: 'rocketchat_message',
-				localField: 'rooms._id',
-				foreignField: 'rid',
-				as: 'messages',
-			},
-		};
-		const messagesProject = {
-			$project: {
-				_id: 1,
-				name: 1,
-				messages: {
-					$filter: {
-						input: '$messages',
-						as: 'message',
-						cond: {
-							$and: [{ $eq: ['$$message.t', 'livechat_transfer_history'] }],
-						},
-					},
-				},
-			},
-		};
-		const transferProject = {
-			$project: {
-				name: 1,
-				transfers: { $size: { $ifNull: ['$messages', []] } },
-			},
-		};
-		const transferGroup = {
-			$group: {
-				_id: {
-					departmentId: '$_id',
-					name: '$name',
-				},
-				numberOfTransferredRooms: { $sum: '$transfers' },
-			},
-		};
-		const presentationProject = {
-			$project: {
-				_id: { $ifNull: ['$_id.departmentId', null] },
-				name: { $ifNull: ['$_id.name', null] },
-				numberOfTransferredRooms: 1,
-			},
-		};
-		const firstParams: Document[] = [match, departmentsLookup, departmentsUnwind];
-		if (departmentId && departmentId !== 'undefined') {
-			firstParams.push({
-				$match: {
-					'departments._id': departmentId,
-				},
-			});
-		}
-		const sort = { $sort: options.sort || { name: 1 } };
-		const params: Document[] = [
-			...firstParams,
-			departmentsGroup,
-			departmentsProject,
-			roomsUnwind,
-			messagesLookup,
-			messagesProject,
-			transferProject,
-			transferGroup,
-			presentationProject,
-			sort,
-		];
-		if (options.offset) {
-			params.push({ $skip: options.offset });
-		}
-		if (options.count) {
-			params.push({ $limit: options.count });
-		}
-		return this.col.aggregate(params, { allowDiskUse: true, readPreference: readSecondaryPreferred() }).toArray();
-	}
-
 	countAllOpenChatsBetweenDate({ start, end, departmentId }: { start: Date; end: Date; departmentId?: string }) {
 		const query: Filter<IOmnichannelRoom> = {
 			't': 'l',
@@ -2167,12 +2038,11 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 						...extraMatchers,
 					},
 				},
-				{ $addFields: { roomId: '$_id' } },
 				{
 					$lookup: {
 						from: 'rocketchat_message',
 						// mongo doesn't like _id as variable name here :(
-						let: { roomId: '$roomId' },
+						let: { roomId: '$_id' },
 						pipeline: [
 							{
 								$match: {
@@ -2190,40 +2060,21 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 									},
 								},
 							},
+							{ $count: 'total' },
 						],
 						as: 'messages',
 					},
 				},
-				{
-					$unwind: {
-						path: '$messages',
-						preserveNullAndEmptyArrays: true,
-					},
-				},
-				{
-					$group: {
-						_id: {
-							_id: '$_id',
-							ts: '$ts',
-							departmentId: '$departmentId',
-							open: '$open',
-							servedBy: '$servedBy',
-							metrics: '$metrics',
-						},
-						messagesCount: {
-							$sum: 1,
-						},
-					},
-				},
 				{
 					$project: {
-						_id: '$_id._id',
-						ts: '$_id.ts',
-						departmentId: '$_id.departmentId',
-						open: '$_id.open',
-						servedBy: '$_id.servedBy',
-						metrics: '$_id.metrics',
-						msgs: '$messagesCount',
+						_id: 1,
+						ts: 1,
+						departmentId: 1,
+						open: 1,
+						servedBy: 1,
+						metrics: 1,
+						// rooms without matching messages have always reported msgs: 1 (the room doc itself survived the old $unwind+$group count)
+						msgs: { $ifNull: [{ $arrayElemAt: ['$messages.total', 0] }, 1] },
 					},
 				},
 			],
@@ -2244,12 +2095,11 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 						...(departmentId && departmentId !== 'undefined' && { departmentId }),
 					},
 				},
-				{ $addFields: { roomId: '$_id' } },
 				{
 					$lookup: {
 						from: 'rocketchat_message',
 						// mongo doesn't like _id as variable name here :(
-						let: { roomId: '$roomId' },
+						let: { roomId: '$_id' },
 						pipeline: [
 							{
 								$match: {
@@ -2266,42 +2116,22 @@ export class LivechatRoomsRaw extends BaseRaw<IOmnichannelRoom> implements ILive
 									},
 								},
 							},
+							{ $count: 'total' },
 						],
 						as: 'messages',
 					},
 				},
-				{
-					$unwind: {
-						path: '$messages',
-						preserveNullAndEmptyArrays: true,
-					},
-				},
-				{
-					$group: {
-						_id: {
-							_id: '$_id',
-							ts: '$ts',
-							departmentId: '$departmentId',
-							open: '$open',
-							servedBy: '$servedBy',
-							metrics: '$metrics',
-							onHold: '$onHold',
-						},
-						messagesCount: {
-							$sum: 1,
-						},
-					},
-				},
 				{
 					$project: {
-						_id: '$_id._id',
-						ts: '$_id.ts',
-						departmentId: '$_id.departmentId',
-						open: '$_id.open',
-						servedBy: '$_id.servedBy',
-						metrics: '$_id.metrics',
-						msgs: '$messagesCount',
-						onHold: '$_id.onHold',
+						_id: 1,
+						ts: 1,
+						departmentId: 1,
+						open: 1,
+						servedBy: 1,
+						metrics: 1,
+						onHold: 1,
+						// rooms without matching messages have always reported msgs: 1 (the room doc itself survived the old $unwind+$group count)
+						msgs: { $ifNull: [{ $arrayElemAt: ['$messages.total', 0] }, 1] },
 					},
 				},
 			],