Add voice broadcast pre-recoding PiP (#9548)
This commit is contained in:
Michael Weimann
GitHub
parent
afdf289a78
commit
abec724387
26 changed files with 977 additions and 111 deletions
|
|
@ -0,0 +1,77 @@
|
|||
/*
|
||||
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 { MatrixClient, Room, RoomMember } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import {
|
||||
startNewVoiceBroadcastRecording,
|
||||
VoiceBroadcastPreRecording,
|
||||
VoiceBroadcastRecordingsStore,
|
||||
} from "../../../src/voice-broadcast";
|
||||
import { stubClient } from "../../test-utils";
|
||||
|
||||
jest.mock("../../../src/voice-broadcast/utils/startNewVoiceBroadcastRecording");
|
||||
|
||||
describe("VoiceBroadcastPreRecording", () => {
|
||||
const roomId = "!room:example.com";
|
||||
let client: MatrixClient;
|
||||
let room: Room;
|
||||
let sender: RoomMember;
|
||||
let recordingsStore: VoiceBroadcastRecordingsStore;
|
||||
let preRecording: VoiceBroadcastPreRecording;
|
||||
let onDismiss: (voiceBroadcastPreRecording: VoiceBroadcastPreRecording) => void;
|
||||
|
||||
beforeAll(() => {
|
||||
client = stubClient();
|
||||
room = new Room(roomId, client, client.getUserId() || "");
|
||||
sender = new RoomMember(roomId, client.getUserId() || "");
|
||||
recordingsStore = new VoiceBroadcastRecordingsStore();
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
onDismiss = jest.fn();
|
||||
preRecording = new VoiceBroadcastPreRecording(room, sender, client, recordingsStore);
|
||||
preRecording.on("dismiss", onDismiss);
|
||||
});
|
||||
|
||||
describe("start", () => {
|
||||
beforeEach(() => {
|
||||
preRecording.start();
|
||||
});
|
||||
|
||||
it("should start a new voice broadcast recording", () => {
|
||||
expect(startNewVoiceBroadcastRecording).toHaveBeenCalledWith(
|
||||
room,
|
||||
client,
|
||||
recordingsStore,
|
||||
);
|
||||
});
|
||||
|
||||
it("should emit a dismiss event", () => {
|
||||
expect(onDismiss).toHaveBeenCalledWith(preRecording);
|
||||
});
|
||||
});
|
||||
|
||||
describe("cancel", () => {
|
||||
beforeEach(() => {
|
||||
preRecording.cancel();
|
||||
});
|
||||
|
||||
it("should emit a dismiss event", () => {
|
||||
expect(onDismiss).toHaveBeenCalledWith(preRecording);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
/*
|
||||
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 { mocked } from "jest-mock";
|
||||
import { MatrixClient, Room, RoomMember } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import {
|
||||
VoiceBroadcastPreRecording,
|
||||
VoiceBroadcastPreRecordingStore,
|
||||
VoiceBroadcastRecordingsStore,
|
||||
} from "../../../src/voice-broadcast";
|
||||
import { stubClient } from "../../test-utils";
|
||||
|
||||
jest.mock("../../../src/voice-broadcast/stores/VoiceBroadcastRecordingsStore");
|
||||
|
||||
describe("VoiceBroadcastPreRecordingStore", () => {
|
||||
const roomId = "!room:example.com";
|
||||
let client: MatrixClient;
|
||||
let room: Room;
|
||||
let sender: RoomMember;
|
||||
let recordingsStore: VoiceBroadcastRecordingsStore;
|
||||
let store: VoiceBroadcastPreRecordingStore;
|
||||
let preRecording1: VoiceBroadcastPreRecording;
|
||||
|
||||
beforeAll(() => {
|
||||
client = stubClient();
|
||||
room = new Room(roomId, client, client.getUserId() || "");
|
||||
sender = new RoomMember(roomId, client.getUserId() || "");
|
||||
recordingsStore = new VoiceBroadcastRecordingsStore();
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
store = new VoiceBroadcastPreRecordingStore();
|
||||
jest.spyOn(store, "emit");
|
||||
jest.spyOn(store, "removeAllListeners");
|
||||
preRecording1 = new VoiceBroadcastPreRecording(room, sender, client, recordingsStore);
|
||||
jest.spyOn(preRecording1, "off");
|
||||
});
|
||||
|
||||
it("getCurrent() should return null", () => {
|
||||
expect(store.getCurrent()).toBeNull();
|
||||
});
|
||||
|
||||
it("clearCurrent() should work", () => {
|
||||
store.clearCurrent();
|
||||
expect(store.getCurrent()).toBeNull();
|
||||
});
|
||||
|
||||
describe("when setting a current recording", () => {
|
||||
beforeEach(() => {
|
||||
store.setCurrent(preRecording1);
|
||||
});
|
||||
|
||||
it("getCurrent() should return the recording", () => {
|
||||
expect(store.getCurrent()).toBe(preRecording1);
|
||||
});
|
||||
|
||||
it("should emit a changed event with the recording", () => {
|
||||
expect(store.emit).toHaveBeenCalledWith("changed", preRecording1);
|
||||
});
|
||||
|
||||
describe("and calling destroy()", () => {
|
||||
beforeEach(() => {
|
||||
store.destroy();
|
||||
});
|
||||
|
||||
it("should remove all listeners", () => {
|
||||
expect(store.removeAllListeners).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("should deregister from the pre-recordings", () => {
|
||||
expect(preRecording1.off).toHaveBeenCalledWith("dismiss", expect.any(Function));
|
||||
});
|
||||
});
|
||||
|
||||
describe("and cancelling the pre-recording", () => {
|
||||
beforeEach(() => {
|
||||
preRecording1.cancel();
|
||||
});
|
||||
|
||||
it("should clear the current recording", () => {
|
||||
expect(store.getCurrent()).toBeNull();
|
||||
});
|
||||
|
||||
it("should emit a changed event with null", () => {
|
||||
expect(store.emit).toHaveBeenCalledWith("changed", null);
|
||||
});
|
||||
});
|
||||
|
||||
describe("and setting the same pre-recording again", () => {
|
||||
beforeEach(() => {
|
||||
mocked(store.emit).mockClear();
|
||||
store.setCurrent(preRecording1);
|
||||
});
|
||||
|
||||
it("should not emit a changed event", () => {
|
||||
expect(store.emit).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("and setting another pre-recording", () => {
|
||||
let preRecording2: VoiceBroadcastPreRecording;
|
||||
|
||||
beforeEach(() => {
|
||||
mocked(store.emit).mockClear();
|
||||
mocked(preRecording1.off).mockClear();
|
||||
preRecording2 = new VoiceBroadcastPreRecording(room, sender, client, recordingsStore);
|
||||
store.setCurrent(preRecording2);
|
||||
});
|
||||
|
||||
it("should deregister from the current pre-recording", () => {
|
||||
expect(preRecording1.off).toHaveBeenCalledWith("dismiss", expect.any(Function));
|
||||
});
|
||||
|
||||
it("getCurrent() should return the new recording", () => {
|
||||
expect(store.getCurrent()).toBe(preRecording2);
|
||||
});
|
||||
|
||||
it("should emit a changed event with the new recording", () => {
|
||||
expect(store.emit).toHaveBeenCalledWith("changed", preRecording2);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
/*
|
||||
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 { mocked } from "jest-mock";
|
||||
import { MatrixClient, Room } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import {
|
||||
checkVoiceBroadcastPreConditions,
|
||||
VoiceBroadcastPreRecording,
|
||||
VoiceBroadcastPreRecordingStore,
|
||||
VoiceBroadcastRecordingsStore,
|
||||
} from "../../../src/voice-broadcast";
|
||||
import { setUpVoiceBroadcastPreRecording } from "../../../src/voice-broadcast/utils/setUpVoiceBroadcastPreRecording";
|
||||
import { mkRoomMemberJoinEvent, stubClient } from "../../test-utils";
|
||||
|
||||
jest.mock("../../../src/voice-broadcast/utils/checkVoiceBroadcastPreConditions");
|
||||
|
||||
describe("setUpVoiceBroadcastPreRecording", () => {
|
||||
const roomId = "!room:example.com";
|
||||
let client: MatrixClient;
|
||||
let userId: string;
|
||||
let room: Room;
|
||||
let preRecordingStore: VoiceBroadcastPreRecordingStore;
|
||||
let recordingsStore: VoiceBroadcastRecordingsStore;
|
||||
|
||||
const itShouldReturnNull = () => {
|
||||
it("should return null", () => {
|
||||
expect(setUpVoiceBroadcastPreRecording(room, client, recordingsStore, preRecordingStore)).toBeNull();
|
||||
expect(checkVoiceBroadcastPreConditions).toHaveBeenCalledWith(room, client, recordingsStore);
|
||||
});
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
client = stubClient();
|
||||
|
||||
const clientUserId = client.getUserId();
|
||||
if (!clientUserId) fail("empty userId");
|
||||
userId = clientUserId;
|
||||
|
||||
room = new Room(roomId, client, userId);
|
||||
preRecordingStore = new VoiceBroadcastPreRecordingStore();
|
||||
recordingsStore = new VoiceBroadcastRecordingsStore();
|
||||
});
|
||||
|
||||
describe("when the preconditions fail", () => {
|
||||
beforeEach(() => {
|
||||
mocked(checkVoiceBroadcastPreConditions).mockReturnValue(false);
|
||||
});
|
||||
|
||||
itShouldReturnNull();
|
||||
});
|
||||
|
||||
describe("when the preconditions pass", () => {
|
||||
beforeEach(() => {
|
||||
mocked(checkVoiceBroadcastPreConditions).mockReturnValue(true);
|
||||
});
|
||||
|
||||
describe("and there is no user id", () => {
|
||||
beforeEach(() => {
|
||||
mocked(client.getUserId).mockReturnValue(null);
|
||||
});
|
||||
|
||||
itShouldReturnNull();
|
||||
});
|
||||
|
||||
describe("and there is no room member", () => {
|
||||
beforeEach(() => {
|
||||
// check test precondition
|
||||
expect(room.getMember(userId)).toBeNull();
|
||||
});
|
||||
|
||||
itShouldReturnNull();
|
||||
});
|
||||
|
||||
describe("and there is a room member", () => {
|
||||
beforeEach(() => {
|
||||
room.currentState.setStateEvents([
|
||||
mkRoomMemberJoinEvent(userId, roomId),
|
||||
]);
|
||||
});
|
||||
|
||||
it("should create a voice broadcast pre-recording", () => {
|
||||
const result = setUpVoiceBroadcastPreRecording(room, client, recordingsStore, preRecordingStore);
|
||||
expect(checkVoiceBroadcastPreConditions).toHaveBeenCalledWith(room, client, recordingsStore);
|
||||
expect(result).toBeInstanceOf(VoiceBroadcastPreRecording);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue