Add tests for various forms of rich replies (#1799)

* Add tests for various forms of rich replies

Signed-off-by: Tadeusz „tadzik” Sośnierz <tadeusz@sosnierz.com>

* Ensure leaving the channel and rejoining doesn't allow you to quote-reply messages you haven't seen

* Fix braces

---------

Signed-off-by: Tadeusz „tadzik” Sośnierz <tadeusz@sosnierz.com>
Co-authored-by: Will Hunt <will@half-shot.uk>

changelog.d/1799.misc

@@ -0,0 +1 @@
+Add tests for various forms of rich replies.

spec/e2e/replies.spec.ts

@@ -0,0 +1,187 @@
+import { TestIrcServer } from "matrix-org-irc";
+import { IrcBridgeE2ETest } from "../util/e2e-test";
+import { describe, expect, it } from "@jest/globals";
+
+
+describe('Reply handling', () => {
+    let testEnv: IrcBridgeE2ETest;
+    async function setupTestEnv(shortReplyTresholdSeconds: number) {
+        testEnv = await IrcBridgeE2ETest.createTestEnv({
+            matrixLocalparts: [TestIrcServer.generateUniqueNick("alice"), TestIrcServer.generateUniqueNick("charlie")],
+            ircNicks: ['bob'],
+            traceToFile: true,
+            shortReplyTresholdSeconds,
+        });
+        await testEnv.setUp();
+    }
+    afterEach(() => {
+        return testEnv?.tearDown();
+    });
+
+    it('should use short and long reply formats, depending on elapsed time', async () => {
+        await setupTestEnv(1);
+
+        const channel = `#${TestIrcServer.generateUniqueNick("test")}`;
+        const { homeserver } = testEnv;
+        const [alice, charlie] = homeserver.users.map(u => u.client);
+        const { bob } = testEnv.ircTest.clients;
+
+        await bob.join(channel);
+
+        const adminRoomId = await testEnv.createAdminRoomHelper(alice);
+        const cRoomId = await testEnv.joinChannelHelper(alice, adminRoomId, channel);
+        await charlie.joinRoom(cRoomId);
+
+        const bobUserId = `@irc_${bob.nick}:${homeserver.domain}`;
+        await alice.waitForRoomEvent(
+            {eventType: 'm.room.member', sender: bobUserId, stateKey: bobUserId, roomId: cRoomId}
+        );
+
+        // first message is always a bit delayed, so let's send&await it ahead of time before we get to testing
+        let bridgedMessage = bob.waitForEvent('message', 10000);
+        await alice.sendText(cRoomId, "warming up...");
+        await bridgedMessage;
+
+        const originalMessageBody = "Original message";
+        bridgedMessage = bob.waitForEvent('message', 10000);
+        const originalMessageId = await alice.sendText(cRoomId, originalMessageBody);
+        await bridgedMessage;
+
+        bridgedMessage = bob.waitForEvent('message', 10000);
+        await charlie.replyText(cRoomId, {
+            event_id: originalMessageId,
+        }, "Short reply");
+        let ircMessage = await bridgedMessage;
+
+        expect(ircMessage[2]).toContain("Short reply");
+        expect(ircMessage[2]).not.toContain("Original message");
+
+        await new Promise(r => setTimeout(r, 1000));
+
+        bridgedMessage = bob.waitForEvent('message', 10000);
+        await charlie.replyText(cRoomId, {
+            event_id: originalMessageId,
+        }, "Long reply");
+        ircMessage = await bridgedMessage;
+
+        expect(ircMessage[2]).toContain("Long reply");
+        expect(ircMessage[2]).toContain("Original message");
+    });
+    it('should not leak the contents of messages to new joiners', async () => {
+        await setupTestEnv(0);
+
+        const channel = `#${TestIrcServer.generateUniqueNick("test")}`;
+        const { homeserver, ircBridge } = testEnv;
+        const [alice, charlie] = homeserver.users.map(u => u.client);
+        const { bob } = testEnv.ircTest.clients;
+
+        // Create the channel
+        await bob.join(channel);
+
+        const adminRoomId = await testEnv.createAdminRoomHelper(alice);
+        const cRoomId = await testEnv.joinChannelHelper(alice, adminRoomId, channel);
+        const roomName = await alice.getRoomStateEvent(cRoomId, 'm.room.name', '');
+        expect(roomName.name).toEqual(channel);
+
+        // And finally wait for bob to appear.
+        const bobUserId = `@irc_${bob.nick}:${homeserver.domain}`;
+        await alice.waitForRoomEvent(
+            {eventType: 'm.room.member', sender: bobUserId, stateKey: bobUserId, roomId: cRoomId}
+        );
+
+        // Send some messages
+        const aliceMsg = bob.waitForEvent('message', 10000);
+        const bobMsg = alice.waitForRoomEvent(
+            {eventType: 'm.room.message', sender: bobUserId, roomId: cRoomId}
+        );
+        const aliceMsgBody = "Hello bib!";
+        const aliceEventId = alice.sendText(cRoomId, aliceMsgBody);
+        await aliceMsg;
+        bob.say(channel, "Hi alice!");
+        await bobMsg;
+
+        // Now charlie joins and tries to reply to alice.
+        await charlie.joinRoom(cRoomId);
+        const charlieMsgIrcPromise = bob.waitForEvent('message', 10000);
+        await charlie.replyText(cRoomId, {
+            event_id: await aliceEventId,
+        }, "Sneaky reply to a message I have not seen");
+
+        // Safety check to ensure that we're using the long form reply format.
+        expect(ircBridge.config.ircService.matrixHandler?.shortReplyTresholdSeconds).toBe(0);
+        // The long form reply format should not contain alice's message.
+        const charlieIrcMessage = (await charlieMsgIrcPromise)[2];
+        expect(charlieIrcMessage).not.toContain(aliceMsgBody);
+
+        // Now check that alice can reply, as they have been in the room long enough.
+        const aliceReplyMsgPromise = bob.waitForEvent('message', 10000);
+        await alice.replyText(cRoomId, {
+            event_id: await aliceEventId,
+        }, "Oh sorry, I meant bob!");
+        expect((await aliceReplyMsgPromise)[2]).toContain(aliceMsgBody);
+
+        // restart the bridge, effectively marking members as "been here forever"
+        await testEnv.recreateBridge();
+        await testEnv.setUp();
+        const postRestartAliceMsg = bob.waitForEvent('message', 10000);
+        const postRestartAliceMsgBody = "Hello post-restart world!";
+        const postRestartAliceEventId = alice.sendText(cRoomId, postRestartAliceMsgBody);
+        await postRestartAliceMsg;
+
+        const postRestartCharlieMsg = bob.waitForEvent('message', 10000);
+        await charlie.replyText(cRoomId, {
+            event_id: await postRestartAliceEventId,
+        }, "Hello alice!");
+        const postRestartCharlieMsgBody = (await postRestartCharlieMsg)[2];
+        expect(postRestartCharlieMsgBody).toContain(postRestartAliceMsgBody);
+    });
+
+    it('should not leak the contents of messages to leavers', async () => {
+        await setupTestEnv(0);
+
+        const channel = `#${TestIrcServer.generateUniqueNick("test")}`;
+        const { homeserver, ircBridge } = testEnv;
+        const [alice, charlie] = homeserver.users.map(u => u.client);
+        const { bob } = testEnv.ircTest.clients;
+
+        // Create the channel
+        await bob.join(channel);
+
+        const adminRoomId = await testEnv.createAdminRoomHelper(alice);
+        const cRoomId = await testEnv.joinChannelHelper(alice, adminRoomId, channel);
+        const roomName = await alice.getRoomStateEvent(cRoomId, 'm.room.name', '');
+        expect(roomName.name).toEqual(channel);
+
+        const bobUserId = `@irc_${bob.nick}:${homeserver.domain}`;
+        await alice.waitForRoomEvent(
+            {eventType: 'm.room.member', sender: bobUserId, stateKey: bobUserId, roomId: cRoomId}
+        );
+
+        await charlie.joinRoom(cRoomId);
+        await charlie.leaveRoom(cRoomId);
+
+        // Send some messages
+        const aliceMsg = bob.waitForEvent('message', 10000);
+        const bobMsg = alice.waitForRoomEvent(
+            {eventType: 'm.room.message', sender: bobUserId, roomId: cRoomId}
+        );
+        const aliceMsgBody = "Hello bib!";
+        const aliceEventId = alice.sendText(cRoomId, aliceMsgBody);
+        await aliceMsg;
+        bob.say(channel, "Hi alice!");
+        await bobMsg;
+
+        // Now charlie joins and tries to reply to alice.
+        await charlie.joinRoom(cRoomId);
+        const charlieMsgIrcPromise = bob.waitForEvent('message', 10000);
+        await charlie.replyText(cRoomId, {
+            event_id: await aliceEventId,
+        }, "Sneaky reply to a message I have not seen");
+
+        // Safety check to ensure that we're using the long form reply format.
+        expect(ircBridge.config.ircService.matrixHandler?.shortReplyTresholdSeconds).toBe(0);
+        // The long form reply format should not contain alice's message.
+        const charlieIrcMessage = (await charlieMsgIrcPromise)[2];
+        expect(charlieIrcMessage).not.toContain(aliceMsgBody);
+    });
+});

spec/integ/matrix-to-irc.spec.js

@@ -244,7 +244,7 @@ describe("Matrix-to-IRC message bridging", function() {
             room_id: roomMapping.roomId,
             sender: repliesUser.id,
             event_id: "$original:bar.com",
-            origin_server_ts: 1_000,
+            origin_server_ts: Date.now(),
             type: "m.room.message"
         });
         const p = env.ircMock._whenClient(roomMapping.server, testUser.nick, "say",
@@ -274,7 +274,7 @@ describe("Matrix-to-IRC message bridging", function() {
             },
             sender: testUser.id,
             room_id: roomMapping.roomId,
-            origin_server_ts: 2_000,
+            origin_server_ts: Date.now(),
             type: "m.room.message"
         });
         await p;
@@ -290,7 +290,7 @@ describe("Matrix-to-IRC message bridging", function() {
             room_id: roomMapping.roomId,
             sender: repliesUser.id,
             event_id: "$original:bar.com",
-            origin_server_ts: 1_000,
+            origin_server_ts: Date.now(),
             type: "m.room.message"
         });
         const p = env.ircMock._whenClient(roomMapping.server, testUser.nick, "say",
@@ -320,7 +320,7 @@ describe("Matrix-to-IRC message bridging", function() {
             },
             sender: testUser.id,
             room_id: roomMapping.roomId,
-            origin_server_ts: 1_000_000,
+            origin_server_ts: Date.now() + 1_000_000,
             type: "m.room.message"
         });
         await p;
@@ -381,7 +381,7 @@ describe("Matrix-to-IRC message bridging", function() {
             room_id: roomMapping.roomId,
             sender: repliesUser.id,
             event_id: "$original:bar.com",
-            origin_server_ts: 1_000,
+            origin_server_ts: Date.now(),
             type: "m.room.message"
         });
         const p = env.ircMock._whenClient(roomMapping.server, testUser.nick, "say",
@@ -411,7 +411,7 @@ describe("Matrix-to-IRC message bridging", function() {
             },
             sender: testUser.id,
             room_id: roomMapping.roomId,
-            origin_server_ts: 1_000_000,
+            origin_server_ts: Date.now() + 1_000_000,
             type: "m.room.message"
         });
         await p;
@@ -465,7 +465,7 @@ describe("Matrix-to-IRC message bridging", function() {
             room_id: roomMapping.roomId,
             sender: repliesUser.id,
             event_id: "$first:bar.com",
-            origin_server_ts: 1_000,
+            origin_server_ts: Date.now(),
             type: "m.room.message"
         })
 
@@ -484,7 +484,7 @@ describe("Matrix-to-IRC message bridging", function() {
             room_id: roomMapping.roomId,
             sender: repliesUser.id,
             event_id: "$second:bar.com",
-            origin_server_ts: 1_000_000,
+            origin_server_ts: Date.now() + 1_000_000,
             type: "m.room.message"
         });
 
@@ -517,7 +517,7 @@ describe("Matrix-to-IRC message bridging", function() {
             },
             sender: testUser.id,
             room_id: roomMapping.roomId,
-            origin_server_ts: 2_000_000,
+            origin_server_ts: Date.now() + 2_000_000,
             type: "m.room.message"
         });
 

