Split membership manager into legacy variant to improve readability

src/matrixrtc/MatrixRTCSession.ts

@@ -24,7 +24,7 @@ import { KnownMembership } from "../@types/membership.ts";
 import { type ISendEventResponse } from "../@types/requests.ts";
 import { CallMembership } from "./CallMembership.ts";
 import { RoomStateEvent } from "../models/room-state.ts";
-import { MembershipManager, StickyEventMembershipManager } from "./MembershipManager.ts";
+import { LegacyMembershipManager, StickyEventMembershipManager } from "./MembershipManager.ts";
 import { EncryptionManager, type IEncryptionManager } from "./EncryptionManager.ts";
 import { deepCompare, logDurationSync } from "../utils.ts";
 import {
@@ -618,7 +618,7 @@ export class MatrixRTCSession extends TypedEventEmitter<
                       this.slotDescription,
                       this.logger,
                   )
-                : new MembershipManager(joinConfig, this.roomSubset, this.client, this.slotDescription, this.logger);
+                : new LegacyMembershipManager(joinConfig, this.roomSubset, this.client, this.slotDescription, this.logger);
 
             this.reEmitter.reEmit(this.membershipManager!, [
                 MembershipManagerEvent.ProbablyLeft,

src/matrixrtc/MembershipManager.ts

@@ -29,9 +29,13 @@ import { type Room } from "../models/room.ts";
 import {
     type CallMembership,
     DEFAULT_EXPIRE_DURATION,
-    type RtcMembershipData,
-    type SessionMembershipData,
 } from "./CallMembership.ts";
+import type {
+    RtcMembershipData,
+} from "./membership/rtc.ts"
+import type {
+    SessionMembershipData,
+} from "./membership/legacy.ts"
 import { type Transport, isMyMembership, type RTCCallIntent, Status, SlotDescription } from "./types.ts";
 import { type MembershipConfig, type SessionConfig } from "./MatrixRTCSession.ts";
 import { ActionScheduler, type ActionUpdate } from "./MembershipManagerActionScheduler.ts";
@@ -181,7 +185,7 @@ type MembershipManagerClient = Pick<
  *   - Stop the timer for the delay refresh
  *   - Stop the timer for updating the state event
  */
-export class MembershipManager
+export abstract class MembershipManager<MembershipData extends SessionMembershipData|RtcMembershipData>
     extends TypedEventEmitter<MembershipManagerEvent, MembershipManagerEventHandlerMap>
     implements IMembershipManager
 {
@@ -382,7 +386,7 @@ export class MembershipManager
     protected memberId: string;
     protected rtcTransport?: Transport;
     /** @deprecated This will be removed in favor or rtcTransport becoming a list of actively used transports */
-    private fociPreferred?: Transport[];
+    protected fociPreferred?: Transport[];
 
     // Config:
     private delayedLeaveEventDelayMsOverride?: number;
@@ -473,15 +477,7 @@ export class MembershipManager
         }
     }
 
-    // an abstraction to switch between sending state or a sticky event
+    protected abstract clientSendDelayedDisconnectMembership: () => Promise<SendDelayedEventResponse>;
-    protected clientSendDelayedDisconnectMembership: () => Promise<SendDelayedEventResponse> = () =>
-        this.client._unstable_sendDelayedStateEvent(
-            this.room.roomId,
-            { delay: this.delayedLeaveEventDelayMs },
-            EventType.GroupCallMemberPrefix,
-            {},
-            this.memberId,
-        );
 
     // HANDLERS (used in the membershipLoopHandler)
     private async sendOrResendDelayedLeaveEvent(): Promise<ActionUpdate> {
@@ -669,16 +665,9 @@ export class MembershipManager
             });
     }
 
-    protected clientSendMembership: (
+    protected abstract clientSendMembership: (
-        myMembership: RtcMembershipData | SessionMembershipData | EmptyObject,
+        myMembership: MembershipData | EmptyObject,
-    ) => Promise<ISendEventResponse> = (myMembership) => {
+    ) => Promise<ISendEventResponse>;
-        return this.client.sendStateEvent(
-            this.room.roomId,
-            EventType.GroupCallMemberPrefix,
-            myMembership as EmptyObject | SessionMembershipData,
-            this.memberId,
-        );
-    };
 
     private async sendJoinEvent(): Promise<ActionUpdate> {
         return await this.clientSendMembership(this.makeMyMembership(this.membershipEventExpiryMs))
@@ -771,30 +760,7 @@ export class MembershipManager
     /**
      * Constructs our own membership
      */
-    protected makeMyMembership(expires: number): SessionMembershipData | RtcMembershipData {
+    protected abstract makeMyMembership(expires: number): MembershipData;
-        const ownMembership = this.ownMembership;
-
-        const focusObjects =
-            this.rtcTransport === undefined
-                ? {
-                      focus_active: { type: "livekit", focus_selection: "oldest_membership" } as const,
-                      foci_preferred: this.fociPreferred ?? [],
-                  }
-                : {
-                      focus_active: { type: "livekit", focus_selection: "multi_sfu" } as const,
-                      foci_preferred: [this.rtcTransport, ...(this.fociPreferred ?? [])],
-                  };
-        return {
-            "application": this.slotDescription.application,
-            "call_id": this.slotDescription.id,
-            "scope": "m.room",
-            "device_id": this.deviceId,
-            expires,
-            "m.call.intent": this.callIntent,
-            ...focusObjects,
-            ...(ownMembership !== undefined ? { created_ts: ownMembership.createdTs() } : undefined),
-        };
-    }
 
     // Error checks and handlers
 
@@ -1020,11 +986,65 @@ export class MembershipManager
     }
 }
 
