New room events (#266)

* Fix security problem

* Add IPreRoomUserJoined event

* Add the IPostRoomUserJoined event

* New "essentials" mechanism (#269)

src/definition/AppStatus.ts

@@ -51,6 +51,13 @@ export class AppStatusUtilsDef {
                 return false;
         }
     }
+
+    public isError(status: AppStatus): boolean {
+        return [
+            AppStatus.ERROR_DISABLED,
+            AppStatus.COMPILER_ERROR_DISABLED,
+        ].includes(status);
+    }
 }
 
 export const AppStatusUtils = new AppStatusUtilsDef();

src/definition/exceptions/AppsEngineException.ts

@@ -0,0 +1,14 @@
+/**
+ * The internal exception from the framework
+ *
+ * It's used to signal to the outside world that
+ * a _known_ exception has happened during the execution
+ * of the apps.
+ *
+ * It's the base exception for other known classes
+ * such as UserNotAllowedException, which is used
+ * to inform the host that an app identified
+ * that a user cannot perform some action, e.g.
+ * join a room
+ */
+export class AppsEngineException extends Error {}

src/definition/exceptions/EssentialAppDisabledException.ts

@@ -0,0 +1,17 @@
+import { AppsEngineException } from '.';
+
+/**
+ * This exception informs the host system that an
+ * app essential to the execution of a system action
+ * is disabled, so the action should be halted.
+ *
+ * Apps can register to be considered essential to
+ * the execution of internal events of the framework
+ * such as `IPreMessageSentPrevent`, `IPreRoomUserJoined`,
+ * etc.
+ *
+ * This is used interally by the framework and is not
+ * intended to be thrown manually by apps.
+ */
+export class EssentialAppDisabledException extends AppsEngineException {
+}

src/definition/exceptions/UserNotAllowedException.ts

@@ -0,0 +1,14 @@
+import { AppsEngineException } from '.';
+
+/**
+ * This exception informs the host system that an
+ * app has determined that an user is not allowed
+ * to perform a specific action.
+ *
+ * Currently it is expected to be thrown by the
+ * following events:
+ * - IPreRoomCreatePrevent
+ * - IPreRoomUserJoined
+ */
+export class UserNotAllowedException extends AppsEngineException {
+}

src/definition/exceptions/index.ts

@@ -0,0 +1,3 @@
+export * from './AppsEngineException';
+export * from './EssentialAppDisabledException';
+export * from './UserNotAllowedException';

src/definition/metadata/AppInterface.ts

@@ -0,0 +1,36 @@
+export enum AppInterface {
+    // Messages
+    IPreMessageSentPrevent = 'IPreMessageSentPrevent',
+    IPreMessageSentExtend = 'IPreMessageSentExtend',
+    IPreMessageSentModify = 'IPreMessageSentModify',
+    IPostMessageSent = 'IPostMessageSent',
+    IPreMessageDeletePrevent = 'IPreMessageDeletePrevent',
+    IPostMessageDeleted = 'IPostMessageDeleted',
+    IPreMessageUpdatedPrevent = 'IPreMessageUpdatedPrevent',
+    IPreMessageUpdatedExtend = 'IPreMessageUpdatedExtend',
+    IPreMessageUpdatedModify = 'IPreMessageUpdatedModify',
+    IPostMessageUpdated = 'IPostMessageUpdated',
+    // Rooms
+    IPreRoomCreatePrevent = 'IPreRoomCreatePrevent',
+    IPreRoomCreateExtend = 'IPreRoomCreateExtend',
+    IPreRoomCreateModify = 'IPreRoomCreateModify',
+    IPostRoomCreate = 'IPostRoomCreate',
+    IPreRoomDeletePrevent = 'IPreRoomDeletePrevent',
+    IPostRoomDeleted = 'IPostRoomDeleted',
+    IPreRoomUserJoined = 'IPreRoomUserJoined',
+    IPostRoomUserJoined = 'IPostRoomUserJoined',
+    // External Components
+    IPostExternalComponentOpened = 'IPostExternalComponentOpened',
+    IPostExternalComponentClosed = 'IPostExternalComponentClosed',
+    // Blocks
+    IUIKitInteractionHandler = 'IUIKitInteractionHandler',
+    // Livechat
+    IPostLivechatRoomStarted = 'IPostLivechatRoomStarted',
+    IPostLivechatRoomClosed = 'IPostLivechatRoomClosed',
+    /**
+     * @deprecated please use the AppMethod.EXECUTE_POST_LIVECHAT_ROOM_CLOSED method
+     */
+    ILivechatRoomClosedHandler = 'ILivechatRoomClosedHandler',
+    IPostLivechatAgentAssigned = 'IPostLivechatAgentAssigned',
+    IPostLivechatAgentUnassigned = 'IPostLivechatAgentUnassigned',
+}

