Draupnir/apps/draupnir/test/integration/fixtures.ts

// Copyright 2022 - 2024 Gnuxie <Gnuxie@protonmail.com>
// Copyright 2021 - 2022 The Matrix.org Foundation C.I.C.
//
// SPDX-License-Identifier: Apache-2.0
//
// SPDX-FileAttributionText: <text>
// This modified file incorporates work from mjolnir
// https://github.com/matrix-org/mjolnir
// </text>

import {
  DefaultEventDecoder,
  MJOLNIR_PROTECTED_ROOMS_EVENT_TYPE,
  MJOLNIR_WATCHED_POLICY_ROOMS_EVENT_TYPE,
  StandardLifetime,
} from "@the-draupnir-project/matrix-protection-suite";
import { configRead, getStoragePath } from "../../src/config";
import { patchMatrixClient } from "../../src/utils";
import {
  DraupnirTestContext,
  draupnir,
  draupnirClient,
  makeBotModeToggle,
} from "./mjolnirSetupUtils";
import { makeTopLevelStores } from "../../src/backingstore/DraupnirStores";
import { SqliteRoomStateBackingStore } from "../../src/backingstore/better-sqlite3/SqliteRoomStateBackingStore";
import { SqliteHashReversalStore } from "../../src/backingstore/better-sqlite3/HashStore";
import { SqliteRoomAuditLog } from "../../src/protections/RoomTakedown/SqliteRoomAuditLog";
import path from "path";
import { promises as fs } from "fs";

patchMatrixClient();

/**
 * We cleanup the stores at the start of the tests, so that they can be
 * inspected if a test fails.
 */
async function cleanUpTopLevelStores(storagePath: string) {
  await fs.mkdir(storagePath, { recursive: true }); // Ensure storagePath exists
  const storePaths = [
    SqliteRoomStateBackingStore.StoreName,
    SqliteHashReversalStore.StoreName,
    SqliteRoomAuditLog.StoreName,
  ].map((name) => path.join(storagePath, name));
  await Promise.all(
    storePaths.map(async (filePath) => {
      try {
        await fs.unlink(filePath);
      } catch (error: unknown) {
        if (
          typeof error === "object" &&
          error !== null &&
          "code" in error &&
          error.code === "ENOENT"
        ) {
          // do nothing
        } else {
          throw error; // Re-throw other errors
        }
      }
    })
  );
  //
}

// When Draupnir starts (src/index.ts) it clobbers the config by resolving the management room
// alias specified in the config (config.managementRoom) and overwriting that with the room ID.
// Unfortunately every piece of code importing that config imports the same instance, including
// testing code, which is problematic when we want to create a fresh management room for each test.
// So there is some code in here to "undo" the mutation after we stop Draupnir syncing.
export const mochaHooks = {
  beforeEach: [
    async function (this: DraupnirTestContext) {
      console.error(
        "---- entering test",
        JSON.stringify(this.currentTest?.title)
      ); // Makes MatrixClient error logs a bit easier to parse.
      console.log("mochaHooks.beforeEach");
      // Sometimes it takes a little longer to register users.
      this.timeout(30000);
      this.lifetime = new StandardLifetime();
      const config = (this.config = configRead());
      const storagePath = getStoragePath(config.dataPath);
      await cleanUpTopLevelStores(storagePath);
      this.stores = makeTopLevelStores(storagePath, DefaultEventDecoder, {
        isRoomStateBackingStoreEnabled: Boolean(
          config.roomStateBackingStore.enabled
        ),
      });
      this.toggle = await makeBotModeToggle(config, {
        eraseAccountData: true,
        stores: this.stores,
      });
      this.draupnir = draupnir();
      const draupnirMatrixClient = draupnirClient();
      if (draupnirMatrixClient === null) {
        throw new TypeError(`setup code is broken`);
      }
      await draupnirClient()?.start();
      await this.toggle.encryptionInitialized();
      console.log("mochaHooks.beforeEach DONE");
    },
  ],
  afterEach: [
    async function (this: DraupnirTestContext) {
      this.timeout(10000);
      await this.toggle?.[Symbol.asyncDispose]();
      draupnirClient()?.stop();
      this.stores?.dispose();
      await this.lifetime[Symbol.asyncDispose]();
      if (this.draupnir !== undefined) {
        await Promise.all([
          this.draupnir.client.setAccountData(
            MJOLNIR_PROTECTED_ROOMS_EVENT_TYPE,
            { rooms: [] }
          ),
          this.draupnir.client.setAccountData(
            MJOLNIR_WATCHED_POLICY_ROOMS_EVENT_TYPE,
            { references: [] }
          ),
        ]);
      }
      console.error(
        "---- completed test",
        JSON.stringify(this.currentTest?.title),
        "\n\n"
      ); // Makes MatrixClient error logs a bit easier to parse.
    },
  ],
};