feat(outbound): Apps engine bridge (#36390)

Co-authored-by: Lucas Pelegrino <16467257+lucas-a-pelegrino@users.noreply.github.com>
Co-authored-by: Diego Sampaio <8591547+sampaiodiego@users.noreply.github.com>

Author: 3 people

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

@@ -16,6 +16,7 @@ import { AppLivechatBridge } from './livechat';
 import { AppMessageBridge } from './messages';
 import { AppModerationBridge } from './moderation';
 import { AppOAuthAppsBridge } from './oauthApps';
+import { OutboundCommunicationBridge } from './outboundCommunication';
 import { AppPersistenceBridge } from './persistence';
 import { AppRoleBridge } from './roles';
 import { AppRoomBridge } from './rooms';
@@ -57,6 +58,7 @@ export class RealAppBridges extends AppBridges {
 		this._roleBridge = new AppRoleBridge(orch);
 		this._emailBridge = new AppEmailBridge(orch);
 		this._contactBridge = new AppContactBridge(orch);
+		this._outboundMessageBridge = new OutboundCommunicationBridge(orch);
 	}
 
 	getCommandBridge() {
@@ -139,6 +141,10 @@ export class RealAppBridges extends AppBridges {
 		return this._videoConfBridge;
 	}
 
+	getOutboundMessageBridge() {
+		return this._outboundMessageBridge;
+	}
+
 	getOAuthAppsBridge() {
 		return this._oAuthBridge;
 	}

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

@@ -0,0 +1,45 @@
+import type { IAppServerOrchestrator } from '@rocket.chat/apps';
+import type {
+	IOutboundEmailMessageProvider,
+	IOutboundMessageProviders,
+	IOutboundPhoneMessageProvider,
+} from '@rocket.chat/apps-engine/definition/outboundComunication';
+import { OutboundMessageBridge } from '@rocket.chat/apps-engine/server/bridges';
+
+import { getOutboundService } from '../../../livechat/server/lib/outboundcommunication';
+
+export class OutboundCommunicationBridge extends OutboundMessageBridge {
+	constructor(private readonly orch: IAppServerOrchestrator) {
+		super();
+	}
+
+	protected async registerPhoneProvider(provider: IOutboundPhoneMessageProvider, appId: string): Promise<void> {
+		try {
+			this.orch.debugLog(`App ${appId} is registering a phone outbound provider.`);
+			getOutboundService().outboundMessageProvider.registerPhoneProvider(provider);
+		} catch (err) {
+			this.orch.getRocketChatLogger().error({ appId, err, msg: 'Failed to register phone provider' });
+			throw new Error('error-registering-provider');
+		}
+	}
+
+	protected async registerEmailProvider(provider: IOutboundEmailMessageProvider, appId: string): Promise<void> {
+		try {
+			this.orch.debugLog(`App ${appId} is registering an email outbound provider.`);
+			getOutboundService().outboundMessageProvider.registerEmailProvider(provider);
+		} catch (err) {
+			this.orch.getRocketChatLogger().error({ appId, err, msg: 'Failed to register email provider' });
+			throw new Error('error-registering-provider');
+		}
+	}
+
+	protected async unRegisterProvider(provider: IOutboundMessageProviders, appId: string): Promise<void> {
+		try {
+			this.orch.debugLog(`App ${appId} is unregistering an outbound provider.`);
+			getOutboundService().outboundMessageProvider.unregisterProvider(appId, provider.type);
+		} catch (err) {
+			this.orch.getRocketChatLogger().error({ appId, err, msg: 'Failed to unregister provider' });
+			throw new Error('error-unregistering-provider');
+		}
+	}
+}

apps/meteor/app/livechat/server/lib/outboundcommunication.ts

@@ -0,0 +1,6 @@
+import type { IOutboundMessageProviderService } from '@rocket.chat/core-typings';
+import { makeFunction } from '@rocket.chat/patch-injection';
+
+export const getOutboundService = makeFunction((): IOutboundMessageProviderService => {
+	throw new Error('error-no-license');
+});

apps/meteor/ee/app/livechat-enterprise/server/api/lib/outbound.ts

@@ -1,15 +1,26 @@
-import type { IOutboundProvider, ValidOutboundProvider } from '@rocket.chat/core-typings';
+import { Apps } from '@rocket.chat/apps';
+import type {
+	IOutboundProvider,
+	ValidOutboundProvider,
+	IOutboundMessageProviderService,
+	IOutboundProviderMetadata,
+} from '@rocket.chat/core-typings';
 import { ValidOutboundProviderList } from '@rocket.chat/core-typings';
 
+import { getOutboundService } from '../../../../../../app/livechat/server/lib/outboundcommunication';
 import { OutboundMessageProvider } from '../../../../../../server/lib/OutboundMessageProvider';
 
-export class OutboundMessageProviderService {
+export class OutboundMessageProviderService implements IOutboundMessageProviderService {
 	private readonly provider: OutboundMessageProvider;
 
 	constructor() {
 		this.provider = new OutboundMessageProvider();
 	}
 
+	get outboundMessageProvider() {
+		return this.provider;
+	}
+
 	private isProviderValid(type: any): type is ValidOutboundProvider {
 		return ValidOutboundProviderList.includes(type);
 	}
@@ -21,6 +32,41 @@ export class OutboundMessageProviderService {
 
 		return this.provider.getOutboundMessageProviders(type);
 	}
+
+	public getProviderMetadata(providerId: string): Promise<IOutboundProviderMetadata> {
+		const provider = this.provider.findOneByProviderId(providerId);
+		if (!provider) {
+			throw new Error('error-invalid-provider');
+		}
+
+		return this.getProviderManager().getProviderMetadata(provider.appId, provider.type);
+	}
+
+	private getProviderManager() {
+		if (!Apps.self?.isLoaded()) {
+			throw new Error('apps-engine-not-loaded');
+		}
+
+		const manager = Apps.self?.getManager()?.getOutboundCommunicationProviderManager();
+		if (!manager) {
+			throw new Error('apps-engine-not-configured-correctly');
+		}
+
+		return manager;
+	}
+
+	public sendMessage(providerId: string, body: any) {
+		const provider = this.provider.findOneByProviderId(providerId);
+		if (!provider) {
+			throw new Error('error-invalid-provider');
+		}
+
+		return this.getProviderManager().sendOutboundMessage(provider.appId, provider.type, body);
+	}
 }
 
 export const outboundMessageProvider = new OutboundMessageProviderService();
+
+getOutboundService.patch(() => {
+	return outboundMessageProvider;
+});

apps/meteor/ee/app/livechat-enterprise/server/api/outbound.ts

@@ -30,6 +30,9 @@ const outboundCommsEndpoints = API.v1.get(
 								providerType: {
 									type: 'string',
 								},
+								documentationUrl: {
+									type: 'string',
+								},
 							},
 						},
 					},

apps/meteor/server/lib/OutboundMessageProvider.ts

@@ -3,14 +3,7 @@ import type {
 	IOutboundMessageProviders,
 	IOutboundPhoneMessageProvider,
 } from '@rocket.chat/apps-engine/definition/outboundComunication';
-import type { ValidOutboundProvider, IOutboundProvider } from '@rocket.chat/core-typings';
-
-interface IOutboundMessageProvider {
-	registerPhoneProvider(provider: IOutboundPhoneMessageProvider): void;
-	registerEmailProvider(provider: IOutboundEmailMessageProvider): void;
-	getOutboundMessageProviders(type?: ValidOutboundProvider): IOutboundProvider[];
-	unregisterProvider(appId: string, providerType: string): void;
-}
+import type { ValidOutboundProvider, IOutboundProvider, IOutboundMessageProvider } from '@rocket.chat/core-typings';
 
 export class OutboundMessageProvider implements IOutboundMessageProvider {
 	private readonly outboundMessageProviders: Map<ValidOutboundProvider, IOutboundMessageProviders[]>;
@@ -22,6 +15,17 @@ export class OutboundMessageProvider implements IOutboundMessageProvider {
 		]);
 	}
 
