Replace SecurityCustomisations with CryptoSetupExtension

src/Lifecycle.ts

@@ -863,7 +863,7 @@ async function persistCredentials(credentials: IMatrixClientCreds): Promise<void
         localStorage.setItem("mx_device_id", credentials.deviceId);
     }
 
-    ModuleRunner.instance.extensions?.cryptoSetup?.persistCredentials(credentials);
+    ModuleRunner.instance.extensions.cryptoSetup?.persistCredentials(credentials);
 
     logger.log(`Session persisted for ${credentials.userId}`);
 }

src/Login.ts

@@ -291,7 +291,7 @@ export async function sendLoginRequest(
         accessToken: data.access_token,
     };
 
-    ModuleRunner.instance.extensions.cryptoSetup?.examineLoginResponse(data, creds);
+    ModuleRunner.instance.extensions.cryptoSetup.examineLoginResponse(data, creds);
 
     return creds;
 }

src/MatrixClientPeg.ts

@@ -463,7 +463,7 @@ class MatrixClientPegClass implements IMatrixClientPeg {
             },
         };
 
-        const dehydrationKeyCallback = ModuleRunner.instance.extensions.cryptoSetup?.getDehydrationKeyCallback();
+        const dehydrationKeyCallback = ModuleRunner.instance.extensions.cryptoSetup.getDehydrationKeyCallback();
         if (dehydrationKeyCallback) {
             opts.cryptoCallbacks!.getDehydrationKey = dehydrationKeyCallback;
         }

src/SecurityManager.ts

@@ -137,7 +137,7 @@ async function getSecretStorageKey({
         }
     }
 
