Merge branch 'verji-develop' into develop

verji · Mar 14, 2024 · abc5ca0 · abc5ca0
2 parents c42562e + 1054d61
commit abc5ca0
Show file tree

Hide file tree

Showing 23 changed files with 440 additions and 83 deletions.
diff --git a/.github/workflows/static_analysis.yaml b/.github/workflows/static_analysis.yaml
@@ -55,6 +55,7 @@ jobs:
 
     i18n_lint:
         name: "i18n Check"
+        if: ${{ github.ref_name != 'verji-develop' }}
         uses: matrix-org/matrix-web-i18n/.github/workflows/i18n_check.yml@main
         with:
             hardcoded-words: "Element"

diff --git a/.github/workflows/verji-release-drafter.yml b/.github/workflows/verji-release-drafter.yml
@@ -0,0 +1,9 @@
+name: Verji Release Drafter
+on:
+    push:
+        branches: [verji-staging]
+    workflow_dispatch: {}
+concurrency: ${{ github.workflow }}
+jobs:
+    draft:
+        uses: verji/matrix-js-sdk/.github/workflows/release-drafter-workflow.yml@verji-develop
diff --git a/jest.config.ts b/jest.config.ts
@@ -20,10 +20,11 @@ import type { Config } from "jest";
 
 const config: Config = {
     testEnvironment: "jsdom",
-    testMatch: ["<rootDir>/test/**/*-test.[jt]s?(x)"],
+    testMatch: ["<rootDir>/test/**/*-test.[jt]s?(x)", "<rootDir>/test/**/**/*-test.[jt]s?(x)"],
     globalSetup: "<rootDir>/test/globalSetup.ts",
     setupFiles: ["jest-canvas-mock"],
     setupFilesAfterEnv: ["<rootDir>/test/setupTests.ts"],
+    moduleFileExtensions: ["js", "jsx", "json", "ts", "tsx"],
     moduleNameMapper: {
         "\\.(gif|png|ttf|woff2)$": "<rootDir>/__mocks__/imageMock.js",
         "\\.svg$": "<rootDir>/__mocks__/svg.js",

diff --git a/package.json b/package.json
@@ -71,7 +71,7 @@
         "@matrix-org/emojibase-bindings": "^1.1.2",
         "@matrix-org/matrix-wysiwyg": "2.17.0",
         "@matrix-org/olm": "3.2.15",
-        "@matrix-org/react-sdk-module-api": "^2.3.0",
+        "@matrix-org/react-sdk-module-api": "^2.4.0",
         "@matrix-org/spec": "^1.7.0",
         "@sentry/browser": "^7.0.0",
         "@testing-library/react-hooks": "^8.0.1",
@@ -218,6 +218,7 @@
         "postcss-scss": "^4.0.4",
         "prettier": "3.2.5",
         "raw-loader": "^4.0.2",
+        "react-test-renderer": "17.0.2",
         "rimraf": "^5.0.0",
         "stylelint": "^16.1.0",
         "stylelint-config-standard": "^36.0.0",

diff --git a/src/Lifecycle.ts b/src/Lifecycle.ts
@@ -25,7 +25,7 @@ import { QueryDict } from "matrix-js-sdk/src/utils";
 import { logger } from "matrix-js-sdk/src/logger";
 
 import { IMatrixClientCreds, MatrixClientPeg } from "./MatrixClientPeg";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import EventIndexPeg from "./indexing/EventIndexPeg";
 import createMatrixClient from "./utils/createMatrixClient";
 import Notifier from "./Notifier";
@@ -899,7 +899,8 @@ async function persistCredentials(credentials: IMatrixClientCreds): Promise<void
         localStorage.setItem("mx_device_id", credentials.deviceId);
     }
 
-    SecurityCustomisations.persistCredentials?.(credentials);
+    //SecurityCustomisations.persistCredentials?.(credentials);
+    ModuleRunner.instance.extensions?.cryptoSetup?.persistCredentials(credentials);
 
     logger.log(`Session persisted for ${credentials.userId}`);
 }

