[MatrixRTC] Use relation based call membership to compute create_ts()

spec/unit/matrixrtc/MembershipManager.spec.ts

@@ -32,8 +32,9 @@ import {
     type SessionMembershipData,
     type LivekitFocusSelection,
 } from "../../../src/matrixrtc";
-import { makeMockClient, makeMockRoom, membershipTemplate, mockCallMembership, type MockClient } from "./mocks";
-import { MembershipManager, StickyEventMembershipManager } from "../../../src/matrixrtc/MembershipManager.ts";
+import { makeMockClient, makeMockRoom, sessionMembershipTemplate, mockCallMembership, type MockClient } from "./mocks";
+import { MembershipManager } from "../../../src/matrixrtc/MembershipManager.ts";
+import { waitFor } from "../../test-utils/test-utils.ts";
 
 /**
  * Create a promise that will resolve once a mocked method is called.
@@ -90,7 +91,7 @@ describe("MembershipManager", () => {
         // Default to fake timers.
         jest.useFakeTimers();
         client = makeMockClient("@alice:example.org", "AAAAAAA");
-        room = makeMockRoom([membershipTemplate]);
+        room = makeMockRoom([sessionMembershipTemplate]);
         // Provide a default mock that is like the default "non error" server behaviour.
         (client._unstable_sendDelayedStateEvent as Mock<any>).mockResolvedValue({ delay_id: "id" });
         (client._unstable_updateDelayedEvent as Mock<any>).mockResolvedValue(undefined);
@@ -350,7 +351,7 @@ describe("MembershipManager", () => {
             const { resolve } = createAsyncHandle(client._unstable_sendDelayedStateEvent);
             await jest.advanceTimersByTimeAsync(RESTART_DELAY);
             // first simulate the sync, then resolve sending the delayed event.
-            await manager.onRTCSessionMemberUpdate([mockCallMembership(membershipTemplate, room.roomId)]);
+            await manager.onRTCSessionMemberUpdate([mockCallMembership(sessionMembershipTemplate, room.roomId)]);
             resolve({ delay_id: "id" });
             // Let the scheduler run one iteration so that the new join gets sent
             await jest.runOnlyPendingTimersAsync();
@@ -433,7 +434,7 @@ describe("MembershipManager", () => {
     describe("onRTCSessionMemberUpdate()", () => {
         it("does nothing if not joined", async () => {
             const manager = new MembershipManager({}, room, client, callSession);
-            await manager.onRTCSessionMemberUpdate([mockCallMembership(membershipTemplate, room.roomId)]);
+            await manager.onRTCSessionMemberUpdate([mockCallMembership(sessionMembershipTemplate, room.roomId)]);
             await jest.advanceTimersToNextTimerAsync();
             expect(client.sendStateEvent).not.toHaveBeenCalled();
             expect(client._unstable_sendDelayedStateEvent).not.toHaveBeenCalled();
@@ -450,7 +451,7 @@ describe("MembershipManager", () => {
             (client._unstable_sendDelayedStateEvent as Mock).mockClear();
 
             await manager.onRTCSessionMemberUpdate([
-                mockCallMembership(membershipTemplate, room.roomId),
+                mockCallMembership(sessionMembershipTemplate, room.roomId),
                 mockCallMembership(
                     { ...(myMembership as SessionMembershipData), user_id: client.getUserId()! },
                     room.roomId,
@@ -473,7 +474,7 @@ describe("MembershipManager", () => {
             (client._unstable_sendDelayedStateEvent as Mock).mockClear();
 
             // Our own membership is removed:
-            await manager.onRTCSessionMemberUpdate([mockCallMembership(membershipTemplate, room.roomId)]);
+            await manager.onRTCSessionMemberUpdate([mockCallMembership(sessionMembershipTemplate, room.roomId)]);
             await jest.advanceTimersByTimeAsync(1);
             expect(client.sendStateEvent).toHaveBeenCalled();
             expect(client._unstable_sendDelayedStateEvent).toHaveBeenCalled();
@@ -496,7 +497,7 @@ describe("MembershipManager", () => {
 
             const { resolve } = createAsyncHandle(client._unstable_sendDelayedStateEvent);
             await jest.advanceTimersByTimeAsync(10_000);
-            await manager.onRTCSessionMemberUpdate([mockCallMembership(membershipTemplate, room.roomId)]);
+            await manager.onRTCSessionMemberUpdate([mockCallMembership(sessionMembershipTemplate, room.roomId)]);
             resolve({ delay_id: "id" });
             await jest.advanceTimersByTimeAsync(10_000);
 
@@ -865,7 +866,10 @@ describe("MembershipManager", () => {
             const manager = new MembershipManager({}, room, client, callSession);
             manager.join([]);
             expect(manager.isActivated()).toEqual(true);
-            const membership = mockCallMembership({ ...membershipTemplate, user_id: client.getUserId()! }, room.roomId);
+            const membership = mockCallMembership(
+                { ...sessionMembershipTemplate, user_id: client.getUserId()! },
+                room.roomId,
+            );
             await manager.onRTCSessionMemberUpdate([membership]);
             await manager.updateCallIntent("video");
             expect(client.sendStateEvent).toHaveBeenCalledTimes(2);
@@ -879,7 +883,7 @@ describe("MembershipManager", () => {
             manager.join([]);
             expect(manager.isActivated()).toEqual(true);
             const membership = mockCallMembership(
-                { ...membershipTemplate, "user_id": client.getUserId()!, "m.call.intent": "video" },
+                { ...sessionMembershipTemplate, "user_id": client.getUserId()!, "m.call.intent": "video" },
                 room.roomId,
             );
             await manager.onRTCSessionMemberUpdate([membership]);
@@ -946,18 +950,18 @@ describe("MembershipManager", () => {
     });
 });
 
-it("Should prefix log with MembershipManager used", () => {
+it("Should prefix log with MembershipManager used", async () => {
+    const spy = jest.spyOn(console, "error");
     const client = makeMockClient("@alice:example.org", "AAAAAAA");
-    const room = makeMockRoom([membershipTemplate]);
+    const room = makeMockRoom([sessionMembershipTemplate]);
 
     const membershipManager = new MembershipManager(undefined, room, client, callSession);
 
-    const spy = jest.spyOn(console, "error");
     // Double join
     membershipManager.join([]);
     membershipManager.join([]);
 
-    expect(spy).toHaveBeenCalled();
+    await waitFor(() => expect(spy).toHaveBeenCalled());
     const logline: string = spy.mock.calls[0][0];
     expect(logline.startsWith("[MembershipManager]")).toBe(true);
 });

spec/unit/matrixrtc/RTCEncryptionManager.spec.ts

@@ -20,7 +20,7 @@ import { RTCEncryptionManager } from "../../../src/matrixrtc/RTCEncryptionManage
 import { type CallMembership, type Statistics } from "../../../src/matrixrtc";
 import { type ToDeviceKeyTransport } from "../../../src/matrixrtc/ToDeviceKeyTransport.ts";
 import { KeyTransportEvents, type KeyTransportEventsHandlerMap } from "../../../src/matrixrtc/IKeyTransport.ts";
-import { membershipTemplate, mockCallMembership } from "./mocks.ts";
+import { sessionMembershipTemplate, mockCallMembership } from "./mocks.ts";
 import { decodeBase64, TypedEventEmitter } from "../../../src";
 import { RoomAndToDeviceTransport } from "../../../src/matrixrtc/RoomAndToDeviceKeyTransport.ts";
 import { type RoomKeyTransport } from "../../../src/matrixrtc/RoomKeyTransport.ts";
@@ -864,7 +864,7 @@ describe("RTCEncryptionManager", () => {
 
     function aCallMembership(userId: string, deviceId: string, ts: number = 1000): CallMembership {
         return mockCallMembership(
-            { ...membershipTemplate, user_id: userId, device_id: deviceId, created_ts: ts },
+            { ...sessionMembershipTemplate, user_id: userId, device_id: deviceId, created_ts: ts },
             "!room:id",
         );
     }

spec/unit/matrixrtc/RoomKeyTransport.spec.ts

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { makeMockEvent, makeMockRoom, membershipTemplate, makeKey } from "./mocks";
+import { makeMockEvent, makeMockRoom, sessionMembershipTemplate, makeKey } from "./mocks";
 import { RoomKeyTransport } from "../../../src/matrixrtc/RoomKeyTransport";
 import { KeyTransportEvents } from "../../../src/matrixrtc/IKeyTransport";
 import { EventType, MatrixClient, RoomEvent } from "../../../src";
@@ -31,7 +31,7 @@ describe("RoomKeyTransport", () => {
     let mockLogger: Mocked<Logger>;
 
     const onCallEncryptionMock = jest.fn();
-    beforeEach(() => {
+    beforeEach(async () => {
         onCallEncryptionMock.mockReset();
         mockLogger = {
             debug: jest.fn(),
@@ -48,9 +48,9 @@ describe("RoomKeyTransport", () => {
                 roomEventEncryptionKeysReceivedTotalAge: 0,
             },
         };
-        room = makeMockRoom([membershipTemplate]);
+        room = makeMockRoom([sessionMembershipTemplate]);
         client = new MatrixClient({ baseUrl: "base_url" });
-        client.matrixRTC.start();
+        await client.matrixRTC.start();
         transport = new RoomKeyTransport(room, client, statistics, {
             getChild: jest.fn().mockReturnValue(mockLogger),
         } as unknown as Mocked<Logger>);

spec/unit/matrixrtc/mocks.ts

@@ -17,20 +17,24 @@ limitations under the License.
 import { EventEmitter } from "stream";
 import { type Mocked } from "jest-mock";
 
-import { EventType, type Room, RoomEvent, type MatrixClient, type MatrixEvent } from "../../../src";
-import { CallMembership, type SessionMembershipData } from "../../../src/matrixrtc/CallMembership";
+import { EventType, MatrixEvent, type Room, RoomEvent, type MatrixClient } from "../../../src";
+import {
+    CallMembership,
+    type RtcMembershipData,
+    type SessionMembershipData,
+} from "../../../src/matrixrtc/CallMembership";
 import { secureRandomString } from "../../../src/randomstring";
 
-export type MembershipData = (SessionMembershipData | {}) & { user_id: string };
+export type MembershipData = (SessionMembershipData | RtcMembershipData | {}) & { user_id: string };
 
-export const membershipTemplate: SessionMembershipData & { user_id: string } = {
-    application: "m.call",
-    call_id: "",
-    user_id: "@mock:user.example",
-    device_id: "AAAAAAA",
-    scope: "m.room",
-    focus_active: { type: "livekit", focus_selection: "oldest_membership" },
-    foci_preferred: [
+export const sessionMembershipTemplate: SessionMembershipData & { user_id: string } = {
+    "application": "m.call",
+    "call_id": "",
+    "user_id": "@mock:user.example",
+    "device_id": "AAAAAAA",
+    "scope": "m.room",
+    "focus_active": { type: "livekit", focus_selection: "oldest_membership" },
+    "foci_preferred": [
         {
             livekit_alias: "!alias:something.org",
             livekit_service_url: "https://livekit-jwt.something.io",
@@ -42,6 +46,16 @@ export const membershipTemplate: SessionMembershipData & { user_id: string } = {
             type: "livekit",
         },
     ],
+    "m.call.intent": "voice",
+};
+
+export const rtcMembershipTemplate: RtcMembershipData = {
+    slot_id: "m.call#",
+    application: { "type": "m.call", "m.call.id": "", "m.call.intent": "voice" },
+    member: { user_id: "@alice:example.org", device_id: "AAAAAAA", id: "xyzHASHxyz" },
+    rtc_transports: [{ type: "livekit" }],
+    msc4354_sticky_key: "my_sticky_key",
+    versions: [],
 };
 
 export type MockClient = Pick<
@@ -93,6 +107,7 @@ export function makeMockRoom(
             .mockImplementation(() =>
                 useStickyEvents ? membershipData.map((m) => mockRTCEvent(m, roomId, 10000, ts)) : [],
             ) as any,
+        findEventById: jest.fn(),
     });
     return Object.assign(room, {
         emitTimelineEvent: (event: MatrixEvent) =>
@@ -143,16 +158,15 @@ export function makeMockEvent(
     timestamp?: number,
     stateKey?: string,
 ): MatrixEvent {
-    return {
-        getType: jest.fn().mockReturnValue(type),
-        getContent: jest.fn().mockReturnValue(content),
-        getSender: jest.fn().mockReturnValue(sender),
-        getTs: jest.fn().mockReturnValue(timestamp ?? Date.now()),
-        getRoomId: jest.fn().mockReturnValue(roomId),
-        getId: jest.fn().mockReturnValue(secureRandomString(8)),
-        getStateKey: jest.fn().mockReturnValue(stateKey),
-        isDecryptionFailure: jest.fn().mockReturnValue(false),
-    } as unknown as MatrixEvent;
+    return new MatrixEvent({
+        event_id: secureRandomString(8),
+        sender,
+        type,
+        content,
+        room_id: roomId,
+        origin_server_ts: timestamp ?? 0,
+        state_key: stateKey,
+    });
 }
 
 export function mockRTCEvent(
@@ -175,7 +189,7 @@ export function mockRTCEvent(
 }
 
 export function mockCallMembership(membershipData: MembershipData, roomId: string): CallMembership {
-    return new CallMembership(mockRTCEvent(membershipData, roomId), membershipData);
+    return new CallMembership(mockRTCEvent(membershipData, roomId));
 }
 
 export function makeKey(id: number, key: string): { key: string; index: number } {