Set up state store if configured in d4all mode (#753)

* Set up state store if configured in d4all mode

Signed-off-by: MTRNord <[email protected]>

* Ensure the dataPath is set in both the example and harness appservice config

Signed-off-by: MTRNord <[email protected]>

* Move the SqliteRoomStateBackingStore creation to a static method instead

Signed-off-by: MTRNord <[email protected]>

* Make the storage path canonicalization less confusing

---------

Signed-off-by: MTRNord <[email protected]>

Author: MTRNord

src/appservice/AppService.ts

@@ -24,7 +24,7 @@ import { Api } from "./Api";
 import { IConfig } from "./config/config";
 import { AccessControl } from "./AccessControl";
 import { AppserviceCommandHandler } from "./bot/AppserviceCommandHandler";
-import { SOFTWARE_VERSION } from "../config";
+import { getStoragePath, SOFTWARE_VERSION } from "../config";
 import { Registry } from "prom-client";
 import {
   ClientCapabilityFactory,
@@ -36,6 +36,7 @@ import {
   ClientsInRoomMap,
   DefaultEventDecoder,
   EventDecoder,
+  RoomStateBackingStore,
   StandardClientsInRoomMap,
   Task,
   isError,
@@ -48,6 +49,7 @@ import {
   isStringRoomAlias,
   isStringRoomID,
 } from "@the-draupnir-project/matrix-basic-types";
+import { SqliteRoomStateBackingStore } from "../backingstore/better-sqlite3/SqliteRoomStateBackingStore";
 
 const log = new Logger("AppService");
 /**
@@ -98,7 +100,8 @@ export class MjolnirAppService {
     config: IConfig,
     dataStore: DataStore,
     eventDecoder: EventDecoder,
-    registrationFilePath: string
+    registrationFilePath: string,
+    backingStore?: RoomStateBackingStore
   ) {
     const bridge = new Bridge({
       homeserverUrl: config.homeserver.url,
@@ -143,7 +146,8 @@ export class MjolnirAppService {
     const roomStateManagerFactory = new RoomStateManagerFactory(
       clientsInRoomMap,
       clientProvider,
-      eventDecoder
+      eventDecoder,
+      backingStore
     );
     const clientCapabilityFactory = new ClientCapabilityFactory(
       clientsInRoomMap,
@@ -226,11 +230,17 @@ export class MjolnirAppService {
     Logger.configure(config.logging ?? { console: "debug" });
     const dataStore = new PgDataStore(config.db.connectionString);
     await dataStore.init();
+    const eventDecoder = DefaultEventDecoder;
+    const storagePath = getStoragePath(config.dataPath);
+    const backingStore = config.roomStateBackingStore.enabled
+      ? SqliteRoomStateBackingStore.create(storagePath, eventDecoder)
+      : undefined;
     const service = await MjolnirAppService.makeMjolnirAppService(
       config,
       dataStore,
       DefaultEventDecoder,
-      registrationFilePath
+      registrationFilePath,
+      backingStore
     );
     // The call to `start` MUST happen last. As it needs the datastore, and the mjolnir manager to be initialized before it can process events from the homeserver.
     await service.start(port);

src/appservice/config/config.example.yaml

@@ -16,3 +16,9 @@ adminRoom: "#draupnir-admin:localhost:9999"
 # This is a web api that the widget connects to in order to interact with the appservice.
 webAPI:
   port: 9001
+
+# The directory the bot should store various bits of information in
+dataPath: "./test/harness/mjolnir-data/"
+
+roomStateBackingStore:
+  enabled: false

src/appservice/config/config.harness.yaml

@@ -10,3 +10,9 @@ adminRoom: "#draupnir-admin:localhost:9999"
 
 webAPI:
   port: 9001
+
+# The directory the bot should store various bits of information in
+dataPath: "./test/harness/mjolnir-data/"
+
+roomStateBackingStore:
+  enabled: false

src/appservice/config/config.ts

@@ -33,6 +33,14 @@ export interface IConfig {
   adminRoom: string;
   /** configuration for matrix-appservice-bridge's Logger */
   logging?: LoggingOpts;
+
+  dataPath: string;
+
+  // Store room state using sqlite to improve startup time when Synapse responds
+  // slowly to requests for `/state`.
+  roomStateBackingStore: {
+    enabled?: boolean;
+  };
 }
 
 export function read(configPath: string): IConfig {

src/backingstore/better-sqlite3/SqliteRoomStateBackingStore.ts

@@ -18,6 +18,7 @@ import {
 import { BetterSqliteStore, flatTransaction } from "./BetterSqliteStore";
 import { jsonReviver } from "../../utils";
 import { StringRoomID } from "@the-draupnir-project/matrix-basic-types";
+import path from "path";
 
 const log = new Logger("SqliteRoomStateBackingStore");
 
@@ -68,6 +69,16 @@ export class SqliteRoomStateBackingStore
     this.ensureSchema();
   }
 
+  public static create(
+    storagePath: string,
+    eventDecoder: EventDecoder
+  ): SqliteRoomStateBackingStore {
+    return new SqliteRoomStateBackingStore(
+      path.join(storagePath, "room-state-backing-store.db"),
+      eventDecoder
+    );
+  }
+
   private updateBackingStore(
     revision: RoomStateRevision,
     changes: StateChange[]

src/config.ts

@@ -540,3 +540,15 @@ export function getUnknownConfigPropertyPaths(config: unknown): string[] {
     []
   );
 }
+
+/**
+ * Ensures we have an absolute path for storage
+ *
+ * @param dataPath The dataPath from either the bot or appservice configs
+ * @returns The storagePath used for the databases
+ */
+export function getStoragePath(dataPath: string) {
+  return path.isAbsolute(dataPath)
+    ? dataPath
+    : path.join(__dirname, "../", dataPath);
+}

src/index.ts

@@ -19,7 +19,7 @@ import {
   RustSdkCryptoStorageProvider,
 } from "matrix-bot-sdk";
 import { StoreType } from "@matrix-org/matrix-sdk-crypto-nodejs";
-import { configRead as configRead } from "./config";
+import { configRead as configRead, getStoragePath } from "./config";
 import { initializeSentry, patchMatrixClient } from "./utils";
 import { DraupnirBotModeToggle } from "./DraupnirBotMode";
 import { SafeMatrixEmitterWrapper } from "matrix-protection-suite-for-matrix-bot-sdk";
@@ -46,9 +46,7 @@ void (async function () {
   let bot: DraupnirBotModeToggle | null = null;
   let client: MatrixClient;
   try {
-    const storagePath = path.isAbsolute(config.dataPath)
-      ? config.dataPath
-      : path.join(__dirname, "../", config.dataPath);
+    const storagePath = getStoragePath(config.dataPath);
     const storage = new SimpleFsStorageProvider(
       path.join(storagePath, "bot.json")
     );
@@ -86,10 +84,7 @@ void (async function () {
     patchMatrixClient();
     const eventDecoder = DefaultEventDecoder;
     const store = config.roomStateBackingStore.enabled
-      ? new SqliteRoomStateBackingStore(
-          path.join(storagePath, "room-state-backing-store.db"),
-          eventDecoder
-        )
+      ? SqliteRoomStateBackingStore.create(storagePath, eventDecoder)
       : undefined;
     bot = await DraupnirBotModeToggle.create(
       client,