Merge pull request #926 from the-draupnir-project/gnuxie/weirdo-tests

Improvements to integration tests

Author: Gnuxie

src/DraupnirBotMode.ts

@@ -48,6 +48,7 @@ import { ResultError } from "@gnuxie/typescript-result";
 import { SafeModeCause, SafeModeReason } from "./safemode/SafeModeCause";
 import { SafeModeBootOption } from "./safemode/BootOption";
 import { TopLevelStores } from "./backingstore/DraupnirStores";
+import { patchMatrixClient } from "./utils";
 
 const log = new Logger("DraupnirBotMode");
 
@@ -111,6 +112,7 @@ export class DraupnirBotModeToggle implements BotModeTogle {
     config: IConfig,
     stores: TopLevelStores
   ): Promise<DraupnirBotModeToggle> {
+    patchMatrixClient();
     const clientUserID = await client.getUserId();
     if (!isStringUserID(clientUserID)) {
       throw new TypeError(`${clientUserID} is not a valid mxid`);

src/appservice/AppService.ts

@@ -49,6 +49,7 @@ import {
 } from "@the-draupnir-project/matrix-basic-types";
 import { SqliteRoomStateBackingStore } from "../backingstore/better-sqlite3/SqliteRoomStateBackingStore";
 import { TopLevelStores } from "../backingstore/DraupnirStores";
+import { patchMatrixClient } from "../utils";
 
 const log = new Logger("AppService");
 /**
@@ -230,6 +231,7 @@ export class MjolnirAppService {
     registrationFilePath: string
   ): Promise<MjolnirAppService> {
     Logger.configure(config.logging ?? { console: "debug" });
+    patchMatrixClient();
     const dataStore = new PgDataStore(config.db.connectionString);
     await dataStore.init();
     const eventDecoder = DefaultEventDecoder;

src/config.ts

@@ -321,6 +321,19 @@ function getConfigMeta(): NonNullable<IConfig["configMeta"]> {
   };
 }
 
+let configHookExitDump: undefined | (() => void) = undefined;
+
+function registerConfigExitHook(config: IConfig): void {
+  if (configHookExitDump) {
+    return;
+  }
+  configHookExitDump = () => {
+    logNonDefaultConfiguration(config);
+    logConfigMeta(config);
+  };
+  process.on("exit", configHookExitDump);
+}
+
 /**
  * @returns The users's raw config, deep copied over the `defaultConfig`.
  */
@@ -349,10 +362,7 @@ function readConfigSource(): IConfig {
       unknownProperties
     );
   }
-  process.on("exit", () => {
-    logNonDefaultConfiguration(config);
-    logConfigMeta(config);
-  });
+  registerConfigExitHook(config);
   return config;
 }
 

src/index.ts

@@ -20,7 +20,7 @@ import {
 } from "matrix-bot-sdk";
 import { StoreType } from "@matrix-org/matrix-sdk-crypto-nodejs";
 import { configRead as configRead, getStoragePath } from "./config";
-import { initializeSentry, patchMatrixClient } from "./utils";
+import { initializeSentry } from "./utils";
 import { DraupnirBotModeToggle } from "./DraupnirBotMode";
 import { SafeMatrixEmitterWrapper } from "matrix-protection-suite-for-matrix-bot-sdk";
 import { DefaultEventDecoder } from "matrix-protection-suite";
@@ -81,7 +81,6 @@ void (async function () {
         storage
       );
     }
-    patchMatrixClient();
     const eventDecoder = DefaultEventDecoder;
     const stores = makeTopLevelStores(storagePath, eventDecoder, {
       isRoomStateBackingStoreEnabled:

test/integration/fixtures.ts

@@ -60,6 +60,7 @@ async function cleanUpTopLevelStores(storagePath: string) {
       }
     })
   );
+  //
 }
 
 // When Draupnir starts (src/index.ts) it clobbers the config by resolving the management room
@@ -106,6 +107,8 @@ export const mochaHooks = {
       await this.toggle?.stopEverything();
       draupnirClient()?.stop();
       this.stores?.dispose();
+      // With regret, please see https://github.com/the-draupnir-project/Draupnir/issues/927.
+      await new Promise((resolve) => setTimeout(resolve, 50));
       if (this.draupnir !== undefined) {
         await Promise.all([
           this.draupnir.client.setAccountData(