Merge branch 'feat/deno-runtime' into feat/videoconf-handler

deno-runtime/handlers/app/construct.ts

@@ -48,7 +48,7 @@ export default async function handleConstructApp(params: unknown): Promise<boole
     const [appPackage] = params as [IParseAppPackageResult];
 
     if (!appPackage?.info?.id || !appPackage?.info?.classFile || !appPackage?.files) {
-        throw new Error('Invalid params', { cause: 'invalid_param_type'});
+        throw new Error('Invalid params', { cause: 'invalid_param_type' });
     }
 
     AppObjectRegistry.set('id', appPackage.info.id);
@@ -93,4 +93,3 @@ export default async function handleConstructApp(params: unknown): Promise<boole
 
     return true;
 }
-

deno-runtime/handlers/app/handleGetStatus.ts

@@ -0,0 +1,14 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+
+export default function handleGetStatus(): Promise<boolean> {
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (typeof app?.getStatus !== 'function') {
+        throw new Error('App must contain a getStatus function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    return app.getStatus();
+}

deno-runtime/handlers/app/initialize.ts → deno-runtime/handlers/app/handleInitialize.ts

@@ -16,3 +16,4 @@ export default async function handleInitialize(): Promise<boolean> {
 
     return true;
 }
+

deno-runtime/handlers/app/handleOnDisable.ts

@@ -0,0 +1,18 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../../lib/accessors/mod.ts';
+
+export default async function handleOnDisable(): Promise<boolean> {
+  const app = AppObjectRegistry.get<App>('app');
+
+  if (typeof app?.onDisable !== 'function') {
+    throw new Error('App must contain an onDisable function', {
+      cause: 'invalid_app',
+    });
+  }
+
+  await app.onDisable(AppAccessorsInstance.getConfigurationModify());
+
+  return true;
+}
+

deno-runtime/handlers/app/handleOnEnable.ts

@@ -0,0 +1,16 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../../lib/accessors/mod.ts';
+
+export default function handleOnEnable(): Promise<boolean> {
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (typeof app?.onEnable !== 'function') {
+        throw new Error('App must contain an onEnable function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    return app.onEnable(AppAccessorsInstance.getEnvironmentRead(), AppAccessorsInstance.getConfigurationModify());
+}

deno-runtime/handlers/app/handleOnInstall.ts

@@ -0,0 +1,29 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../../lib/accessors/mod.ts';
+
+export default async function handleOnInstall(params: unknown): Promise<boolean> {
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (typeof app?.onInstall !== 'function') {
+        throw new Error('App must contain an onInstall function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    if (!Array.isArray(params)) {
+        throw new Error('Invalid params', { cause: 'invalid_param_type' });
+    }
+
+    const [context] = params as [Record<string, unknown>];
+
+    await app.onInstall(
+        context,
+        AppAccessorsInstance.getReader(),
+        AppAccessorsInstance.getHttp(),
+        AppAccessorsInstance.getPersistence(),
+        AppAccessorsInstance.getModifier(),
+    );
+
+    return true;
+}

deno-runtime/handlers/app/handleOnPreSettingUpdate.ts

@@ -0,0 +1,21 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../../lib/accessors/mod.ts';
+
+export default function handleOnPreSettingUpdate(params: unknown): Promise<object> {
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (typeof app?.onPreSettingUpdate !== 'function') {
+        throw new Error('App must contain an onPreSettingUpdate function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    if (!Array.isArray(params)) {
+        throw new Error('Invalid params', { cause: 'invalid_param_type' });
+    }
+
+    const [setting] = params as [Record<string, unknown>];
+
+    return app.onPreSettingUpdate(setting, AppAccessorsInstance.getConfigurationModify(), AppAccessorsInstance.getReader(), AppAccessorsInstance.getHttp());
+}

deno-runtime/handlers/app/handleOnSettingUpdated.ts

@@ -0,0 +1,23 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../../lib/accessors/mod.ts';
+
+export default async function handleOnSettingUpdated(params: unknown): Promise<boolean> {
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (typeof app?.onSettingUpdated !== 'function') {
+        throw new Error('App must contain an onSettingUpdated function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    if (!Array.isArray(params)) {
+        throw new Error('Invalid params', { cause: 'invalid_param_type' });
+    }
+
+    const [setting] = params as [Record<string, unknown>];
+
+    await app.onSettingUpdated(setting, AppAccessorsInstance.getConfigurationModify(), AppAccessorsInstance.getReader(), AppAccessorsInstance.getHttp());
+
+    return true;
+}

deno-runtime/handlers/app/handleOnUninstall.ts

@@ -0,0 +1,29 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { AppAccessorsInstance } from '../../lib/accessors/mod.ts';
+
+export default async function handleOnUninstall(params: unknown): Promise<boolean> {
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (typeof app?.onUninstall !== 'function') {
+        throw new Error('App must contain an onUninstall function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    if (!Array.isArray(params)) {
+        throw new Error('Invalid params', { cause: 'invalid_param_type' });
+    }
+
+    const [context] = params as [Record<string, unknown>];
+
+    await app.onUninstall(
+        context,
+        AppAccessorsInstance.getReader(),
+        AppAccessorsInstance.getHttp(),
+        AppAccessorsInstance.getPersistence(),
+        AppAccessorsInstance.getModifier(),
+    );
+
+    return true;
+}

deno-runtime/handlers/app/handleSetStatus.ts

@@ -0,0 +1,24 @@
+import type { App } from '@rocket.chat/apps-engine/definition/App.ts';
+import { AppStatus } from '@rocket.chat/apps-engine/definition/AppStatus.ts';
+
+import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+
+export default async function handleSetStatus(params: unknown): Promise<null> {
+    if (!Array.isArray(params) || !Object.values(AppStatus).includes(params[0])) {
+        throw new Error('Invalid params', { cause: 'invalid_param_type' });
+    }
+
+    const [status] = params as [AppStatus];
+
+    const app = AppObjectRegistry.get<App>('app');
+
+    if (!app || typeof app['setStatus'] !== 'function') {
+        throw new Error('App must contain a setStatus function', {
+            cause: 'invalid_app',
+        });
+    }
+
+    await app['setStatus'](status);
+
+    return null;
+}

deno-runtime/handlers/app/handler.ts

@@ -1,6 +1,15 @@
 import { Defined, JsonRpcError } from 'jsonrpc-lite';
+
 import handleConstructApp from './construct.ts';
-import handleInitialize from './initialize.ts';
+import handleInitialize from './handleInitialize.ts';
+import handleGetStatus from './handleGetStatus.ts';
+import handleSetStatus from './handleSetStatus.ts';
+import handleOnEnable from './handleOnEnable.ts';
+import handleOnInstall from './handleOnInstall.ts';
+import handleOnDisable from './handleOnDisable.ts';
+import handleOnUninstall from './handleOnUninstall.ts';
+import handleOnPreSettingUpdate from './handleOnPreSettingUpdate.ts';
+import handleOnSettingUpdated from './handleOnSettingUpdated.ts';
 
 export default async function handleApp(method: string, params: unknown): Promise<Defined | JsonRpcError> {
     const [, appMethod] = method.split(':');
@@ -11,6 +20,22 @@ export default async function handleApp(method: string, params: unknown): Promis
                 return await handleConstructApp(params);
             case 'initialize':
                 return await handleInitialize();
+            case 'getStatus':
+                return await handleGetStatus();
+            case 'setStatus':
+                return await handleSetStatus(params);
+            case 'onEnable':
+                return await handleOnEnable();
+            case 'onDisable':
+                return await handleOnDisable();
+            case 'onInstall':
+                return await handleOnInstall(params);
+            case 'onUninstall':
+                return await handleOnUninstall(params);
+            case 'onPreSettingUpdate':
+                return await handleOnPreSettingUpdate(params);
+            case 'onSettingUpdated':
+                return await handleOnSettingUpdated(params);
             default:
                 throw new JsonRpcError('Method not found', -32601);
         }

deno-runtime/lib/accessors/mod.ts

@@ -14,9 +14,9 @@ import type { IVideoConfProvider } from '@rocket.chat/apps-engine/definition/vid
 
 import * as Messenger from '../messenger.ts';
 import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
-import { ModifyCreator } from "./modify/ModifyCreator.ts";
-import { ModifyUpdater } from "./modify/ModifyUpdater.ts";
-import { ModifyExtender } from "./modify/ModifyExtender.ts";
+import { ModifyCreator } from './modify/ModifyCreator.ts';
+import { ModifyUpdater } from './modify/ModifyUpdater.ts';
+import { ModifyExtender } from './modify/ModifyExtender.ts';
 
 const httpMethods = ['get', 'post', 'put', 'delete', 'head', 'options', 'patch'] as const;
 
@@ -44,10 +44,12 @@ export class AppAccessors {
                     get:
                         (_target: unknown, prop: string) =>
                         (...params: unknown[]) =>
-                            senderFn({
-                                method: `accessor:${namespace}:${prop}`,
-                                params,
-                            }),
+                            prop === 'toJSON'
+                                ? {}
+                                : senderFn({
+                                      method: `accessor:${namespace}:${prop}`,
+                                      params,
+                                  }),
                 },
             ) as T;
     }

deno-runtime/lib/accessors/modify/ModifyCreator.ts

@@ -44,6 +44,10 @@ export class ModifyCreator implements IModifyCreator {
                         return () => Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
                     }
 
+                    if (prop === 'toJSON') {
+                        return () => ({});
+                    }
+
                     return (...params: unknown[]) =>
                         this.senderFn({
                             method: `accessor:getModifier:getCreator:getLivechatCreator:${prop}`,
@@ -61,10 +65,12 @@ export class ModifyCreator implements IModifyCreator {
                 get:
                     (_target: unknown, prop: string) =>
                     (...params: unknown[]) =>
-                        this.senderFn({
-                            method: `accessor:getModifier:getCreator:getUploadCreator:${prop}`,
-                            params,
-                        }),
+                        prop === 'toJSON'
+                            ? {}
+                            : this.senderFn({
+                                  method: `accessor:getModifier:getCreator:getUploadCreator:${prop}`,
+                                  params,
+                              }),
             },
         ) as IUploadCreator;
     }

deno-runtime/lib/accessors/modify/ModifyUpdater.ts

@@ -32,10 +32,12 @@ export class ModifyUpdater implements IModifyUpdater {
                 get:
                     (_target: unknown, prop: string) =>
                     (...params: unknown[]) =>
-                        this.senderFn({
-                            method: `accessor:getModifier:getUpdater:getLivechatUpdater:${prop}`,
-                            params,
-                        }),
+                        prop === 'toJSON'
+                            ? {}
+                            : this.senderFn({
+                                  method: `accessor:getModifier:getUpdater:getLivechatUpdater:${prop}`,
+                                  params,
+                              }),
             },
         ) as ILivechatUpdater;
     }
@@ -47,10 +49,12 @@ export class ModifyUpdater implements IModifyUpdater {
                 get:
                     (_target: unknown, prop: string) =>
                     (...params: unknown[]) =>
-                        this.senderFn({
-                            method: `accessor:getModifier:getUpdater:getUserUpdater:${prop}`,
-                            params,
-                        }),
+                        prop === 'toJSON'
+                            ? {}
+                            : this.senderFn({
+                                  method: `accessor:getModifier:getUpdater:getUserUpdater:${prop}`,
+                                  params,
+                              }),
             },
         ) as IUserUpdater;
     }

src/definition/App.ts

@@ -220,4 +220,9 @@ export abstract class App implements IApp {
         this.logger.debug(`The status is now: ${status}`);
         this.status = status;
     }
+
+    // Avoid leaking references if object is serialized (e.g. to be sent over IPC)
+    public toJSON(): Record<string, any> {
+        return this.info;
+    }
 }

src/server/AppManager.ts

@@ -462,9 +462,7 @@ export class AppManager {
         }
 
         if (AppStatusUtils.isEnabled(app.getStatus())) {
-            await app
-                .call(AppMethod.ONDISABLE, this.accessorManager.getConfigurationModify(app.getID()))
-                .catch((e) => console.warn('Error while disabling:', e));
+            await app.call(AppMethod.ONDISABLE).catch((e) => console.warn('Error while disabling:', e));
         }
 
         await this.purgeAppConfig(app, { keepScheduledJobs: true });
@@ -887,14 +885,10 @@ export class AppManager {
 
     private async installApp(storageItem: IAppStorageItem, app: ProxiedApp, user: IUser): Promise<boolean> {
         let result: boolean;
-        const read = this.getAccessorManager().getReader(storageItem.id);
-        const http = this.getAccessorManager().getHttp(storageItem.id);
-        const persistence = this.getAccessorManager().getPersistence(storageItem.id);
-        const modifier = this.getAccessorManager().getModifier(storageItem.id);
         const context = { user };
 
         try {
-            await app.call(AppMethod.ONINSTALL, context, read, http, persistence, modifier);
+            await app.call(AppMethod.ONINSTALL, context);
 
             result = true;
         } catch (e) {
@@ -1000,11 +994,7 @@ export class AppManager {
             await app.validateLicense();
             await app.validateInstallation();
 
-            enable = (await app.call(
-                AppMethod.ONENABLE,
-                this.getAccessorManager().getEnvironmentRead(storageItem.id),
-                this.getAccessorManager().getConfigurationModify(storageItem.id),
-            )) as boolean;
+            enable = (await app.call(AppMethod.ONENABLE)) as boolean;
 
             if (enable) {
                 status = isManual ? AppStatus.MANUALLY_ENABLED : AppStatus.AUTO_ENABLED;
@@ -1089,14 +1079,10 @@ export class AppManager {
 
     private async uninstallApp(app: ProxiedApp, user: IUser): Promise<boolean> {
         let result: boolean;
-        const read = this.getAccessorManager().getReader(app.getID());
-        const http = this.getAccessorManager().getHttp(app.getID());
-        const persistence = this.getAccessorManager().getPersistence(app.getID());
-        const modifier = this.getAccessorManager().getModifier(app.getID());
         const context = { user };
 
         try {
-            await app.call(AppMethod.ONUNINSTALL, context, read, http, persistence, modifier);
+            await app.call(AppMethod.ONUNINSTALL, context);
 
             result = true;
         } catch (e) {