WIP Extension mechanism

src/modules/ModuleRunner.ts

@@ -16,8 +16,7 @@ limitations under the License.
 
 import { safeSet } from "matrix-js-sdk/src/utils";
 import { TranslationStringsObject } from "@matrix-org/react-sdk-module-api/lib/types/translations";
-import { AnyLifecycle } from "@matrix-org/react-sdk-module-api/lib/lifecycles/types";
-
+import { AnyLifecycle, ProxiedExtensions } from "@matrix-org/react-sdk-module-api/lib/lifecycles/types";
 import { AppModule } from "./AppModule";
 import { ModuleFactory } from "./ModuleFactory";
 
@@ -85,4 +84,26 @@ export class ModuleRunner {
             module.module.emit(lifecycleEvent, ...args);
         }
     }
+
+
+    public extensionMethods = new ProxiedExtensions(this.modules);
+
+    //   /**
+    //  * Invokes a method in any of the registeres modules (only a single module can register a fetcher of a given type).
+    //  * @param extensionMethod The extension method to call
+    //  * @param args The arguments for the method.
+    //  */
+    //   public invokeMethod<T>(extensionMethod: AnyExtensionMethod, ...args: any[]): T | undefined{
+    //     console.log("Try invokeMethod: ", extensionMethod);
+    //     for (const module of this.modules) {
+    //         let method = module.module.methods.get(extensionMethod);
+    //         if(method){
+    //             console.log("Found. invoking method: ", extensionMethod);
+    //             var methodResult = method(args);
+    //             return methodResult;
+    //         }
+    //     }
+    //     console.log("Method not found. returning undefined");
+    //     return undefined;
+    // }    
 }

test/modules/MockModule.ts

@@ -18,6 +18,8 @@ import { RuntimeModule } from "@matrix-org/react-sdk-module-api/lib/RuntimeModul
 import { ModuleApi } from "@matrix-org/react-sdk-module-api/lib/ModuleApi";
 
 import { ModuleRunner } from "../../src/modules/ModuleRunner";
+import { AllExtensions } from "@matrix-org/react-sdk-module-api/lib/lifecycles/types";
+import { CryptoSetupExtensionsBase, IExtendedMatrixClientCreds } from "@matrix-org/react-sdk-module-api/lib/lifecycles/SecurityLifecycle";
 
 export class MockModule extends RuntimeModule {
     public get apiInstance(): ModuleApi {
@@ -28,6 +30,27 @@ export class MockModule extends RuntimeModule {
         super(moduleApi);
     }
 }
+export class MockModuleWithCryptoSetupExtension extends RuntimeModule {
+    public get apiInstance(): ModuleApi {
+        return this.moduleApi;
+    }
+
+    extensions?: AllExtensions | undefined = {
+        cryptoSetup: new (class extends CryptoSetupExtensionsBase {
+            GetSecretStorageKey() {
+                return "my secret storage key"
+            }
+
+            ExamineLoginResponse(response: any, credentials: IExtendedMatrixClientCreds): void {      
+                credentials.secureBackupKey = "my secure backup key";          
+            }
+        })()
+    }
+
+    public constructor(moduleApi: ModuleApi) {
+        super(moduleApi);
+    }
+}
 
 export function registerMockModule(): MockModule {
     let module: MockModule | undefined;
@@ -43,3 +66,19 @@ export function registerMockModule(): MockModule {
     }
     return module;
 }
+
+export function registerMockModuleWithCryptoSetupExtension(): MockModuleWithCryptoSetupExtension {
+    let module: MockModuleWithCryptoSetupExtension | undefined;
+
+    ModuleRunner.instance.registerModule((api) => {
+        if (module) {
+            throw new Error("State machine error: ModuleRunner created the module twice");
+        }
+        module = new MockModuleWithCryptoSetupExtension(api);
+        return module;
+    });
+    if (!module) {
+        throw new Error("State machine error: ModuleRunner did not create module");
+    }
+    return module;
+}

test/modules/ModuleRunner-test.ts

@@ -16,7 +16,12 @@ limitations under the License.
 
 import { RoomPreviewOpts, RoomViewLifecycle } from "@matrix-org/react-sdk-module-api/lib/lifecycles/RoomViewLifecycle";
 
-import { MockModule, registerMockModule } from "./MockModule";
+import { 
+    MockModule,
+    registerMockModule,
+    registerMockModuleWithCryptoSetupExtension 
+} from "./MockModule";
+
 import { ModuleRunner } from "../../src/modules/ModuleRunner";
 
 describe("ModuleRunner", () => {
@@ -49,4 +54,15 @@ describe("ModuleRunner", () => {
             ]);
         });
     });
+
+    describe("extensionMethods", () => {
+
+        it("should return value when extension provided by a registered module", async () => {
+            const module1 = registerMockModule();
+            const module2 = registerMockModuleWithCryptoSetupExtension();
+
+            var result = ModuleRunner.instance.extensionMethods.extensions.cryptoSetup?.GetSecretStorageKey();
+            expect(results).toEqual("")
+        });
+    });
 });