fix: brings back roomName on GET /groups.messages endpoint (#35546)

Author: ricardogarim

.changeset/chatty-berries-compare.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/rest-typings': patch
+'@rocket.chat/meteor': patch
+---
+
+Restores `roomName` property in the `GET /groups.messages` endpoint to fix unintended removal.

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

@@ -764,10 +764,13 @@ API.v1.addRoute(
 	{ authRequired: true, validateParams: isGroupsMessagesProps },
 	{
 		async get() {
-			const { roomId, mentionIds, starredIds, pinned } = this.queryParams;
+			const { roomId, roomName, mentionIds, starredIds, pinned } = this.queryParams;
 
 			const findResult = await findPrivateGroupByIdOrName({
-				params: { roomId },
+				params: {
+					...(roomId && { roomId }),
+					...(roomName && { roomName }),
+				},
 				userId: this.userId,
 			});
 			const { offset, count } = await getPaginationItems(this.queryParams);

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

@@ -633,6 +633,43 @@ describe('[Groups]', () => {
 					expect(res.body).to.have.property('total', 1);
 				});
 		});
+
+		it('should return all messages from a group using roomName parameter', async () => {
+			await request
+				.get(api('groups.messages'))
+				.set(credentials)
+				.query({ roomName: testGroup.name })
+				.expect('Content-Type', 'application/json')
+				.expect(200)
+				.expect((res) => {
+					expect(res.body).to.have.property('success', true);
+					expect(res.body).to.have.property('messages').and.to.be.an('array');
+					expect(res.body.messages).to.have.lengthOf(5);
+				});
+		});
+
+		it('should return error if both roomId and roomName are provided', async () => {
+			const thirdGroup = (await createGroup({ name: `test-priority-${Date.now()}` })).body.group;
+			const secondGroup = (await createGroup({ name: `test-priority-${Date.now()}` })).body.group;
+
+			try {
+				await request
+					.get(api('groups.messages'))
+					.set(credentials)
+					.query({
+						roomId: thirdGroup._id,
+						roomName: secondGroup.name,
+					})
+					.expect('Content-Type', 'application/json')
+					.expect(400)
+					.expect((res) => {
+						expect(res.body).to.have.property('success', false);
+						expect(res.body).to.have.property('errorType', 'invalid-params');
+					});
+			} finally {
+				await Promise.all([deleteGroup({ roomName: secondGroup.name }), deleteGroup({ roomName: thirdGroup.name })]);
+			}
+		});
 	});
 
 	describe('/groups.invite', async () => {

packages/rest-typings/src/v1/groups/GroupsMessagesProps.ts

@@ -8,18 +8,22 @@ const ajv = new Ajv({
 	coerceTypes: true,
 });
 
-export type GroupsMessagesProps = PaginatedRequest<{
-	roomId: IRoom['_id'];
-	mentionIds?: string;
-	starredIds?: string;
-	pinned?: boolean;
-	query?: Record<string, any>;
-}>;
+export type GroupsMessagesProps = PaginatedRequest<
+	({ roomId: IRoom['_id'] } | { roomName: IRoom['name'] }) & {
+		mentionIds?: string;
+		starredIds?: string;
+		pinned?: boolean;
+		query?: Record<string, any>;
+	}
+>;
 
 const GroupsMessagesPropsSchema = withGroupBaseProperties({
 	roomId: {
 		type: 'string',
 	},
+	roomName: {
+		type: 'string',
+	},
 	mentionIds: {
 		type: 'string',
 	},