Add voice broadcast ended message (#9728)

test/events/EventTileFactory-test.ts

@@ -14,22 +14,30 @@ limitations under the License.
 import { EventType, MatrixClient, MatrixEvent, MsgType } from "matrix-js-sdk/src/matrix";
 
 import { JSONEventFactory, pickFactory } from "../../src/events/EventTileFactory";
-import { VoiceBroadcastChunkEventType } from "../../src/voice-broadcast";
+import { VoiceBroadcastChunkEventType, VoiceBroadcastInfoState } from "../../src/voice-broadcast";
 import { createTestClient, mkEvent } from "../test-utils";
+import { mkVoiceBroadcastInfoStateEvent } from "../voice-broadcast/utils/test-utils";
 
 const roomId = "!room:example.com";
 
 describe("pickFactory", () => {
+    let voiceBroadcastStoppedEvent: MatrixEvent;
     let voiceBroadcastChunkEvent: MatrixEvent;
     let audioMessageEvent: MatrixEvent;
     let client: MatrixClient;
 
     beforeAll(() => {
         client = createTestClient();
+        voiceBroadcastStoppedEvent = mkVoiceBroadcastInfoStateEvent(
+            "!room:example.com",
+            VoiceBroadcastInfoState.Stopped,
+            client.getUserId()!,
+            client.deviceId!,
+        );
         voiceBroadcastChunkEvent = mkEvent({
             event: true,
             type: EventType.RoomMessage,
-            user: client.getUserId(),
+            user: client.getUserId()!,
             room: roomId,
             content: {
                 msgtype: MsgType.Audio,
@@ -39,7 +47,7 @@ describe("pickFactory", () => {
         audioMessageEvent = mkEvent({
             event: true,
             type: EventType.RoomMessage,
-            user: client.getUserId(),
+            user: client.getUserId()!,
             room: roomId,
             content: {
                 msgtype: MsgType.Audio,
@@ -52,7 +60,7 @@ describe("pickFactory", () => {
             type: EventType.RoomPowerLevels,
             state_key: "",
             content: {},
-            sender: client.getUserId(),
+            sender: client.getUserId()!,
             room_id: roomId,
         });
         expect(pickFactory(event, client, true)).toBe(JSONEventFactory);
@@ -63,6 +71,10 @@ describe("pickFactory", () => {
             expect(pickFactory(voiceBroadcastChunkEvent, client, true)).toBeInstanceOf(Function);
         });
 
+        it("should return a Function for a voice broadcast stopped event", () => {
+            expect(pickFactory(voiceBroadcastStoppedEvent, client, true)).toBeInstanceOf(Function);
+        });
+
         it("should return a function for an audio message event", () => {
             expect(pickFactory(audioMessageEvent, client, true)).toBeInstanceOf(Function);
         });
@@ -73,6 +85,10 @@ 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 function for an audio message event", () => {
             expect(pickFactory(audioMessageEvent, client, false)).toBeInstanceOf(Function);
         });

test/utils/EventUtils-test.ts

@@ -35,11 +35,16 @@ import {
     canEditOwnEvent,
     fetchInitialEvent,
     findEditableEvent,
+    highlightEvent,
     isContentActionable,
     isLocationEvent,
     isVoiceMessage,
 } from "../../src/utils/EventUtils";
 import { getMockClientWithEventEmitter, makeBeaconInfoEvent, makePollStartEvent, stubClient } from "../test-utils";
+import dis from "../../src/dispatcher/dispatcher";
+import { Action } from "../../src/dispatcher/actions";
+
+jest.mock("../../src/dispatcher/dispatcher");
 
 describe('EventUtils', () => {
     const userId = '@user:server';
@@ -440,4 +445,19 @@ describe('EventUtils', () => {
             })).toBeUndefined();
         });
     });
+
+    describe("highlightEvent", () => {
+        const eventId = "$zLg9jResFQmMO_UKFeWpgLgOgyWrL8qIgLgZ5VywrCQ";
+
+        it("should dispatch an action to view the event", () => {
+            highlightEvent(roomId, eventId);
+            expect(dis.dispatch).toHaveBeenCalledWith({
+                action: Action.ViewRoom,
+                event_id: eventId,
+                highlighted: true,
+                room_id: roomId,
+                metricsTrigger: undefined,
+            });
+        });
+    });
 });

test/voice-broadcast/utils/__snapshots__/textForVoiceBroadcastStoppedEvent-test.tsx.snap

@@ -0,0 +1,42 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`textForVoiceBroadcastStoppedEvent should render other users broadcast as expected 1`] = `
+<div>
+  <div>
+    @other:example.com ended a voice broadcast
+  </div>
+</div>
+`;
+
+exports[`textForVoiceBroadcastStoppedEvent should render own broadcast as expected 1`] = `
+<div>
+  <div>
+    You ended a voice broadcast
+  </div>
+</div>
+`;
+
+exports[`textForVoiceBroadcastStoppedEvent should render without login as expected 1`] = `
+<div>
+  <div>
+    @other:example.com ended a voice broadcast
+  </div>
+</div>
+`;
+
+exports[`textForVoiceBroadcastStoppedEvent when rendering an event with relation to the start event should render events with relation to the start event 1`] = `
+<div>
+  <div>
+    <span>
+      You ended a 
+      <div
+        class="mx_AccessibleButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_link_inline"
+        role="button"
+        tabindex="0"
+      >
+        voice broadcast
+      </div>
+    </span>
+  </div>
+</div>
+`;

test/voice-broadcast/utils/textForVoiceBroadcastStoppedEvent-test.tsx

@@ -0,0 +1,98 @@
+/*
+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 React from "react";
+import { render, RenderResult, screen } from "@testing-library/react";
+import userEvent from '@testing-library/user-event';
+import { mocked } from "jest-mock";
+import { MatrixClient, RelationType } from "matrix-js-sdk/src/matrix";
+
+import { textForVoiceBroadcastStoppedEvent, VoiceBroadcastInfoState } from "../../../src/voice-broadcast";
+import { stubClient } from "../../test-utils";
+import { mkVoiceBroadcastInfoStateEvent } from "./test-utils";
+import dis from "../../../src/dispatcher/dispatcher";
+import { Action } from "../../../src/dispatcher/actions";
+
+jest.mock("../../../src/dispatcher/dispatcher");
+
+describe("textForVoiceBroadcastStoppedEvent", () => {
+    const otherUserId = "@other:example.com";
+    const roomId = "!room:example.com";
+    let client: MatrixClient;
+
+    const renderText = (senderId: string, startEventId?: string) => {
+        const event = mkVoiceBroadcastInfoStateEvent(
+            roomId,
+            VoiceBroadcastInfoState.Stopped,
+            senderId,
+            client.deviceId!,
+        );
+
+        if (startEventId) {
+            event.getContent()["m.relates_to"] = {
+                rel_type: RelationType.Reference,
+                event_id: startEventId,
+            };
+        }
+
+        return render(<div>{ textForVoiceBroadcastStoppedEvent(event)() }</div>);
+    };
+
+    beforeEach(() => {
+        client = stubClient();
+    });
+
+    it("should render own broadcast as expected", () => {
+        expect(renderText(client.getUserId()!).container).toMatchSnapshot();
+    });
+
+    it("should render other users broadcast as expected", () => {
+        expect(renderText(otherUserId).container).toMatchSnapshot();
+    });
+
+    it("should render without login as expected", () => {
+        mocked(client.getUserId).mockReturnValue(null);
+        expect(renderText(otherUserId).container).toMatchSnapshot();
+    });
+
+    describe("when rendering an event with relation to the start event", () => {
+        let result: RenderResult;
+
+        beforeEach(() => {
+            result = renderText(client.getUserId()!, "$start-id");
+        });
+
+        it("should render events with relation to the start event", () => {
+            expect(result.container).toMatchSnapshot();
+        });
+
+        describe("and clicking the link", () => {
+            beforeEach(async () => {
+                await userEvent.click(screen.getByRole("button"));
+            });
+
+            it("should dispatch an action to highlight the event", () => {
+                expect(dis.dispatch).toHaveBeenCalledWith({
+                    action: Action.ViewRoom,
+                    event_id: "$start-id",
+                    highlighted: true,
+                    room_id: roomId,
+                    metricsTrigger: undefined, // room doesn't change
+                });
+            });
+        });
+    });
+});