deprecate membershipID -> memberId & memberId -> stateKey in membership

manager

The membership manager used the memberId label for the stateKey. But
only the StickymembershipManager really has a configurable memberId.

Author: toger5

src/matrixrtc/CallMembership.ts

@@ -407,8 +407,26 @@ export class CallMembership {
      * value (used until version 0.16.0)
      *
      * It is also possible for a session event to set a custom membershipID. in that case this will be used.
+     *
+     * @deprecated renamed to `memberId`
      */
     public get membershipID(): string {
+        return this.memberId;
+    }
+
+    /**
+     * This computes the membership ID for the membership.
+     * for the sticky event based rtcSessionData this is trivial it is `member.id`.
+     *
+     * For the legacy sessionMemberEvents it is a bit more complex. Here we sometimes do not have this data
+     * in the event content and we expected the SFU and the client to use `${this.matrixEventData.sender}:${data.device_id}`.
+     *
+     * So if there is no membershipID we use the hard coded jwt id default (`${this.matrixEventData.sender}:${data.device_id}`)
+     * value (used until version 0.16.0)
+     *
+     * It is also possible for a session event to set a custom membershipID. in that case this will be used.
+     */
+    public get memberId(): string {
         // the createdTs behaves equivalent to the membershipID.
         // we only need the field for the legacy member events where we needed to update them
         // synapse ignores sending state events if they have the same content.

src/matrixrtc/MatrixRTCSession.ts

@@ -593,6 +593,9 @@ export class MatrixRTCSession extends TypedEventEmitter<
         multiSfuFocus?: Transport,
         joinConfig?: JoinSessionConfig,
     ): void {
+        const [userId, deviceId] = [this.client.getUserId()!, this.client.getDeviceId()!];
+        // TODO this wants to become a UUID
+        const memberId = `${userId}:${deviceId}`;
         if (this.isJoined()) {
             this.logger.info(`Already joined to session in room ${this.roomSubset.roomId}: ignoring join call`);
             return;
@@ -604,6 +607,7 @@ export class MatrixRTCSession extends TypedEventEmitter<
                       this.roomSubset,
                       this.client,
                       this.slotDescription,
+                      memberId,
                       this.logger,
                   )
                 : new MembershipManager(joinConfig, this.roomSubset, this.client, this.slotDescription, this.logger);

src/matrixrtc/MembershipManager.ts

@@ -336,7 +336,7 @@ export class MembershipManager
         this.userId = userId;
         // this needs to become a uuid so that consecutive join/leaves result in a key rotation.
         // we keep it as a string for now for backwards compatibility.
-        this.memberId = this.makeMembershipStateKey(userId, deviceId);
+        this.stateKey = this.makeMembershipStateKey(userId, deviceId);
         this.state = MembershipManager.defaultState;
         this.callIntent = joinConfig?.callIntent;
         this.scheduler = new ActionScheduler((type): Promise<ActionUpdate> => {
@@ -383,7 +383,7 @@ export class MembershipManager
     // Membership Event static parameters:
     protected deviceId: string;
     protected userId: string;
-    protected memberId: string;
+    protected stateKey: string;
     protected rtcTransport?: Transport;
     /** @deprecated This will be removed in favor or rtcTransport becoming a list of actively used transports */
     private fociPreferred?: Transport[];
@@ -484,7 +484,7 @@ export class MembershipManager
             { delay: this.delayedLeaveEventDelayMs },
             EventType.GroupCallMemberPrefix,
             {},
-            this.memberId,
+            this.stateKey,
         );
 
     // HANDLERS (used in the membershipLoopHandler)
@@ -677,7 +677,7 @@ export class MembershipManager
             this.room.roomId,
             EventType.GroupCallMemberPrefix,
             myMembership as EmptyObject | SessionMembershipData,
-            this.memberId,
+            this.stateKey,
         );
     };
 
@@ -1040,6 +1040,9 @@ export class StickyEventMembershipManager extends MembershipManager {
         private readonly clientWithSticky: MembershipManagerClient &
             Pick<MatrixClient, "_unstable_sendStickyEvent" | "_unstable_sendStickyDelayedEvent">,
         sessionDescription: SlotDescription,
+        // this needs to become a uuid so that consecutive join/leaves result in a key rotation.
+        // we keep it as a string for now for backwards compatibility.
+        private readonly memberId: string,
         parentLogger?: Logger,
     ) {
         super(joinConfig, room, clientWithSticky, sessionDescription, parentLogger);