[NEW] Video Conference Providers

src/definition/accessors/IConfigurationExtend.ts

@@ -5,6 +5,7 @@ import { ISchedulerExtend } from './ISchedulerExtend';
 import { ISettingsExtend } from './ISettingsExtend';
 import { ISlashCommandsExtend } from './ISlashCommandsExtend';
 import { IUIExtend } from './IUIExtend';
+import { IVideoConfProvidersExtend } from './IVideoConfProvidersExtend';
 
 /**
  * This accessor provides methods for declaring the configuration
@@ -29,4 +30,7 @@ export interface IConfigurationExtend {
     readonly scheduler: ISchedulerExtend;
     /** Accessor for registering different elements in the host UI */
     readonly ui: IUIExtend;
+
+    /** Accessor for declaring the videoconf providers which your App provides. */
+    readonly videoConfProviders: IVideoConfProvidersExtend;
 }

src/definition/accessors/IVideoConfProvidersExtend.ts

@@ -0,0 +1,15 @@
+import { IVideoConfProvider } from '../videoConfProviders';
+
+/**
+ * This accessor provides methods for adding videoconf providers.
+ * It is provided during the initialization of your App
+ */
+
+export interface IVideoConfProvidersExtend {
+    /**
+     * Adds a videoconf provider
+     *
+     * @param provider the provider information
+     */
+    provideVideoConfProvider(provider: IVideoConfProvider): Promise<void>;
+}

src/definition/accessors/index.ts

@@ -45,3 +45,4 @@ export * from './IUploadCreator';
 export * from './IUploadRead';
 export * from './IUserBuilder';
 export * from './IUserRead';
+export * from './IVideoConfProvidersExtend';

src/definition/metadata/AppMethod.ts

