feat(backend): expose read count to clients

Author: qmaster0803

apps/meteor/app/api/server/v1/chat.ts

@@ -29,6 +29,7 @@ import {
 	isChatSyncThreadMessagesProps,
 	isChatGetStarredMessagesProps,
 	isChatGetDiscussionsProps,
+	isChatGetMessageReadCountProps,
 	validateBadRequestErrorResponse,
 	validateUnauthorizedErrorResponse,
 } from '@rocket.chat/rest-typings';
@@ -48,6 +49,7 @@ import { processWebhookMessage } from '../../../lib/server/functions/processWebh
 import { getSingleMessage } from '../../../lib/server/methods/getSingleMessage';
 import { executeSendMessage } from '../../../lib/server/methods/sendMessage';
 import { executeUpdateMessage } from '../../../lib/server/methods/updateMessage';
+import { getMessageReadCount as getMessageReadCountHelper } from '../../../read-counter/server/getMessageReadCount';
 import { applyAirGappedRestrictionsValidation } from '../../../license/server/airGappedRestrictionsWrapper';
 import { pinMessage, unpinMessage } from '../../../message-pin/server/pinMessage';
 import { starMessage } from '../../../message-star/server/starMessage';
@@ -174,6 +176,37 @@ API.v1.addRoute(
 	},
 );
 
+API.v1.addRoute(
+	'chat.getMessageReadCount',
+	{
+		authRequired: true,
+		validateParams: isChatGetMessageReadCountProps,
+	},
+	{
+		async get() {
+			const { messageId } = this.queryParams;
+
+			const message = await Messages.findOneById(messageId, { projection: { rid: 1 } });
+
+			if (!message) {
+				return API.v1.failure('The required "messageId" param is missing or invalid.');
+			}
+
+			if (!(await canAccessRoomIdAsync(message.rid, this.userId))) {
+				throw new Meteor.Error('error-not-allowed', 'Not allowed');
+			}
+
+			const result = await getMessageReadCountHelper(messageId, this.userId);
+
+			if (!result) {
+				return API.v1.failure();
+			}
+
+			return API.v1.success(result);
+		},
+	},
+);
+
 type ChatPinMessage = {
 	messageId: IMessage['_id'];
 };

apps/meteor/server/methods/getMessageReadCount.ts

@@ -0,0 +1,27 @@
+import type { IMessage } from '@rocket.chat/core-typings';
+import type { ServerMethods } from '@rocket.chat/ddp-client';
+import { check } from 'meteor/check';
+import { Meteor } from 'meteor/meteor';
+
+import { getMessageReadCount as getMessageReadCountHelper } from '../../app/read-counter/server/getMessageReadCount';
+
+declare module '@rocket.chat/ddp-client' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	interface ServerMethods {
+		getMessageReadCount(options: { messageId: IMessage['_id'] }): { readCount: number } | null;
+	}
+}
+
+Meteor.methods<ServerMethods>({
+	async getMessageReadCount({ messageId }) {
+		check(messageId, String);
+
+		const uid = Meteor.userId();
+		if (!uid) {
+			throw new Meteor.Error('error-invalid-user', 'Invalid user', { method: 'getMessageReadCount' });
+		}
+
+		return getMessageReadCountHelper(messageId, uid);
+	},
+});
+

apps/meteor/server/methods/index.ts

@@ -13,6 +13,7 @@ import './createDirectMessage';
 import './deleteFileMessage';
 import './deleteUser';
 import './getAvatarSuggestion';
+import './getMessageReadCount';
 import './getRoomById';
 import './getRoomIdByNameOrId';
 import './getRoomNameById';

packages/rest-typings/src/v1/chat.ts

@@ -574,6 +574,23 @@ const ChatGetMessageReadReceiptsSchema = {
 
 export const isChatGetMessageReadReceiptsProps = ajv.compile<ChatGetMessageReadReceipts>(ChatGetMessageReadReceiptsSchema);
 
+type ChatGetMessageReadCount = {
+	messageId: IMessage['_id'];
+};
+
+const ChatGetMessageReadCountSchema = {
+	type: 'object',
+	properties: {
+		messageId: {
+			type: 'string',
+		},
+	},
+	required: ['messageId'],
+	additionalProperties: false,
+};
+
+export const isChatGetMessageReadCountProps = ajv.compile<ChatGetMessageReadCount>(ChatGetMessageReadCountSchema);
+
 type GetStarredMessages = {
 	roomId: IRoom['_id'];
 	count?: number;
@@ -1054,6 +1071,9 @@ export type ChatEndpoints = {
 	'/v1/chat.getMessageReadReceipts': {
 		GET: (params: ChatGetMessageReadReceipts) => { receipts: IReadReceiptWithUser[] };
 	};
+	'/v1/chat.getMessageReadCount': {
+		GET: (params: ChatGetMessageReadCount) => { readCount: number };
+	};
 	'/v1/chat.getStarredMessages': {
 		GET: (params: GetStarredMessages) => {
 			messages: IMessage[];