Add option to omit the hook payload data from matrix events from generic hooks

changelog.d/1004.feature

@@ -0,0 +1 @@
+Add an option in the config to disable hook bodies in Matrix messages.

spec/generic-hooks.spec.ts

@@ -116,4 +116,31 @@ describe('Inbound (Generic) Webhooks', () => {
             error: "This hook has expired",
         });
     });
+
+    it('should allow disabling hook data in matrix events.', async () => {
+        const user = testEnv.getUser('user');
+        const roomId = await user.createRoom({ name: 'My Test Webhooks room'});
+        const okMsg = user.waitForRoomEvent({ eventType: "m.room.message", sender: testEnv.botMxid, roomId });
+        const url = await createInboundConnection(user, testEnv.botMxid, roomId, '2h');
+        expect((await okMsg).data.content.body).toEqual('Room configured to bridge webhooks. See admin room for secret url.');
+        const stateEvent = (await user.getRoomState(roomId)).find(v => v.type === GenericHookConnection.CanonicalEventType)
+        await user.sendStateEvent(roomId, stateEvent.type, stateEvent.state_key, {
+            ...stateEvent.content,
+            includeHookBody: false,
+        });
+
+        const expectedMsg = user.waitForRoomEvent({ eventType: "m.room.message", sender: testEnv.botMxid, roomId });
+        const req = await fetch(url, {
+            method: "PUT",
+            body: "Hello world"
+        });
+        expect(req.status).toEqual(200);
+        expect(await req.json()).toEqual({ ok: true });
+        expect((await expectedMsg).data.content).toEqual({
+            msgtype: 'm.notice',
+            body: 'Received webhook data: Hello world',
+            formatted_body: '<p>Received webhook data: Hello world</p>',
+            format: 'org.matrix.custom.html',
+        });
+    });
 });

src/Connections/GenericHook.ts

@@ -36,6 +36,8 @@
      * (in UTC) time.
      */
     expirationDate?: string;
+
+    includeHookBody?: boolean;
 }
 
 export interface GenericHookSecrets {
@@ -152,7 +154,7 @@
     }
 
     static validateState(state: Partial<Record<keyof GenericHookConnectionState, unknown>>): GenericHookConnectionState {
-        const {name, transformationFunction, waitForComplete, expirationDate: expirationDateStr} = state;
+        const {name, transformationFunction, waitForComplete, expirationDate: expirationDateStr, includeHookBody} = state;
         if (!name) {
             throw new ApiError('Missing name', ErrCode.BadValue);
         }
@@ -162,6 +164,9 @@
         if (waitForComplete !== undefined && typeof waitForComplete !== "boolean") {
             throw new ApiError("'waitForComplete' must be a boolean", ErrCode.BadValue);
         }
+        if (includeHookBody !== undefined && typeof includeHookBody !== "boolean") {
+            throw new ApiError("'includeHookBody' must be a boolean", ErrCode.BadValue);
+        }
         // Use !=, not !==, to check for both undefined and null
         if (transformationFunction != undefined) {
             if (!this.quickModule) {
@@ -186,6 +191,7 @@
             name,
             transformationFunction: transformationFunction || undefined,
             waitForComplete,
+            includeHookBody: includeHookBody ?? true,
             expirationDate,
         };
     }
@@ -249,7 +255,6 @@
             throw new ApiError('Expiration date must be set', ErrCode.BadValue);
         }
 
-
         await GenericHookConnection.ensureRoomAccountData(roomId, intent, hookId, validState.name);
         await intent.underlyingClient.sendStateEvent(roomId, this.CanonicalEventType, validState.name, validState);
         const connection = new GenericHookConnection(roomId, validState, hookId, validState.name, messageClient, config.generic, as, intent, storage);
@@ -355,7 +360,7 @@
             if (this.cachedDisplayname !== expectedDisplayname) {
                 this.cachedDisplayname = (await intent.underlyingClient.getUserProfile(this.intent.userId)).displayname;
             }
         } catch (ex) {
             // Couldn't fetch, probably not set.
             this.cachedDisplayname = undefined;
         }
@@ -580,7 +585,7 @@
             await ensureUserIsInRoom(senderIntent, this.intent.underlyingClient, this.roomId);
 
             // Matrix cannot handle float data, so make sure we parse out any floats.
-            const safeData = GenericHookConnection.sanitiseObjectForMatrixJSON(data);
+            const safeData = (this.config.includeHookBody && this.state.includeHookBody) ? GenericHookConnection.sanitiseObjectForMatrixJSON(data) : undefined;
 
             await this.messageClient.sendMatrixMessage(this.roomId, {
                 msgtype: content.msgtype || "m.notice",
@@ -617,6 +622,7 @@
                 waitForComplete: this.waitForComplete,
                 name: this.state.name,
                 expirationDate: this.state.expirationDate,
+                includeHookBody: this.config.includeHookBody && this.state.includeHookBody,
             },
             ...(showSecrets ? { secrets: {
                 url: new URL(this.hookId, this.config.parsedUrlPrefix),

src/config/sections/generichooks.ts

@@ -19,6 +19,7 @@ export interface BridgeGenericWebhooksConfigYAML {
     maxExpiryTime?: string;
     sendExpiryNotice?: boolean;
     requireExpiryTime?: boolean;
+    includeHookBody?: boolean;
 }
 
 export class BridgeConfigGenericWebhooks {
@@ -33,6 +34,7 @@ export class BridgeConfigGenericWebhooks {
     public readonly allowJsTransformationFunctions?: boolean;
     public readonly waitForComplete?: boolean;
     public readonly enableHttpGet: boolean;
+    public readonly includeHookBody: boolean;
 
     @hideKey()
     public readonly maxExpiryTimeMs?: number;
@@ -47,6 +49,7 @@ export class BridgeConfigGenericWebhooks {
         this.enableHttpGet = yaml.enableHttpGet || false;
         this.sendExpiryNotice = yaml.sendExpiryNotice || false;
         this.requireExpiryTime = yaml.requireExpiryTime || false;
+        this.includeHookBody = yaml.includeHookBody || false;
         try {
             this.parsedUrlPrefix = makePrefixedUrl(yaml.urlPrefix);
             this.urlPrefix = () => { return this.parsedUrlPrefix.href; }