+	public findOneByProviderId(providerId: string) {
+		for (const providers of this.outboundMessageProviders.values()) {
+			for (const provider of providers) {
+				if (provider.appId === providerId) {
+					return provider;
+				}
+			}
+		}
+		return undefined;
+	}
+
 	public registerPhoneProvider(provider: IOutboundPhoneMessageProvider): void {
 		this.outboundMessageProviders.set('phone', [...(this.outboundMessageProviders.get('phone') || []), provider]);
 	}
@@ -36,6 +40,7 @@ export class OutboundMessageProvider implements IOutboundMessageProvider {
 				providerId: provider.appId,
 				providerName: provider.name,
 				providerType: provider.type,
+				...(provider.documentationUrl && { documentationUrl: provider.documentationUrl }),
 				...(provider.supportsTemplates && { supportsTemplates: provider.supportsTemplates }),
 			}));
 		}

packages/apps-engine/deno-runtime/handlers/outboundcomms-handler.ts

@@ -0,0 +1,32 @@
+import { JsonRpcError, Defined } from 'jsonrpc-lite';
+import type { IOutboundMessageProviders } from '@rocket.chat/apps-engine/definition/outboundCommunication/IOutboundCommsProvider.ts';
+
+import { AppObjectRegistry } from '../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../lib/accessors/mod.ts';
+import { Logger } from '../lib/logger.ts';
+
+export default async function outboundMessageHandler(call: string, params: unknown): Promise<JsonRpcError | Defined> {
+	const [, providerName, methodName] = call.split(':');
+	const provider = AppObjectRegistry.get<IOutboundMessageProviders>(`outboundCommunication:${providerName}`);
+	if (!provider) {
+		return new JsonRpcError('error-invalid-provider', -32000);
+	}
+	const method = provider[methodName as keyof IOutboundMessageProviders];
+	const logger = AppObjectRegistry.get<Logger>('logger');
+	const args = (params as Array<unknown>) ?? [];
+
+	try {
+		logger?.debug(`Executing ${methodName} on outbound communication provider...`);
+
+		// deno-lint-ignore ban-types
+		return await (method as Function).apply(provider, [
+			...args,
+			AppAccessorsInstance.getReader(),
+			AppAccessorsInstance.getModifier(),
+			AppAccessorsInstance.getHttp(),
+			AppAccessorsInstance.getPersistence(),
+		]);
+	} catch (e) {
+		return new JsonRpcError(e.message, -32000);
+	}
+}

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

