chore!: remove query field on online groups listing (#33647)

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

@@ -1,6 +1,7 @@
 import { Team, isMeteorError } from '@rocket.chat/core-services';
 import type { IIntegration, IUser, IRoom, RoomType } from '@rocket.chat/core-typings';
 import { Integrations, Messages, Rooms, Subscriptions, Uploads, Users } from '@rocket.chat/models';
+import { isGroupsOnlineProps } from '@rocket.chat/rest-typings';
 import { check, Match } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
 import type { Filter } from 'mongodb';
@@ -779,23 +780,28 @@ API.v1.addRoute(
 // TODO: CACHE: same as channels.online
 API.v1.addRoute(
 	'groups.online',
-	{ authRequired: true },
+	{ authRequired: true, validateParams: isGroupsOnlineProps },
 	{
 		async get() {
 			const { query } = await this.parseJsonQuery();
-			if (!query || Object.keys(query).length === 0) {
+			const { _id } = this.queryParams;
+
+			if ((!query || Object.keys(query).length === 0) && !_id) {
 				return API.v1.failure('Invalid query');
 			}
 
-			const ourQuery = Object.assign({}, query, { t: 'p' });
-
-			const room = await Rooms.findOne(ourQuery as Record<string, any>);
+			const filter = {
+				...query,
+				...(_id ? { _id } : {}),
+				t: 'p',
+			};
 
+			const room = await Rooms.findOne(filter as Record<string, any>);
 			if (!room) {
 				return API.v1.failure('Group does not exists');
 			}
-			const user = await getLoggedInUser(this.request);
 
+			const user = await getLoggedInUser(this.request);
 			if (!user) {
 				return API.v1.failure('User does not exists');
 			}

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

@@ -1119,7 +1119,9 @@ describe('[Groups]', () => {
 		it('should return an array with online members', async () => {
 			const { testUser, testUserCredentials, room } = await createUserAndChannel();
 
-			const response = await request.get(api('groups.online')).set(testUserCredentials).query(`query={"_id": "${room._id}"}`);
+			const response = await request.get(api('groups.online')).set(testUserCredentials).query({
+				_id: room._id,
+			});
 
 			const { body } = response;
 
@@ -1134,7 +1136,9 @@ describe('[Groups]', () => {
 		it('should return an empty array if members are offline', async () => {
 			const { testUserCredentials, room } = await createUserAndChannel(false);
 
-			const response = await request.get(api('groups.online')).set(testUserCredentials).query(`query={"_id": "${room._id}"}`);
+			const response = await request.get(api('groups.online')).set(testUserCredentials).query({
+				_id: room._id,
+			});
 
 			const { body } = response;
 
@@ -1150,7 +1154,9 @@ describe('[Groups]', () => {
 			await request
 				.get(api('groups.online'))
 				.set(outsiderCredentials)
-				.query(`query={"_id": "${room._id}"}`)
+				.query({
+					_id: room._id,
+				})
 				.expect(400)
 				.expect((res) => {
 					expect(res.body).to.have.property('success', false);

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

@@ -4,10 +4,15 @@ const ajv = new Ajv({
 	coerceTypes: true,
 });
 
-export type GroupsOnlineProps = { query?: Record<string, any> };
-const groupsOnlyPropsSchema = {
+export type GroupsOnlineProps = { _id?: string; query?: Record<string, any> };
+
+const groupsOnlinePropsSchema = {
 	type: 'object',
 	properties: {
+		_id: {
+			type: 'string',
+			nullable: true,
+		},
 		query: {
 			type: 'string',
 			nullable: true,
@@ -16,4 +21,5 @@ const groupsOnlyPropsSchema = {
 	required: [],
 	additionalProperties: false,
 };
-export const isGroupsOnlineProps = ajv.compile<GroupsOnlineProps>(groupsOnlyPropsSchema);
+
+export const isGroupsOnlineProps = ajv.compile<GroupsOnlineProps>(groupsOnlinePropsSchema);