src/definition/metadata/AppMethod.ts

@@ -43,6 +43,8 @@ export enum AppMethod {
     EXECUTEPREROOMDELETEPREVENT = 'executePreRoomDeletePrevent',
     CHECKPOSTROOMDELETED = 'checkPostRoomDeleted',
     EXECUTEPOSTROOMDELETED = 'executePostRoomDeleted',
+    EXECUTE_PRE_ROOM_USER_JOINED = 'executePreRoomUserJoined',
+    EXECUTE_POST_ROOM_USER_JOINED = 'executePostRoomUserJoined',
     // External Component handlers
     EXECUTEPOSTEXTERNALCOMPONENTOPENED = 'executePostExternalComponentOpened',
     EXECUTEPOSTEXTERNALCOMPONENTCLOSED = 'executePostExternalComponentClosed',

src/definition/metadata/IAppInfo.ts

@@ -1,3 +1,4 @@
+import { AppInterface } from './AppInterface';
 import { IAppAuthorInfo } from './IAppAuthorInfo';
 
 export interface IAppInfo {
@@ -12,4 +13,5 @@ export interface IAppInfo {
     iconFile: string;
     /** Base64 string of the App's icon. */
     iconFileContent?: string;
+    essentials?: Array<AppInterface>;
 }

src/definition/metadata/index.ts

@@ -3,6 +3,8 @@ import { IAppAuthorInfo } from './IAppAuthorInfo';
 import { IAppInfo } from './IAppInfo';
 import { RocketChatAssociationModel, RocketChatAssociationRecord } from './RocketChatAssociations';
 
+export * from './AppInterface';
+
 export {
     AppMethod,
     IAppAuthorInfo,

src/definition/rooms/IPostRoomUserJoined.ts

@@ -0,0 +1,19 @@
+import { IHttp, IPersistence, IRead } from '../accessors';
+import { IRoomUserJoinedContext } from './IRoomUserJoinedContext';
+
+/**
+ * Event interface that allows an app to
+ * register as a handler of the `IPostRoomUserJoined`
+ * event
+ *
+ * This event is triggered after an user succcessfully joined
+ * a room.
+ *
+ * This event does not allow an app to prevent any action from
+ * happening. For that, see its "pre counterpart(s)":
+ *
+ * - IPreRoomUserJoined
+ */
+export interface IPostRoomUserJoined {
+    executePostRoomUserJoined(context: IRoomUserJoinedContext, read: IRead, http: IHttp, persistence: IPersistence): Promise<void>;
+}

src/definition/rooms/IPreRoomUserJoined.ts

@@ -0,0 +1,18 @@
+import { IHttp, IPersistence, IRead } from '../accessors';
+import { IRoomUserJoinedContext } from './IRoomUserJoinedContext';
+
+/**
+ * Event interface that allows an app to
+ * register as a handler of the `IPreRoomUserJoined`
+ * event
+ *
+ * This event is triggered prior to an user succcessfully
+ * joining a room. To prevent the user from executing
+ * such action, an app should throw the `UserNotAllowedException`.
+ *
+ * This event is not triggered before a room has been created. For that,
+ * check the `IPreRoomCreate` events
+ */
+export interface IPreRoomUserJoined {
+    executePreRoomUserJoined(context: IRoomUserJoinedContext, read: IRead, http: IHttp, persistence: IPersistence): Promise<void>;
+}

src/definition/rooms/IRoomUserJoinedContext.ts

@@ -0,0 +1,23 @@
+import { IUser } from '../users';
+import { IRoom } from './IRoom';
+
+/**
+ * The context of execution for the following events:
+ * - IPreRoomUserJoined
+ * - IPostRoomUserJoined
+ */
+export interface IRoomUserJoinedContext {
+    /**
+     * The user that is being added to the room
+     */
+    joiningUser: IUser;
+    /**
+     * The room to which the user is being added
+     */
+    room: IRoom;
+    /**
+     * The user that has invited `joiningUser` to `room`,
+     * if any.
+     */
+    inviter?: IUser;
+}

src/definition/rooms/index.ts

@@ -17,3 +17,7 @@ export {
     IPreRoomCreatePrevent,
     IPreRoomDeletePrevent,
 };
+
+export * from './IPreRoomUserJoined';
+export * from './IPostRoomUserJoined';
+export * from './IRoomUserJoinedContext';

src/server/AppManager.ts

@@ -222,9 +222,11 @@ export class AppManager {
 
         // Now let's enable the apps which were once enabled
         // but are not currently disabled.
-        for (const rl of this.apps.values()) {
-            if (!AppStatusUtils.isDisabled(rl.getStatus()) && AppStatusUtils.isEnabled(rl.getPreviousStatus())) {
-                await this.enableApp(items.get(rl.getID()), rl, true, rl.getPreviousStatus() === AppStatus.MANUALLY_ENABLED).catch(console.error);
+        for (const app of this.apps.values()) {
+            if (!AppStatusUtils.isDisabled(app.getStatus()) && AppStatusUtils.isEnabled(app.getPreviousStatus())) {
+                await this.enableApp(items.get(app.getID()), app, true, app.getPreviousStatus() === AppStatus.MANUALLY_ENABLED).catch(console.error);
+            } else if (!AppStatusUtils.isError(app.getStatus())) {
+                this.listenerManager.lockEssentialEvents(app);
             }
         }
 
@@ -239,21 +241,18 @@ export class AppManager {
             return;
         }
 
-        for (const rl of this.apps.values()) {
-            if (AppStatusUtils.isDisabled(rl.getStatus())) {
-                continue;
-            }
-
-            if (rl.getStatus() === AppStatus.INITIALIZED) {
-                this.listenerManager.unregisterListeners(rl);
-                this.commandManager.unregisterCommands(rl.getID());
-                this.externalComponentManager.unregisterExternalComponents(rl.getID());
-                this.apiManager.unregisterApis(rl.getID());
-                this.accessorManager.purifyApp(rl.getID());
-                continue;
+        for (const app of this.apps.values()) {
+            if (app.getStatus() === AppStatus.INITIALIZED) {
+                this.listenerManager.unregisterListeners(app);
+                this.commandManager.unregisterCommands(app.getID());
+                this.externalComponentManager.unregisterExternalComponents(app.getID());
+                this.apiManager.unregisterApis(app.getID());
+                this.accessorManager.purifyApp(app.getID());
+            } else if (!AppStatusUtils.isDisabled(app.getStatus())) {
+                await this.disable(app.getID(), isManual ? AppStatus.MANUALLY_DISABLED : AppStatus.DISABLED);
             }
 
-            await this.disable(rl.getID(), isManual ? AppStatus.MANUALLY_DISABLED : AppStatus.DISABLED);
+            this.listenerManager.releaseEssentialEvents(app);
         }
 
         // Remove all the apps from the system now that we have unloaded everything
@@ -350,33 +349,34 @@ export class AppManager {
             throw new Error('Invalid disabled status');
         }
 
-        const rl = this.apps.get(id);
+        const app = this.apps.get(id);
 
-        if (!rl) {
+        if (!app) {
             throw new Error(`No App by the id "${id}" exists.`);
         }
 
-        if (AppStatusUtils.isEnabled(rl.getStatus())) {
-            await rl.call(AppMethod.ONDISABLE, this.accessorManager.getConfigurationModify(rl.getID()))
+        if (AppStatusUtils.isEnabled(app.getStatus())) {
+            await app.call(AppMethod.ONDISABLE, this.accessorManager.getConfigurationModify(app.getID()))
                 .catch((e) => console.warn('Error while disabling:', e));
         }
 
-        this.listenerManager.unregisterListeners(rl);
-        this.commandManager.unregisterCommands(rl.getID());
-        this.externalComponentManager.unregisterExternalComponents(rl.getID());
-        this.apiManager.unregisterApis(rl.getID());
-        this.accessorManager.purifyApp(rl.getID());
+        this.listenerManager.unregisterListeners(app);
+        this.listenerManager.lockEssentialEvents(app);
+        this.commandManager.unregisterCommands(app.getID());
+        this.externalComponentManager.unregisterExternalComponents(app.getID());
+        this.apiManager.unregisterApis(app.getID());
+        this.accessorManager.purifyApp(app.getID());
 
-        await rl.setStatus(status, silent);
+        await app.setStatus(status, silent);
 
         const storageItem = await this.storage.retrieveOne(id);
 
-        rl.getStorageItem().marketplaceInfo = storageItem.marketplaceInfo;
-        await rl.validateLicense().catch();
+        app.getStorageItem().marketplaceInfo = storageItem.marketplaceInfo;
+        await app.validateLicense().catch();
 
         // This is async, but we don't care since it only updates in the database
         // and it should not mutate any properties we care about
-        storageItem.status = rl.getStatus();
+        storageItem.status = app.getStatus();
         await this.storage.update(storageItem).catch();
 
         return true;
@@ -462,6 +462,7 @@ export class AppManager {
         }
 
         this.listenerManager.unregisterListeners(app);
+        this.listenerManager.releaseEssentialEvents(app);
         this.commandManager.unregisterCommands(app.getID());
         this.externalComponentManager.purgeExternalComponents(app.getID());
         this.apiManager.unregisterApis(app.getID());
@@ -796,10 +797,12 @@ export class AppManager {
             this.externalComponentManager.registerExternalComponents(app.getID());
             this.apiManager.registerApis(app.getID());
             this.listenerManager.registerListeners(app);
+            this.listenerManager.releaseEssentialEvents(app);
         } else {
             this.commandManager.unregisterCommands(app.getID());
             this.externalComponentManager.unregisterExternalComponents(app.getID());
             this.apiManager.unregisterApis(app.getID());
+            this.listenerManager.lockEssentialEvents(app);
         }
 
         if (saveToDb) {

src/server/ProxiedApp.ts

@@ -1,8 +1,8 @@
 import * as vm from 'vm';
-
 import { IAppAccessors, ILogger } from '../definition/accessors';
 import { App } from '../definition/App';
 import { AppStatus } from '../definition/AppStatus';
+import { AppsEngineException } from '../definition/exceptions';
 import { IApp } from '../definition/IApp';
 import { AppMethod, IAppAuthorInfo, IAppInfo } from '../definition/metadata';
 import { AppManager } from './AppManager';
@@ -88,6 +88,10 @@ export class ProxiedApp implements IApp {
         } catch (e) {
             logger.error(e);
             logger.debug(`'${method}' was unsuccessful.`);
+
+            if (e instanceof AppsEngineException) {
+                throw e;
+            }
         }
 
         this.manager.getLogStorage().storeEntries(this.getID(), logger);
@@ -150,6 +154,10 @@ export class ProxiedApp implements IApp {
         return this.app.getAccessors();
     }
 
+    public getEssentials(): IAppInfo['essentials'] {
+        return this.getInfo().essentials;
+    }
+
     public getLatestLicenseValidationResult(): AppLicenseValidationResult {
         return this.latestLicenseValidationResult;
     }

src/server/bridges/IListenerBridge.ts

@@ -1,7 +1,7 @@
 import { IMessage } from '../../definition/messages';
+import { AppInterface } from '../../definition/metadata';
 import { IRoom } from '../../definition/rooms';
 import { IUIKitIncomingInteraction } from '../../definition/uikit';
-import { AppInterface } from '../compiler';
 
 export interface IListenerBridge {
     messageEvent(int: AppInterface, message: IMessage): Promise<void | boolean | IMessage>;