@@ -13,6 +13,10 @@ import type { ISlashCommand } from '@rocket.chat/apps-engine/definition/slashcom
 import type { IProcessor } from '@rocket.chat/apps-engine/definition/scheduler/IProcessor.ts';
 import type { IApi } from '@rocket.chat/apps-engine/definition/api/IApi.ts';
 import type { IVideoConfProvider } from '@rocket.chat/apps-engine/definition/videoConfProviders/IVideoConfProvider.ts';
+import type {
+	IOutboundPhoneMessageProvider,
+	IOutboundEmailMessageProvider,
+} from '@rocket.chat/apps-engine/definition/outboundCommunication/IOutboundCommsProvider.ts';
 
 import { Http } from './http.ts';
 import { HttpExtend } from './extenders/HttpExtender.ts';
@@ -188,6 +192,17 @@ export class AppAccessors {
 						return this._proxy.provideVideoConfProvider(provider);
 					},
 				},
+				outboundCommunication: {
+					_proxy: this.proxify('getConfigurationExtend:outboundCommunication'),
+					registerEmailProvider(provider: IOutboundEmailMessageProvider) {
+						AppObjectRegistry.set(`outboundCommunication:${provider.name}-${provider.type}`, provider);
+						return this._proxy.registerEmailProvider(provider);
+					},
+					registerPhoneProvider(provider: IOutboundPhoneMessageProvider) {
+						AppObjectRegistry.set(`outboundCommunication:${provider.name}-${provider.type}`, provider);
+						return this._proxy.registerPhoneProvider(provider);
+					},
+				},
 				slashCommands: {
 					_proxy: this.proxify('getConfigurationExtend:slashCommands'),
 					provideSlashCommand(slashcommand: ISlashCommand) {

packages/apps-engine/deno-runtime/main.ts

@@ -23,12 +23,14 @@ import handleApp from './handlers/app/handler.ts';
 import handleScheduler from './handlers/scheduler-handler.ts';
 import registerErrorListeners from './error-handlers.ts';
 import { sendMetrics } from './lib/metricsCollector.ts';
+import outboundMessageHandler from './handlers/outboundcomms-handler.ts';
 
 type Handlers = {
 	app: typeof handleApp;
 	api: typeof apiHandler;
 	slashcommand: typeof slashcommandHandler;
 	videoconference: typeof videoConferenceHandler;
+	outboundCommunication: typeof outboundMessageHandler;
 	scheduler: typeof handleScheduler;
 	ping: (method: string, params: unknown) => 'pong';
 };
@@ -41,6 +43,7 @@ async function requestRouter({ type, payload }: Messenger.JsonRpcRequest): Promi
 		api: apiHandler,
 		slashcommand: slashcommandHandler,
 		videoconference: videoConferenceHandler,
+		outboundCommunication: outboundMessageHandler,
 		scheduler: handleScheduler,
 		ping: (_method, _params) => 'pong',
 	};

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

@@ -1,6 +1,7 @@
 import type { IApiExtend } from './IApiExtend';
 import type { IExternalComponentsExtend } from './IExternalComponentsExtend';
 import type { IHttpExtend } from './IHttp';
+import type { IOutboundCommunicationProviderExtend } from './IOutboundCommunicationProviderExtend';
 import type { ISchedulerExtend } from './ISchedulerExtend';
 import type { ISettingsExtend } from './ISettingsExtend';
 import type { ISlashCommandsExtend } from './ISlashCommandsExtend';
@@ -33,4 +34,7 @@ export interface IConfigurationExtend {
 
 	/** Accessor for declaring the videoconf providers which your App provides. */
 	readonly videoConfProviders: IVideoConfProvidersExtend;
+
+	/** Accessor for declaring outbound communication providers */
+	readonly outboundCommunication: IOutboundCommunicationProviderExtend;
 }