Implement broadcast UTD handling (#10021)

test/events/EventTileFactory-test.ts

@@ -11,9 +11,15 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { EventType, MatrixClient, MatrixEvent, MsgType } from "matrix-js-sdk/src/matrix";
+import { mocked } from "jest-mock";
+import { EventType, MatrixClient, MatrixEvent, MsgType, RelationType, Room } from "matrix-js-sdk/src/matrix";
 
-import { JSONEventFactory, pickFactory } from "../../src/events/EventTileFactory";
+import {
+    JSONEventFactory,
+    MessageEventFactory,
+    pickFactory,
+    TextualEventFactory,
+} from "../../src/events/EventTileFactory";
 import { VoiceBroadcastChunkEventType, VoiceBroadcastInfoState } from "../../src/voice-broadcast";
 import { createTestClient, mkEvent } from "../test-utils";
 import { mkVoiceBroadcastInfoStateEvent } from "../voice-broadcast/utils/test-utils";
@@ -21,15 +27,32 @@ import { mkVoiceBroadcastInfoStateEvent } from "../voice-broadcast/utils/test-ut
 const roomId = "!room:example.com";
 
 describe("pickFactory", () => {
+    let voiceBroadcastStartedEvent: MatrixEvent;
     let voiceBroadcastStoppedEvent: MatrixEvent;
     let voiceBroadcastChunkEvent: MatrixEvent;
+    let utdEvent: MatrixEvent;
+    let utdBroadcastChunkEvent: MatrixEvent;
     let audioMessageEvent: MatrixEvent;
     let client: MatrixClient;
 
     beforeAll(() => {
         client = createTestClient();
+
+        const room = new Room(roomId, client, client.getSafeUserId());
+        mocked(client.getRoom).mockImplementation((getRoomId: string): Room | null => {
+            if (getRoomId === room.roomId) return room;
+            return null;
+        });
+
+        voiceBroadcastStartedEvent = mkVoiceBroadcastInfoStateEvent(
+            roomId,
+            VoiceBroadcastInfoState.Started,
+            client.getUserId()!,
+            client.deviceId!,
+        );
+        room.addLiveEvents([voiceBroadcastStartedEvent]);
         voiceBroadcastStoppedEvent = mkVoiceBroadcastInfoStateEvent(
-            "!room:example.com",
+            roomId,
             VoiceBroadcastInfoState.Stopped,
             client.getUserId()!,
             client.deviceId!,
@@ -53,6 +76,29 @@ describe("pickFactory", () => {
                 msgtype: MsgType.Audio,
             },
         });
+        utdEvent = mkEvent({
+            event: true,
+            type: EventType.RoomMessage,
+            user: client.getUserId()!,
+            room: roomId,
+            content: {
+                msgtype: "m.bad.encrypted",
+            },
+        });
+        utdBroadcastChunkEvent = mkEvent({
+            event: true,
+            type: EventType.RoomMessage,
+            user: client.getUserId()!,
+            room: roomId,
+            content: {
+                "msgtype": "m.bad.encrypted",
+                "m.relates_to": {
+                    rel_type: RelationType.Reference,
+                    event_id: voiceBroadcastStartedEvent.getId(),
+                },
+            },
+        });
+        jest.spyOn(utdBroadcastChunkEvent, "isDecryptionFailure").mockReturnValue(true);
     });
 
     it("should return JSONEventFactory for a no-op m.room.power_levels event", () => {
@@ -67,16 +113,20 @@ describe("pickFactory", () => {
     });
 
     describe("when showing hidden events", () => {
-        it("should return a function for a voice broadcast event", () => {
-            expect(pickFactory(voiceBroadcastChunkEvent, client, true)).toBeInstanceOf(Function);
+        it("should return a JSONEventFactory for a voice broadcast event", () => {
+            expect(pickFactory(voiceBroadcastChunkEvent, client, true)).toBe(JSONEventFactory);
         });
 
-        it("should return a Function for a voice broadcast stopped event", () => {
-            expect(pickFactory(voiceBroadcastStoppedEvent, client, true)).toBeInstanceOf(Function);
+        it("should return a TextualEventFactory for a voice broadcast stopped event", () => {
+            expect(pickFactory(voiceBroadcastStoppedEvent, client, true)).toBe(TextualEventFactory);
         });
 
-        it("should return a function for an audio message event", () => {
-            expect(pickFactory(audioMessageEvent, client, true)).toBeInstanceOf(Function);
+        it("should return a MessageEventFactory for an audio message event", () => {
+            expect(pickFactory(audioMessageEvent, client, true)).toBe(MessageEventFactory);
+        });
+
+        it("should return a MessageEventFactory for a UTD broadcast chunk event", () => {
+            expect(pickFactory(utdBroadcastChunkEvent, client, true)).toBe(MessageEventFactory);
         });
     });
 
@@ -85,12 +135,20 @@ describe("pickFactory", () => {
             expect(pickFactory(voiceBroadcastChunkEvent, client, false)).toBeUndefined();
         });
 
-        it("should return a Function for a voice broadcast stopped event", () => {
-            expect(pickFactory(voiceBroadcastStoppedEvent, client, true)).toBeInstanceOf(Function);
+        it("should return a TextualEventFactory for a voice broadcast stopped event", () => {
+            expect(pickFactory(voiceBroadcastStoppedEvent, client, false)).toBe(TextualEventFactory);
         });
 
-        it("should return a function for an audio message event", () => {
-            expect(pickFactory(audioMessageEvent, client, false)).toBeInstanceOf(Function);
+        it("should return a MessageEventFactory for an audio message event", () => {
+            expect(pickFactory(audioMessageEvent, client, false)).toBe(MessageEventFactory);
+        });
+
+        it("should return a MessageEventFactory for a UTD event", () => {
+            expect(pickFactory(utdEvent, client, false)).toBe(MessageEventFactory);
+        });
+
+        it("should return undefined for a UTD broadcast chunk event", () => {
+            expect(pickFactory(utdBroadcastChunkEvent, client, false)).toBeUndefined();
         });
     });
 });

test/voice-broadcast/models/VoiceBroadcastPlayback-test.tsx

@@ -17,7 +17,7 @@ limitations under the License.
 import { mocked } from "jest-mock";
 import { screen } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
-import { MatrixClient, MatrixEvent, Room } from "matrix-js-sdk/src/matrix";
+import { MatrixClient, MatrixEvent, MatrixEventEvent, Room } from "matrix-js-sdk/src/matrix";
 
 import { Playback, PlaybackState } from "../../../src/audio/Playback";
 import { PlaybackManager } from "../../../src/audio/PlaybackManager";
@@ -268,6 +268,32 @@ describe("VoiceBroadcastPlayback", () => {
                     expect(chunk1Playback.play).toHaveBeenCalled();
                 });
             });
+
+            describe("and receiving the first undecryptable chunk", () => {
+                beforeEach(() => {
+                    jest.spyOn(chunk1Event, "isDecryptionFailure").mockReturnValue(true);
+                    room.relations.aggregateChildEvent(chunk1Event);
+                });
+
+                itShouldSetTheStateTo(VoiceBroadcastPlaybackState.Error);
+
+                it("should not update the duration", () => {
+                    expect(playback.durationSeconds).toBe(0);
+                });
+
+                describe("and the chunk is decrypted", () => {
+                    beforeEach(() => {
+                        mocked(chunk1Event.isDecryptionFailure).mockReturnValue(false);
+                        chunk1Event.emit(MatrixEventEvent.Decrypted, chunk1Event);
+                    });
+
+                    itShouldSetTheStateTo(VoiceBroadcastPlaybackState.Paused);
+
+                    it("should not update the duration", () => {
+                        expect(playback.durationSeconds).toBe(2.3);
+                    });
+                });
+            });
         });
     });
 

test/voice-broadcast/utils/isRelatedToVoiceBroadcast-test.ts

@@ -0,0 +1,118 @@
+/*
+Copyright 2023 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 { EventType, MatrixEvent, RelationType, Room } from "matrix-js-sdk/src/matrix";
+import { MatrixClient } from "matrix-js-sdk/src/client";
+import { mocked } from "jest-mock";
+
+import { isRelatedToVoiceBroadcast, VoiceBroadcastInfoState } from "../../../src/voice-broadcast";
+import { mkEvent, stubClient } from "../../test-utils";
+import { mkVoiceBroadcastInfoStateEvent } from "./test-utils";
+
+const mkRelatedEvent = (
+    room: Room,
+    relationType: RelationType,
+    relatesTo: MatrixEvent | undefined,
+    client: MatrixClient,
+): MatrixEvent => {
+    const event = mkEvent({
+        event: true,
+        type: EventType.RoomMessage,
+        room: room.roomId,
+        content: {
+            "m.relates_to": {
+                rel_type: relationType,
+                event_id: relatesTo?.getId(),
+            },
+        },
+        user: client.getSafeUserId(),
+    });
+    room.addLiveEvents([event]);
+    return event;
+};
+
+describe("isRelatedToVoiceBroadcast", () => {
+    const roomId = "!room:example.com";
+    let client: MatrixClient;
+    let room: Room;
+    let broadcastEvent: MatrixEvent;
+    let nonBroadcastEvent: MatrixEvent;
+
+    beforeAll(() => {
+        client = stubClient();
+        room = new Room(roomId, client, client.getSafeUserId());
+
+        mocked(client.getRoom).mockImplementation((getRoomId: string): Room | null => {
+            if (getRoomId === roomId) return room;
+            return null;
+        });
+
+        broadcastEvent = mkVoiceBroadcastInfoStateEvent(
+            roomId,
+            VoiceBroadcastInfoState.Started,
+            client.getSafeUserId(),
+            "ABC123",
+        );
+        nonBroadcastEvent = mkEvent({
+            event: true,
+            type: EventType.RoomMessage,
+            room: roomId,
+            content: {},
+            user: client.getSafeUserId(),
+        });
+
+        room.addLiveEvents([broadcastEvent, nonBroadcastEvent]);
+    });
+
+    it("should return true if related (reference) to a broadcast event", () => {
+        expect(
+            isRelatedToVoiceBroadcast(mkRelatedEvent(room, RelationType.Reference, broadcastEvent, client), client),
+        ).toBe(true);
+    });
+
+    it("should return false if related (reference) is undefeind", () => {
+        expect(isRelatedToVoiceBroadcast(mkRelatedEvent(room, RelationType.Reference, undefined, client), client)).toBe(
+            false,
+        );
+    });
+
+    it("should return false if related (referenireplace) to a broadcast event", () => {
+        expect(
+            isRelatedToVoiceBroadcast(mkRelatedEvent(room, RelationType.Replace, broadcastEvent, client), client),
+        ).toBe(false);
+    });
+
+    it("should return false if the event has no relation", () => {
+        const noRelationEvent = mkEvent({
+            event: true,
+            type: EventType.RoomMessage,
+            room: room.roomId,
+            content: {},
+            user: client.getSafeUserId(),
+        });
+        expect(isRelatedToVoiceBroadcast(noRelationEvent, client)).toBe(false);
+    });
+
+    it("should return false for an unknown room", () => {
+        const otherRoom = new Room("!other:example.com", client, client.getSafeUserId());
+        expect(
+            isRelatedToVoiceBroadcast(
+                mkRelatedEvent(otherRoom, RelationType.Reference, broadcastEvent, client),
+                client,
+            ),
+        ).toBe(false);
+    });
+});