-    const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup?.getSecretStorageKey();
+    const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup.getSecretStorageKey();
     if (keyFromCustomisations) {
         logger.log("CryptoSetupExtension: Using key from extension (secret storage)");
         cacheSecretStorageKey(keyId, keyInfo, keyFromCustomisations);
@@ -187,7 +187,7 @@ export async function getDehydrationKey(
     keyInfo: SecretStorage.SecretStorageKeyDescription,
     checkFunc: (data: Uint8Array) => void,
 ): Promise<Uint8Array> {
-    const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup?.getSecretStorageKey();
+    const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup.getSecretStorageKey();
     if (keyFromCustomisations) {
         logger.log("CryptoSetupExtension: Using key from extension (dehydration)");
         return keyFromCustomisations;
@@ -430,7 +430,7 @@ async function doAccessSecretStorage(func: () => Promise<void>, forceReset: bool
         // inner operation completes.
         return await func();
     } catch (e) {
-        ModuleRunner.instance.extensions.cryptoSetup?.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;

src/async-components/views/dialogs/security/CreateSecretStorageDialog.tsx

@@ -180,7 +180,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent<IProp
     }
 
     private getInitialPhase(): void {
-        const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup?.createSecretStorageKey();
+        const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup.createSecretStorageKey();
         if (keyFromCustomisations) {
             logger.log("CryptoSetupExtension: Created key via extension, jumping to bootstrap step");
             this.recoveryKey = {

src/components/structures/MatrixChat.tsx

@@ -445,7 +445,7 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
             // private keys.
 
             const cryptoExtension = ModuleRunner.instance.extensions.cryptoSetup;
-            if (cryptoExtension !== undefined && cryptoExtension.SHOW_ENCRYPTION_SETUP_UI == false) {
+            if (cryptoExtension.SHOW_ENCRYPTION_SETUP_UI == false) {
                 this.onLoggedIn();
             } else {
                 this.setStateForNewView({ view: Views.COMPLETE_SECURITY });

src/modules/ModuleRunner.ts

@@ -31,91 +31,80 @@ import { ModuleFactory } from "./ModuleFactory";
 
 import "./ModuleComponents";
 
-class ExtensionImplementationMap {
-    public hasDefaultCryptoSetupExtension: boolean = true;
-    public hasDefaultExperimentalExtension: boolean = true;
-}
-
 /**
- * Handles and manages any extensions provided by modules
+ * Handles and manages extensions provided by modules.
  */
 class ExtensionsManager {
-    private _cryptoSetup: ProvideCryptoSetupExtensions;
-    private _experimental: ProvideExperimentalExtensions;
-    private _implementionMap: ExtensionImplementationMap = new ExtensionImplementationMap();
+    // Private backing fields for extensions
+    private cryptoSetupExtension: ProvideCryptoSetupExtensions;
+    private experimentalExtension: ProvideExperimentalExtensions;
+
+    // Map to keep track of which extensions has been provided by modules.
+    private implementionMap = {
+        hasDefaultCryptoSetupExtension: true,
+        hasDefaultExperimentalExtension: true,
+    };
 
     /**
-     * Create a new instance
+     * Create a new instance.
      */
     public constructor() {
         // Set up defaults
-        this._cryptoSetup = new DefaultCryptoSetupExtensions();
-        this._experimental = new DefaultExperimentalExtensions();
+        this.cryptoSetupExtension = new DefaultCryptoSetupExtensions();
+        this.experimentalExtension = new DefaultExperimentalExtensions();
     }
 
     /**
      * Provides a crypto setup extension.
      *
-     * @returns The registered extension. If no module provides this extension, a default implementation is returned
+     * @returns The registered extension. If no module provides this extension, a default implementation is returned.
      */
     public get cryptoSetup(): ProvideCryptoSetupExtensions {
-        return this._cryptoSetup;
+        return this.cryptoSetupExtension;
     }
 
     /**
-     * Provides a n experimental extension.
+     * Provides an experimental extension.
      *
      * @remarks
-     * This method extension is provided to simplify experimentaion an development, and is not intended for production code
+     * This method extension is provided to simplify experimentation and development, and is not intended for production code.
      *
-     * @returns The registered extension. If no module provides this extension, a default implementation is returned
+     * @returns The registered extension. If no module provides this extension, a default implementation is returned.
      */
     public get experimental(): ProvideExperimentalExtensions {
-        return this._experimental;
+        return this.experimentalExtension;
     }
 
     /**
-     * Resets the extension to the defaults
-     *
-     * Intended for test usage only.
-     */
-    public reset(): void {
-        this._implementionMap = new ExtensionImplementationMap();
-        this._cryptoSetup = new DefaultCryptoSetupExtensions();
-        this._experimental = new DefaultExperimentalExtensions();
-    }
-
-    /**
-     * Add any extensions provided by the module
-     *
-     * @param module - The appModule to check for extensions
+     * Add any extensions provided by the module.
      *
-     * @throws if an extension is provided by more than one module
+     * @param module - The appModule to check for extensions.
      *
+     * @throws if an extension is provided by more than one module.
      */
     public addExtensions(module: AppModule): void {
         const runtimeModule = module.module;
 
-        /* Record the cryptoSetup extensions if any */
+        /* Record the cryptoSetup extension if any */
         if (runtimeModule.extensions?.cryptoSetup) {
-            if (this._implementionMap.hasDefaultCryptoSetupExtension) {
-                this._cryptoSetup = runtimeModule.extensions?.cryptoSetup;
-                this._implementionMap.hasDefaultCryptoSetupExtension = false;
+            if (this.implementionMap.hasDefaultCryptoSetupExtension) {
+                this.cryptoSetupExtension = runtimeModule.extensions?.cryptoSetup;
+                this.implementionMap.hasDefaultCryptoSetupExtension = false;
             } else {
                 throw new Error(
-                    `adding cryptoSetup extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided`,
+                    `adding cryptoSetup extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided.`,
                 );
             }
         }
 
-        /* Record the experimental extensions if any */
+        /* Record the experimental extension if any */
         if (runtimeModule.extensions?.experimental) {
-            if (this._implementionMap.hasDefaultExperimentalExtension) {
-                this._experimental = runtimeModule.extensions?.experimental;
-                this._implementionMap.hasDefaultExperimentalExtension = false;
+            if (this.implementionMap.hasDefaultExperimentalExtension) {
+                this.experimentalExtension = runtimeModule.extensions?.experimental;
+                this.implementionMap.hasDefaultExperimentalExtension = false;
             } else {
                 throw new Error(
-                    `adding experimental extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided`,
+                    `adding experimental extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided.`,
                 );
             }
         }
@@ -128,7 +117,7 @@ class ExtensionsManager {
 export class ModuleRunner {
     public static readonly instance = new ModuleRunner();
 
-    private _extensions = new ExtensionsManager();
+    private extensionsManager = new ExtensionsManager();
 
     private modules: AppModule[] = [];
 
@@ -137,12 +126,12 @@ export class ModuleRunner {
     }
 
     /**
-     * Exposes all extensions which may be overridden/provided by modules
+     * Exposes all extensions which may be overridden/provided by modules.
      *
-     * @returns En extensionsmanager which exposes the extensions
+     * @returns An `ExtensionsManager` which exposes the extensions.
      */
     public get extensions(): ExtensionsManager {
-        return this._extensions;
+        return this.extensionsManager;
     }
 
     /**
@@ -152,7 +141,7 @@ export class ModuleRunner {
      */
     public reset(): void {
         this.modules = [];
-        this._extensions.reset();
+        this.extensionsManager = new ExtensionsManager();
     }
 
     /**
@@ -187,10 +176,8 @@ export class ModuleRunner {
 
         this.modules.push(appModule);
 
-        /**
-         * Check if the new module provides any extensions, and also ensure a given extension is only provided by a single runtime module
-         */
-        this._extensions.addExtensions(appModule);
+        // Check if the new module provides any extensions, and also ensure a given extension is only provided by a single runtime module.
+        this.extensionsManager.addExtensions(appModule);
     }
 
     /**

src/toasts/SetupEncryptionToast.ts

@@ -81,7 +81,7 @@ const onReject = (): void => {
 
 export const showToast = (kind: Kind): void => {
     if (
-        ModuleRunner.instance.extensions.cryptoSetup?.setupEncryptionNeeded({
+        ModuleRunner.instance.extensions.cryptoSetup.setupEncryptionNeeded({
             kind: kind as any,
             storeProvider: { getInstance: () => SetupEncryptionStore.sharedInstance() },
         })

test/MatrixClientPeg-test.ts

@@ -18,7 +18,6 @@ import { logger } from "matrix-js-sdk/src/logger";
 import fetchMockJest from "fetch-mock-jest";
 import EventEmitter from "events";
 import {
-    CryptoSetupExtensionsBase,
     ProvideCryptoSetupExtensions,
     SecretStorageKeyDescription,
 } from "@matrix-org/react-sdk-module-api/lib/lifecycles/CryptoSetupExtensions";
@@ -94,16 +93,16 @@ describe("MatrixClientPeg", () => {
 
         describe("cryptoSetup extension", () => {
             it("should call default cryptoSetup.getDehydrationKeyCallback", async () => {
-                const mockCryptoSetup = new (class extends CryptoSetupExtensionsBase {
-                    SHOW_ENCRYPTION_SETUP_UI = true;
-                    examineLoginResponse = jest.fn();
-                    persistCredentials = jest.fn();
-                    getSecretStorageKey = jest.fn();
-                    createSecretStorageKey = jest.fn();
-                    catchAccessSecretStorageError = jest.fn();
-                    setupEncryptionNeeded = jest.fn();
-                    getDehydrationKeyCallback = jest.fn().mockReturnValue(null);
-                })() as ProvideCryptoSetupExtensions;
+                const mockCryptoSetup = {
+                    SHOW_ENCRYPTION_SETUP_UI: true,
+                    examineLoginResponse: jest.fn(),
+                    persistCredentials: jest.fn(),
+                    getSecretStorageKey: jest.fn(),
+                    createSecretStorageKey: jest.fn(),
+                    catchAccessSecretStorageError: jest.fn(),
+                    setupEncryptionNeeded: jest.fn(),
+                    getDehydrationKeyCallback: jest.fn().mockReturnValue(null),
+                } as ProvideCryptoSetupExtensions;
 
                 // Ensure we have an instance before we set up spies
                 const instance = ModuleRunner.instance;
@@ -122,16 +121,16 @@ describe("MatrixClientPeg", () => {
             it("should call overridden cryptoSetup.getDehydrationKeyCallback", async () => {
                 const mockDehydrationKeyCallback = () => Uint8Array.from([0x11, 0x22, 0x33]);
 
-                const mockCryptoSetup = new (class extends CryptoSetupExtensionsBase {
-                    SHOW_ENCRYPTION_SETUP_UI = true;
-                    examineLoginResponse = jest.fn();
-                    persistCredentials = jest.fn();
-                    getSecretStorageKey = jest.fn();
-                    createSecretStorageKey = jest.fn();
-                    catchAccessSecretStorageError = jest.fn();
-                    setupEncryptionNeeded = jest.fn();
-                    getDehydrationKeyCallback = jest.fn().mockReturnValue(mockDehydrationKeyCallback);
-                })() as ProvideCryptoSetupExtensions;
+                const mockCryptoSetup = {
+                    SHOW_ENCRYPTION_SETUP_UI: true,
+                    examineLoginResponse: jest.fn(),
+                    persistCredentials: jest.fn(),
+                    getSecretStorageKey: jest.fn(),
+                    createSecretStorageKey: jest.fn(),
+                    catchAccessSecretStorageError: jest.fn(),
+                    setupEncryptionNeeded: jest.fn(),
+                    getDehydrationKeyCallback: jest.fn().mockReturnValue(mockDehydrationKeyCallback),
+                } as ProvideCryptoSetupExtensions;
 
                 // Ensure we have an instance before we set up spies
                 const instance = ModuleRunner.instance;