mjolnir/test/integration/clientHelper.ts

import axios from "axios";
import { HmacSHA1 } from "crypto-js";
import { LogService, MatrixClient, MemoryStorageProvider, PantalaimonClient } from "matrix-bot-sdk";
import config from "../../src/config";

/**
 * Register a user using the synapse admin api that requires the use of a registration secret rather than an admin user.
 * This should only be used by test code and should not be included from any file in the source directory
 * either by explicit imports or copy pasting.
 * 
 * @param username The username to give the user.
 * @param displayname The displayname to give the user.
 * @param password The password to use.
 * @param admin True to make the user an admin, false otherwise.
 * @returns The response from synapse.
 */
export async function registerUser(username: string, displayname: string, password: string, admin: boolean) {
    let registerUrl = `${config.homeserverUrl}/_synapse/admin/v1/register`
    let { data } = await axios.get(registerUrl);
    let nonce = data.nonce!;
    let mac = HmacSHA1(`${nonce}\0${username}\0${password}\0${admin ? 'admin' : 'notadmin'}`, 'REGISTRATION_SHARED_SECRET');
    return await axios.post(registerUrl, {
        nonce,
        username,
        displayname,
        password,
        admin,
        mac: mac.toString()
    })
}

/**
 * Register a new test user with a unique username.
 *
 * @param isAdmin Whether to make the new user an admin.
 * @param label If specified, a string to place somewhere within the username.
 * @returns A string that is the username and password of a new user. 
 */
export async function registerNewTestUser(isAdmin: boolean, label: string = "") {
    let isUserValid = false;
    let username;
    if (label != "") {
        label += "-";
    }
    do {
        username = `mjolnir-test-user-${label}${Math.floor(Math.random() * 100000)}`
        await registerUser(username, username, username, isAdmin).then(_ => isUserValid = true).catch(e => {
            if (e.isAxiosError && e?.response?.data?.errcode === 'M_USER_IN_USE') {
                LogService.debug("test/clientHelper", `${username} already registered, trying another`);
                false // continue and try again
            } else {
                console.error(`failed to register user ${e}`);
                throw e;
            }
        })
    } while (!isUserValid);
    return username;
} 

/**
 * Registers a unique test user and returns a `MatrixClient` logged in and ready to use.
 *
 * @param isAdmin Whether to make the user an admin.
 * @param label If specified, a string to place somewhere within the username.
 * @returns A new `MatrixClient` session for a unique test user.
 */
export async function newTestUser(isAdmin: boolean = false, label: string = ""): Promise<MatrixClient> {
    const username = await registerNewTestUser(isAdmin, label);
    const pantalaimon = new PantalaimonClient(config.homeserverUrl, new MemoryStorageProvider());
    return await pantalaimon.createClientWithCredentials(username, username);
}

/**
 * Utility to create an event listener for m.notice msgtype m.room.messages.
 * @param targetRoomdId The roomId to listen into.
 * @param cb The callback when a m.notice event is found in targetRoomId.
 * @returns The callback to pass to `MatrixClient.on('room.message', cb)`
 */
export function noticeListener(targetRoomdId: string, cb) {
    return (roomId, event) => {
        if (roomId !== targetRoomdId) return;
        if (event?.content?.msgtype !== "m.notice") return;
            cb(event);
    } 
}