From 064a5ad422ce3da3bd3eb0da61e93b6fe117c00c Mon Sep 17 00:00:00 2001
From: Michael Weimann <michaelw@matrix.org>
Date: Thu, 29 Dec 2022 11:03:24 +0100
Subject: [PATCH] Show regular avatar for broadcasts (#9835)

---
 src/utils/EventRenderingUtils.ts       | 31 ++++++++++-----
 test/utils/EventRenderingUtils-test.ts | 53 ++++++++++++++++++++++++++
 2 files changed, 75 insertions(+), 9 deletions(-)
 create mode 100644 test/utils/EventRenderingUtils-test.ts

diff --git a/src/utils/EventRenderingUtils.ts b/src/utils/EventRenderingUtils.ts
index 047d75192f..49e6330783 100644
--- a/src/utils/EventRenderingUtils.ts
+++ b/src/utils/EventRenderingUtils.ts
@@ -18,12 +18,33 @@ import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType, MsgType } from "matrix-js-sdk/src/@types/event";
 import { M_POLL_START } from "matrix-events-sdk";
 import { M_BEACON_INFO } from "matrix-js-sdk/src/@types/beacon";
+import { IContent } from "matrix-js-sdk/src/matrix";
 
 import SettingsStore from "../settings/SettingsStore";
 import { haveRendererForEvent, JitsiEventFactory, JSONEventFactory, pickFactory } from "../events/EventTileFactory";
 import { MatrixClientPeg } from "../MatrixClientPeg";
 import { getMessageModerationState, isLocationEvent, MessageModerationState } from "./EventUtils";
 import { ElementCall } from "../models/Call";
+import { VoiceBroadcastInfoEventType, VoiceBroadcastInfoState } from "../voice-broadcast";
+
+const calcIsInfoMessage = (
+    eventType: EventType | string,
+    content: IContent,
+    isBubbleMessage: boolean,
+    isLeftAlignedBubbleMessage: boolean,
+): boolean => {
+    return (
+        !isBubbleMessage &&
+        !isLeftAlignedBubbleMessage &&
+        eventType !== EventType.RoomMessage &&
+        eventType !== EventType.RoomMessageEncrypted &&
+        eventType !== EventType.Sticker &&
+        eventType !== EventType.RoomCreate &&
+        !M_POLL_START.matches(eventType) &&
+        !M_BEACON_INFO.matches(eventType) &&
+        !(eventType === VoiceBroadcastInfoEventType && content?.state === VoiceBroadcastInfoState.Started)
+    );
+};
 
 export function getEventDisplayInfo(
     mxEvent: MatrixEvent,
@@ -67,15 +88,7 @@ export function getEventDisplayInfo(
         factory === JitsiEventFactory;
     const isLeftAlignedBubbleMessage =
         !isBubbleMessage && (eventType === EventType.CallInvite || ElementCall.CALL_EVENT_TYPE.matches(eventType));
-    let isInfoMessage =
-        !isBubbleMessage &&
-        !isLeftAlignedBubbleMessage &&
-        eventType !== EventType.RoomMessage &&
-        eventType !== EventType.RoomMessageEncrypted &&
-        eventType !== EventType.Sticker &&
-        eventType !== EventType.RoomCreate &&
-        !M_POLL_START.matches(eventType) &&
-        !M_BEACON_INFO.matches(eventType);
+    let isInfoMessage = calcIsInfoMessage(eventType, content, isBubbleMessage, isLeftAlignedBubbleMessage);
     // Some non-info messages want to be rendered in the appropriate bubble column but without the bubble background
     const noBubbleEvent =
         (eventType === EventType.RoomMessage && msgtype === MsgType.Emote) ||
diff --git a/test/utils/EventRenderingUtils-test.ts b/test/utils/EventRenderingUtils-test.ts
new file mode 100644
index 0000000000..2f07822489
--- /dev/null
+++ b/test/utils/EventRenderingUtils-test.ts
@@ -0,0 +1,53 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { getEventDisplayInfo } from "../../src/utils/EventRenderingUtils";
+import { VoiceBroadcastInfoState } from "../../src/voice-broadcast";
+import { mkVoiceBroadcastInfoStateEvent } from "../voice-broadcast/utils/test-utils";
+
+describe("getEventDisplayInfo", () => {
+    const mkBroadcastInfoEvent = (state: VoiceBroadcastInfoState) => {
+        return mkVoiceBroadcastInfoStateEvent("!room:example.com", state, "@user:example.com", "ASD123");
+    };
+
+    it("should return the expected value for a broadcast started event", () => {
+        expect(getEventDisplayInfo(mkBroadcastInfoEvent(VoiceBroadcastInfoState.Started), false))
+            .toMatchInlineSnapshot(`
+            {
+              "hasRenderer": true,
+              "isBubbleMessage": false,
+              "isInfoMessage": false,
+              "isLeftAlignedBubbleMessage": false,
+              "isSeeingThroughMessageHiddenForModeration": false,
+              "noBubbleEvent": false,
+            }
+        `);
+    });
+
+    it("should return the expected value for a broadcast stopped event", () => {
+        expect(getEventDisplayInfo(mkBroadcastInfoEvent(VoiceBroadcastInfoState.Stopped), false))
+            .toMatchInlineSnapshot(`
+            {
+              "hasRenderer": true,
+              "isBubbleMessage": false,
+              "isInfoMessage": true,
+              "isLeftAlignedBubbleMessage": false,
+              "isSeeingThroughMessageHiddenForModeration": false,
+              "noBubbleEvent": false,
+            }
+        `);
+    });
+});