From 590ef74cc92271961b34d1c2314049cdf7aae467 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ond=C5=99ej=20Ho=C5=A1ek?= <ondra.hosek@gmail.com>
Date: Sat, 19 Oct 2024 22:17:45 +0200
Subject: [PATCH] Allow hiding invite and kick messages from timeline

---
 src/components/structures/RoomView.tsx        |  6 ++++
 .../tabs/user/PreferencesUserSettingsTab.tsx  |  1 +
 src/contexts/RoomContext.ts                   |  1 +
 src/i18n/strings/en_EN.json                   |  1 +
 src/settings/Settings.tsx                     |  6 ++++
 src/shouldHideEvent.ts                        |  6 ++++
 test/test-utils/room.ts                       |  1 +
 .../structures/MessagePanel-test.tsx          | 29 +++++++++++++++++++
 .../views/rooms/SendMessageComposer-test.tsx  |  1 +
 9 files changed, 52 insertions(+)

diff --git a/src/components/structures/RoomView.tsx b/src/components/structures/RoomView.tsx
index 486a7fb652..404b8fa67e 100644
--- a/src/components/structures/RoomView.tsx
+++ b/src/components/structures/RoomView.tsx
@@ -217,6 +217,7 @@ export interface IRoomState {
     showReadReceipts: boolean;
     showRedactions: boolean;
     showJoinLeaves: boolean;
+    showInviteKicks: boolean;
     showAvatarChanges: boolean;
     showDisplaynameChanges: boolean;
     matrixClientIsReady: boolean;
@@ -406,6 +407,7 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
             showReadReceipts: true,
             showRedactions: true,
             showJoinLeaves: true,
+            showInviteKicks: true,
             showAvatarChanges: true,
             showDisplaynameChanges: true,
             matrixClientIsReady: context.client?.isInitialSyncComplete(),
@@ -608,6 +610,7 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
             showReadReceipts: SettingsStore.getValue("showReadReceipts", roomId),
             showRedactions: SettingsStore.getValue("showRedactions", roomId),
             showJoinLeaves: SettingsStore.getValue("showJoinLeaves", roomId),
+            showInviteKicks: SettingsStore.getValue("showInviteKicks", roomId),
             showAvatarChanges: SettingsStore.getValue("showAvatarChanges", roomId),
             showDisplaynameChanges: SettingsStore.getValue("showDisplaynameChanges", roomId),
             wasContextSwitch: this.context.roomViewStore.getWasContextSwitch(),
@@ -679,6 +682,9 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
             SettingsStore.watchSetting("showJoinLeaves", roomId, (...[, , , value]) =>
                 this.setState({ showJoinLeaves: value as boolean }),
             ),
+            SettingsStore.watchSetting("showInviteKicks", roomId, (...[, , , value]) =>
+                this.setState({ showInviteKicks: value as boolean }),
+            ),
             SettingsStore.watchSetting("showAvatarChanges", roomId, (...[, , , value]) =>
                 this.setState({ showAvatarChanges: value as boolean }),
             ),
diff --git a/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx b/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx
index d95b0894d9..bdc5dc7067 100644
--- a/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx
+++ b/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx
@@ -150,6 +150,7 @@ export default class PreferencesUserSettingsTab extends React.Component<IProps,
         "showRedactions",
         "showReadReceipts",
         "showJoinLeaves",
+        "showInviteKicks",
         "showDisplaynameChanges",
         "showChatEffects",
         "showAvatarChanges",
diff --git a/src/contexts/RoomContext.ts b/src/contexts/RoomContext.ts
index acd4bfa6f4..6434c21304 100644
--- a/src/contexts/RoomContext.ts
+++ b/src/contexts/RoomContext.ts
@@ -61,6 +61,7 @@ const RoomContext = createContext<
     showReadReceipts: true,
     showRedactions: true,
     showJoinLeaves: true,
+    showInviteKicks: true,
     showAvatarChanges: true,
     showDisplaynameChanges: true,
     matrixClientIsReady: false,
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
index 7ba141c784..1cbcee1755 100644
--- a/src/i18n/strings/en_EN.json
+++ b/src/i18n/strings/en_EN.json
@@ -2900,6 +2900,7 @@
         "show_breadcrumbs": "Show shortcuts to recently viewed rooms above the room list",
         "show_chat_effects": "Show chat effects (animations when receiving e.g. confetti)",
         "show_displayname_changes": "Show display name changes",
+        "show_invite_kick": "Show invite/remove messages",
         "show_join_leave": "Show join/leave messages (invites/removes/bans unaffected)",
         "show_nsfw_content": "Show NSFW content",
         "show_read_receipts": "Show read receipts sent by other users",
diff --git a/src/settings/Settings.tsx b/src/settings/Settings.tsx
index 1c27f03e88..ccc1a97022 100644
--- a/src/settings/Settings.tsx
+++ b/src/settings/Settings.tsx
@@ -599,6 +599,12 @@ export const SETTINGS: { [setting: string]: ISetting } = {
         default: true,
         invertedSettingName: "hideJoinLeaves",
     },
+    "showInviteKicks": {
+        supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
+        displayName: _td("settings|show_invite_kick"),
+        default: true,
+        invertedSettingName: "hideInviteKicks",
+    },
     "showAvatarChanges": {
         supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
         displayName: _td("settings|show_avatar_changes"),
diff --git a/src/shouldHideEvent.ts b/src/shouldHideEvent.ts
index 7948bfb9f9..527c49884b 100644
--- a/src/shouldHideEvent.ts
+++ b/src/shouldHideEvent.ts
@@ -18,6 +18,8 @@ interface IDiff {
     isPart?: boolean;
     isDisplaynameChange?: boolean;
     isAvatarChange?: boolean;
+    isInvite?: boolean;
+    isKick?: boolean;
 }
 
 function memberEventDiff(ev: MatrixEvent): IDiff {
@@ -35,6 +37,9 @@ function memberEventDiff(ev: MatrixEvent): IDiff {
     diff.isJoin = isMembershipChanged && content.membership === KnownMembership.Join;
     diff.isPart =
         isMembershipChanged && content.membership === KnownMembership.Leave && ev.getStateKey() === ev.getSender();
+    diff.isInvite = isMembershipChanged && content.membership === KnownMembership.Invite;
+    diff.isKick =
+        isMembershipChanged && content.membership === KnownMembership.Leave && ev.getStateKey() !== ev.getSender();
 
     const isJoinToJoin = !isMembershipChanged && content.membership === KnownMembership.Join;
     diff.isDisplaynameChange = isJoinToJoin && content.displayname !== prevContent.displayname;
@@ -67,6 +72,7 @@ export default function shouldHideEvent(ev: MatrixEvent, ctx?: IRoomState): bool
 
     if (eventDiff.isMemberEvent) {
         if ((eventDiff.isJoin || eventDiff.isPart) && !isEnabled("showJoinLeaves")) return true;
+        if ((eventDiff.isInvite || eventDiff.isKick) && !isEnabled("showInviteKicks")) return true;
         if (eventDiff.isAvatarChange && !isEnabled("showAvatarChanges")) return true;
         if (eventDiff.isDisplaynameChange && !isEnabled("showDisplaynameChanges")) return true;
     }
diff --git a/test/test-utils/room.ts b/test/test-utils/room.ts
index d618932726..f2df7e3cca 100644
--- a/test/test-utils/room.ts
+++ b/test/test-utils/room.ts
@@ -71,6 +71,7 @@ export function getRoomContext(room: Room, override: Partial<IRoomState>): IRoom
         showReadReceipts: true,
         showRedactions: true,
         showJoinLeaves: true,
+        showInviteKicks: true,
         showAvatarChanges: true,
         showDisplaynameChanges: true,
         matrixClientIsReady: false,
diff --git a/test/unit-tests/components/structures/MessagePanel-test.tsx b/test/unit-tests/components/structures/MessagePanel-test.tsx
index 037a57bb06..6604ad7510 100644
--- a/test/unit-tests/components/structures/MessagePanel-test.tsx
+++ b/test/unit-tests/components/structures/MessagePanel-test.tsx
@@ -82,6 +82,7 @@ describe("MessagePanel", function () {
         showReadReceipts: true,
         showRedactions: false,
         showJoinLeaves: false,
+        showInviteKicks: true,
         showAvatarChanges: false,
         showDisplaynameChanges: true,
         showHiddenEvents: false,
@@ -463,6 +464,34 @@ describe("MessagePanel", function () {
         expect(summaryEventTiles.length).toEqual(tiles.length - 3);
     });
 
+    it("shows invite events if the user wishes to see them", function () {
+        const events = mkCreationEvents();
+        const inviteEvent = events.find(
+            (event) =>
+                event.getType() === "m.room.member"
+                && event.getContent()?.membership === "invite"
+        )!;
+        const { container } = render(getComponent({ events }, { showInviteKicks: true }));
+
+        // there must be an invite event
+        const inviteEventTiles = container.querySelectorAll(`.mx_EventTile[data-event-id=\"${inviteEvent.getId()}\"]`);
+        expect(inviteEventTiles.length).toBeGreaterThan(0);
+    });
+
+    it("hides invite events if the user does not wish to see them", function () {
+        const events = mkCreationEvents();
+        const inviteEvent = events.find(
+            (event) =>
+                event.getType() === "m.room.member"
+                && event.getContent()?.membership === "invite"
+        )!;
+        const { container } = render(getComponent({ events }, { showInviteKicks: false }));
+
+        // our invite event must not exist
+        const inviteEventTiles = container.querySelectorAll(`.mx_EventTile[data-event-id=\"${inviteEvent.getId()}\"]`);
+        expect(inviteEventTiles.length).toBe(0);
+    });
+
     it("should not collapse beacons as part of creation events", function () {
         const events = mkCreationEvents();
         const creationEvent = events.find((event) => event.getType() === "m.room.create")!;
diff --git a/test/unit-tests/components/views/rooms/SendMessageComposer-test.tsx b/test/unit-tests/components/views/rooms/SendMessageComposer-test.tsx
index a41c221616..c625d1f671 100644
--- a/test/unit-tests/components/views/rooms/SendMessageComposer-test.tsx
+++ b/test/unit-tests/components/views/rooms/SendMessageComposer-test.tsx
@@ -64,6 +64,7 @@ describe("<SendMessageComposer/>", () => {
         showReadReceipts: true,
         showRedactions: true,
         showJoinLeaves: true,
+        showInviteKicks: true,
         showAvatarChanges: true,
         showDisplaynameChanges: true,
         matrixClientIsReady: false,