matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-23 17:02:25 +03:00
Code Activity

Add tests for MatrixRTCSessionManager

Browse Source
This commit is contained in:
Half-Shot
2025-09-30 12:09:54 +01:00
parent 0b1fae59f3
commit 791b119d07
2 changed files with 133 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
spec/unit/matrixrtc/MatrixRTCSessionManager.spec.ts
View File

@@ -14,15 +14,29 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
import { ClientEvent, EventTimeline, MatrixClient } from "../../../src"; import { ClientEvent, EventTimeline, MatrixClient, Room } from "../../../src";
import { RoomStateEvent } from "../../../src/models/room-state"; import { RoomStateEvent } from "../../../src/models/room-state";
import { MatrixRTCSessionManager, MatrixRTCSessionManagerEvents } from "../../../src/matrixrtc/MatrixRTCSessionManager"; import { MatrixRTCSessionManager, MatrixRTCSessionManagerEvents } from "../../../src/matrixrtc/MatrixRTCSessionManager";
import { makeMockRoom, membershipTemplate, mockRoomState } from "./mocks"; import { makeMockRoom, MembershipData, membershipTemplate, mockRoomState, mockRTCEvent } from "./mocks";
import { logger } from "../../../src/logger"; import { logger } from "../../../src/logger";
describe("MatrixRTCSessionManager", () => { describe.each([{ eventKind: "sticky" }, { eventKind: "memberState" }])(
"MatrixRTCSessionManager ($eventKind)",
({ eventKind }) => {
let client: MatrixClient; let client: MatrixClient;
function sendLeaveMembership(room: Room, membershipData: MembershipData[]): void {
if (eventKind === "memberState") {
mockRoomState(room, [{ user_id: membershipTemplate.user_id }]);
const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS)!;
const membEvent = roomState.getStateEvents("org.matrix.msc3401.call.member")[0];
client.emit(RoomStateEvent.Events, membEvent, roomState, null);
} else {
membershipData.splice(0, 1, { user_id: membershipTemplate.user_id });
client.emit(ClientEvent.Event, mockRTCEvent(membershipData[0], room.roomId, 10000));
}
}
beforeEach(() => { beforeEach(() => {
client = new MatrixClient({ baseUrl: "base_url" }); client = new MatrixClient({ baseUrl: "base_url" });
client.matrixRTC.start(); client.matrixRTC.start();
@@ -38,7 +52,7 @@ describe("MatrixRTCSessionManager", () => {
client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionStarted, onStarted); client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionStarted, onStarted);
try { try {
const room1 = makeMockRoom([membershipTemplate]); const room1 = makeMockRoom([membershipTemplate], eventKind === "sticky");
jest.spyOn(client, "getRooms").mockReturnValue([room1]); jest.spyOn(client, "getRooms").mockReturnValue([room1]);
client.emit(ClientEvent.Room, room1); client.emit(ClientEvent.Room, room1);
@@ -53,7 +67,7 @@ describe("MatrixRTCSessionManager", () => {
client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionStarted, onStarted); client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionStarted, onStarted);
try { try {
const room1 = makeMockRoom([{ ...membershipTemplate, application: "m.other" }]); const room1 = makeMockRoom([{ ...membershipTemplate, application: "m.other" }], eventKind === "sticky");
jest.spyOn(client, "getRooms").mockReturnValue([room1]); jest.spyOn(client, "getRooms").mockReturnValue([room1]);
client.emit(ClientEvent.Room, room1); client.emit(ClientEvent.Room, room1);
@@ -63,29 +77,28 @@ describe("MatrixRTCSessionManager", () => {
} }
}); });
it("Fires event when session ends", () => { it("Fires event when session ends", async () => {
const onEnded = jest.fn(); const onEnded = jest.fn();
client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionEnded, onEnded); client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionEnded, onEnded);
const room1 = makeMockRoom([membershipTemplate]); const membershipData: MembershipData[] = [membershipTemplate];
const room1 = makeMockRoom(membershipData, eventKind === "sticky");
jest.spyOn(client, "getRooms").mockReturnValue([room1]); jest.spyOn(client, "getRooms").mockReturnValue([room1]);
jest.spyOn(client, "getRoom").mockReturnValue(room1); jest.spyOn(client, "getRoom").mockReturnValue(room1);
client.emit(ClientEvent.Room, room1); client.emit(ClientEvent.Room, room1);
mockRoomState(room1, [{ user_id: membershipTemplate.user_id }]); sendLeaveMembership(room1, membershipData);
const roomState = room1.getLiveTimeline().getState(EventTimeline.FORWARDS)!;
const membEvent = roomState.getStateEvents("org.matrix.msc3401.call.member")[0];
client.emit(RoomStateEvent.Events, membEvent, roomState, null);
expect(onEnded).toHaveBeenCalledWith(room1.roomId, client.matrixRTC.getActiveRoomSession(room1)); expect(onEnded).toHaveBeenCalledWith(room1.roomId, client.matrixRTC.getActiveRoomSession(room1));
}); });
it("Fires correctly with for with custom sessionDescription", () => { it("Fires correctly with custom sessionDescription", () => {
const onStarted = jest.fn(); const onStarted = jest.fn();
const onEnded = jest.fn(); const onEnded = jest.fn();
// create a session manager with a custom session description // create a session manager with a custom session description
const sessionManager = new MatrixRTCSessionManager(logger, client, { id: "test", application: "m.notCall" }); const sessionManager = new MatrixRTCSessionManager(logger, client, {
id: "test",
application: "m.notCall",
});
// manually start the session manager (its not the default one started by the client) // manually start the session manager (its not the default one started by the client)
sessionManager.start(); sessionManager.start();
@@ -93,35 +106,33 @@ describe("MatrixRTCSessionManager", () => {
sessionManager.on(MatrixRTCSessionManagerEvents.SessionStarted, onStarted); sessionManager.on(MatrixRTCSessionManagerEvents.SessionStarted, onStarted);
try { try {
const room1 = makeMockRoom([{ ...membershipTemplate, application: "m.other" }]); // Create a session for applicaation m.other, we ignore this session ecause it lacks a call_id
const room1MembershipData: MembershipData[] = [{ ...membershipTemplate, application: "m.other" }];
const room1 = makeMockRoom(room1MembershipData, eventKind === "sticky");
jest.spyOn(client, "getRooms").mockReturnValue([room1]); jest.spyOn(client, "getRooms").mockReturnValue([room1]);
client.emit(ClientEvent.Room, room1); client.emit(ClientEvent.Room, room1);
expect(onStarted).not.toHaveBeenCalled(); expect(onStarted).not.toHaveBeenCalled();
onStarted.mockClear(); onStarted.mockClear();
const room2 = makeMockRoom([{ ...membershipTemplate, application: "m.notCall", call_id: "test" }]); // Create a session for applicaation m.notCall. We expect this call to be tracked because it has a call_id
const room2MembershipData: MembershipData[] = [
{ ...membershipTemplate, application: "m.notCall", call_id: "test" },
];
const room2 = makeMockRoom(room2MembershipData, eventKind === "sticky");
jest.spyOn(client, "getRooms").mockReturnValue([room1, room2]); jest.spyOn(client, "getRooms").mockReturnValue([room1, room2]);
client.emit(ClientEvent.Room, room2); client.emit(ClientEvent.Room, room2);
expect(onStarted).toHaveBeenCalled(); expect(onStarted).toHaveBeenCalled();
onStarted.mockClear(); onStarted.mockClear();
mockRoomState(room2, [{ user_id: membershipTemplate.user_id }]); // Stop room1's RTC session. Tracked.
jest.spyOn(client, "getRoom").mockReturnValue(room2); jest.spyOn(client, "getRoom").mockReturnValue(room2);
sendLeaveMembership(room2, room2MembershipData);
const roomState = room2.getLiveTimeline().getState(EventTimeline.FORWARDS)!;
const membEvent = roomState.getStateEvents("org.matrix.msc3401.call.member")[0];
client.emit(RoomStateEvent.Events, membEvent, roomState, null);
expect(onEnded).toHaveBeenCalled(); expect(onEnded).toHaveBeenCalled();
onEnded.mockClear(); onEnded.mockClear();
mockRoomState(room1, [{ user_id: membershipTemplate.user_id }]); // Stop room1's RTC session. Not tracked.
jest.spyOn(client, "getRoom").mockReturnValue(room1); jest.spyOn(client, "getRoom").mockReturnValue(room1);
sendLeaveMembership(room1, room1MembershipData);
const roomStateOther = room1.getLiveTimeline().getState(EventTimeline.FORWARDS)!;
const membEventOther = roomStateOther.getStateEvents("org.matrix.msc3401.call.member")[0];
client.emit(RoomStateEvent.Events, membEventOther, roomStateOther, null);
expect(onEnded).not.toHaveBeenCalled(); expect(onEnded).not.toHaveBeenCalled();
} finally { } finally {
client.matrixRTC.off(MatrixRTCSessionManagerEvents.SessionStarted, onStarted); client.matrixRTC.off(MatrixRTCSessionManagerEvents.SessionStarted, onStarted);
@@ -132,18 +143,16 @@ describe("MatrixRTCSessionManager", () => {
it("Doesn't fire event if unrelated sessions ends", () => { it("Doesn't fire event if unrelated sessions ends", () => {
const onEnded = jest.fn(); const onEnded = jest.fn();
client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionEnded, onEnded); client.matrixRTC.on(MatrixRTCSessionManagerEvents.SessionEnded, onEnded);
const room1 = makeMockRoom([{ ...membershipTemplate, application: "m.other_app" }]); const membership: MembershipData[] = [{ ...membershipTemplate, application: "m.other_app" }];
const room1 = makeMockRoom(membership, eventKind === "sticky");
jest.spyOn(client, "getRooms").mockReturnValue([room1]); jest.spyOn(client, "getRooms").mockReturnValue([room1]);
jest.spyOn(client, "getRoom").mockReturnValue(room1); jest.spyOn(client, "getRoom").mockReturnValue(room1);
client.emit(ClientEvent.Room, room1); client.emit(ClientEvent.Room, room1);
mockRoomState(room1, [{ user_id: membershipTemplate.user_id }]); sendLeaveMembership(room1, membership);
const roomState = room1.getLiveTimeline().getState(EventTimeline.FORWARDS)!;
const membEvent = roomState.getStateEvents("org.matrix.msc3401.call.member")[0];
client.emit(RoomStateEvent.Events, membEvent, roomState, null);
expect(onEnded).not.toHaveBeenCalledWith(room1.roomId, client.matrixRTC.getActiveRoomSession(room1)); expect(onEnded).not.toHaveBeenCalledWith(room1.roomId, client.matrixRTC.getActiveRoomSession(room1));
}); });
}); },
);

17
spec/unit/matrixrtc/mocks.ts
View File

@@ -88,7 +88,9 @@ export function makeMockRoom(
getVersion: jest.fn().mockReturnValue("default"), getVersion: jest.fn().mockReturnValue("default"),
unstableGetStickyEvents: jest unstableGetStickyEvents: jest
.fn() .fn()
.mockReturnValue(useStickyEvents ? membershipData.map((m) => mockRTCEvent(m, roomId)) : []), .mockImplementation(() =>
useStickyEvents ? membershipData.map((m) => mockRTCEvent(m, roomId, 10000)) : [],
),
}) as unknown as Room; }) as unknown as Room;
return Object.assign(room, { return Object.assign(room, {
emitTimelineEvent: (event: MatrixEvent) => emitTimelineEvent: (event: MatrixEvent) =>
@@ -149,8 +151,17 @@ export function makeMockEvent(
} as unknown as MatrixEvent; } as unknown as MatrixEvent;
} }
export function mockRTCEvent({ user_id: sender, ...membershipData }: MembershipData, roomId: string): MatrixEvent { export function mockRTCEvent(
return makeMockEvent(EventType.GroupCallMemberPrefix, sender, roomId, membershipData); { user_id: sender, ...membershipData }: MembershipData,
roomId: string,
stickyDuration?: number,
): MatrixEvent {
return {
...makeMockEvent(EventType.GroupCallMemberPrefix, sender, roomId, membershipData),
unstableStickyContent: {
duration_ms: stickyDuration,
},
} as unknown as MatrixEvent;
} }
export function mockCallMembership(membershipData: MembershipData, roomId: string): CallMembership { export function mockCallMembership(membershipData: MembershipData, roomId: string): CallMembership {