Merge pull request #1258 from matrix-org/hs/delete-room-on-matrix-leave

Remove admin/pm rooms when the matrix-side user leaves to allow server to GC

changelog.d/1258.misc

@@ -0,0 +1 @@
+Leave DM rooms and admin rooms if the Matrix user leaves so that a homeserver may clear them up later.

src/bridge/MatrixHandler.ts

@@ -719,9 +719,34 @@ export class MatrixHandler {
             serverLookup[ircClient.server.domain] = ircClient;
         });
 
+        const store = this.ircBridge.getStore();
 
         // which channels should the connected client leave?
-        const ircRooms = await this.ircBridge.getStore().getIrcChannelsForRoomId(event.room_id);
+        const ircRooms = await store.getIrcChannelsForRoomId(event.room_id);
+
+        if (!ircRooms) {
+            const adminRoom = await store.getAdminRoomById(event.room_id);
+            if (adminRoom) {
+                await store.removeAdminRoom(adminRoom);
+                // The user left the admin room, let's also leave.
+                // XXX: The typing of .leave is wrong, it should
+                // allow undefined.
+                await this.membershipQueue.leave(event.room_id, "", req);
+                return null;
+            }
+
+            const pmRoom = await store.getMatrixPmRoomById(event.room_id);
+            if (pmRoom) {
+                await store.removePmRoom(pmRoom.roomId);
+                // The user left the pm room, let's also leave.
+                const members = await this.ircBridge.getAppServiceBridge().getBot().getJoinedMembers(pmRoom.roomId);
+                await Promise.all(Object.keys(members).map((u) => {
+                    this.membershipQueue.leave(event.room_id, u, req);
+                }));
+                return null;
+            }
+
+        }
 
         // ========== Client Parting ==========
         // for each room, if we're connected to it, leave the channel.

src/datastore/DataStore.ts

@@ -124,6 +124,8 @@ export interface DataStore {
 
     getMatrixPmRoom(realUserId: string, virtualUserId: string): Promise<MatrixRoom|null>;
 
+    getMatrixPmRoomById(roomId: string): Promise<MatrixRoom|null>;
+
     getTrackedChannelsForServer(domain: string): Promise<string[]>;
 
     getRoomIdsFromConfig(): Promise<string[]>;
@@ -138,6 +140,8 @@ export interface DataStore {
 
     storeAdminRoom(room: MatrixRoom, userId: string): Promise<void>;
 
+    removeAdminRoom(room: MatrixRoom): Promise<void>;
+
     upsertMatrixRoom(room: MatrixRoom): Promise<void>;
 
     getAdminRoomByUserId(userId: string): Promise<MatrixRoom|null>;

src/datastore/NedbDataStore.ts

@@ -384,6 +384,18 @@ export class NeDBDataStore implements DataStore {
         return entry.matrix || null;
     }
 
+    public async getMatrixPmRoomById(roomId: string) {
+        const entry = await this.roomStore.getEntriesByMatrixId(roomId);
+        if (!entry) {
+            return null;
+        }
+        if (entry.length > 1) {
+            log.warn(`More than one PM room assigned to Matrix room ${roomId}, returning first`);
+        }
+        return entry[0].matrix || null;
+    }
+
+
     public async getTrackedChannelsForServer(domain: string) {
         const entries: Entry[] = await this.roomStore.getEntriesByRemoteRoomData({ domain });
         const channels = new Set<string>();
@@ -480,6 +492,12 @@ export class NeDBDataStore implements DataStore {
         });
     }
 
+    public async removeAdminRoom(room: MatrixRoom): Promise<void> {
+        await this.roomStore.delete({
+            matrix: room,
+        });
+    }
+
     public async upsertMatrixRoom(room: MatrixRoom): Promise<void> {
         await this.roomStore.setMatrixRoom(room);
     }

src/datastore/postgres/PgDataStore.ts

@@ -348,6 +348,18 @@ export class PgDataStore implements DataStore {
         return new MatrixRoom(res.rows[0].room_id);
     }
 
+    public async getMatrixPmRoomById(roomId: string): Promise<MatrixRoom|null> {
+        log.debug(`getMatrixPmRoom (roomId=${roomId})`);
+        const res = await this.pgPool.query(
+            "SELECT room_id, matrix_user_id, virtual_user_id FROM pm_rooms WHERE room_id = $1", [
+            roomId,
+        ]);
+        if (res.rowCount === 0) {
+            return null;
+        }
+        return new MatrixRoom(res.rows[0].room_id);
+    }
+
     public async getTrackedChannelsForServer(domain: string): Promise<string[]> {
         if (!this.serverMappings[domain]) {
             // Return empty if we don't know the server.
@@ -410,6 +422,10 @@ export class PgDataStore implements DataStore {
         return new MatrixRoom(res.rows[0].room_id);
     }
 
+    public async removeAdminRoom(room: MatrixRoom): Promise<void> {
+        await this.pgPool.query("DELETE FROM admin_rooms WHERE room_id = $1", [room.roomId]);
+    }
+
     public async storeMatrixUser(matrixUser: MatrixUser): Promise<void> {
         const parameters = {
             user_id: matrixUser.getId(),