diff --git a/src/Login.ts b/src/Login.ts
@@ -27,7 +27,7 @@ import {
 import { logger } from "matrix-js-sdk/src/logger";
 
 import { IMatrixClientCreds } from "./MatrixClientPeg";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import { getOidcClientId } from "./utils/oidc/registerClient";
 import { IConfigOptions } from "./IConfigOptions";
 import SdkConfig from "./SdkConfig";
@@ -291,7 +291,8 @@ export async function sendLoginRequest(
         accessToken: data.access_token,
     };
 
-    SecurityCustomisations.examineLoginResponse?.(data, creds);
+    // SecurityCustomisations.examineLoginResponse?.(data, creds);
+    ModuleRunner.instance.extensions.cryptoSetup?.examineLoginResponse(data, creds);
 
     return creds;
 }
diff --git a/src/MatrixClientPeg.ts b/src/MatrixClientPeg.ts
@@ -42,7 +42,7 @@ import MatrixClientBackedSettingsHandler from "./settings/handlers/MatrixClientB
 import * as StorageManager from "./utils/StorageManager";
 import IdentityAuthClient from "./IdentityAuthClient";
 import { crossSigningCallbacks, tryToUnlockSecretStorageWithDehydrationKey } from "./SecurityManager";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import { SlidingSyncManager } from "./SlidingSyncManager";
 import CryptoStoreTooNewDialog from "./components/views/dialogs/CryptoStoreTooNewDialog";
 import { _t, UserFriendlyError } from "./languageHandler";
@@ -464,8 +464,15 @@ class MatrixClientPegClass implements IMatrixClientPeg {
             },
         };
 
