snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/tests/unit/server/lib/messaging/reactions/setReaction.spec.ts

@@ -0,0 +1,430 @@
+import { expect } from 'chai';
+import { beforeEach, describe, it } from 'mocha';
+import p from 'proxyquire';
+import sinon from 'sinon';
+
+const meteorMethodsMock = sinon.stub();
+const emojiList: Record<string, any> = {};
+const modelsMock = {
+	EmojiCustom: {
+		countByNameOrAlias: sinon.stub(),
+	},
+	Users: {
+		findOneById: sinon.stub(),
+	},
+	Messages: {
+		findOneById: sinon.stub(),
+		setReactions: sinon.stub(),
+		unsetReactions: sinon.stub(),
+	},
+	Rooms: {
+		findOneById: sinon.stub(),
+		unsetReactionsInLastMessage: sinon.stub(),
+		setReactionsInLastMessage: sinon.stub(),
+	},
+};
+const canAccessRoomAsyncMock = sinon.stub();
+const isTheLastMessageMock = sinon.stub();
+const notifyOnMessageChangeMock = sinon.stub();
+const hasPermissionAsyncMock = sinon.stub();
+const i18nMock = { t: sinon.stub() };
+const callbacksRunMock = sinon.stub();
+const meteorErrorMock = class extends Error {
+	constructor(message: string) {
+		super(message);
+	}
+};
+
+const { removeUserReaction, executeSetReaction, setReaction } = p
+	.noCallThru()
+	.load('../../../../../../server/lib/messaging/reactions/setReaction.ts', {
+		'@rocket.chat/models': modelsMock,
+		'@rocket.chat/core-services': { Message: { beforeReacted: sinon.stub() } },
+		'meteor/meteor': { Meteor: { methods: meteorMethodsMock, Error: meteorErrorMock } },
+		'../../callbacks': { callbacks: { run: callbacksRunMock } },
+		'../../i18n': { i18n: i18nMock },
+		'../../authorization': { canAccessRoomAsync: canAccessRoomAsyncMock },
+		'../../authorization/hasPermission': { hasPermissionAsync: hasPermissionAsyncMock },
+		'../emoji': { emoji: { list: emojiList } },
+		'../../messages/isTheLastMessage': { isTheLastMessage: isTheLastMessageMock },
+		'../../notifyListener': {
+			notifyOnMessageChange: notifyOnMessageChangeMock,
+		},
+	});
+
+describe('Reactions', () => {
+	describe('removeUserReaction', () => {
+		it('should return the message unmodified when no reactions exist', () => {
+			const message = {};
+
+			const result = removeUserReaction(message as any, 'test', 'test');
+			expect(result).to.equal(message);
+		});
+		it('should remove the reaction from a message', () => {
+			const message = {
+				reactions: {
+					test: {
+						usernames: ['test', 'test2'],
+					},
+				},
+			};
+
+			const result = removeUserReaction(message as any, 'test', 'test');
+			expect(result.reactions.test.usernames).to.not.include('test');
+			expect(result.reactions.test.usernames).to.include('test2');
+		});
+		it('should remove the reaction from a message when the user is the last one on the array', () => {
+			const message = {
+				reactions: {
+					test: {
+						usernames: ['test'],
+					},
+				},
+			};
+
+			const result = removeUserReaction(message as any, 'test', 'test');
+			expect(result.reactions.test).to.be.undefined;
+		});
+		it('should remove username only from the reaction thats passed in', () => {
+			const message = {
+				reactions: {
+					test: {
+						usernames: ['test', 'test2'],
+					},
+					other: {
+						usernames: ['test', 'test2'],
+					},
+				},
+			};
+
+			const result = removeUserReaction(message as any, 'test', 'test');
+			expect(result.reactions.test.usernames).to.not.include('test');
+			expect(result.reactions.test.usernames).to.include('test2');
+			expect(result.reactions.other.usernames).to.include('test');
+			expect(result.reactions.other.usernames).to.include('test2');
+		});
+		it('should do nothing if username is not in the reaction', () => {
+			const message = {
+				reactions: {
+					test: {
+						usernames: ['test', 'test2'],
+					},
+				},
+			};
+
+			const result = removeUserReaction(message as any, 'test', 'test3');
+			expect(result.reactions.test.usernames).to.not.include('test3');
+			expect(result.reactions.test.usernames).to.include('test');
+			expect(result.reactions.test.usernames).to.include('test2');
+		});
+	});
+	describe('executeSetReaction', () => {
+		beforeEach(() => {
+			modelsMock.EmojiCustom.countByNameOrAlias.reset();
+		});
+		it('should throw an error if reaction is not on emoji list', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(0);
+			await expect(executeSetReaction('test', 'test', 'test')).to.be.rejectedWith('error-not-allowed');
+		});
+		it('should fail if user does not exist', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			await expect(executeSetReaction('test', 'test', 'test')).to.be.rejectedWith('error-invalid-user');
+		});
+		it('should fail if message does not exist', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			await expect(executeSetReaction('test', 'test', 'test')).to.be.rejectedWith('error-not-allowed');
+		});
+		it('should return nothing if user already reacted and its trying to react again', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			modelsMock.Messages.findOneById.resolves({ reactions: { ':test:': { usernames: ['test'] } } });
+			expect(await executeSetReaction('test', 'test', 'test', true)).to.be.undefined;
+		});
+		it('should return nothing if user hasnt reacted and its trying to unreact', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			modelsMock.Messages.findOneById.resolves({ reactions: { ':test:': { usernames: ['testxxxx'] } } });
+			expect(await executeSetReaction('test', 'test', 'test', false)).to.be.undefined;
+		});
+		it('should fail if room does not exist', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			modelsMock.Messages.findOneById.resolves({ reactions: { ':test:': { usernames: ['test'] } } });
+			modelsMock.Rooms.findOneById.resolves(undefined);
+			await expect(executeSetReaction('test', 'test', 'test')).to.be.rejectedWith('error-not-allowed');
+		});
+		it('should fail if user doesnt have acccess to the room', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			modelsMock.Messages.findOneById.resolves({ reactions: { ':test:': { usernames: ['test'] } } });
+			modelsMock.Rooms.findOneById.resolves({ t: 'd' });
+			canAccessRoomAsyncMock.resolves(false);
+			await expect(executeSetReaction('test', 'test', 'test')).to.be.rejectedWith('not-authorized');
+		});
+		it('should call setReaction with correct params', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			modelsMock.Messages.findOneById.resolves({ reactions: { ':test:': { usernames: ['test'] } } });
+			modelsMock.Rooms.findOneById.resolves({ t: 'c' });
+			canAccessRoomAsyncMock.resolves(true);
+
+			const res = await executeSetReaction('test', 'test', 'test');
+			expect(res).to.be.undefined;
+		});
+		it('should use the message from param when the type is not an string', async () => {
+			modelsMock.EmojiCustom.countByNameOrAlias.resolves(1);
+			modelsMock.Users.findOneById.resolves({ username: 'test' });
+			modelsMock.Rooms.findOneById.resolves({ t: 'c' });
+			canAccessRoomAsyncMock.resolves(true);
+
+			await executeSetReaction('test', 'test', { reactions: { ':test:': { usernames: ['test'] } } });
+			expect(modelsMock.Messages.findOneById.calledOnce).to.be.false;
+		});
+	});
+	describe('setReaction', () => {
+		beforeEach(() => {
+			canAccessRoomAsyncMock.reset();
+			hasPermissionAsyncMock.reset();
+			isTheLastMessageMock.reset();
+			modelsMock.Messages.setReactions.reset();
+			modelsMock.Rooms.setReactionsInLastMessage.reset();
+			modelsMock.Rooms.unsetReactionsInLastMessage.reset();
+			modelsMock.Messages.unsetReactions.reset();
+			callbacksRunMock.reset();
+		});
+		it('should throw an error if user is muted from the room', async () => {
+			const room = {
+				muted: ['test'],
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+			};
+			await expect(setReaction(room, user, message, ':test:')).to.be.rejectedWith('error-not-allowed');
+		});
+		it('should throw an error if room is readonly and cannot be reacted when readonly and user trying doesnt have permissions and user is not unmuted from room', async () => {
+			const room = {
+				ro: true,
+				reactWhenReadOnly: false,
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+			};
+			canAccessRoomAsyncMock.resolves(false);
+			await expect(setReaction(room, user, message, ':test:')).to.be.rejectedWith("You can't send messages because the room is readonly.");
+		});
+		it('should remove the user reaction if userAlreadyReacted is true and call unsetReaction if reaction is the last one on message', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+				reactions: {
+					':test:': {
+						usernames: ['test'],
+					},
+				},
+			};
+			const reaction = ':test:';
+
+			await setReaction(room, user, message, reaction, true);
+			expect(modelsMock.Messages.unsetReactions.calledWith(message._id)).to.be.true;
+		});
+		it('should call Rooms.unsetReactionsInLastMessage when userAlreadyReacted is true and reaction is the last one on message', async () => {
+			const room = {
+				_id: 'test',
+				lastMessage: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+				reactions: {
+					':test:': {
+						usernames: ['test'],
+					},
+				},
+			};
+			const reaction = ':test:';
+
+			isTheLastMessageMock.resolves(true);
+
+			await setReaction(room, user, message, reaction, true);
+			expect(modelsMock.Messages.unsetReactions.calledWith(message._id)).to.be.true;
+			expect(modelsMock.Rooms.unsetReactionsInLastMessage.calledWith(room._id)).to.be.true;
+		});
+		it('should update the reactions object when userAlreadyReacted is true and there is more reactions on message', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+				reactions: {
+					':test:': {
+						usernames: ['test'],
+					},
+					':test2:': {
+						usernames: ['test'],
+					},
+				},
+			};
+			const reaction = ':test:';
+
+			await setReaction(room, user, message, reaction, true);
+			expect(modelsMock.Messages.setReactions.calledWith(message._id, sinon.match({ ':test2:': { usernames: ['test'] } }))).to.be.true;
+		});
+		it('should call Rooms.setReactionsInLastMessage when userAlreadyReacted is true and reaction is not the last one on message', async () => {
+			const room = {
+				_id: 'test',
+				lastMessage: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+				reactions: {
+					':test:': {
+						usernames: ['test'],
+					},
+					':test2:': {
+						usernames: ['test'],
+					},
+				},
+			};
+			const reaction = ':test:';
+
+			isTheLastMessageMock.resolves(true);
+
+			await setReaction(room, user, message, reaction, true);
+			expect(modelsMock.Messages.setReactions.calledWith(message._id, sinon.match({ ':test2:': { usernames: ['test'] } }))).to.be.true;
+			expect(modelsMock.Rooms.setReactionsInLastMessage.calledWith(room._id, sinon.match({ ':test2:': { usernames: ['test'] } }))).to.be
+				.true;
+		});
+		it('should call afterUnsetReaction callback when userAlreadyReacted is true', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+				reactions: {
+					':test:': {
+						usernames: ['test'],
+					},
+				},
+			};
+			const reaction = ':test:';
+
+			await setReaction(room, user, message, reaction, true);
+			expect(
+				callbacksRunMock.calledWith(
+					'afterUnsetReaction',
+					sinon.match({ _id: 'test' }),
+					sinon.match({ user, reaction, shouldReact: false, oldMessage: message }),
+				),
+			).to.be.true;
+		});
+		it('should set reactions when userAlreadyReacted is false', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+			};
+			const reaction = ':test:';
+			await setReaction(room, user, message, reaction, false);
+			expect(modelsMock.Messages.setReactions.calledWith(message._id, sinon.match({ ':test:': { usernames: ['test'] } }))).to.be.true;
+		});
+		it('should properly add username to the list of reactions when userAlreadyReacted is false', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test2',
+			};
+			const message = {
+				_id: 'test',
+				reactions: {
+					':test:': {
+						usernames: ['test'],
+					},
+				},
+			};
+			const reaction = ':test:';
+
+			await setReaction(room, user, message, reaction, false);
+			expect(modelsMock.Messages.setReactions.calledWith(message._id, sinon.match({ ':test:': { usernames: ['test', 'test2'] } }))).to.be
+				.true;
+		});
+		it('should call Rooms.setReactionInLastMessage when userAlreadyReacted is false', async () => {
+			const room = {
+				_id: 'x5',
+				lastMessage: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+			};
+			const reaction = ':test:';
+
+			isTheLastMessageMock.resolves(true);
+
+			await setReaction(room, user, message, reaction, false);
+			expect(modelsMock.Messages.setReactions.calledWith(message._id, sinon.match({ ':test:': { usernames: ['test'] } }))).to.be.true;
+			expect(modelsMock.Rooms.setReactionsInLastMessage.calledWith(room._id, sinon.match({ ':test:': { usernames: ['test'] } }))).to.be
+				.true;
+		});
+		it('should call afterSetReaction callback when userAlreadyReacted is false', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+			};
+			const reaction = ':test:';
+
+			await setReaction(room, user, message, reaction, false);
+			expect(
+				callbacksRunMock.calledWith('afterSetReaction', sinon.match({ _id: 'test' }), sinon.match({ user, reaction, shouldReact: true })),
+			).to.be.true;
+		});
+		it('should return undefined on a successful reaction', async () => {
+			const room = {
+				_id: 'test',
+			};
+			const user = {
+				username: 'test',
+			};
+			const message = {
+				_id: 'test',
+			};
+			const reaction = ':test:';
+
+			expect(await setReaction(room, user, message, reaction, false)).to.be.undefined;
+		});
+	});
+});