chore: Rooms store (RocketChat#36439)

Co-authored-by: juliajforesti <juliajforesti@gmail.com>
Co-authored-by: Tasso <tasso.evangelista@rocket.chat>

Author: 3 people

apps/meteor/app/e2e/client/rocketchat.e2e.room.ts

@@ -335,9 +335,8 @@ export class E2ERoom extends Emitter {
 		}
 
 		try {
-			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			const room = Rooms.findOne({ _id: this.roomId })!;
-			if (!room.e2eKeyId) {
+			const room = Rooms.state.get(this.roomId);
+			if (!room?.e2eKeyId) {
 				this.setState(E2ERoomState.CREATING_KEYS);
 				await this.createGroupKey();
 				this.setState(E2ERoomState.READY);

apps/meteor/app/e2e/client/rocketchat.e2e.ts

@@ -32,7 +32,6 @@ import * as banners from '../../../client/lib/banners';
 import type { LegacyBannerPayload } from '../../../client/lib/banners';
 import { dispatchToastMessage } from '../../../client/lib/toast';
 import { mapMessageFromApi } from '../../../client/lib/utils/mapMessageFromApi';
-import { waitUntilFind } from '../../../client/lib/utils/waitUntilFind';
 import EnterE2EPasswordModal from '../../../client/views/e2e/EnterE2EPasswordModal';
 import SaveE2EPasswordModal from '../../../client/views/e2e/SaveE2EPasswordModal';
 import { createQuoteAttachment } from '../../../lib/createQuoteAttachment';
@@ -254,8 +253,24 @@ class E2E extends Emitter {
 		);
 	}
 
+	private waitForRoom(rid: IRoom['_id']): Promise<IRoom> {
+		return new Promise((resolve) => {
+			const room = Rooms.state.get(rid);
+
+			if (room) resolve(room);
+
+			const unsubscribe = Rooms.use.subscribe((state) => {
+				const room = state.get(rid);
+				if (room) {
+					unsubscribe();
+					resolve(room);
+				}
+			});
+		});
+	}
+
 	async getInstanceByRoomId(rid: IRoom['_id']): Promise<E2ERoom | null> {
-		const room = await waitUntilFind(() => Rooms.findOne({ _id: rid }));
+		const room = await this.waitForRoom(rid);
 
 		if (room.t !== 'd' && room.t !== 'p') {
 			return null;
@@ -846,11 +861,12 @@ class E2E extends Emitter {
 			return;
 		}
 
+		const predicate = (record: IRoom) =>
+			Boolean('usersWaitingForE2EKeys' in record && record.usersWaitingForE2EKeys?.every((user) => user.userId !== Meteor.userId()));
+
 		const keyDistribution = async () => {
-			const roomIds = Rooms.find({
-				'usersWaitingForE2EKeys': { $exists: true },
-				'usersWaitingForE2EKeys.userId': { $ne: Meteor.userId() },
-			}).map((room) => room._id);
+			const roomIds = Rooms.state.filter(predicate).map((room) => room._id);
+
 			if (!roomIds.length) {
 				return;
 			}

apps/meteor/app/lib/client/methods/sendMessage.ts

@@ -36,7 +36,7 @@ Meteor.methods<ServerMethods>({
 		}
 
 		// If the room is federated, send the message to matrix only
-		const room = Rooms.findOne({ _id: message.rid }, { fields: { federated: 1, name: 1 } });
+		const room = Rooms.state.get(message.rid);
 		if (room?.federated) {
 			return;
 		}

apps/meteor/app/livechat/client/lib/stream/queueManager.ts

@@ -45,9 +45,11 @@ const processInquiryEvent = async (args: unknown): Promise<void> => {
 };
 
 const invalidateRoomQueries = async (rid: string) => {
-	await queryClient.invalidateQueries({ queryKey: ['rooms', { reference: rid, type: 'l' }] });
-	queryClient.removeQueries({ queryKey: roomsQueryKeys.room(rid) });
-	queryClient.removeQueries({ queryKey: roomsQueryKeys.info(rid) });
+	await Promise.all([
+		queryClient.invalidateQueries({ queryKey: ['rooms', { reference: rid, type: 'l' }] }),
+		queryClient.invalidateQueries({ queryKey: roomsQueryKeys.room(rid) }),
+		queryClient.invalidateQueries({ queryKey: roomsQueryKeys.info(rid) }),
+	]);
 };
 
 const removeInquiry = async (inquiry: ILivechatInquiryRecord) => {

apps/meteor/app/models/client/models/CachedChatRoom.ts

@@ -3,13 +3,15 @@ import { DEFAULT_SLA_CONFIG, LivechatPriorityWeight } from '@rocket.chat/core-ty
 import type { SubscriptionWithRoom } from '@rocket.chat/ui-contexts';
 
 import { CachedChatSubscription } from './CachedChatSubscription';
-import { PrivateCachedCollection } from '../../../../client/lib/cachedCollections/CachedCollection';
+import { PrivateCachedStore } from '../../../../client/lib/cachedCollections/CachedCollection';
+import { createDocumentMapStore } from '../../../../client/lib/cachedCollections/DocumentMapStore';
 
-class CachedChatRoom extends PrivateCachedCollection<IRoom> {
+class CachedChatRoom extends PrivateCachedStore<IRoom> {
 	constructor() {
 		super({
 			name: 'rooms',
 			eventType: 'notify-user',
+			store: createDocumentMapStore(),
 		});
 	}
 

apps/meteor/app/models/client/models/CachedChatSubscription.ts

@@ -21,7 +21,7 @@ class CachedChatSubscription extends PrivateCachedCollection<SubscriptionWithRoo
 	}
 
 	protected override mapRecord(subscription: ISubscription): SubscriptionWithRoom {
-		const room = CachedChatRoom.collection.state.find((r) => r._id === subscription.rid);
+		const room = CachedChatRoom.store.getState().find((r) => r._id === subscription.rid);
 
 		const lastRoomUpdate = room?.lm || subscription.ts || room?.ts;
 

apps/meteor/app/models/client/models/Rooms.ts

@@ -1,4 +1,9 @@
 import { CachedChatRoom } from './CachedChatRoom';
 
 /** @deprecated new code refer to Minimongo collections like this one; prefer fetching data from the REST API, listening to changes via streamer events, and storing the state in a Tanstack Query */
-export const Rooms = CachedChatRoom.collection;
+export const Rooms = {
+	use: CachedChatRoom.store,
+	get state() {
+		return this.use.getState();
+	},
+} as const;

apps/meteor/app/reactions/client/methods/setReaction.ts

@@ -1,4 +1,4 @@
-import type { IMessage, IRoom } from '@rocket.chat/core-typings';
+import type { IMessage } from '@rocket.chat/core-typings';
 import type { ServerMethods } from '@rocket.chat/ddp-client';
 import { Meteor } from 'meteor/meteor';
 
@@ -23,7 +23,7 @@ Meteor.methods<ServerMethods>({
 			return false;
 		}
 
-		const room: IRoom | undefined = Rooms.findOne({ _id: message.rid });
+		const room = Rooms.state.get(message.rid);
 		if (!room) {
 			return false;
 		}
@@ -36,7 +36,7 @@ Meteor.methods<ServerMethods>({
 			return false;
 		}
 
-		if (roomCoordinator.readOnly(room._id, user)) {
+		if (roomCoordinator.readOnly(room, user)) {
 			return false;
 		}
 

apps/meteor/app/slashcommands-topic/client/topic.ts

@@ -13,7 +13,7 @@ slashCommands.add({
 		if (hasPermission('edit-room', message.rid)) {
 			try {
 				await sdk.call('saveRoomSettings', message.rid, 'roomTopic', params);
-				await callbacks.run('roomTopicChanged', Rooms.findOne(message.rid));
+				await callbacks.run('roomTopicChanged', Rooms.state.get(message.rid));
 			} catch (error: unknown) {
 				dispatchToastMessage({ type: 'error', message: error });
 				throw error;

apps/meteor/app/webrtc/client/actionLink.tsx

@@ -7,7 +7,7 @@ import { sdk } from '../../utils/client/lib/SDKClient';
 import { t } from '../../utils/lib/i18n';
 
 actionLinks.register('joinLivechatWebRTCCall', (message: IMessage) => {
-	const room = Rooms.findOne({ _id: message.rid });
+	const room = Rooms.state.get(message.rid);
 	if (!room) {
 		throw new Error('Room not found');
 	}
@@ -20,7 +20,7 @@ actionLinks.register('joinLivechatWebRTCCall', (message: IMessage) => {
 });
 
 actionLinks.register('endLivechatWebRTCCall', async (message: IMessage) => {
-	const room = Rooms.findOne({ _id: message.rid });
+	const room = Rooms.state.get(message.rid);
 	if (!room) {
 		throw new Error('Room not found');
 	}