From 7a1c47a23eb9ad643a057a37b41a61c70fadae79 Mon Sep 17 00:00:00 2001 From: Michael Weimann Date: Thu, 13 Oct 2022 14:02:53 +0200 Subject: [PATCH] Extract useVoiceBroadcastRecording hook (#9406) * Extract useVoiceBroadcastRecording hook * Trigger CI --- .../components/VoiceBroadcastBody.tsx | 26 +--- .../molecules/VoiceBroadcastRecordingBody.tsx | 29 ++-- .../hooks/useVoiceBroadcastRecording.ts | 51 +++++++ src/voice-broadcast/index.ts | 1 + .../stores/VoiceBroadcastRecordingsStore.ts | 7 + .../components/VoiceBroadcastBody-test.tsx | 125 ++++-------------- .../VoiceBroadcastRecordingBody-test.tsx | 70 +++++----- .../VoiceBroadcastRecordingBody-test.tsx.snap | 54 +++++++- .../VoiceBroadcastRecordingsStore-test.ts | 14 ++ 9 files changed, 192 insertions(+), 185 deletions(-) create mode 100644 src/voice-broadcast/hooks/useVoiceBroadcastRecording.ts diff --git a/src/voice-broadcast/components/VoiceBroadcastBody.tsx b/src/voice-broadcast/components/VoiceBroadcastBody.tsx index e36460b9f3..3be79ca882 100644 --- a/src/voice-broadcast/components/VoiceBroadcastBody.tsx +++ b/src/voice-broadcast/components/VoiceBroadcastBody.tsx @@ -14,42 +14,20 @@ See the License for the specific language governing permissions and limitations under the License. */ -import React, { useState } from "react"; +import React from "react"; import { - VoiceBroadcastInfoState, VoiceBroadcastRecordingBody, VoiceBroadcastRecordingsStore, - VoiceBroadcastRecording, - VoiceBroadcastRecordingEvent, } from ".."; import { IBodyProps } from "../../components/views/messages/IBodyProps"; import { MatrixClientPeg } from "../../MatrixClientPeg"; -import { useTypedEventEmitter } from "../../hooks/useEventEmitter"; export const VoiceBroadcastBody: React.FC = ({ mxEvent }) => { const client = MatrixClientPeg.get(); - const room = client.getRoom(mxEvent.getRoomId()); const recording = VoiceBroadcastRecordingsStore.instance().getByInfoEvent(mxEvent, client); - const [recordingState, setRecordingState] = useState(recording.getState()); - - useTypedEventEmitter( - recording, - VoiceBroadcastRecordingEvent.StateChanged, - (state: VoiceBroadcastInfoState, _recording: VoiceBroadcastRecording) => { - setRecordingState(state); - }, - ); - - const stopVoiceBroadcast = () => { - if (recordingState !== VoiceBroadcastInfoState.Started) return; - recording.stop(); - }; return ; }; diff --git a/src/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody.tsx b/src/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody.tsx index 0db9bb92e1..45ee289103 100644 --- a/src/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody.tsx +++ b/src/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody.tsx @@ -1,12 +1,9 @@ /* 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. @@ -14,28 +11,26 @@ See the License for the specific language governing permissions and limitations under the License. */ -import React, { MouseEventHandler } from "react"; -import { RoomMember } from "matrix-js-sdk/src/matrix"; +import React from "react"; -import { VoiceBroadcastHeader } from "../.."; +import { useVoiceBroadcastRecording, VoiceBroadcastHeader, VoiceBroadcastRecording } from "../.."; interface VoiceBroadcastRecordingBodyProps { - live: boolean; - onClick: MouseEventHandler; - roomName: string; - sender: RoomMember; + recording: VoiceBroadcastRecording; } -export const VoiceBroadcastRecordingBody: React.FC = ({ - live, - onClick, - roomName, - sender, -}) => { +export const VoiceBroadcastRecordingBody: React.FC = ({ recording }) => { + const { + live, + roomName, + sender, + stopRecording, + } = useVoiceBroadcastRecording(recording); + return (
{ + const client = MatrixClientPeg.get(); + const room = client.getRoom(recording.infoEvent.getRoomId()); + const stopRecording = () => { + recording.stop(); + VoiceBroadcastRecordingsStore.instance().clearCurrent(); + }; + + const [live, setLive] = useState(recording.getState() === VoiceBroadcastInfoState.Started); + useTypedEventEmitter( + recording, + VoiceBroadcastRecordingEvent.StateChanged, + (state: VoiceBroadcastInfoState, _recording: VoiceBroadcastRecording) => { + setLive(state === VoiceBroadcastInfoState.Started); + }, + ); + + return { + live, + roomName: room.name, + sender: recording.infoEvent.sender, + stopRecording, + }; +}; diff --git a/src/voice-broadcast/index.ts b/src/voice-broadcast/index.ts index 73f428fd34..12027c9b42 100644 --- a/src/voice-broadcast/index.ts +++ b/src/voice-broadcast/index.ts @@ -30,6 +30,7 @@ export * from "./models/VoiceBroadcastRecording"; export * from "./stores/VoiceBroadcastRecordingsStore"; export * from "./utils/shouldDisplayAsVoiceBroadcastTile"; export * from "./utils/startNewVoiceBroadcastRecording"; +export * from "./hooks/useVoiceBroadcastRecording"; export const VoiceBroadcastInfoEventType = "io.element.voice_broadcast_info"; export const VoiceBroadcastChunkEventType = "io.element.voice_broadcast_chunk"; diff --git a/src/voice-broadcast/stores/VoiceBroadcastRecordingsStore.ts b/src/voice-broadcast/stores/VoiceBroadcastRecordingsStore.ts index 380fd1d318..cc12b474e8 100644 --- a/src/voice-broadcast/stores/VoiceBroadcastRecordingsStore.ts +++ b/src/voice-broadcast/stores/VoiceBroadcastRecordingsStore.ts @@ -50,6 +50,13 @@ export class VoiceBroadcastRecordingsStore extends TypedEventEmitter ({ VoiceBroadcastRecordingBody: jest.fn(), @@ -38,12 +35,9 @@ jest.mock("../../../src/voice-broadcast/components/molecules/VoiceBroadcastRecor describe("VoiceBroadcastBody", () => { const roomId = "!room:example.com"; - const recordingTestid = "voice-recording"; let client: MatrixClient; - let room: Room; let infoEvent: MatrixEvent; - let recording: VoiceBroadcastRecording; - let onRecordingStateChanged: (state: VoiceBroadcastInfoState) => void; + let testRecording: VoiceBroadcastRecording; const mkVoiceBroadcastInfoEvent = (state: VoiceBroadcastInfoState) => { return mkEvent({ @@ -58,104 +52,39 @@ describe("VoiceBroadcastBody", () => { }; const renderVoiceBroadcast = () => { - const props: IBodyProps = { - mxEvent: infoEvent, - } as unknown as IBodyProps; - render(); - recording = VoiceBroadcastRecordingsStore.instance().getByInfoEvent(infoEvent, client); - recording.on(VoiceBroadcastRecordingEvent.StateChanged, onRecordingStateChanged); - }; - - const itShouldRenderALiveVoiceBroadcast = () => { - it("should render a live voice broadcast", () => { - expect(VoiceBroadcastRecordingBody).toHaveBeenCalledWith( - { - onClick: expect.any(Function), - live: true, - sender: infoEvent.sender, - roomName: room.name, - }, - {}, - ); - screen.getByTestId(recordingTestid); - screen.getByText("Live"); - }); - }; - - const itShouldRenderANonLiveVoiceBroadcast = () => { - it("should render a non-live voice broadcast", () => { - expect(VoiceBroadcastRecordingBody).toHaveBeenCalledWith( - { - onClick: expect.any(Function), - live: false, - sender: infoEvent.sender, - roomName: room.name, - }, - {}, - ); - expect(screen.getByTestId(recordingTestid)).not.toBeNull(); - screen.getByTestId(recordingTestid); - expect(screen.queryByText("live")).toBeNull(); - }); + render( {}} + onMessageAllowed={() => {}} + permalinkCreator={null} + />); + testRecording = VoiceBroadcastRecordingsStore.instance().getByInfoEvent(infoEvent, client); }; beforeEach(() => { - mocked(VoiceBroadcastRecordingBody).mockImplementation( - ({ - live, - sender, - onClick, - roomName, - }) => { - return ( -
-
{ sender.name }
-
{ roomName }
-
{ live && "Live" }
-
- ); - }, - ); client = stubClient(); - room = mkStubRoom(roomId, "test room", client); - mocked(client.getRoom).mockImplementation((getRoomId: string) => { - if (getRoomId === roomId) { - return room; + infoEvent = mkVoiceBroadcastInfoEvent(VoiceBroadcastInfoState.Started); + testRecording = new VoiceBroadcastRecording(infoEvent, client); + mocked(VoiceBroadcastRecordingBody).mockImplementation(({ recording }) => { + if (testRecording === recording) { + return
; } }); - infoEvent = mkVoiceBroadcastInfoEvent(VoiceBroadcastInfoState.Started); - onRecordingStateChanged = jest.fn(); + + jest.spyOn(VoiceBroadcastRecordingsStore.instance(), "getByInfoEvent").mockImplementation( + (getEvent: MatrixEvent, getClient: MatrixClient) => { + if (getEvent === infoEvent && getClient === client) { + return testRecording; + } + }, + ); }); - afterEach(() => { - if (recording && onRecordingStateChanged) { - recording.off(VoiceBroadcastRecordingEvent.StateChanged, onRecordingStateChanged); - } - }); - - describe("when there is a Started Voice Broadcast info event", () => { - beforeEach(() => { + describe("when rendering a voice broadcast", () => { + it("should render a voice broadcast recording body", () => { renderVoiceBroadcast(); - }); - - itShouldRenderALiveVoiceBroadcast(); - - describe("and it is clicked", () => { - beforeEach(async () => { - mocked(VoiceBroadcastRecordingBody).mockClear(); - mocked(onRecordingStateChanged).mockClear(); - await userEvent.click(screen.getByTestId(recordingTestid)); - }); - - itShouldRenderANonLiveVoiceBroadcast(); - - it("should call stop on the recording", () => { - expect(recording.getState()).toBe(VoiceBroadcastInfoState.Stopped); - expect(onRecordingStateChanged).toHaveBeenCalledWith(VoiceBroadcastInfoState.Stopped); - }); + screen.getByTestId("voice-broadcast-recording-body"); }); }); }); diff --git a/test/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody-test.tsx b/test/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody-test.tsx index d9cb83642b..85c67f03e2 100644 --- a/test/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody-test.tsx +++ b/test/voice-broadcast/components/molecules/VoiceBroadcastRecordingBody-test.tsx @@ -14,45 +14,43 @@ See the License for the specific language governing permissions and limitations under the License. */ -import React, { MouseEventHandler } from "react"; +import React from "react"; import { render, RenderResult } from "@testing-library/react"; import userEvent from "@testing-library/user-event"; -import { RoomMember } from "matrix-js-sdk/src/matrix"; +import { MatrixClient, MatrixEvent } from "matrix-js-sdk/src/matrix"; -import { VoiceBroadcastHeader, VoiceBroadcastRecordingBody } from "../../../../src/voice-broadcast"; - -jest.mock("../../../../src/voice-broadcast/components/atoms/VoiceBroadcastHeader", () => ({ - VoiceBroadcastHeader: ({ live, sender, roomName }: React.ComponentProps) => { - return
- live: { live }, - sender: { sender.userId }, - room name: { roomName } -
; - }, -})); +import { + VoiceBroadcastInfoEventType, + VoiceBroadcastInfoState, + VoiceBroadcastRecording, + VoiceBroadcastRecordingBody, +} from "../../../../src/voice-broadcast"; +import { mkEvent, stubClient } from "../../../test-utils"; describe("VoiceBroadcastRecordingBody", () => { - const testRoomName = "test room name"; const userId = "@user:example.com"; - const roomMember = new RoomMember("!room:example.com", userId); - let onClick: MouseEventHandler; + const roomId = "!room:example.com"; + let client: MatrixClient; + let infoEvent: MatrixEvent; + let recording: VoiceBroadcastRecording; - beforeEach(() => { - onClick = jest.fn(); + beforeAll(() => { + client = stubClient(); + infoEvent = mkEvent({ + event: true, + type: VoiceBroadcastInfoEventType, + content: {}, + room: roomId, + user: userId, + }); + recording = new VoiceBroadcastRecording(infoEvent, client); }); - describe("when rendered", () => { + describe("when rendering a live broadcast", () => { let renderResult: RenderResult; beforeEach(() => { - renderResult = render( - , - ); + renderResult = render(); }); it("should render the expected HTML", () => { @@ -61,27 +59,21 @@ describe("VoiceBroadcastRecordingBody", () => { describe("and clicked", () => { beforeEach(async () => { - await userEvent.click(renderResult.getByTestId("voice-broadcast-header")); + await userEvent.click(renderResult.getByText("My room")); }); - it("should call the onClick prop", () => { - expect(onClick).toHaveBeenCalled(); + it("should stop the recording", () => { + expect(recording.getState()).toBe(VoiceBroadcastInfoState.Stopped); }); }); }); - describe("when non-live rendered", () => { + describe("when rendering a non-live broadcast", () => { let renderResult: RenderResult; beforeEach(() => { - renderResult = render( - , - ); + recording.stop(); + renderResult = render(); }); it("should not render the live badge", () => { diff --git a/test/voice-broadcast/components/molecules/__snapshots__/VoiceBroadcastRecordingBody-test.tsx.snap b/test/voice-broadcast/components/molecules/__snapshots__/VoiceBroadcastRecordingBody-test.tsx.snap index a642e8dffc..b0df97b625 100644 --- a/test/voice-broadcast/components/molecules/__snapshots__/VoiceBroadcastRecordingBody-test.tsx.snap +++ b/test/voice-broadcast/components/molecules/__snapshots__/VoiceBroadcastRecordingBody-test.tsx.snap @@ -1,18 +1,58 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`VoiceBroadcastRecordingBody when rendered should render the expected HTML 1`] = ` +exports[`VoiceBroadcastRecordingBody when rendering a live broadcast should render the expected HTML 1`] = `
- live: - , sender: - @user:example.com - , room name: - test room name + + + + +
+
+ @user:example.com +
+
+ My room +
+
+
+