Support a module API surface for custom functionality (#8246)

* Early implementation of module API surface + functions for ILAG module

* Wire up dialog functions and ILAG-needed surface

* Ensure component renders for modules get overridden

* Respond to changes from module API interface

* Use a real module-api dependency

* Update for new Dialogs interface

* Add support for getConfigValue from module API

* Update the remainder of the module API interface

* Docs & cleanup

* Add some unit tests around module stuff

Needs end-to-end tests still.

* Appease early linters

* Break import cycles by not directly depending on Lifecycle

* Appease the linter

* Fix bad merge

Author: turt2live

package.json

@@ -57,6 +57,7 @@
   "dependencies": {
     "@babel/runtime": "^7.12.5",
     "@matrix-org/analytics-events": "^0.1.1",
+    "@matrix-org/react-sdk-module-api": "^0.0.3",
     "@sentry/browser": "^6.11.0",
     "@sentry/tracing": "^6.11.0",
     "@testing-library/react": "^12.1.5",

src/Lifecycle.ts

@@ -63,6 +63,7 @@ import VideoChannelStore from "./stores/VideoChannelStore";
 import { fixStuckDevices } from "./utils/VideoChannelUtils";
 import { Action } from "./dispatcher/actions";
 import AbstractLocalStorageSettingsHandler from "./settings/handlers/AbstractLocalStorageSettingsHandler";
+import { OverwriteLoginPayload } from "./dispatcher/payloads/OverwriteLoginPayload";
 
 const HOMESERVER_URL_KEY = "mx_hs_url";
 const ID_SERVER_URL_KEY = "mx_is_url";
@@ -71,6 +72,10 @@ dis.register((payload) => {
     if (payload.action === Action.TriggerLogout) {
         // noinspection JSIgnoredPromiseFromCall - we don't care if it fails
         onLoggedOut();
+    } else if (payload.action === Action.OverwriteLogin) {
+        const typed = <OverwriteLoginPayload>payload;
+        // noinspection JSIgnoredPromiseFromCall - we don't care if it fails
+        doSetLoggedIn(typed.credentials, true);
     }
 });
 

src/components/views/dialogs/ModuleUiDialog.tsx

@@ -0,0 +1,66 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import React, { createRef } from "react";
+import { DialogContent, DialogProps } from "@matrix-org/react-sdk-module-api/lib/components/DialogContent";
+import { logger } from "matrix-js-sdk/src/logger";
+
+import ScrollableBaseModal, { IScrollableBaseState } from "./ScrollableBaseModal";
+import { IDialogProps } from "./IDialogProps";
+import { _t } from "../../../languageHandler";
+
+interface IProps extends IDialogProps {
+    contentFactory: (props: DialogProps, ref: React.Ref<DialogContent>) => React.ReactNode;
+    contentProps: DialogProps;
+    title: string;
+}
+
+interface IState extends IScrollableBaseState {
+    // nothing special
+}
+
+export class ModuleUiDialog extends ScrollableBaseModal<IProps, IState> {
+    private contentRef = createRef<DialogContent>();
+
+    public constructor(props: IProps) {
+        super(props);
+
+        this.state = {
+            title: this.props.title,
+            canSubmit: true,
+            actionLabel: _t("OK"),
+        };
+    }
+
+    protected async submit() {
+        try {
+            const model = await this.contentRef.current.trySubmit();
+            this.props.onFinished(true, model);
+        } catch (e) {
+            logger.error("Error during submission of module dialog:", e);
+        }
+    }
+
+    protected cancel(): void {
+        this.props.onFinished(false);
+    }
+
+    protected renderContent(): React.ReactNode {
+        return <div className="mx_ModuleUiDialog">
+            { this.props.contentFactory(this.props.contentProps, this.contentRef) }
+        </div>;
+    }
+}

src/components/views/rooms/RoomPreviewBar.tsx

@@ -21,6 +21,10 @@ import { EventType, RoomType } from "matrix-js-sdk/src/@types/event";
 import { IJoinRuleEventContent, JoinRule } from "matrix-js-sdk/src/@types/partials";
 import { RoomMember } from "matrix-js-sdk/src/models/room-member";
 import classNames from 'classnames';
+import {
+    RoomPreviewOpts,
+    RoomViewLifecycle,
+} from "@matrix-org/react-sdk-module-api/lib/lifecycles/RoomViewLifecycle";
 
 import { MatrixClientPeg } from '../../../MatrixClientPeg';
 import dis from '../../../dispatcher/dispatcher';
@@ -34,6 +38,7 @@ import AccessibleButton from "../elements/AccessibleButton";
 import RoomAvatar from "../avatars/RoomAvatar";
 import SettingsStore from "../../../settings/SettingsStore";
 import { UIFeature } from "../../../settings/UIFeature";
+import { ModuleRunner } from "../../../modules/ModuleRunner";
 
 const MemberEventHtmlReasonField = "io.element.html_reason";
 
@@ -313,13 +318,26 @@ export default class RoomPreviewBar extends React.Component<IProps, IState> {
                 break;
             }
             case MessageCase.NotLoggedIn: {
-                title = _t("Join the conversation with an account");
-                if (SettingsStore.getValue(UIFeature.Registration)) {
-                    primaryActionLabel = _t("Sign Up");
-                    primaryActionHandler = this.onRegisterClick;
+                const opts: RoomPreviewOpts = { canJoin: false };
+                if (this.props.room?.roomId) {
+                    ModuleRunner.instance
+                        .invoke(RoomViewLifecycle.PreviewRoomNotLoggedIn, opts, this.props.room.roomId);
+                }
+                if (opts.canJoin) {
+                    title = _t("Join the room to participate");
+                    primaryActionLabel = _t("Join");
+                    primaryActionHandler = () => {
+                        ModuleRunner.instance.invoke(RoomViewLifecycle.JoinFromRoomPreview, this.props.room.roomId);
+                    };
+                } else {
+                    title = _t("Join the conversation with an account");
+                    if (SettingsStore.getValue(UIFeature.Registration)) {
+                        primaryActionLabel = _t("Sign Up");
+                        primaryActionHandler = this.onRegisterClick;
+                    }
+                    secondaryActionLabel = _t("Sign In");
+                    secondaryActionHandler = this.onLoginClick;
                 }
-                secondaryActionLabel = _t("Sign In");
-                secondaryActionHandler = this.onLoginClick;
                 if (this.props.previewLoading) {
                     footer = (
                         <div>

src/dispatcher/actions.ts

@@ -316,6 +316,11 @@ export enum Action {
      */
     OnLoggedIn = "on_logged_in",
 
+    /**
+     * Overwrites the existing login with fresh session credentials. Use with a OverwriteLoginPayload.
+     */
+    OverwriteLogin = "overwrite_login",
+
     /**
      * Fired when the PlatformPeg gets a new platform set upon it, should only happen once per app load lifecycle.
      * Fires with the PlatformSetPayload.

src/dispatcher/payloads/OverwriteLoginPayload.ts

@@ -0,0 +1,25 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { ActionPayload } from "../payloads";
+import { Action } from "../actions";
+import { IMatrixClientCreds } from "../../MatrixClientPeg";
+
+export interface OverwriteLoginPayload extends ActionPayload {
+    action: Action.OverwriteLogin;
+
+    credentials: IMatrixClientCreds;
+}

src/i18n/strings/en_EN.json

@@ -1805,6 +1805,7 @@
     "Joining …": "Joining …",
     "Loading …": "Loading …",
     "Rejecting invite …": "Rejecting invite …",
+    "Join the room to participate": "Join the room to participate",
     "Join the conversation with an account": "Join the conversation with an account",
     "Sign Up": "Sign Up",
     "Loading preview": "Loading preview",

src/languageHandler.tsx

@@ -28,6 +28,7 @@ import PlatformPeg from "./PlatformPeg";
 import { SettingLevel } from "./settings/SettingLevel";
 import { retry } from "./utils/promise";
 import SdkConfig from "./SdkConfig";
+import { ModuleRunner } from "./modules/ModuleRunner";
 
 // @ts-ignore - $webapp is a webpack resolve alias pointing to the output directory, see webpack config
 import webpackLangJsonUrl from "$webapp/i18n/languages.json";
@@ -609,15 +610,40 @@ export class CustomTranslationOptions {
     }
 }
 
+function doRegisterTranslations(customTranslations: ICustomTranslations) {
+    // We convert the operator-friendly version into something counterpart can
+    // consume.
+    const langs: {
+        // same structure, just flipped key order
+        [lang: string]: {
+            [str: string]: string;
+        };
+    } = {};
+    for (const [str, translations] of Object.entries(customTranslations)) {
+        for (const [lang, newStr] of Object.entries(translations)) {
+            if (!langs[lang]) langs[lang] = {};
+            langs[lang][str] = newStr;
+        }
+    }
+
+    // Finally, tell counterpart about our translations
+    for (const [lang, translations] of Object.entries(langs)) {
+        counterpart.registerTranslations(lang, translations);
+    }
+}
+
 /**
- * If a custom translations file is configured, it will be parsed and registered.
- * If no customization is made, or the file can't be parsed, no action will be
- * taken.
+ * Any custom modules with translations to load are parsed first, followed by an
+ * optionally defined translations file in the config. If no customization is made,
+ * or the file can't be parsed, no action will be taken.
  *
  * This function should be called *after* registering other translations data to
  * ensure it overrides strings properly.
  */
 export async function registerCustomTranslations() {
+    const moduleTranslations = ModuleRunner.instance.allTranslations;
+    doRegisterTranslations(moduleTranslations);
+
     const lookupUrl = SdkConfig.get().custom_translations_url;
     if (!lookupUrl) return; // easy - nothing to do
 
@@ -639,25 +665,8 @@ export async function registerCustomTranslations() {
         // If the (potentially cached) json is invalid, don't use it.
         if (!json) return;
 
-        // We convert the operator-friendly version into something counterpart can
-        // consume.
-        const langs: {
-            // same structure, just flipped key order
-            [lang: string]: {
-                [str: string]: string;
-            };
-        } = {};
-        for (const [str, translations] of Object.entries(json)) {
-            for (const [lang, newStr] of Object.entries(translations)) {
-                if (!langs[lang]) langs[lang] = {};
-                langs[lang][str] = newStr;
-            }
-        }
-
-        // Finally, tell counterpart about our translations
-        for (const [lang, translations] of Object.entries(langs)) {
-            counterpart.registerTranslations(lang, translations);
-        }
+        // Finally, register it.
+        doRegisterTranslations(json);
     } catch (e) {
         // We consume all exceptions because it's considered non-fatal for custom
         // translations to break. Most failures will be during initial development

src/modules/AppModule.ts

@@ -0,0 +1,45 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { RuntimeModule } from "@matrix-org/react-sdk-module-api/lib/RuntimeModule";
+
+import { ModuleFactory } from "./ModuleFactory";
+import { ProxiedModuleApi } from "./ProxiedModuleApi";
+
+/**
+ * Wraps a module factory into a usable module. Acts as a simple container
+ * for the constructs needed to operate a module.
+ */
+export class AppModule {
+    /**
+     * The module instance.
+     */
+    public readonly module: RuntimeModule;
+
+    /**
+     * The API instance used by the module.
+     */
+    public readonly api = new ProxiedModuleApi();
+
+    /**
+     * Converts a factory into an AppModule. The factory will be called
+     * immediately.
+     * @param factory The module factory.
+     */
+    public constructor(factory: ModuleFactory) {
+        this.module = factory(this.api);
+    }
+}

src/modules/ModuleComponents.tsx

@@ -0,0 +1,40 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { TextInputField } from "@matrix-org/react-sdk-module-api/lib/components/TextInputField";
+import { Spinner as ModuleSpinner } from "@matrix-org/react-sdk-module-api/lib/components/Spinner";
+import React from "react";
+
+import Field from "../components/views/elements/Field";
+import Spinner from "../components/views/elements/Spinner";
+
+// Here we define all the render factories for the module API components. This file should be
+// imported by the ModuleRunner to load them into the call stack at runtime.
+//
+// If a new component is added to the module API, it should be added here too.
+//
+// Don't forget to add a test to ensure the renderFactory is overridden! See ModuleComponents-test.tsx
+
+TextInputField.renderFactory = (props) => (
+    <Field
+        type="text"
+        value={props.value}
+        onChange={e => props.onChange(e.target.value)}
+        label={props.label}
+        autoComplete="off"
+    />
+);
+ModuleSpinner.renderFactory = () => <Spinner />;