[NEW] Bridge to get all users crated by app and also delete them

apps/meteor/app/apps/server/bridges/users.ts

@@ -1,9 +1,9 @@
 import { Random } from 'meteor/random';
 import { UserBridge } from '@rocket.chat/apps-engine/server/bridges/UserBridge';
-import type { IUserCreationOptions, IUser } from '@rocket.chat/apps-engine/definition/users';
+import type { IUserCreationOptions, IUser, UserType } from '@rocket.chat/apps-engine/definition/users';
 import { Subscriptions, Users as UsersRaw } from '@rocket.chat/models';
 
-import { setUserAvatar, checkUsernameAvailability, deleteUser } from '../../../lib/server/functions';
+import { setUserAvatar, checkUsernameAvailability, deleteUser, getUserCreatedByApp } from '../../../lib/server/functions';
 import { Users } from '../../../models/server';
 import type { AppServerOrchestrator } from '../orchestrator';
 
@@ -33,6 +33,24 @@ export class AppUserBridge extends UserBridge {
 		return this.orch.getConverters()?.get('users').convertToApp(user);
 	}
 
+	/**
+	 * Deletes all bot or app users created by the App.
+	 * @param appId the App's ID.
+	 * @param type the type of the user to be deleted.
+	 * @returns true if any user was deleted, false otherwise.
+	 */
+	protected async deleteUsersCreatedByApp(appId: string, type: UserType.APP | UserType.BOT): Promise<boolean> {
+		this.orch.debugLog(`The App ${appId} is deleting all bot users`);
+
+		const appUsers = await getUserCreatedByApp(appId, type);
+		if (appUsers.length) {
+			this.orch.debugLog(`The App ${appId} is deleting ${appUsers.length} users`);
+			await Promise.all(appUsers.map((appUser) => deleteUser(appUser._id)));
+			return true;
+		}
+		return false;
+	}
+
 	protected async create(userDescriptor: Partial<IUser>, appId: string, options?: IUserCreationOptions): Promise<string> {
 		this.orch.debugLog(`The App ${appId} is requesting to create a new user.`);
 		const user = this.orch.getConverters()?.get('users').convertToRocketChat(userDescriptor);
@@ -46,6 +64,7 @@ export class AppUserBridge extends UserBridge {
 		}
 
 		switch (user.type) {
+			case 'bot':
 			case 'app':
 				if (!checkUsernameAvailability(user.username)) {
 					throw new Error(`The username "${user.username}" is already being used. Rename or remove the user using it to install this App`);

apps/meteor/app/lib/server/functions/getUserCreatedByApp.ts

@@ -0,0 +1,13 @@
+import type { FindOptions } from 'mongodb';
+import type { IUser } from '@rocket.chat/core-typings';
+import { Users } from '@rocket.chat/models';
+import type { UserType } from '@rocket.chat/apps-engine/definition/users';
+
+export async function getUserCreatedByApp(
+	appId: string,
+	type: UserType.BOT | UserType.APP,
+	options?: FindOptions<IUser>,
+): Promise<Array<IUser>> {
+	const users = await Users.find({ appId, type }, options).toArray();
+	return users ?? [];
+}

apps/meteor/app/lib/server/functions/index.ts

@@ -12,6 +12,7 @@ export { deleteRoom } from './deleteRoom';
 export { deleteUser } from './deleteUser';
 export { getRoomByNameOrIdWithOptionToJoin } from './getRoomByNameOrIdWithOptionToJoin';
 export { getUserSingleOwnedRooms } from './getUserSingleOwnedRooms';
+export { getUserCreatedByApp } from './getUserCreatedByApp';
 export { generateUsernameSuggestion } from './getUsernameSuggestion';
 export { insertMessage } from './insertMessage';
 export { isTheLastMessage } from './isTheLastMessage';