@@ -5,6 +5,8 @@ export enum AppMethod {
     _COMMAND_PREVIEWER = 'previewer',
     _COMMAND_PREVIEW_EXECUTOR = 'executePreviewItem',
     _JOB_PROCESSOR = 'jobProcessor',
+    _VIDEOCONF_GENERATE_URL = 'generateUrl',
+    _VIDEOCONF_CUSTOMIZE_URL = 'customizeUrl',
     INITIALIZE = 'initialize',
     ONENABLE = 'onEnable',
     ONDISABLE = 'onDisable',

src/definition/videoConfProviders/IVideoConfProvider.ts

@@ -0,0 +1,17 @@
+import { INewVideoConference, IVideoConference } from './IVideoConference';
+import { IVideoConferenceOptions } from './IVideoConferenceOptions';
+import { IVideoConferenceUser } from './IVideoConferenceUser';
+
+/**
+ * Represents a video conference provider
+ */
+export interface IVideoConfProvider {
+    /**
+     * The function which gets called when a new video conference url is requested
+     */
+    generateUrl(call: INewVideoConference): Promise<string>;
+    /**
+     * The function which gets called whenever a user join url is requested
+     */
+    customizeUrl(call: IVideoConference, user?: IVideoConferenceUser, options?: IVideoConferenceOptions): Promise<string>;
+}

src/definition/videoConfProviders/IVideoConference.ts

@@ -0,0 +1,13 @@
+import type { IVideoConferenceUser } from './IVideoConferenceUser';
+
+export interface INewVideoConference {
+    _id: string;
+    type: 'direct' | 'videoconference';
+    rid: string;
+    createdBy: IVideoConferenceUser;
+    title?: string;
+}
+
+export interface IVideoConference extends INewVideoConference {
+    url: string;
+}

src/definition/videoConfProviders/IVideoConferenceOptions.ts

@@ -0,0 +1,4 @@
+export interface IVideoConferenceOptions {
+    mic?: boolean;
+    cam?: boolean;
+}

src/definition/videoConfProviders/IVideoConferenceUser.ts

@@ -0,0 +1,5 @@
+export interface IVideoConferenceUser {
+    _id: string;
+    username: string;
+    name: string;
+}

src/definition/videoConfProviders/index.ts

@@ -0,0 +1,12 @@
+import { INewVideoConference, IVideoConference } from './IVideoConference';
+import { IVideoConferenceOptions } from './IVideoConferenceOptions';
+import { IVideoConferenceUser } from './IVideoConferenceUser';
+import { IVideoConfProvider } from './IVideoConfProvider';
+
+export {
+    INewVideoConference,
+    IVideoConference,
+    IVideoConferenceOptions,
+    IVideoConferenceUser,
+    IVideoConfProvider,
+};

src/server/AppManager.ts

@@ -11,7 +11,7 @@ import { InvalidLicenseError } from './errors';
 import { IGetAppsFilter } from './IGetAppsFilter';
 import {
     AppAccessorManager, AppApiManager, AppExternalComponentManager, AppLicenseManager, AppListenerManager, AppSchedulerManager, AppSettingsManager,
-    AppSlashCommandManager,
+    AppSlashCommandManager, AppVideoConfProviderManager,
 } from './managers';
 import { UIActionButtonManager } from './managers/UIActionButtonManager';
 import { IMarketplaceInfo } from './marketplace';
@@ -60,6 +60,7 @@ export class AppManager {
     private readonly licenseManager: AppLicenseManager;
     private readonly schedulerManager: AppSchedulerManager;
     private readonly uiActionButtonManager: UIActionButtonManager;
+    private readonly videoConfProviderManager: AppVideoConfProviderManager;
 
     private isLoaded: boolean;
 
@@ -106,6 +107,7 @@ export class AppManager {
         this.licenseManager = new AppLicenseManager(this);
         this.schedulerManager = new AppSchedulerManager(this);
         this.uiActionButtonManager = new UIActionButtonManager(this);
+        this.videoConfProviderManager = new AppVideoConfProviderManager(this);
 
         this.isLoaded = false;
         AppManager.Instance = this;
@@ -151,6 +153,10 @@ export class AppManager {
         return this.commandManager;
     }
 
+    public getVideoConfProviderManager(): AppVideoConfProviderManager {
+        return this.videoConfProviderManager;
+    }
+
     public getLicenseManager(): AppLicenseManager {
         return this.licenseManager;
     }
@@ -870,6 +876,7 @@ export class AppManager {
         this.accessorManager.purifyApp(app.getID());
         await this.schedulerManager.cleanUp(app.getID());
         this.uiActionButtonManager.clearAppActionButtons(app.getID());
+        this.videoConfProviderManager.unregisterProviders(app.getID());
     }
 
     /**
@@ -936,6 +943,7 @@ export class AppManager {
             this.apiManager.registerApis(app.getID());
             this.listenerManager.registerListeners(app);
             this.listenerManager.releaseEssentialEvents(app);
+            this.videoConfProviderManager.registerProviders(app.getID());
         } else {
             await this.purgeAppConfig(app);
         }

src/server/accessors/ConfigurationExtend.ts

@@ -7,6 +7,7 @@ import {
     ISettingsExtend,
     ISlashCommandsExtend,
     IUIExtend,
+    IVideoConfProvidersExtend,
 } from '../../definition/accessors';
 
 export class ConfigurationExtend implements IConfigurationExtend {
@@ -18,5 +19,6 @@ export class ConfigurationExtend implements IConfigurationExtend {
         public readonly externalComponents: IExternalComponentsExtend,
         public readonly scheduler: ISchedulerExtend,
         public readonly ui: IUIExtend,
+        public readonly videoConfProviders: IVideoConfProvidersExtend,
     ) { }
 }

src/server/accessors/VideoConfProviderExtend.ts

@@ -0,0 +1,12 @@
+import { AppVideoConfProviderManager } from '../managers/AppVideoConfProviderManager';
+
+import { IVideoConfProvidersExtend } from '../../definition/accessors';
+import { IVideoConfProvider } from '../../definition/videoConfProviders';
+
+export class VideoConfProviderExtend implements IVideoConfProvidersExtend {
+    constructor(private readonly manager: AppVideoConfProviderManager, private readonly appId: string) { }
+
+    public provideVideoConfProvider(provider: IVideoConfProvider): Promise<void> {
+        return Promise.resolve(this.manager.addProvider(this.appId, provider));
+    }
+}

src/server/accessors/index.ts

@@ -33,6 +33,7 @@ import { SlashCommandsModify } from './SlashCommandsModify';
 import { UploadRead } from './UploadRead';
 import { UserBuilder } from './UserBuilder';
 import { UserRead } from './UserRead';
+import { VideoConfProviderExtend } from './VideoConfProviderExtend';
 
 export {
     ApiExtend,
@@ -70,4 +71,5 @@ export {
     UserRead,
     SchedulerExtend,
     SchedulerModify,
+    VideoConfProviderExtend,
 };

src/server/errors/AVideoConfProviderAlreadyExistsError.ts

@@ -0,0 +1,4 @@
+export class AVideoConfProviderAlreadyExistsError implements Error {
+    public name = 'AVideoConfProviderAlreadyExists';
+    public message = 'A video conference provider is already registered in the system.';
+}

src/server/errors/NoVideoConfProviderRegisteredError.ts

@@ -0,0 +1,4 @@
+export class NoVideoConfProviderRegisteredError implements Error {
+    public name = 'NoVideoConfProviderRegistered';
+    public message = 'There are no video conference providers registered in the system.';
+}

src/server/errors/index.ts

@@ -1,10 +1,12 @@
+import { AVideoConfProviderAlreadyExistsError } from './AVideoConfProviderAlreadyExistsError';
 import { CommandAlreadyExistsError } from './CommandAlreadyExistsError';
 import { CommandHasAlreadyBeenTouchedError } from './CommandHasAlreadyBeenTouchedError';
 import { CompilerError } from './CompilerError';
 import { InvalidLicenseError } from './InvalidLicenseError';
 import { MustContainFunctionError } from './MustContainFunctionError';
 import { MustExtendAppError } from './MustExtendAppError';
 import { NotEnoughMethodArgumentsError } from './NotEnoughMethodArgumentsError';
+import { NoVideoConfProviderRegisteredError } from './NoVideoConfProviderRegisteredError';
 import { PathAlreadyExistsError } from './PathAlreadyExistsError';
 import { RequiredApiVersionError } from './RequiredApiVersionError';
 
@@ -18,4 +20,6 @@ export {
     NotEnoughMethodArgumentsError,
     RequiredApiVersionError,
     InvalidLicenseError,
+    NoVideoConfProviderRegisteredError,
+    AVideoConfProviderAlreadyExistsError,
 };

src/server/managers/AppAccessorManager.ts

@@ -35,6 +35,7 @@ import {
     SlashCommandsModify,
     UploadRead,
     UserRead,
+    VideoConfProviderExtend,
 } from '../accessors';
 import { CloudWorkspaceRead } from '../accessors/CloudWorkspaceRead';
 import { UIExtend } from '../accessors/UIExtend';
@@ -87,13 +88,14 @@ export class AppAccessorManager {
 
             const htt = new HttpExtend();
             const cmds = new SlashCommandsExtend(this.manager.getCommandManager(), appId);
+            const videoConf = new VideoConfProviderExtend(this.manager.getVideoConfProviderManager(), appId);
             const apis = new ApiExtend(this.manager.getApiManager(), appId);
             const sets = new SettingsExtend(rl);
             const excs = new ExternalComponentsExtend(this.manager.getExternalComponentManager(), appId);
             const scheduler = new SchedulerExtend(this.manager.getSchedulerManager(), appId);
             const ui = new UIExtend(this.manager.getUIActionButtonManager(), appId);
 
-            this.configExtenders.set(appId, new ConfigurationExtend(htt, sets, cmds, apis, excs, scheduler, ui));
+            this.configExtenders.set(appId, new ConfigurationExtend(htt, sets, cmds, apis, excs, scheduler, ui, videoConf));
         }
 
         return this.configExtenders.get(appId);

src/server/managers/AppVideoConfProvider.ts

@@ -0,0 +1,88 @@
+import { AppMethod } from '../../definition/metadata';
+import type { INewVideoConference, IVideoConference, IVideoConferenceOptions, IVideoConferenceUser, IVideoConfProvider } from '../../definition/videoConfProviders';
+
+import { ProxiedApp } from '../ProxiedApp';
+import { AppLogStorage } from '../storage';
+import { AppAccessorManager } from './AppAccessorManager';
+
+export class AppVideoConfProvider {
+    /**
+     * States whether this provider has been registered into the Rocket.Chat system or not.
+     */
+    public isRegistered: boolean;
+
+    constructor(public app: ProxiedApp, public provider: IVideoConfProvider) {
+        this.isRegistered = false;
+    }
+
+    public hasBeenRegistered(): void {
+        this.isRegistered = true;
+    }
+
+    public canBeRan(method: AppMethod): boolean {
+        return this.app.hasMethod(method);
+    }
+
+    public async runGenerateUrl(
+      call: INewVideoConference,
+      logStorage: AppLogStorage,
+      accessors: AppAccessorManager,
+    ): Promise<string> {
+        return await this.runTheCode(AppMethod._VIDEOCONF_GENERATE_URL, logStorage, accessors, [call]);
+    }
+
+    public async runCustomizeUrl(
+      call: IVideoConference,
+      user: IVideoConferenceUser | undefined,
+      options: IVideoConferenceOptions = {},
+      logStorage: AppLogStorage,
+      accessors: AppAccessorManager,
+    ): Promise<string> {
+        return await this.runTheCode(AppMethod._VIDEOCONF_CUSTOMIZE_URL, logStorage, accessors, [call, user, options]);
+    }
+
+    private async runTheCode(
+      method: AppMethod._VIDEOCONF_GENERATE_URL | AppMethod._VIDEOCONF_CUSTOMIZE_URL,
+      logStorage: AppLogStorage,
+      accessors: AppAccessorManager,
+      runContextArgs: Array<any>,
+    ): Promise<string | undefined> {
+        // Ensure the provider has the property before going on
+        if (typeof this.provider[method] !== 'function') {
+            return;
+        }
+
+        const runContext = this.app.makeContext({
+            provider: this.provider,
+            args: [
+                ...runContextArgs,
+                accessors.getReader(this.app.getID()),
+                accessors.getModifier(this.app.getID()),
+                accessors.getHttp(this.app.getID()),
+                accessors.getPersistence(this.app.getID()),
+            ],
+        });
+
+        const logger = this.app.setupLogger(method);
+        logger.debug(`Executing ${ method } on video conference provider...`);
+
+        let result: string | undefined;
+        try {
+            const runCode = `provider.${ method }.apply(provider, args)`;
+            result = await this.app.runInContext(runCode, runContext);
+            logger.debug(`Video Conference Provider's ${ method } was successfully executed.`);
+        } catch (e) {
+            logger.error(e);
+            logger.debug(`Video Conference Provider's ${ method } was unsuccessful.`);
+        }
+
+        try {
+            await logStorage.storeEntries(this.app.getID(), logger);
+        } catch (e) {
+            // Don't care, at the moment.
+            // TODO: Evaluate to determine if we do care
+        }
+
+        return result;
+    }
+}