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

apps/meteor/tests/end-to-end/api/subscriptions.ts

@@ -0,0 +1,432 @@
+import type { Credentials } from '@rocket.chat/api-client';
+import type { IRoom, IThreadMessage, IUser } from '@rocket.chat/core-typings';
+import { expect } from 'chai';
+import { after, before, describe, it } from 'mocha';
+
+import { getCredentials, api, request, credentials } from '../../data/api-data';
+import { createRoom, deleteRoom } from '../../data/rooms.helper';
+import { adminUsername } from '../../data/user';
+import type { TestUser } from '../../data/users.helper';
+import { createUser, deleteUser, login } from '../../data/users.helper';
+
+describe('[Subscriptions]', () => {
+	before((done) => getCredentials(done));
+
+	let testChannel: IRoom;
+
+	before(async () => {
+		testChannel = (await createRoom({ type: 'c', name: `channel.test.${Date.now()}` })).body.channel;
+	});
+
+	after(() => deleteRoom({ type: 'c', roomId: testChannel._id }));
+
+	it('/subscriptions.get', async () => {
+		const res = await request.get(api('subscriptions.get')).set(credentials).expect('Content-Type', 'application/json').expect(200);
+
+		expect(res.body).to.have.property('success', true);
+		expect(res.body).to.have.property('update');
+		expect(res.body).to.have.property('remove');
+	});
+
+	it('/subscriptions.get?updatedSince', async () => {
+		const res = await request
+			.get(api('subscriptions.get'))
+			.set(credentials)
+			.query({
+				updatedSince: new Date(),
+			})
+			.expect(200);
+
+		expect(res.body).to.have.property('success', true);
+		expect(res.body).to.have.property('update').that.have.lengthOf(0);
+		expect(res.body).to.have.property('remove').that.have.lengthOf(0);
+	});
+
+	describe('/subscriptions.getOne', () => {
+		it('should fail if no roomId provided', async () => {
+			const res = await request.get(api('subscriptions.getOne')).set(credentials).expect('Content-Type', 'application/json').expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error', "must have required property 'roomId'");
+		});
+
+		it('should fail if not logged in', async () => {
+			const res = await request
+				.get(api('subscriptions.getOne'))
+				.query({
+					roomId: testChannel._id,
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(401);
+
+			expect(res.body).to.have.property('status', 'error');
+			expect(res.body).to.have.property('message');
+		});
+
+		it('should return the subscription with success', async () => {
+			const res = await request
+				.get(api('subscriptions.getOne'))
+				.set(credentials)
+				.query({
+					roomId: testChannel._id,
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(200);
+
+			expect(res.body).to.have.property('success', true);
+			expect(res.body).to.have.property('subscription').and.to.be.an('object');
+		});
+
+		it('should keep subscription as read after sending a message', async () => {
+			await request
+				.get(api('subscriptions.getOne'))
+				.set(credentials)
+				.query({
+					roomId: testChannel._id,
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(200)
+				.expect((res) => {
+					expect(res.body).to.have.property('success', true);
+					expect(res.body).to.have.property('subscription').and.to.be.an('object');
+					expect(res.body.subscription).to.have.property('alert', false);
+				});
+
+			await request
+				.post(api('chat.sendMessage'))
+				.set(credentials)
+				.send({
+					message: {
+						rid: testChannel._id,
+						msg: 'Sample message',
+					},
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(200)
+				.expect((res) => {
+					expect(res.body).to.have.property('success', true);
+					expect(res.body).to.have.property('message').and.to.be.an('object');
+				});
+
+			await request
+				.get(api('subscriptions.getOne'))
+				.set(credentials)
+				.query({
+					roomId: testChannel._id,
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(200)
+				.expect((res) => {
+					expect(res.body).to.have.property('success', true);
+					expect(res.body).to.have.property('subscription').and.to.be.an('object');
+					expect(res.body.subscription).to.have.property('alert', false);
+				});
+		});
+	});
+
+	describe('[/subscriptions.read]', () => {
+		let testChannel: IRoom;
+		let testGroup: IRoom;
+		let testDM: IRoom;
+		let user: TestUser<IUser>;
+
+		before(async () => {
+			user = await createUser();
+			testChannel = (await createRoom({ type: 'c', name: `channel.test.${Date.now()}` })).body.channel;
+			testGroup = (await createRoom({ type: 'p', name: `group.test.${Date.now()}` })).body.group;
+			testDM = (await createRoom({ type: 'd', username: user.username })).body.room;
+		});
+
+		after(() =>
+			Promise.all([
+				deleteRoom({ type: 'd', roomId: testDM._id }),
+				deleteRoom({ type: 'c', roomId: testChannel._id }),
+				deleteRoom({ type: 'p', roomId: testGroup._id }),
+				deleteUser(user),
+			]),
+		);
+
+		it('should mark public channels as read', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: testChannel._id,
+				})
+				.expect(200);
+
+			expect(res.body).to.have.property('success', true);
+		});
+
+		it('should mark groups as read', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: testGroup._id,
+				})
+				.expect(200);
+
+			expect(res.body).to.have.property('success', true);
+		});
+
+		it('should mark DMs as read', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: testDM._id,
+				})
+				.expect(200);
+
+			expect(res.body).to.have.property('success', true);
+		});
+
+		it('should fail on two params with different ids', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: testDM._id,
+					roomId: testChannel._id,
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('errorType', 'invalid-params');
+		});
+
+		it('should fail on mark inexistent public channel as read', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: 'foobar123-somechannel',
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error', 'error-invalid-subscription');
+		});
+
+		it('should fail on mark inexistent group as read', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: 'foobar123-somegroup',
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error', 'error-invalid-subscription');
+		});
+
+		it('should fail on mark inexistent DM as read', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: 'foobar123-somedm',
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error', 'error-invalid-subscription');
+		});
+
+		it('should fail on invalid params', async () => {
+			const res = await request
+				.post(api('subscriptions.read'))
+				.set(credentials)
+				.send({
+					rid: 12345,
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error', 'error-invalid-subscription');
+		});
+
+		it('should fail on empty params', async () => {
+			const res = await request.post(api('subscriptions.read')).set(credentials).send({}).expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('errorType', 'invalid-params');
+		});
+
+		describe('should handle threads correctly', () => {
+			let threadId: IThreadMessage['_id'];
+			let user: TestUser<IUser>;
+			let threadUserCredentials: Credentials;
+
+			before(async () => {
+				user = await createUser({ username: 'testthread123', password: 'testthread123' });
+				threadUserCredentials = await login('testthread123', 'testthread123');
+
+				const res = await request
+					.post(api('chat.sendMessage'))
+					.set(threadUserCredentials)
+					.send({
+						message: {
+							rid: testChannel._id,
+							msg: 'Starting a Thread',
+						},
+					});
+
+				threadId = res.body.message._id;
+			});
+
+			after(async () => {
+				await deleteUser(user);
+			});
+
+			it('should mark threads as read', async () => {
+				await request
+					.post(api('chat.sendMessage'))
+					.set(threadUserCredentials)
+					.send({
+						message: {
+							rid: testChannel._id,
+							msg: `@${adminUsername} making admin follow this thread`,
+							tmid: threadId,
+						},
+					});
+				await request
+					.post(api('subscriptions.read'))
+					.set(credentials)
+					.send({
+						rid: testChannel._id,
+						readThreads: true,
+					})
+					.expect(200)
+					.expect((res) => {
+						expect(res.body).to.have.property('success', true);
+					});
+
+				await request
+					.get(api('subscriptions.getOne'))
+					.set(credentials)
+					.query({
+						roomId: testChannel._id,
+					})
+					.expect(200)
+					.expect((res) => {
+						expect(res.body).to.have.property('success', true);
+						expect(res.body.subscription).to.not.have.property('tunread');
+					});
+			});
+
+			it('should not mark threads as read', async () => {
+				await request
+					.post(api('chat.sendMessage'))
+					.set(threadUserCredentials)
+					.send({
+						message: {
+							rid: testChannel._id,
+							msg: `@${adminUsername} making admin follow this thread`,
+							tmid: threadId,
+						},
+					});
+				await request
+					.post(api('subscriptions.read'))
+					.set(credentials)
+					.send({
+						rid: testChannel._id,
+						readThreads: false,
+					})
+					.expect(200)
+					.expect((res) => {
+						expect(res.body).to.have.property('success', true);
+					});
+
+				await request
+					.get(api('subscriptions.getOne'))
+					.set(credentials)
+					.query({
+						roomId: testChannel._id,
+					})
+					.expect(200)
+					.expect((res) => {
+						expect(res.body).to.have.property('success', true);
+						expect(res.body.subscription).to.have.property('tunread');
+						expect(res.body.subscription.tunread).to.be.an('array');
+						expect(res.body.subscription.tunread).to.deep.equal([threadId]);
+					});
+			});
+		});
+	});
+
+	describe('[/subscriptions.unread]', () => {
+		let testChannel: IRoom;
+
+		before(async () => {
+			testChannel = (await createRoom({ type: 'c', name: `channel.test.${Date.now()}` })).body.channel;
+		});
+
+		after(() => deleteRoom({ type: 'c', roomId: testChannel._id }));
+
+		it('should fail when there are no messages on an channel', async () => {
+			const res = await request
+				.post(api('subscriptions.unread'))
+				.set(credentials)
+				.send({
+					roomId: testChannel._id,
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error');
+			expect(res.body).to.have.property('errorType', 'error-no-message-for-unread');
+		});
+
+		it('sending message', async () => {
+			const res = await request
+				.post(api('chat.sendMessage'))
+				.set(credentials)
+				.send({
+					message: {
+						rid: testChannel._id,
+						msg: 'Sample message',
+					},
+				})
+				.expect('Content-Type', 'application/json')
+				.expect(200);
+
+			expect(res.body).to.have.property('success', true);
+			expect(res.body).to.have.property('message').and.to.be.an('object');
+		});
+
+		it('should return success: true when make as unread successfully', async () => {
+			const res = await request
+				.post(api('subscriptions.unread'))
+				.set(credentials)
+				.send({
+					roomId: testChannel._id,
+				})
+				.expect(200);
+
+			expect(res.body).to.have.property('success', true);
+		});
+
+		it('should fail on invalid params', async () => {
+			const res = await request
+				.post(api('subscriptions.unread'))
+				.set(credentials)
+				.send({
+					roomId: 12345,
+				})
+				.expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error');
+		});
+
+		it('should fail on empty params', async () => {
+			const res = await request.post(api('subscriptions.unread')).set(credentials).send({}).expect(400);
+
+			expect(res.body).to.have.property('success', false);
+			expect(res.body).to.have.property('error');
+		});
+	});
+});