-        if (SecurityCustomisations.getDehydrationKey) {
-            opts.cryptoCallbacks!.getDehydrationKey = SecurityCustomisations.getDehydrationKey;
+        // if (SecurityCustomisations.getDehydrationKey) {
+        //     opts.cryptoCallbacks!.getDehydrationKey = SecurityCustomisations.getDehydrationKey;
+        // }
+
+        console.log("CryptoSetupExtensions: Executing getDehydrationKeyCallback...");
+        const dehydrationKeyCallback = ModuleRunner.instance.extensions.cryptoSetup?.getDehydrationKeyCallback();
+        console.log("CryptoSetupExtensions: Executing getDehydrationKeyCallback...Done");
+        if (dehydrationKeyCallback) {
+            opts.cryptoCallbacks!.getDehydrationKey = dehydrationKeyCallback;
         }
 
         this.matrixClient = createMatrixClient(opts);

diff --git a/src/SecurityManager.ts b/src/SecurityManager.ts
@@ -28,7 +28,7 @@ import { isSecureBackupRequired } from "./utils/WellKnownUtils";
 import AccessSecretStorageDialog, { KeyParams } from "./components/views/dialogs/security/AccessSecretStorageDialog";
 import RestoreKeyBackupDialog from "./components/views/dialogs/security/RestoreKeyBackupDialog";
 import SettingsStore from "./settings/SettingsStore";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import QuestionDialog from "./components/views/dialogs/QuestionDialog";
 import InteractiveAuthDialog from "./components/views/dialogs/InteractiveAuthDialog";
 
@@ -130,9 +130,10 @@ async function getSecretStorageKey({
         }
     }
 
-    const keyFromCustomisations = SecurityCustomisations.getSecretStorageKey?.();
+    // const keyFromCustomisations = SecurityCustomisations.getSecretStorageKey?.();
+    const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup?.getSecretStorageKey();
     if (keyFromCustomisations) {
-        logger.log("Using key from security customisations (secret storage)");
+        logger.log("CryptoSetupExtension: Using key from extension (secret storage)");
         cacheSecretStorageKey(keyId, keyInfo, keyFromCustomisations);
         return [keyId, keyFromCustomisations];
     }
@@ -180,9 +181,10 @@ export async function getDehydrationKey(
     keyInfo: ISecretStorageKeyInfo,
     checkFunc: (data: Uint8Array) => void,
 ): Promise<Uint8Array> {
-    const keyFromCustomisations = SecurityCustomisations.getSecretStorageKey?.();
+    // const keyFromCustomisations = SecurityCustomisations.getSecretStorageKey?.();
+    const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup?.getSecretStorageKey();
     if (keyFromCustomisations) {
-        logger.log("Using key from security customisations (dehydration)");
+        logger.log("CryptoSetupExtension: Using key from extension (dehydration)");
         return keyFromCustomisations;
     }
 
@@ -419,7 +421,8 @@ async function doAccessSecretStorage(func: () => Promise<void>, forceReset: bool
         // inner operation completes.
         return await func();
     } catch (e) {
-        SecurityCustomisations.catchAccessSecretStorageError?.(e);
+        // SecurityCustomisations.catchAccessSecretStorageError?.(e as Error);
+        ModuleRunner.instance.extensions.cryptoSetup?.catchAccessSecretStorageError(e as Error);
         logger.error(e);
         // Re-throw so that higher level logic can abort as needed
         throw e;

diff --git a/src/async-components/views/dialogs/security/CreateSecretStorageDialog.tsx b/src/async-components/views/dialogs/security/CreateSecretStorageDialog.tsx
@@ -41,7 +41,7 @@ import {
     isSecureBackupRequired,
     SecureBackupSetupMethod,
 } from "../../../../utils/WellKnownUtils";
-import SecurityCustomisations from "../../../../customisations/Security";
+import { ModuleRunner } from "../../../../modules/ModuleRunner";
 import Field from "../../../../components/views/elements/Field";
 import BaseDialog from "../../../../components/views/dialogs/BaseDialog";
 import Spinner from "../../../../components/views/elements/Spinner";
@@ -181,9 +181,10 @@ export default class CreateSecretStorageDialog extends React.PureComponent<IProp
     }
 
     private getInitialPhase(): void {
-        const keyFromCustomisations = SecurityCustomisations.createSecretStorageKey?.();
+        //const keyFromCustomisations = SecurityCustomisations.createSecretStorageKey?.();
+        const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup?.createSecretStorageKey();
         if (keyFromCustomisations) {
-            logger.log("Created key via customisations, jumping to bootstrap step");
+            logger.log("CryptoSetupExtension: Created key via extension, jumping to bootstrap step");
             this.recoveryKey = {
                 privateKey: keyFromCustomisations,
             };

diff --git a/src/components/structures/HomePage.tsx b/src/components/structures/HomePage.tsx
@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import * as React from "react";
-import { useContext, useState } from "react";
+import { useState } from "react";
 
 import AutoHideScrollbar from "./AutoHideScrollbar";
 import { getHomePageUrl } from "../../utils/pages";
@@ -28,10 +28,13 @@ import { OwnProfileStore } from "../../stores/OwnProfileStore";
 import AccessibleButton, { ButtonEvent } from "../views/elements/AccessibleButton";
 import { UPDATE_EVENT } from "../../stores/AsyncStore";
 import { useEventEmitter } from "../../hooks/useEventEmitter";
-import MatrixClientContext, { useMatrixClientContext } from "../../contexts/MatrixClientContext";
+import { useMatrixClientContext } from "../../contexts/MatrixClientContext";
 import MiniAvatarUploader, { AVATAR_SIZE } from "../views/elements/MiniAvatarUploader";
 import PosthogTrackers from "../../PosthogTrackers";
 import EmbeddedPage from "./EmbeddedPage";
+import SettingsStore from "../../settings/SettingsStore";
+import { UIFeature } from "../../settings/UIFeature";
+import { MatrixClientPeg } from "../../MatrixClientPeg";
 
 const onClickSendDm = (ev: ButtonEvent): void => {
     PosthogTrackers.trackInteraction("WebHomeCreateChatButton", ev);
@@ -63,7 +66,8 @@ const getOwnProfile = (
 });
 
 const UserWelcomeTop: React.FC = () => {
-    const cli = useContext(MatrixClientContext);
+    // const cli = useContext(MatrixClientContext);
+    const cli = MatrixClientPeg.safeGet();
     const userId = cli.getUserId()!;
     const [ownProfile, setOwnProfile] = useState(getOwnProfile(userId));
     useEventEmitter(OwnProfileStore.instance, UPDATE_EVENT, () => {
@@ -94,6 +98,38 @@ const UserWelcomeTop: React.FC = () => {
     );
 };
 
+// //Buttons on homepage can be enabled (true), or disabled (false) setting the UIFeature.HomePageButtons in settings.tsx
+// const ShowButtons = () => {
+//     return (
+//         <div className="mx_HomePage_default_buttons">
+//             <AccessibleButton onClick={onClickSendDm} className="mx_HomePage_button_sendDm">
+//                 {_tDom("onboarding|send_dm")}
+//             </AccessibleButton>
+//             <AccessibleButton onClick={onClickExplore} className="mx_HomePage_button_explore">
+//                 {_tDom("onboarding|explore_rooms")}
+//             </AccessibleButton>
+//             <AccessibleButton onClick={onClickNewRoom} className="mx_HomePage_button_createGroup">
+//                 {_tDom("onboarding|create_room")}
+//             </AccessibleButton>
+//         </div>
+//     )
+// }
+
+//Buttons on homepage can be enabled (true), or disabled (false) setting the UIFeature.HomePageButtons in settings.tsx
+const showButtons = (
+    <div className="mx_HomePage_default_buttons">
+        <AccessibleButton onClick={onClickSendDm} className="mx_HomePage_button_sendDm">
+            {_tDom("onboarding|send_dm")}
+        </AccessibleButton>
+        <AccessibleButton onClick={onClickExplore} className="mx_HomePage_button_explore">
+            {_tDom("onboarding|explore_rooms")}
+        </AccessibleButton>
+        <AccessibleButton onClick={onClickNewRoom} className="mx_HomePage_button_createGroup">
+            {_tDom("onboarding|create_room")}
+        </AccessibleButton>
+    </div>
+);
+
 const HomePage: React.FC<IProps> = ({ justRegistered = false }) => {
     const cli = useMatrixClientContext();
     const config = SdkConfig.get();
@@ -123,17 +159,8 @@ const HomePage: React.FC<IProps> = ({ justRegistered = false }) => {
         <AutoHideScrollbar className="mx_HomePage mx_HomePage_default" element="main">
             <div className="mx_HomePage_default_wrapper">
                 {introSection}
-                <div className="mx_HomePage_default_buttons">
-                    <AccessibleButton onClick={onClickSendDm} className="mx_HomePage_button_sendDm">
-                        {_tDom("onboarding|send_dm")}
-                    </AccessibleButton>
-                    <AccessibleButton onClick={onClickExplore} className="mx_HomePage_button_explore">
-                        {_tDom("onboarding|explore_rooms")}
-                    </AccessibleButton>
-                    <AccessibleButton onClick={onClickNewRoom} className="mx_HomePage_button_createGroup">
-                        {_tDom("onboarding|create_room")}
-                    </AccessibleButton>
-                </div>
+                {/* {SettingsStore.getValue(UIFeature.HomePageButtons) && <ShowButtons>} */}
+                {SettingsStore.getValue(UIFeature.HomePageButtons) && showButtons}
             </div>
         </AutoHideScrollbar>
     );

diff --git a/src/components/structures/MatrixChat.tsx b/src/components/structures/MatrixChat.tsx
@@ -88,7 +88,7 @@ import { showToast as showMobileGuideToast } from "../../toasts/MobileGuideToast
 import { shouldUseLoginForWelcome } from "../../utils/pages";
 import RoomListStore from "../../stores/room-list/RoomListStore";
 import { RoomUpdateCause } from "../../stores/room-list/models";
-import SecurityCustomisations from "../../customisations/Security";
+import { ModuleRunner } from "../../modules/ModuleRunner";
 import Spinner from "../views/elements/Spinner";
 import QuestionDialog from "../views/dialogs/QuestionDialog";
 import UserSettingsDialog from "../views/dialogs/UserSettingsDialog";
@@ -443,7 +443,10 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
         if (crossSigningIsSetUp) {
             // if the user has previously set up cross-signing, verify this device so we can fetch the
             // private keys.
-            if (SecurityCustomisations.SHOW_ENCRYPTION_SETUP_UI === false) {
+
+            // if (SecurityCustomisations.SHOW_ENCRYPTION_SETUP_UI === false) {
+            const cryptoExtension = ModuleRunner.instance.extensions.cryptoSetup;
+            if (cryptoExtension !== undefined && cryptoExtension.SHOW_ENCRYPTION_SETUP_UI == false) {
                 this.onLoggedIn();
             } else {
                 this.setStateForNewView({ view: Views.COMPLETE_SECURITY });

diff --git a/src/components/views/dialogs/CreateRoomDialog.tsx b/src/components/views/dialogs/CreateRoomDialog.tsx
@@ -34,6 +34,7 @@ import { KeyBindingAction } from "../../../accessibility/KeyboardShortcuts";
 import { privateShouldBeEncrypted } from "../../../utils/rooms";
 import SettingsStore from "../../../settings/SettingsStore";
 import LabelledCheckbox from "../elements/LabelledCheckbox";
+import { UIFeature } from "../../../settings/UIFeature";
 
 interface IProps {
     type?: RoomType;
@@ -412,37 +413,51 @@ export default class CreateRoomDialog extends React.Component<IProps, IState> {
                             className="mx_CreateRoomDialog_topic"
                         />
 
-                        <JoinRuleDropdown
-                            label={_t("create_room|room_visibility_label")}
-                            labelInvite={_t("create_room|join_rule_invite")}
-                            labelKnock={
-                                this.askToJoinEnabled ? _t("room_settings|security|join_rule_knock") : undefined
-                            }
-                            labelPublic={_t("common|public_room")}
-                            labelRestricted={
-                                this.supportsRestricted ? _t("create_room|join_rule_restricted") : undefined
-                            }
-                            value={this.state.joinRule}
-                            onChange={this.onJoinRuleChange}
-                        />
+                        {/* For those who only want to create private room, set the CreateRoomShowJoinRuleDropdown to false in settings.tsx,
+                        for public rooms and knock rooms, set the flag to true */}
+                        {SettingsStore.getValue(UIFeature.CreateRoomShowJoinRuleDropdown) && (
+                            <>
+                                <JoinRuleDropdown
+                                    label={_t("create_room|room_visibility_label")}
+                                    labelInvite={_t("create_room|join_rule_invite")}
+                                    labelKnock={
+                                        this.askToJoinEnabled ? _t("room_settings|security|join_rule_knock") : undefined
+                                    }
+                                    labelPublic={_t("common|public_room")}
+                                    labelRestricted={
+                                        this.supportsRestricted ? _t("create_room|join_rule_restricted") : undefined
+                                    }
+                                    value={this.state.joinRule}
+                                    onChange={this.onJoinRuleChange}
+                                />
+                            </>
+                        )}
 
                         {publicPrivateLabel}
                         {visibilitySection}
-                        {e2eeSection}
+                        {/* To create only encrypted room, the options can be hidden by setting the flag to false in in settings.tsx, */}
+                        {SettingsStore.getValue(UIFeature.CreateRoomE2eeSection) && e2eeSection}
                         {aliasField}
-                        <details onToggle={this.onDetailsToggled} className="mx_CreateRoomDialog_details">
-                            <summary className="mx_CreateRoomDialog_details_summary">
-                                {this.state.detailsOpen ? _t("action|hide_advanced") : _t("action|show_advanced")}
-                            </summary>
-                            <LabelledToggleSwitch
-                                label={_t("create_room|unfederated", {
-                                    serverName: MatrixClientPeg.getHomeserverName(),
-                                })}
-                                onChange={this.onNoFederateChange}
-                                value={this.state.noFederate}
-                            />
-                            <p>{federateLabel}</p>
-                        </details>
+                        {/* To limit the usage to only your server, set flag to false in in settings.tsx, */}
+                        {SettingsStore.getValue(UIFeature.CreateRoomShowAdvancedSettings) && (
+                            <>
+                                <details onToggle={this.onDetailsToggled} className="mx_CreateRoomDialog_details">
+                                    <summary className="mx_CreateRoomDialog_details_summary">
+                                        {this.state.detailsOpen
+                                            ? _t("action|hide_advanced")
+                                            : _t("action|show_advanced")}
+                                    </summary>
+                                    <LabelledToggleSwitch
+                                        label={_t("create_room|unfederated", {
+                                            serverName: MatrixClientPeg.getHomeserverName(),
+                                        })}
+                                        onChange={this.onNoFederateChange}
+                                        value={this.state.noFederate}
+                                    />
+                                    <p>{federateLabel}</p>
+                                </details>
+                            </>
+                        )}
                     </div>
                 </form>
                 <DialogButtons