Merge pull request #32 from matrix-org/hs/ephemeral

Add support for MSC2409

Author: Half-Shot

changelog.d/32.feature

@@ -0,0 +1 @@
+Add experimental support for receiving ephemeral data from the homeserver (MSC2409)

src/app-service-registration.ts

@@ -36,6 +36,7 @@ export class AppServiceRegistration {
         reg.setSenderLocalpart(obj.sender_localpart);
         reg.setRateLimited(obj.rate_limited);
         reg.setProtocols(obj.protocols);
+        reg.pushEphemeral = obj["de.sorunome.msc2409.push_ephemeral"];
         if (obj.namespaces) {
             const kinds = ["users", "aliases", "rooms"];
             kinds.forEach((kind) => {
@@ -62,6 +63,11 @@ export class AppServiceRegistration {
     private asToken: string|null = null;
     private senderLocalpart: string|null = null;
     private rateLimited = true;
+    /**
+     * **Experimental**  
+     * Signal to the homeserver that this appservice will accept ephemeral events.
+     */
+    public pushEphemeral = false;
     private namespaces: {
         users: RegexObj[];
         aliases: RegexObj[];
@@ -223,6 +229,7 @@ export class AppServiceRegistration {
             sender_localpart: this.senderLocalpart,
             rate_limited: this.rateLimited,
             protocols: this.protocols,
+            "de.sorunome.msc2409.push_ephemeral": this.pushEphemeral,
         };
     }
 

src/app-service.ts

@@ -21,6 +21,17 @@ export declare interface AppService {
      * });
      */
     on(event: "event", cb: (event: Record<string, unknown>) => void): this;
+    /**
+     * Emitted when an ephemeral event is pushed to the appservice.
+     * The format of the event object is documented at
+     * https://github.com/matrix-org/matrix-doc/pull/2409
+     * @event
+     * @example
+     * appService.on("ephemeral", function(ev) {
+     *   console.log("ID: %s", ev.type);
+     * });
+     */
+    on(event: "ephemeral", cb: (event: Record<string, unknown>) => void): this;
     /**
      * Emitted when the HTTP listener logs some information.
      * `access_tokens` are stripped from requests
@@ -42,7 +53,6 @@ export declare interface AppService {
      *   console.log("ID: %s", ev.content.body);
      * });
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event: string, cb: (event: Record<string, unknown>) => void): this;
 }
 
@@ -194,6 +204,7 @@ export class AppService extends EventEmitter {
     private isInvalidToken(req: Request, res: Response): boolean {
         const providedToken = req.query.access_token;
         if (providedToken !== this.config.homeserverToken) {
+            res.status(403);
             res.send({
                 errcode: "M_FORBIDDEN",
                 error: "Bad token supplied,"
@@ -255,11 +266,13 @@ export class AppService extends EventEmitter {
             res.send("Missing transaction ID.");
             return;
         }
-        if (!req.body || !req.body.events) {
-            res.send("Missing events body.");
+        if (!req.body) {
+            res.send("Missing body.");
             return;
         }
-        const events = req.body.events;
+
+        const events = req.body.events || [];
+        const ephemeral = req.body["de.sorunome.msc2409.ephemeral"] || [];
 
         if (this.lastProcessedTxnId === txnId) {
             res.send({}); // duplicate
@@ -271,6 +284,12 @@ export class AppService extends EventEmitter {
                 this.emit("type:" + event.type, event);
             }
         }
+        for (const event of ephemeral) {
+            this.emit("ephemeral", event);
+            if (event.type) {
+                this.emit("ephemeral_type:" + event.type, event);
+            }
+        }
         this.lastProcessedTxnId = txnId;
         res.send({});
     }