+/**
+ * Handles sending membership for MSC3401 RTC events.
+ */
+export class LegacyMembershipManager extends MembershipManager<SessionMembershipData> {
+    protected clientSendDelayedDisconnectMembership: () => Promise<SendDelayedEventResponse> = () =>
+        this.client._unstable_sendDelayedStateEvent(
+            this.room.roomId,
+            { delay: this.delayedLeaveEventDelayMs },
+            EventType.GroupCallMemberPrefix,
+            {},
+            this.memberId,
+        );
+
+    protected makeMyMembership(expires: number): SessionMembershipData {
+        const ownMembership = this.ownMembership;
+
+        const focusObjects =
+            this.rtcTransport === undefined
+                ? {
+                      focus_active: { type: "livekit", focus_selection: "oldest_membership" } as const,
+                      foci_preferred: this.fociPreferred ?? [],
+                  }
+                : {
+                      focus_active: { type: "livekit", focus_selection: "multi_sfu" } as const,
+                      foci_preferred: [this.rtcTransport, ...(this.fociPreferred ?? [])],
+                  };
+        return {
+            "application": this.slotDescription.application,
+            "call_id": this.slotDescription.id ?? "",
+            "scope": "m.room",
+            "device_id": this.deviceId,
+            expires,
+            "m.call.intent": this.callIntent,
+            ...focusObjects,
+            ...(ownMembership !== undefined ? { created_ts: ownMembership.createdTs() } : undefined),
+        };
+    }
+
+
+    protected clientSendMembership: (
+        myMembership: SessionMembershipData | EmptyObject,
+    ) => Promise<ISendEventResponse> = (myMembership) => {
+        return this.client.sendStateEvent(
+            this.room.roomId,
+            EventType.GroupCallMemberPrefix,
+            myMembership,
+            this.memberId,
+        );
+    };
+
+}
+
 /**
  * Implementation of the Membership manager that uses sticky events
  * rather than state events.
+ * 
+ * This exclusively sends RTCMembershipData 
  */
-export class StickyEventMembershipManager extends MembershipManager {
+export class StickyEventMembershipManager extends MembershipManager<RtcMembershipData> {
     public constructor(
         joinConfig: (SessionConfig & MembershipConfig) | undefined,
         room: Pick<Room, "getLiveTimeline" | "roomId" | "getVersion">,
@@ -1036,6 +1056,8 @@ export class StickyEventMembershipManager extends MembershipManager {
         super(joinConfig, room, clientWithSticky, sessionDescription, parentLogger);
     }
 
+    protected readonly eventType = EventType.RTCMembership;
+
     protected clientSendDelayedDisconnectMembership: () => Promise<SendDelayedEventResponse> = () =>
         this.clientWithSticky._unstable_sendStickyDelayedEvent(
             this.room.roomId,
@@ -1047,7 +1069,7 @@ export class StickyEventMembershipManager extends MembershipManager {
         );
 
     protected clientSendMembership: (
-        myMembership: RtcMembershipData | SessionMembershipData | EmptyObject,
+        myMembership: RtcMembershipData | EmptyObject,
     ) => Promise<ISendEventResponse> = (myMembership) => {
         return this.clientWithSticky._unstable_sendStickyEvent(
             this.room.roomId,
@@ -1066,7 +1088,7 @@ export class StickyEventMembershipManager extends MembershipManager {
         return super.actionUpdateFromErrors(e, t, StickyEventMembershipManager.nameMap.get(m) ?? "unknown");
     }
 
-    protected makeMyMembership(expires: number): SessionMembershipData | RtcMembershipData {
+    protected makeMyMembership(_expires: number): RtcMembershipData {
         const ownMembership = this.ownMembership;
 
         const relationObject = ownMembership?.eventId
@@ -1079,7 +1101,7 @@ export class StickyEventMembershipManager extends MembershipManager {
             },
             slot_id: slotDescriptionToId(this.slotDescription),
             rtc_transports: this.rtcTransport ? [this.rtcTransport] : [],
-            member: { device_id: this.deviceId, user_id: this.client.getUserId()!, id: this.memberId },
+            member: { claimed_device_id: this.deviceId, claimed_user_id: this.client.getUserId()!, id: this.memberId },
             versions: [],
             ...relationObject,
         };