fix not subscribing to KeyTransportEvents in the EncryptionManager + cleanup

Author: toger5

src/matrixrtc/EncryptionManager.ts

@@ -5,7 +5,7 @@ import { secureRandomBase64Url } from "../randomstring.ts";
 import { decodeBase64, encodeUnpaddedBase64 } from "../base64.ts";
 import { safeGetRetryAfterMs } from "../http-api/errors.ts";
 import { type CallMembership } from "./CallMembership.ts";
-import { KeyTransportEventListener, type IKeyTransport } from "./IKeyTransport.ts";
+import { KeyTransportEventListener, KeyTransportEvents, type IKeyTransport } from "./IKeyTransport.ts";
 
 const logger = rootLogger.getChild("MatrixRTCSession");
 
@@ -116,6 +116,7 @@ export class EncryptionManager implements IEncryptionManager {
         this.joinConfig = joinConfig;
         this.joined = true;
         this.manageMediaKeys = this.joinConfig?.manageMediaKeys ?? this.manageMediaKeys;
+        this.transport.on(KeyTransportEvents.ReceivedKeys, this.onNewKeyReceived);
         if (this.joinConfig?.manageMediaKeys) {
             this.makeNewSenderKey();
             this.requestSendCurrentKey();
@@ -127,6 +128,7 @@ export class EncryptionManager implements IEncryptionManager {
         // make new keys if we rejoin). We leave keys for other participants
         // as they may still be using the same ones.
         this.encryptionKeys.set(getParticipantId(this.userId, this.deviceId), []);
+        this.transport.off(KeyTransportEvents.ReceivedKeys, this.onNewKeyReceived);
 
         if (this.makeNewKeyTimeout !== undefined) {
             clearTimeout(this.makeNewKeyTimeout);

src/matrixrtc/MatrixRTCSession.ts

@@ -296,6 +296,7 @@ export class MatrixRTCSession extends TypedEventEmitter<MatrixRTCSessionEvent, M
             | "_unstable_updateDelayedEvent"
             | "sendEvent"
             | "cancelPendingEvent"
+            | "decryptEventIfNeeded"
         >,
         private roomSubset: Pick<
             Room,

src/matrixrtc/MatrixRTCSessionManager.ts

@@ -17,7 +17,7 @@ limitations under the License.
 import { logger as rootLogger } from "../logger.ts";
 import { type MatrixClient, ClientEvent } from "../client.ts";
 import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
-import { type Room, RoomEvent } from "../models/room.ts";
+import { type Room } from "../models/room.ts";
 import { type RoomState, RoomStateEvent } from "../models/room-state.ts";
 import { type MatrixEvent } from "../models/event.ts";
 import { MatrixRTCSession } from "./MatrixRTCSession.ts";
@@ -116,14 +116,15 @@ export class MatrixRTCSessionManager extends TypedEventEmitter<MatrixRTCSessionM
 
     private refreshRoom(room: Room): void {
         const isNewSession = !this.roomSessions.has(room.roomId);
-        const sess = this.getRoomSession(room);
+        const session = this.getRoomSession(room);
 
-        const wasActiveAndKnown = sess.memberships.length > 0 && !isNewSession;
-        // TODO remove this and make the session subscribe to this manually.
-        // move away from magically called methods. Prefer explicit subscriptions.
-        sess.onRTCSessionMemberUpdate();
+        const wasActiveAndKnown = session.memberships.length > 0 && !isNewSession;
+        // TODO: we can move this directly into the rtcSession without any performacn impact.
+        // Because it is possible to subscribe to state events per room. So each session will just
+        // subscribe to only a subset of events.
+        session.onRTCSessionMemberUpdate();
 
-        const nowActive = sess.memberships.length > 0;
+        const nowActive = session.memberships.length > 0;
 
         if (wasActiveAndKnown && !nowActive) {
             this.emit(MatrixRTCSessionManagerEvents.SessionEnded, room.roomId, this.roomSessions.get(room.roomId)!);

src/matrixrtc/RoomKeyTransport.ts

@@ -23,7 +23,8 @@ import { KeyTransportEvents, KeyTransportEventsHandlerMap, type IKeyTransport }
 import { type MatrixEvent } from "../models/event.ts";
 import { type Statistics } from "./EncryptionManager.ts";
 import { type CallMembership } from "./CallMembership.ts";
-import { Room, RoomEvent, TypedEventEmitter } from "../matrix.ts";
+import { Room, RoomEvent } from "../matrix.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
 
 export class RoomKeyTransport
     extends TypedEventEmitter<KeyTransportEvents, KeyTransportEventsHandlerMap>
@@ -33,22 +34,25 @@ export class RoomKeyTransport
 
     public constructor(
         private room: Pick<Room, "on" | "off" | "roomId">,
-        private client: Pick<MatrixClient, "sendEvent" | "getDeviceId" | "getUserId" | "cancelPendingEvent">,
+        private client: Pick<
+            MatrixClient,
+            "sendEvent" | "getDeviceId" | "getUserId" | "cancelPendingEvent" | "decryptEventIfNeeded"
+        >,
         private statistics: Statistics,
     ) {
         super();
         this.prefixedLogger = logger.getChild(`[RTC: ${room.roomId} RoomKeyTransport]`);
     }
     public start(): void {
-        this.room.on(RoomEvent.Timeline, this.onTimeline);
+        this.room.on(RoomEvent.Timeline, (ev) => this.consumeCallEncryptionEvent(ev));
     }
     public stop(): void {
-        this.room.off(RoomEvent.Timeline, this.onTimeline);
+        this.room.off(RoomEvent.Timeline, (ev) => this.consumeCallEncryptionEvent(ev));
     }
 
     private async consumeCallEncryptionEvent(event: MatrixEvent, isRetry = false): Promise<void> {
-        // we should not need this
-        // await this.client.decryptEventIfNeeded(event);
+        await this.client.decryptEventIfNeeded(event);
+
         if (event.isDecryptionFailure()) {
             if (!isRetry) {
                 logger.warn(
@@ -73,9 +77,6 @@ export class RoomKeyTransport
 
         this.onEncryptionEvent(event);
     }
-    private onTimeline = (event: MatrixEvent): void => {
-        void this.consumeCallEncryptionEvent(event);
-    };
 
     /** implements {@link IKeyTransport#sendKey} */
     public async sendKey(keyBase64Encoded: string, index: number, members: CallMembership[]): Promise<void> {