feat(apps): experimental member room IDs read bridge (RocketChat#37057)

Co-authored-by: Douglas Gubert <1810309+d-gubert@users.noreply.github.com>

Author: Dnouv

.changeset/chatty-foxes-attend.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/apps-engine': minor
+'@rocket.chat/meteor': minor
+---
+
+Adds an experimental API to the apps-engine that retrieves the ids of rooms the user is a member of

apps/meteor/app/apps/server/bridges/bridges.js

@@ -8,6 +8,7 @@ import { AppContactBridge } from './contact';
 import { AppDetailChangesBridge } from './details';
 import { AppEmailBridge } from './email';
 import { AppEnvironmentalVariableBridge } from './environmental';
+import { AppExperimentalBridge } from './experimental';
 import { AppHttpBridge } from './http';
 import { AppInternalBridge } from './internal';
 import { AppInternalFederationBridge } from './internalFederation';
@@ -59,6 +60,7 @@ export class RealAppBridges extends AppBridges {
 		this._emailBridge = new AppEmailBridge(orch);
 		this._contactBridge = new AppContactBridge(orch);
 		this._outboundMessageBridge = new OutboundCommunicationBridge(orch);
+		this._experimentalBridge = new AppExperimentalBridge(orch);
 	}
 
 	getCommandBridge() {
@@ -168,4 +170,8 @@ export class RealAppBridges extends AppBridges {
 	getContactBridge() {
 		return this._contactBridge;
 	}
+
+	getExperimentalBridge() {
+		return this._experimentalBridge;
+	}
 }

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

@@ -0,0 +1,17 @@
+import type { IAppServerOrchestrator } from '@rocket.chat/apps';
+import { ExperimentalBridge } from '@rocket.chat/apps-engine/server/bridges';
+import { Subscriptions } from '@rocket.chat/models';
+
+export class AppExperimentalBridge extends ExperimentalBridge {
+	constructor(private readonly orch: IAppServerOrchestrator) {
+		super();
+	}
+
+	protected async getUserRoomIds(userId: string, appId: string): Promise<string[] | undefined> {
+		this.orch.debugLog(`The App ${appId} is getting the room ids for the user: "${userId}"`);
+
+		const subscriptions = await Subscriptions.findByUserId(userId, { projection: { rid: 1 } }).toArray();
+
+		return subscriptions.map((subscription) => subscription.rid);
+	}
+}

packages/apps-engine/deno-runtime/lib/accessors/mod.ts

@@ -253,6 +253,7 @@ export class AppAccessors {
 				getThreadReader: () => this.proxify('getReader:getThreadReader'),
 				getRoleReader: () => this.proxify('getReader:getRoleReader'),
 				getContactReader: () => this.proxify('getReader:getContactReader'),
+				getExperimentalReader: () => this.proxify('getReader:getExperimentalReader'),
 			};
 		}
 

packages/apps-engine/src/definition/accessors/IExperimentalRead.ts

@@ -0,0 +1,16 @@
+/**
+ * @description
+ * Experimental bridge for experimental features.
+ * Methods in this class are not guaranteed to be stable between updates as the
+ * team evaluates the proper signature, underlying implementation and performance
+ * impact of candidates for future APIs
+ */
+export interface IExperimentalRead {
+	/**
+	 * Fetches the IDs of the rooms that the user is a member of.
+	 *
+	 * @returns an array of room ids or undefined if the app doesn't have the proper permission
+	 * @experimental
+	 */
+	getUserRoomIds(userId: string): Promise<string[] | undefined>;
+}

packages/apps-engine/src/definition/accessors/IRead.ts

@@ -1,6 +1,7 @@
 import type { ICloudWorkspaceRead } from './ICloudWorkspaceRead';
 import type { IContactRead } from './IContactRead';
 import type { IEnvironmentRead } from './IEnvironmentRead';
+import type { IExperimentalRead } from './IExperimentalRead';
 import type { ILivechatRead } from './ILivechatRead';
 import type { IMessageRead } from './IMessageRead';
 import type { INotifier } from './INotifier';
@@ -51,4 +52,6 @@ export interface IRead {
 
 	getRoleReader(): IRoleRead;
 	getContactReader(): IContactRead;
+
+	getExperimentalReader(): IExperimentalRead;
 }

packages/apps-engine/src/definition/accessors/index.ts

@@ -11,6 +11,7 @@ export * from './IEnvironmentalVariableRead';
 export * from './IEnvironmentRead';
 export * from './IEnvironmentWrite';
 export * from './IExternalComponentsExtend';
+export * from './IExperimentalRead';
 export * from './IHttp';
 export * from './ILivechatCreator';
 export * from './ILivechatMessageBuilder';

packages/apps-engine/src/server/accessors/ExperimentalRead.ts

@@ -0,0 +1,13 @@
+import type { IExperimentalRead } from '../../definition/accessors';
+import type { ExperimentalBridge } from '../bridges';
+
+export class ExperimentalRead implements IExperimentalRead {
+	constructor(
+		private experimentalBridge: ExperimentalBridge,
+		private appId: string,
+	) {}
+
+	public async getUserRoomIds(userId: string): Promise<string[] | undefined> {
+		return this.experimentalBridge.doGetUserRoomIds(userId, this.appId);
+	}
+}

packages/apps-engine/src/server/accessors/Reader.ts

@@ -1,6 +1,7 @@
 import type {
 	ICloudWorkspaceRead,
 	IEnvironmentRead,
+	IExperimentalRead,
 	ILivechatRead,
 	IMessageRead,
 	INotifier,
@@ -29,10 +30,10 @@ export class Reader implements IRead {
 		private cloud: ICloudWorkspaceRead,
 		private videoConf: IVideoConferenceRead,
 		private contactRead: IContactRead,
-
 		private oauthApps: IOAuthAppsReader,
 		private thread: IThreadRead,
 		private role: IRoleRead,
+		private experimental: IExperimentalRead,
 	) {}
 
 	public getEnvironmentReader(): IEnvironmentRead {
@@ -90,4 +91,8 @@ export class Reader implements IRead {
 	public getContactReader(): IContactRead {
 		return this.contactRead;
 	}
+
+	public getExperimentalReader(): IExperimentalRead {
+		return this.experimental;
+	}
 }

packages/apps-engine/src/server/bridges/AppBridges.ts

@@ -6,6 +6,7 @@ import type { CommandBridge } from './CommandBridge';
 import type { ContactBridge } from './ContactBridge';
 import type { EmailBridge } from './EmailBridge';
 import type { EnvironmentalVariableBridge } from './EnvironmentalVariableBridge';
+import type { ExperimentalBridge } from './ExperimentalBridge';
 import type { HttpBridge } from './HttpBridge';
 import type { IInternalBridge } from './IInternalBridge';
 import type { IInternalFederationBridge } from './IInternalFederationBridge';
@@ -42,6 +43,7 @@ export type Bridge =
 	| IInternalBridge
 	| ServerSettingBridge
 	| EmailBridge
+	| ExperimentalBridge
 	| UploadBridge
 	| UserBridge
 	| UiInteractionBridge
@@ -106,4 +108,6 @@ export abstract class AppBridges {
 	public abstract getRoleBridge(): RoleBridge;
 
 	public abstract getOutboundMessageBridge(): OutboundMessageBridge;
+
+	public abstract getExperimentalBridge(): ExperimentalBridge;
 }