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
This commit is contained in:
parent
2dd683a42f
commit
7f5bb61a79
22 changed files with 906 additions and 34 deletions
54
test/modules/ModuleRunner-test.ts
Normal file
54
test/modules/ModuleRunner-test.ts
Normal file
|
@ -0,0 +1,54 @@
|
|||
/*
|
||||
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 { RoomPreviewOpts, RoomViewLifecycle } from "@matrix-org/react-sdk-module-api/lib/lifecycles/RoomViewLifecycle";
|
||||
|
||||
import { MockModule, registerMockModule } from "./MockModule";
|
||||
import { ModuleRunner } from "../../src/modules/ModuleRunner";
|
||||
|
||||
describe("ModuleRunner", () => {
|
||||
afterEach(() => {
|
||||
ModuleRunner.instance.reset();
|
||||
});
|
||||
|
||||
// Translations implicitly tested by ProxiedModuleApi integration tests.
|
||||
|
||||
describe("invoke", () => {
|
||||
it("should invoke to every registered module", async () => {
|
||||
const module1 = registerMockModule();
|
||||
const module2 = registerMockModule();
|
||||
|
||||
const wrapEmit = (module: MockModule) => new Promise((resolve) => {
|
||||
module.on(RoomViewLifecycle.PreviewRoomNotLoggedIn, (val1, val2) => {
|
||||
resolve([val1, val2]);
|
||||
});
|
||||
});
|
||||
const promises = Promise.all([
|
||||
wrapEmit(module1),
|
||||
wrapEmit(module2),
|
||||
]);
|
||||
|
||||
const roomId = "!room:example.org";
|
||||
const opts: RoomPreviewOpts = { canJoin: false };
|
||||
ModuleRunner.instance.invoke(RoomViewLifecycle.PreviewRoomNotLoggedIn, opts, roomId);
|
||||
const results = await promises;
|
||||
expect(results).toEqual([
|
||||
[opts, roomId], // module 1
|
||||
[opts, roomId], // module 2
|
||||
]);
|
||||
});
|
||||
});
|
||||
});
|
Loading…
Add table
Add a link
Reference in a new issue