spec/util/e2e-test.ts

@@ -11,6 +11,7 @@ import { expect } from "@jest/globals";
 import dns from 'node:dns';
 import fs from "node:fs/promises";
 import { WriteStream, createWriteStream } from "node:fs";
+import { DEFAULTS as MatrixHandlerDefaults } from "../../src/bridge/MatrixHandler";
 // Needed to make tests work on GitHub actions. Node 17+ defaults
 // to IPv6, and the homerunner domain resolves to IPv6, but the
 // runtime doesn't actually support IPv6 🤦
@@ -22,12 +23,14 @@ const DEFAULT_PORT = parseInt(process.env.IRC_TEST_PORT ?? '6667', 10);
 const DEFAULT_ADDRESS = process.env.IRC_TEST_ADDRESS ?? "127.0.0.1";
 const IRCBRIDGE_TEST_REDIS_URL = process.env.IRCBRIDGE_TEST_REDIS_URL;
 
+
 interface Opts {
     matrixLocalparts?: string[];
     ircNicks?: string[];
     timeout?: number;
     config?: Partial<BridgeConfig>,
     traceToFile?: boolean,
+    shortReplyTresholdSeconds?: number,
 }
 
 const traceFilePath = '.e2e-traces';
@@ -235,6 +238,10 @@ export class IrcBridgeE2ETest {
                 ircHandler: {
                     powerLevelGracePeriodMs: 0,
                 },
+                matrixHandler: {
+                    ...MatrixHandlerDefaults,
+                    shortReplyTresholdSeconds: opts.shortReplyTresholdSeconds ?? 0,
+                },
                 servers: {
                     localhost: {
                         ...IrcServer.DEFAULT_CONFIG,