Merge pull request #182 from matrix-org/hs/safe-shutdown

Ensure bridge quits on SIGTERM

changelog.d/182.feature

@@ -0,0 +1 @@
+The bridge will now close the AS and XMPP connections on a SIGTERM signal

src/MatrixEventHandler.ts

@@ -361,7 +361,7 @@ return `- ${account.protocol.name} (${username}) [Enabled=${account.isEnabled}]
         }
         const requiredPl = this.config.provisioning.requiredUserPL;
         const intent = this.bridge.getIntent();
-        const powerLevels = await intent.getClient().getStateEvent(event.room_id, "m.room.power_levels");
+        const powerLevels = await intent.getStateEvent(event.room_id, "m.room.power_levels");
         const userPl = powerLevels.users[event.sender] === undefined ? powerLevels.users_default :
             powerLevels.users[event.sender];
         if (userPl < requiredPl) {

src/Program.ts

@@ -61,6 +61,9 @@ class Program {
         });
         this.cfg = new Config();
         this.deduplicator = new Deduplicator();
+        process.on("SIGTERM", () =>
+            this.killBridge()
+        )
     }
 
     public get config(): Config {
@@ -131,6 +134,12 @@ class Program {
         }
     }
 
+    private async killBridge() {
+        log.info("SIGTERM recieved, killing bridge");
+        await this.bridge.close();
+        await this.purple.close();
+    }
+
     private async runBridge(port: number, config: any) {
         const checkOnly = process.env.BIFROST_CHECK_ONLY === "true";
         this.cfg.ApplyConfig(config);

src/bifrost/Instance.ts

@@ -23,6 +23,7 @@ export interface IBifrostInstance extends EventEmitter {
     createBifrostAccount(username, protocol: BifrostProtocol): IBifrostAccount;
     getBuddyFromChat(conv: any, buddy: string): any;
     start(): Promise<void>;
+    close(): Promise<void>;
     getAccount(username: string, protocolId: string, mxid?: string): IBifrostAccount|null;
     getProtocol(id: string): BifrostProtocol|undefined;
     getProtocols(): BifrostProtocol[];

src/purple/PurpleInstance.ts

@@ -94,6 +94,8 @@ export class PurpleInstance extends EventEmitter implements IBifrostInstance {
         return true;
     }
 
+    public async close() {/* nothing to do */}
+
     public getUsernameFromMxid(
             mxid: string,
             prefix: string = ""): {username: string, protocol: BifrostProtocol} {

src/xmppjs/XJSInstance.ts

@@ -186,6 +186,10 @@ export class XmppJsInstance extends EventEmitter implements IBifrostInstance {
         return undefined;
     }
 
+    public async close() {
+        await this.xmpp?.stop();
+    }
+
     public async start(): Promise<void> {
         const config = this.config.purple;
         const opts = config.backendOpts as IXJSBackendOpts;