mirror of
https://github.com/matrix-org/mjolnir.git
synced 2024-09-29 20:56:23 +00:00
704bb660c2
* Refactor Matrix event listener in Mjolnir and ManagedMjolnir. closes https://github.com/matrix-org/mjolnir/issues/411. Issue #411 says that we have to be careful about room.join, but this was before we figured how to make matrix-appservice-bridge echo events sent by its own intents. * Remove MatrixClientListener since it isn't actually needed. * Protect which config values can be used for ManagedMjolnirs. * Introduce MatrixSendClient so listeners aren't accidentally added to a MatrixClient instead of MatrixEmitter. * doc * Move provisioned mjolnir config to src/config. This just aids maintance so whenever someone goes to change the config of the bot they will see this and update it. * doc for matrix intent listener.
103 lines
3.8 KiB
TypeScript
103 lines
3.8 KiB
TypeScript
/*
|
|
Copyright 2021 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 {
|
|
MatrixClient,
|
|
PantalaimonClient,
|
|
MemoryStorageProvider,
|
|
LogService,
|
|
LogLevel,
|
|
RichConsoleLogger
|
|
} from "matrix-bot-sdk";
|
|
import { Mjolnir} from '../../src/Mjolnir';
|
|
import { overrideRatelimitForUser, registerUser } from "./clientHelper";
|
|
import { initializeSentry, patchMatrixClient } from "../../src/utils";
|
|
import { IConfig } from "../../src/config";
|
|
|
|
/**
|
|
* Ensures that a room exists with the alias, if it does not exist we create it.
|
|
* @param client The MatrixClient to use to resolve or create the aliased room.
|
|
* @param alias The alias of the room.
|
|
* @returns The room ID of the aliased room.
|
|
*/
|
|
export async function ensureAliasedRoomExists(client: MatrixClient, alias: string): Promise<string> {
|
|
try {
|
|
return await client.resolveRoom(alias);
|
|
} catch (e) {
|
|
if (e?.body?.errcode === 'M_NOT_FOUND') {
|
|
console.info(`${alias} hasn't been created yet, so we're making it now.`)
|
|
let roomId = await client.createRoom({
|
|
visibility: "public",
|
|
});
|
|
await client.createRoomAlias(alias, roomId);
|
|
return roomId
|
|
}
|
|
throw e;
|
|
}
|
|
}
|
|
|
|
async function configureMjolnir(config: IConfig) {
|
|
// Initialize error monitoring as early as possible.
|
|
initializeSentry(config);
|
|
try {
|
|
await registerUser(config.homeserverUrl, config.pantalaimon.username, config.pantalaimon.username, config.pantalaimon.password, true)
|
|
} catch (e) {
|
|
if (e?.body?.errcode === 'M_USER_IN_USE') {
|
|
console.log(`${config.pantalaimon.username} already registered, skipping`);
|
|
return;
|
|
}
|
|
throw e;
|
|
};
|
|
}
|
|
|
|
export function mjolnir(): Mjolnir | null {
|
|
return globalMjolnir;
|
|
}
|
|
export function matrixClient(): MatrixClient | null {
|
|
return globalClient;
|
|
}
|
|
let globalClient: MatrixClient | null
|
|
let globalMjolnir: Mjolnir | null;
|
|
|
|
/**
|
|
* Return a test instance of Mjolnir.
|
|
*/
|
|
export async function makeMjolnir(config: IConfig): Promise<Mjolnir> {
|
|
await configureMjolnir(config);
|
|
LogService.setLogger(new RichConsoleLogger());
|
|
LogService.setLevel(LogLevel.fromString(config.logLevel, LogLevel.DEBUG));
|
|
LogService.info("test/mjolnirSetupUtils", "Starting bot...");
|
|
const pantalaimon = new PantalaimonClient(config.homeserverUrl, new MemoryStorageProvider());
|
|
const client = await pantalaimon.createClientWithCredentials(config.pantalaimon.username, config.pantalaimon.password);
|
|
await overrideRatelimitForUser(config.homeserverUrl, await client.getUserId());
|
|
patchMatrixClient();
|
|
await ensureAliasedRoomExists(client, config.managementRoom);
|
|
let mj = await Mjolnir.setupMjolnirFromConfig(client, client, config);
|
|
globalClient = client;
|
|
globalMjolnir = mj;
|
|
return mj;
|
|
}
|
|
|
|
/**
|
|
* Remove the alias and leave the room, can't be implicitly provided from the config because Mjolnir currently mutates it.
|
|
* @param client The client to use to leave the room.
|
|
* @param roomId The roomId of the room to leave.
|
|
* @param alias The alias to remove from the room.
|
|
*/
|
|
export async function teardownManagementRoom(client: MatrixClient, roomId: string, alias: string) {
|
|
await client.deleteRoomAlias(alias);
|
|
await client.leaveRoom(roomId);
|
|
}
|