Omit disabled visitors from queries

RocketChat · Aug 31, 2023 · 7c03abe · 7c03abe
1 parent d88839b
commit 7c03abe
Show file tree

Hide file tree

Showing 23 changed files with 59 additions and 28 deletions.
diff --git a/apps/meteor/app/apps/server/bridges/livechat.ts b/apps/meteor/app/apps/server/bridges/livechat.ts
@@ -223,7 +223,7 @@ export class AppLivechatBridge extends LivechatBridge {
 		}
 
 		return Promise.all(
-			(await LivechatVisitors.find(query).toArray()).map(
+			(await LivechatVisitors.findEnabled(query).toArray()).map(
 				async (visitor) => visitor && this.orch.getConverters()?.get('visitors').convertVisitor(visitor),
 			),
 		);

diff --git a/apps/meteor/app/apps/server/converters/rooms.js b/apps/meteor/app/apps/server/converters/rooms.js
@@ -37,7 +37,7 @@ export class AppRoomsConverter {
 
 		let v;
 		if (room.visitor) {
-			const visitor = await LivechatVisitors.findOneById(room.visitor.id);
+			const visitor = await LivechatVisitors.findOneEnabledById(room.visitor.id);
 
 			const { lastMessageTs, phone } = room.visitorChannelInfo;
 

diff --git a/apps/meteor/app/apps/server/converters/visitors.js b/apps/meteor/app/apps/server/converters/visitors.js
@@ -9,7 +9,7 @@ export class AppVisitorsConverter {
 	}
 
 	async convertById(id) {
-		const visitor = await LivechatVisitors.findOneById(id);
+		const visitor = await LivechatVisitors.findOneEnabledById(id);
 
 		return this.convertVisitor(visitor);
 	}

diff --git a/apps/meteor/app/livechat/imports/server/rest/sms.js b/apps/meteor/app/livechat/imports/server/rest/sms.js
@@ -56,7 +56,7 @@ const defineVisitor = async (smsNumber, targetDepartment) => {
 	}
 
 	const id = await LivechatTyped.registerGuest(data);
-	return LivechatVisitors.findOneById(id);
+	return LivechatVisitors.findOneEnabledById(id);
 };
 
 const normalizeLocationSharing = (payload) => {

diff --git a/apps/meteor/app/livechat/server/api/lib/visitors.ts b/apps/meteor/app/livechat/server/api/lib/visitors.ts
@@ -6,7 +6,7 @@ import { callbacks } from '../../../../../lib/callbacks';
 import { canAccessRoomAsync } from '../../../../authorization/server/functions/canAccessRoom';
 
 export async function findVisitorInfo({ visitorId }: { visitorId: IVisitor['_id'] }) {
-	const visitor = await LivechatVisitors.findOneById(visitorId);
+	const visitor = await LivechatVisitors.findOneEnabledById(visitorId);
 	if (!visitor) {
 		throw new Error('visitor-not-found');
 	}

diff --git a/apps/meteor/app/livechat/server/api/v1/contact.ts b/apps/meteor/app/livechat/server/api/v1/contact.ts
@@ -33,7 +33,7 @@ API.v1.addRoute(
 				contactId: String,
 			});
 
-			const contact = await LivechatVisitors.findOneById(this.queryParams.contactId);
+			const contact = await LivechatVisitors.findOneEnabledById(this.queryParams.contactId);
 
 			return API.v1.success({ contact });
 		},

diff --git a/apps/meteor/app/livechat/server/api/v1/message.ts b/apps/meteor/app/livechat/server/api/v1/message.ts
@@ -269,7 +269,7 @@ API.v1.addRoute(
 				guest.connectionData = normalizeHttpHeaderData(this.request.headers);
 
 				const visitorId = await LivechatTyped.registerGuest(guest);
-				visitor = await LivechatVisitors.findOneById(visitorId);
+				visitor = await LivechatVisitors.findOneEnabledById(visitorId);
 			}
 
 			const sentMessages = await Promise.all(

diff --git a/apps/meteor/app/livechat/server/api/v1/room.ts b/apps/meteor/app/livechat/server/api/v1/room.ts
@@ -326,7 +326,7 @@ API.v1.addRoute(
 				throw new Error('This_conversation_is_already_closed');
 			}
 
-			const guest = await LivechatVisitors.findOneById(room.v?._id);
+			const guest = await LivechatVisitors.findOneEnabledById(room.v?._id);
 			const transferedBy = this.user satisfies TransferByData;
 			transferData.transferredBy = normalizeTransferredByData(transferedBy, room);
 			if (transferData.userId) {

diff --git a/apps/meteor/app/livechat/server/api/v1/visitor.ts b/apps/meteor/app/livechat/server/api/v1/visitor.ts
@@ -45,7 +45,7 @@ API.v1.addRoute('livechat/visitor', {
 
 		const visitorId = await LivechatTyped.registerGuest(guest);
 
-		let visitor = await VisitorsRaw.findOneById(visitorId, {});
+		let visitor = await VisitorsRaw.findOneEnabledById(visitorId, {});
 		if (visitor) {
 			const extraQuery = await callbacks.run('livechat.applyRoomRestrictions', {});
 			// If it's updating an existing visitor, it must also update the roomInfo
@@ -65,7 +65,7 @@ API.v1.addRoute('livechat/visitor', {
 				}
 			}
 
-			visitor = await VisitorsRaw.findOneById(visitorId, {});
+			visitor = await VisitorsRaw.findOneEnabledById(visitorId, {});
 		}
 
 		if (!visitor) {

diff --git a/apps/meteor/app/livechat/server/lib/Livechat.js b/apps/meteor/app/livechat/server/lib/Livechat.js
@@ -298,7 +298,7 @@ export const Livechat = {
 	async forwardOpenChats(userId) {
 		Livechat.logger.debug(`Transferring open chats for user ${userId}`);
 		for await (const room of LivechatRooms.findOpenByAgent(userId)) {
-			const guest = await LivechatVisitors.findOneById(room.v._id);
+			const guest = await LivechatVisitors.findOneEnabledById(room.v._id);
 			const user = await Users.findOneById(userId);
 			const { _id, username, name } = user;
 			const transferredBy = normalizeTransferredByData({ _id, username, name }, room);
@@ -462,7 +462,7 @@ export const Livechat = {
 	},
 
 	async getLivechatRoomGuestInfo(room) {
-		const visitor = await LivechatVisitors.findOneById(room.v._id);
+		const visitor = await LivechatVisitors.findOneEnabledById(room.v._id);
 		const agent = await Users.findOneById(room.servedBy && room.servedBy._id);
 
 		const ua = new UAParser();
@@ -630,6 +630,11 @@ export const Livechat = {
 	async cleanGuestHistory(guest) {
 		const { token } = guest;
 
+		// This shouldn't be possible, but just in case
+		if (!token) {
+			throw new Error('error-invalid-guest');
+		}
+
 		const extraQuery = await callbacks.run('livechat.applyRoomRestrictions', {});
 		const cursor = LivechatRooms.findByVisitorToken(token, extraQuery);
 		for await (const room of cursor) {

diff --git a/apps/meteor/app/livechat/server/lib/LivechatTyped.ts b/apps/meteor/app/livechat/server/lib/LivechatTyped.ts
@@ -305,7 +305,7 @@ class LivechatClass {
 			!(await LivechatDepartment.findOneById<Pick<ILivechatDepartment, '_id'>>(guest.department, { projection: { _id: 1 } }))
 		) {
 			await LivechatVisitors.removeDepartmentById(guest._id);
-			const tmpGuest = await LivechatVisitors.findOneById(guest._id);
+			const tmpGuest = await LivechatVisitors.findOneEnabledById(guest._id);
 			if (tmpGuest) {
 				guest = tmpGuest;
 			}

diff --git a/apps/meteor/app/livechat/server/methods/transfer.ts b/apps/meteor/app/livechat/server/methods/transfer.ts
@@ -58,7 +58,7 @@ Meteor.methods<ServerMethods>({
 			});
 		}
 
-		const guest = await LivechatVisitors.findOneById(room.v?._id);
+		const guest = await LivechatVisitors.findOneEnabledById(room.v?._id);
 
 		const user = await Meteor.userAsync();
 

diff --git a/apps/meteor/ee/app/canned-responses/server/hooks/onMessageSentParsePlaceholder.ts b/apps/meteor/ee/app/canned-responses/server/hooks/onMessageSentParsePlaceholder.ts
@@ -48,7 +48,7 @@ const handleBeforeSaveMessage = async (message: IMessage, room?: IOmnichannelRoo
 	}
 	const visitorId = room?.v?._id;
 	const agent = (await Users.findOneById(agentId, { projection: { name: 1, _id: 1, emails: 1 } })) || {};
-	const visitor = visitorId && ((await LivechatVisitors.findOneById(visitorId, {})) || {});
+	const visitor = visitorId && ((await LivechatVisitors.findOneEnabledById(visitorId, {})) || {});
 
 	Object.keys(placeholderFields).map((field) => {
 		const templateKey = `{{${field}}}`;

diff --git a/apps/meteor/ee/app/livechat-enterprise/server/hooks/handleNextAgentPreferredEvents.ts b/apps/meteor/ee/app/livechat-enterprise/server/hooks/handleNextAgentPreferredEvents.ts
@@ -90,7 +90,7 @@ callbacks.add(
 		}
 
 		const { _id: guestId } = defaultGuest;
-		const guest = await LivechatVisitors.findOneById(guestId, {
+		const guest = await LivechatVisitors.findOneEnabledById(guestId, {
 			projection: { lastAgent: 1, token: 1, contactManager: 1 },
 		});
 		if (!guest) {

diff --git a/apps/meteor/ee/app/livechat-enterprise/server/hooks/resumeOnHold.ts b/apps/meteor/ee/app/livechat-enterprise/server/hooks/resumeOnHold.ts
@@ -12,7 +12,7 @@ const resumeOnHoldCommentAndUser = async (room: IOmnichannelRoom): Promise<{ com
 		v: { _id: visitorId },
 		_id: rid,
 	} = room;
-	const visitor = await LivechatVisitors.findOneById<Pick<ILivechatVisitor, 'name' | 'username'>>(visitorId, {
+	const visitor = await LivechatVisitors.findOneEnabledById<Pick<ILivechatVisitor, 'name' | 'username'>>(visitorId, {
 		projection: { name: 1, username: 1 },
 	});
 	if (!visitor) {

diff --git a/apps/meteor/ee/app/livechat-enterprise/server/lib/VisitorInactivityMonitor.ts b/apps/meteor/ee/app/livechat-enterprise/server/lib/VisitorInactivityMonitor.ts
@@ -160,7 +160,7 @@ export class VisitorInactivityMonitor {
 	}
 
 	private async getDefaultAbandonedCustomMessage(abandonmentAction: 'close' | 'on-hold', visitorId: string) {
-		const visitor = await LivechatVisitors.findOneById<Pick<ILivechatVisitor, 'name' | 'username'>>(visitorId, {
+		const visitor = await LivechatVisitors.findOneEnabledById<Pick<ILivechatVisitor, 'name' | 'username'>>(visitorId, {
 			projection: {
 				name: 1,
 				username: 1,

diff --git a/apps/meteor/ee/app/livechat-enterprise/server/methods/resumeOnHold.ts b/apps/meteor/ee/app/livechat-enterprise/server/methods/resumeOnHold.ts
@@ -19,7 +19,7 @@ async function resolveOnHoldCommentInfo(options: { clientAction: boolean }, room
 	const {
 		v: { _id: visitorId },
 	} = room;
-	const visitor = await LivechatVisitors.findOneById<Pick<ILivechatVisitor, 'name' | 'username'>>(visitorId, {
+	const visitor = await LivechatVisitors.findOneEnabledById<Pick<ILivechatVisitor, 'name' | 'username'>>(visitorId, {
 		projection: { name: 1, username: 1 },
 	});
 	if (!visitor) {

diff --git a/apps/meteor/server/features/EmailInbox/EmailInbox_Incoming.ts b/apps/meteor/server/features/EmailInbox/EmailInbox_Incoming.ts
@@ -43,7 +43,7 @@ async function getGuestByEmail(email: string, name: string, department = ''): Pr
 				return guest;
 			}
 			await LivechatTyped.setDepartmentForGuest({ token: guest.token, department });
-			return LivechatVisitors.findOneById(guest._id, {});
+			return LivechatVisitors.findOneEnabledById(guest._id, {});
 		}
 		return guest;
 	}
@@ -59,7 +59,7 @@ async function getGuestByEmail(email: string, name: string, department = ''): Pr
 		department,
 	});
 
-	const newGuest = await LivechatVisitors.findOneById(userId);
+	const newGuest = await LivechatVisitors.findOneEnabledById(userId);
 	logger.debug(`Guest ${userId} for visitor ${email} created`);
 	if (newGuest) {
 		return newGuest;

diff --git a/apps/meteor/server/lib/rooms/roomTypes/livechat.ts b/apps/meteor/server/lib/rooms/roomTypes/livechat.ts
@@ -39,7 +39,7 @@ roomCoordinator.add(LivechatRoomType, {
 	},
 
 	async getMsgSender(senderId) {
-		return LivechatVisitors.findOneById(senderId);
+		return LivechatVisitors.findOneEnabledById(senderId);
 	},
 
 	getReadReceiptsExtraData(message) {

diff --git a/apps/meteor/server/models/raw/LivechatVisitors.ts b/apps/meteor/server/models/raw/LivechatVisitors.ts
@@ -65,18 +65,29 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 		return this.find(query, options);
 	}
 
-	findOneEnabledById(_id: string, options?: FindOptions<ILivechatVisitor>): Promise<ILivechatVisitor | null> {
+	findEnabled(query: Filter<ILivechatVisitor>, options?: FindOptions<ILivechatVisitor>): FindCursor<ILivechatVisitor> {
+		return this.find(
+			{
+				...query,
+				disabled: { $ne: true },
+			},
+			options,
+		);
+	}
+
+	findOneEnabledById<T extends ILivechatVisitor>(_id: string, options?: FindOptions<ILivechatVisitor>): Promise<T | null> {
 		const query = {
 			_id,
 			disabled: { $ne: true },
 		};
 
-		return this.findOne(query, options);
+		return this.findOne<T>(query, options);
 	}
 
 	findVisitorByToken(token: string): FindCursor<ILivechatVisitor> {
 		const query = {
 			token,
+			disabled: { $ne: true },
 		};
 
 		return this.find(query);
@@ -177,7 +188,7 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 		options?: FindOptions<ILivechatVisitor>,
 	): Promise<FindPaginated<FindCursor<ILivechatVisitor>>> {
 		if (!emailOrPhone && !nameOrUsername && allowedCustomFields.length === 0) {
-			return this.findPaginated({}, options);
+			return this.findPaginated({ disabled: { $ne: true } }, options);
 		}
 
 		const query: Filter<ILivechatVisitor> = {
@@ -204,8 +215,10 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 					: []),
 				...allowedCustomFields.map((c: string) => ({ [`livechatData.${c}`]: nameOrUsername })),
 			],
+			disabled: { $ne: true },
 		};
 
+		console.log(JSON.stringify(query));
 		return this.findPaginated(query, options);
 	}
 
@@ -215,7 +228,9 @@ export class LivechatVisitorsRaw extends BaseRaw<ILivechatVisitor> implements IL
 		customFields?: { [key: string]: RegExp },
 	): Promise<ILivechatVisitor | null> {
 		const query = Object.assign(
-			{},
+			{
+				disabled: { $ne: true },
+			},
 			{
 				...(email && { visitorEmails: { address: email } }),
 				...(phone && { phone: { phoneNumber: phone } }),

diff --git a/apps/meteor/tsconfig.typecheck.tsbuildinfo b/apps/meteor/tsconfig.typecheck.tsbuildinfo
diff --git a/ee/packages/omnichannel-services/src/OmnichannelTranscript.ts b/ee/packages/omnichannel-services/src/OmnichannelTranscript.ts
@@ -304,7 +304,8 @@ export class OmnichannelTranscript extends ServiceClass implements IOmnichannelT
 			const messages = await this.getMessagesFromRoom({ rid: room._id });
 
 			const visitor =
-				room.v && (await LivechatVisitors.findOneById(room.v._id, { projection: { _id: 1, name: 1, username: 1, visitorEmails: 1 } }));
+				room.v &&
+				(await LivechatVisitors.findOneEnabledById(room.v._id, { projection: { _id: 1, name: 1, username: 1, visitorEmails: 1 } }));
 			const agent =
 				room.servedBy && (await Users.findOneAgentById(room.servedBy._id, { projection: { _id: 1, name: 1, username: 1, utcOffset: 1 } }));
 

diff --git a/packages/model-typings/src/models/ILivechatVisitorsModel.ts b/packages/model-typings/src/models/ILivechatVisitorsModel.ts
@@ -48,8 +48,17 @@ export interface ILivechatVisitorsModel extends IBaseModel<ILivechatVisitor> {
 	updateById(_id: string, update: UpdateFilter<ILivechatVisitor>): Promise<Document | UpdateResult>;
 
 	saveGuestEmailPhoneById(_id: string, emails: string[], phones: string[]): Promise<UpdateResult | Document | void>;
+
 	isVisitorActiveOnPeriod(visitorId: string, period: string): Promise<boolean>;
+
 	markVisitorActiveForPeriod(visitorId: string, period: string): Promise<UpdateResult>;
-	findOneEnabledById(_id: string, options?: FindOptions<ILivechatVisitor>): Promise<ILivechatVisitor | null>;
+
+	findOneEnabledById<T extends ILivechatVisitor = ILivechatVisitor>(
+		_id: string,
+		options?: FindOptions<ILivechatVisitor>,
+	): Promise<T | null>;
+
 	disableById(_id: string): Promise<UpdateResult>;
+
+	findEnabled(query: Filter<ILivechatVisitor>, options?: FindOptions<ILivechatVisitor>): FindCursor<ILivechatVisitor>;
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,7 +58,7 @@ Meteor.methods<ServerMethods>({ @@
     			});
     		}
-    		const guest = await LivechatVisitors.findOneById(room.v?._id);
+    		const guest = await LivechatVisitors.findOneEnabledById(room.v?._id);
     		const user = await Meteor.userAsync();
@@ Expand Down @@