[BREAK] Move read-receipts to EE and threads check marks improvements

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

@@ -366,31 +366,6 @@ API.v1.addRoute(
 	},
 );
 
-API.v1.addRoute(
-	'chat.getMessageReadReceipts',
-	{ authRequired: true },
-	{
-		async get() {
-			const { messageId } = this.queryParams;
-			if (!messageId) {
-				return API.v1.failure({
-					error: "The required 'messageId' param is missing.",
-				});
-			}
-
-			try {
-				return API.v1.success({
-					receipts: await Meteor.call('getReadReceipts', { messageId }),
-				});
-			} catch (error) {
-				return API.v1.failure({
-					error: error.message,
-				});
-			}
-		},
-	},
-);
-
 API.v1.addRoute(
 	'chat.reportMessage',
 	{ authRequired: true },

apps/meteor/app/lib/server/startup/settings.ts

@@ -1179,6 +1179,23 @@ settingsRegistry.addGroup('Message', function () {
 			public: true,
 		});
 	});
+	this.section('Read_Receipts', function () {
+		this.add('Message_Read_Receipt_Enabled', false, {
+			type: 'boolean',
+			enterprise: true,
+			invalidValue: false,
+			modules: ['message-read-receipt'],
+			public: true,
+		});
+		this.add('Message_Read_Receipt_Store_Users', false, {
+			type: 'boolean',
+			enterprise: true,
+			invalidValue: false,
+			modules: ['message-read-receipt'],
+			public: true,
+			enableQuery: { _id: 'Message_Read_Receipt_Enabled', value: true },
+		});
+	});
 	this.add('Message_AllowEditing', true, {
 		type: 'boolean',
 		public: true,

apps/meteor/app/models/server/models/Messages.js

@@ -1059,12 +1059,38 @@ export class Messages extends Base {
 		return this.findOne(query, options);
 	}
 
-	setAsRead(rid, until) {
+	setVisibleMessagesAsRead(rid, until) {
 		return this.update(
 			{
 				rid,
 				unread: true,
 				ts: { $lt: until },
+				$or: [
+					{
+						tmid: { $exists: false },
+					},
+					{
+						tshow: true,
+					},
+				],
+			},
+			{
+				$unset: {
+					unread: 1,
+				},
+			},
+			{
+				multi: true,
+			},
+		);
+	}
+
+	setThreadMessagesAsRead(tmid, until) {
+		return this.update(
+			{
+				tmid,
+				unread: true,
+				ts: { $lt: until },
 			},
 			{
 				$unset: {
@@ -1090,10 +1116,37 @@ export class Messages extends Base {
 		);
 	}
 
-	findUnreadMessagesByRoomAndDate(rid, after) {
+	findVisibleUnreadMessagesByRoomAndDate(rid, after) {
 		const query = {
 			unread: true,
 			rid,
+			$or: [
+				{
+					tmid: { $exists: false },
+				},
+				{
+					tshow: true,
+				},
+			],
+		};
+
+		if (after) {
+			query.ts = { $gt: after };
+		}
+
+		return this.find(query, {
+			fields: {
+				_id: 1,
+			},
+		});
+	}
+
+	findUnreadThreadMessagesByDate(tmid, userId, after) {
+		const query = {
+			'u._id': { $ne: userId },
+			'unread': true,
+			tmid,
+			'tshow': { $exists: false },
 		};
 
 		if (after) {

apps/meteor/app/threads/server/methods/getThreadMessages.js

@@ -1,5 +1,6 @@
 import { Meteor } from 'meteor/meteor';
 
+import { callbacks } from '../../../../lib/callbacks';
 import { Messages, Rooms } from '../../../models/server';
 import { canAccessRoom } from '../../../authorization/server';
 import { settings } from '../../../settings/server';
@@ -33,13 +34,19 @@ Meteor.methods({
 			throw new Meteor.Error('error-not-allowed', 'Not allowed', { method: 'getThreadMessages' });
 		}
 
+		if (!thread.tcount) {
+			return [];
+		}
+
+		callbacks.run('beforeReadMessages', thread.rid, user._id);
 		readThread({ userId: user._id, rid: thread.rid, tmid });
 
 		const result = Messages.findVisibleThreadByThreadId(tmid, {
 			...(skip && { skip }),
 			...(limit && { limit }),
 			sort: { ts: -1 },
 		}).fetch();
+		callbacks.runAsync('afterReadMessages', room._id, { uid: user._id, tmid });
 
 		return [thread, ...result];
 	},

apps/meteor/app/ui-cached-collection/client/models/CachedCollection.ts

@@ -44,7 +44,7 @@ export class CachedCollection<T extends object> extends Emitter<{ changed: T; re
 
 	public eventType: EventType;
 
-	public version = 17;
+	public version = 18;
 
 	public userRelated: boolean;
 

apps/meteor/client/views/admin/info/LicenseCard.tsx

@@ -27,6 +27,7 @@ const LicenseCard = (): ReactElement => {
 	const hasOmnichannel = modules.includes('livechat-enterprise');
 	const hasAuditing = modules.includes('auditing');
 	const hasCannedResponses = modules.includes('canned-responses');
+	const hasReadReceipts = modules.includes('message-read-receipt');
 
 	const handleApplyLicense = useMutableCallback(() =>
 		setModal(
@@ -64,6 +65,7 @@ const LicenseCard = (): ReactElement => {
 									<Feature label={t('Auditing')} enabled={hasAuditing} />
 									<Feature label={t('Canned_Responses')} enabled={hasCannedResponses} />
 									<Feature label={t('Engagement_Dashboard')} enabled={hasEngagement} />
+									<Feature label={t('Read_Receipts')} enabled={hasReadReceipts} />
 								</>
 							)}
 						</Margins>

apps/meteor/ee/app/license/server/bundles.ts

@@ -13,7 +13,8 @@ export type BundleFeature =
 	| 'device-management'
 	| 'oauth-enterprise'
 	| 'federation'
-	| 'videoconference-enterprise';
+	| 'videoconference-enterprise'
+	| 'message-read-receipt';
 
 interface IBundle {
 	[key: string]: BundleFeature[];
@@ -36,6 +37,7 @@ const bundles: IBundle = {
 		'device-management',
 		'federation',
 		'videoconference-enterprise',
+		'message-read-receipt',
 	],
 	pro: [],
 };

apps/meteor/ee/app/message-read-receipt/server/hooks/afterReadMessages.ts

@@ -0,0 +1,24 @@
+import type { IUser, IRoom, IMessage } from '@rocket.chat/core-typings';
+import { MessageReads } from '@rocket.chat/core-services';
+
+import { ReadReceipt } from '../../../../server/lib/message-read-receipt/ReadReceipt';
+import { callbacks } from '../../../../../lib/callbacks';
+import { settings } from '../../../../../app/settings/server';
+
+callbacks.add(
+	'afterReadMessages',
+	(rid: IRoom['_id'], params: { uid: IUser['_id']; lastSeen?: Date; tmid?: IMessage['_id'] }) => {
+		if (!settings.get('Message_Read_Receipt_Enabled')) {
+			return;
+		}
+		const { uid, lastSeen, tmid } = params;
+
+		if (tmid) {
+			MessageReads.readThread(uid, tmid);
+		} else if (lastSeen) {
+			ReadReceipt.markMessagesAsRead(rid, uid, lastSeen);
+		}
+	},
+	callbacks.priority.MEDIUM,
+	'message-read-receipt-afterReadMessages',
+);

apps/meteor/imports/message-read-receipt/server/hooks.js → apps/meteor/ee/app/message-read-receipt/server/hooks/afterSaveMessage.ts

@@ -1,17 +1,19 @@
 import { Subscriptions } from '@rocket.chat/models';
+import type { IRoom, IMessage } from '@rocket.chat/core-typings';
+import { isEditedMessage, isOmnichannelRoom } from '@rocket.chat/core-typings';
 
-import { ReadReceipt } from './lib/ReadReceipt';
-import { callbacks } from '../../../lib/callbacks';
+import { ReadReceipt } from '../../../../server/lib/message-read-receipt/ReadReceipt';
+import { callbacks } from '../../../../../lib/callbacks';
 
 callbacks.add(
 	'afterSaveMessage',
-	(message, room) => {
+	(message: IMessage, room: IRoom) => {
 		// skips this callback if the message was edited
-		if (message.editedAt) {
+		if (isEditedMessage(message) && message.editedAt) {
 			return message;
 		}
 
-		if (room && !room.closedAt) {
+		if (!isOmnichannelRoom(room) || !room.closedAt) {
 			// set subscription as read right after message was sent
 			Promise.await(Subscriptions.setAsReadByRoomIdAndUserId(room._id, message.u._id));
 		}
@@ -24,12 +26,3 @@ callbacks.add(
 	callbacks.priority.MEDIUM,
 	'message-read-receipt-afterSaveMessage',
 );
-
-callbacks.add(
-	'afterReadMessages',
-	(rid, { uid, lastSeen }) => {
-		ReadReceipt.markMessagesAsRead(rid, uid, lastSeen);
-	},
-	callbacks.priority.MEDIUM,
-	'message-read-receipt-afterReadMessages',
-);

apps/meteor/ee/app/message-read-receipt/server/hooks/index.ts

@@ -0,0 +1,2 @@
+import './afterReadMessages';
+import './afterSaveMessage';

apps/meteor/ee/app/message-read-receipt/server/index.ts

@@ -0,0 +1,5 @@
+import { onLicense } from '../../license/server';
+
+onLicense('message-read-receipt', async () => {
+	await import('./hooks');
+});

apps/meteor/ee/client/startup/index.ts

@@ -2,3 +2,4 @@ import './audit';
 import './deviceManagement';
 import './engagementDashboard';
 import './slashCommands';
+import './readReceipt';

apps/meteor/ee/client/startup/readReceipt.ts

@@ -0,0 +1,34 @@
+import { Meteor } from 'meteor/meteor';
+import { Tracker } from 'meteor/tracker';
+
+import { settings } from '../../../app/settings/client';
+import { MessageAction } from '../../../app/ui-utils/client';
+import { imperativeModal } from '../../../client/lib/imperativeModal';
+import { messageArgs } from '../../../client/lib/utils/messageArgs';
+import ReadReceiptsModal from '../../../client/views/room/modals/ReadReceiptsModal';
+
+Meteor.startup(() => {
+	Tracker.autorun(() => {
+		const enabled = settings.get('Message_Read_Receipt_Store_Users');
+
+		if (!enabled) {
+			return MessageAction.removeButton('receipt-detail');
+		}
+
+		MessageAction.addButton({
+			id: 'receipt-detail',
+			icon: 'info-circled',
+			label: 'Info',
+			context: ['starred', 'message', 'message-mobile', 'threads'],
+			action(_, props) {
+				const { message = messageArgs(this).msg } = props;
+				imperativeModal.open({
+					component: ReadReceiptsModal,
+					props: { messageId: message._id, onClose: imperativeModal.close },
+				});
+			},
+			order: 10,
+			group: 'menu',
+		});
+	});
+});

apps/meteor/ee/definition/rest/index.ts

@@ -3,4 +3,5 @@
 import './v1/engagementDashboard';
 import './v1/omnichannel';
 import './v1/sessions';
+import './v1/chat';
 import './v1/roles';

apps/meteor/ee/definition/rest/v1/chat.ts

@@ -0,0 +1,34 @@
+import type { IMessage, ReadReceipt } from '@rocket.chat/core-typings';
+import Ajv from 'ajv';
+
+const ajv = new Ajv({
+	coerceTypes: true,
+});
+
+type GetMessageReadReceiptsProps = {
+	messageId: IMessage['_id'];
+};
+
+const getMessageReadReceiptsPropsSchema = {
+	type: 'object',
+	properties: {
+		messageId: {
+			type: 'string',
+		},
+	},
+	required: ['messageId'],
+	additionalProperties: false,
+};
+
+export const isGetMessageReadReceiptsProps = ajv.compile<GetMessageReadReceiptsProps>(getMessageReadReceiptsPropsSchema);
+
+declare module '@rocket.chat/rest-typings' {
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	interface Endpoints {
+		'/v1/chat.getMessageReadReceipts': {
+			GET: (params: GetMessageReadReceiptsProps) => {
+				receipts: ReadReceipt[];
+			};
+		};
+	}
+}

apps/meteor/ee/server/api/chat.ts

@@ -0,0 +1,27 @@
+import { Meteor } from 'meteor/meteor';
+
+import { API } from '../../../app/api/server/api';
+import { hasLicense } from '../../app/license/server/license';
+
+API.v1.addRoute(
+	'chat.getMessageReadReceipts',
+	{ authRequired: true },
+	{
+		async get() {
+			if (!hasLicense('message-read-receipt')) {
+				throw new Meteor.Error('error-action-not-allowed', 'This is an enterprise feature');
+			}
+
+			const { messageId } = this.queryParams;
+			if (!messageId) {
+				return API.v1.failure({
+					error: "The required 'messageId' param is missing.",
+				});
+			}
+
+			return API.v1.success({
+				receipts: await Meteor.call('getReadReceipts', { messageId }),
+			});
+		},
+	},
+);

apps/meteor/ee/server/api/index.ts

@@ -2,4 +2,5 @@ import './api';
 import './ldap';
 import './licenses';
 import './sessions';
+import './chat';
 import './roles';