matrix-js-sdk 41.8.0 → 41.9.0

package/lib/webrtc/callEventHandler.js

@@ -1,4 +1,3 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /*
 Copyright 2020 The Matrix.org Foundation C.I.C.
@@ -25,8 +24,8 @@ import { RoomEvent } from "../models/room.js";
 
 // Don't ring unless we'd be ringing for at least 3 seconds: the user needs some
 // time to press the 'accept' button
-var RING_GRACE_PERIOD = 3000;
-export var CallEventHandlerEvent = /*#__PURE__*/function (CallEventHandlerEvent) {
+const RING_GRACE_PERIOD = 3000;
+export let CallEventHandlerEvent = /*#__PURE__*/function (CallEventHandlerEvent) {
   CallEventHandlerEvent["Incoming"] = "Call.incoming";
   return CallEventHandlerEvent;
 }({});
@@ -42,7 +41,7 @@ export class CallEventHandler {
     _defineProperty(this, "eventBufferPromiseChain", void 0);
     _defineProperty(this, "onSync", () => {
       // Process the current event buffer and start queuing into a new one.
-      var currentEventBuffer = this.callEventBuffer;
+      const currentEventBuffer = this.callEventBuffer;
       this.callEventBuffer = [];
 
       // Ensure correct ordering by only processing this queue after the previous one has finished processing
@@ -56,7 +55,7 @@ export class CallEventHandler {
       this.callEventBuffer.push(event);
     });
     _defineProperty(this, "onToDeviceEvent", event => {
-      var content = event.getContent();
+      const content = event.getContent();
       if (!content.call_id) {
         this.callEventBuffer.push(event);
         return;
@@ -68,28 +67,28 @@ export class CallEventHandler {
         this.callEventBuffer.push(event);
         return;
       }
-      var nextSeq = this.nextSeqByCall.get(content.call_id) || 0;
+      const nextSeq = this.nextSeqByCall.get(content.call_id) || 0;
       if (content.seq !== nextSeq) {
         if (!this.toDeviceEventBuffers.has(content.call_id)) {
           this.toDeviceEventBuffers.set(content.call_id, []);
         }
-        var buffer = this.toDeviceEventBuffers.get(content.call_id);
-        var index = buffer.findIndex(e => e.getContent().seq > content.seq);
+        const buffer = this.toDeviceEventBuffers.get(content.call_id);
+        const index = buffer.findIndex(e => e.getContent().seq > content.seq);
         if (index === -1) {
           buffer.push(event);
         } else {
           buffer.splice(index, 0, event);
         }
       } else {
-        var callId = content.call_id;
+        const callId = content.call_id;
         this.callEventBuffer.push(event);
         this.nextSeqByCall.set(callId, content.seq + 1);
-        var _buffer = this.toDeviceEventBuffers.get(callId);
-        var nextEvent = _buffer && _buffer.shift();
+        const buffer = this.toDeviceEventBuffers.get(callId);
+        let nextEvent = buffer && buffer.shift();
         while (nextEvent && nextEvent.getContent().seq === this.nextSeqByCall.get(callId)) {
           this.callEventBuffer.push(nextEvent);
           this.nextSeqByCall.set(callId, nextEvent.getContent().seq + 1);
-          nextEvent = _buffer.shift();
+          nextEvent = buffer.shift();
         }
       }
     });
@@ -116,229 +115,218 @@ export class CallEventHandler {
     this.client.removeListener(RoomEvent.Timeline, this.onRoomTimeline);
     this.client.removeListener(ClientEvent.ToDeviceEvent, this.onToDeviceEvent);
   }
-  evaluateEventBuffer(eventBuffer) {
-    var _this = this;
-    return _asyncToGenerator(function* () {
-      yield Promise.all(eventBuffer.map(event => _this.client.decryptEventIfNeeded(event)));
-      var callEvents = eventBuffer.filter(event => {
-        var eventType = event.getType();
-        return eventType.startsWith("m.call.") || eventType.startsWith("org.matrix.call.");
-      });
-      var ignoreCallIds = new Set();
+  async evaluateEventBuffer(eventBuffer) {
+    await Promise.all(eventBuffer.map(event => this.client.decryptEventIfNeeded(event)));
+    const callEvents = eventBuffer.filter(event => {
+      const eventType = event.getType();
+      return eventType.startsWith("m.call.") || eventType.startsWith("org.matrix.call.");
+    });
+    const ignoreCallIds = new Set();
 
-      // inspect the buffer and mark all calls which have been answered
-      // or hung up before passing them to the call event handler.
-      for (var event of callEvents) {
-        var eventType = event.getType();
-        if (eventType === EventType.CallAnswer || eventType === EventType.CallHangup) {
-          ignoreCallIds.add(event.getContent().call_id);
-        }
+    // inspect the buffer and mark all calls which have been answered
+    // or hung up before passing them to the call event handler.
+    for (const event of callEvents) {
+      const eventType = event.getType();
+      if (eventType === EventType.CallAnswer || eventType === EventType.CallHangup) {
+        ignoreCallIds.add(event.getContent().call_id);
       }
+    }
 
-      // Process call events in the order that they were received
-      for (var _event of callEvents) {
-        var _eventType = _event.getType();
-        var callId = _event.getContent().call_id;
-        if (_eventType === EventType.CallInvite && ignoreCallIds.has(callId)) {
-          // This call has previously been answered or hung up: ignore it
-          continue;
-        }
-        try {
-          yield _this.handleCallEvent(_event);
-        } catch (e) {
-          logger.error("CallEventHandler evaluateEventBuffer() caught exception handling call event", e);
-        }
+    // Process call events in the order that they were received
+    for (const event of callEvents) {
+      const eventType = event.getType();
+      const callId = event.getContent().call_id;
+      if (eventType === EventType.CallInvite && ignoreCallIds.has(callId)) {
+        // This call has previously been answered or hung up: ignore it
+        continue;
       }
-    })();
+      try {
+        await this.handleCallEvent(event);
+      } catch (e) {
+        logger.error("CallEventHandler evaluateEventBuffer() caught exception handling call event", e);
+      }
+    }
   }
-  handleCallEvent(event) {
-    var _this2 = this;
-    return _asyncToGenerator(function* () {
-      var _getGroupCallById;
-      _this2.client.emit(ClientEvent.ReceivedVoipEvent, event);
-      var content = event.getContent();
-      var callRoomId = event.getRoomId() || ((_getGroupCallById = _this2.client.groupCallEventHandler.getGroupCallById(content.conf_id)) === null || _getGroupCallById === void 0 || (_getGroupCallById = _getGroupCallById.room) === null || _getGroupCallById === void 0 ? void 0 : _getGroupCallById.roomId);
-      var groupCallId = content.conf_id;
-      var type = event.getType();
-      var senderId = event.getSender();
-      var call = content.call_id ? _this2.calls.get(content.call_id) : undefined;
-      var opponentDeviceId;
-      var groupCall;
-      if (groupCallId) {
-        groupCall = _this2.client.groupCallEventHandler.getGroupCallById(groupCallId);
-        if (!groupCall) {
-          logger.warn("CallEventHandler handleCallEvent() could not find a group call - ignoring event (groupCallId=".concat(groupCallId, ", type=").concat(type, ")"));
-          return;
-        }
-        opponentDeviceId = content.device_id;
-        if (!opponentDeviceId) {
-          logger.warn("CallEventHandler handleCallEvent() could not find a device id - ignoring event (senderId=".concat(senderId, ")"));
-          groupCall.emit(GroupCallEvent.Error, new GroupCallUnknownDeviceError(senderId));
-          return;
-        }
-        if (content.dest_session_id !== _this2.client.getSessionId()) {
-          logger.warn("CallEventHandler handleCallEvent() call event does not match current session id - ignoring");
-          return;
-        }
+  async handleCallEvent(event) {
+    this.client.emit(ClientEvent.ReceivedVoipEvent, event);
+    const content = event.getContent();
+    const callRoomId = event.getRoomId() || this.client.groupCallEventHandler.getGroupCallById(content.conf_id)?.room?.roomId;
+    const groupCallId = content.conf_id;
+    const type = event.getType();
+    const senderId = event.getSender();
+    let call = content.call_id ? this.calls.get(content.call_id) : undefined;
+    let opponentDeviceId;
+    let groupCall;
+    if (groupCallId) {
+      groupCall = this.client.groupCallEventHandler.getGroupCallById(groupCallId);
+      if (!groupCall) {
+        logger.warn(`CallEventHandler handleCallEvent() could not find a group call - ignoring event (groupCallId=${groupCallId}, type=${type})`);
+        return;
       }
-      var weSentTheEvent = senderId === _this2.client.credentials.userId && (opponentDeviceId === undefined || opponentDeviceId === _this2.client.getDeviceId());
-      if (!callRoomId) return;
-      if (type === EventType.CallInvite) {
-        var _this2$client$getTurn, _createNewMatrixCall, _groupCall;
-        // ignore invites you send
-        if (weSentTheEvent) return;
-        // expired call
-        if (event.getLocalAge() > content.lifetime - RING_GRACE_PERIOD) return;
-        // stale/old invite event
-        if (call && call.state === CallState.Ended) return;
-        if (call) {
-          logger.warn("CallEventHandler handleCallEvent() already has a call but got an invite - clobbering (callId=".concat(content.call_id, ")"));
-        }
-        if (content.invitee && content.invitee !== _this2.client.getUserId()) {
-          return; // This invite was meant for another user in the room
-        }
-        var timeUntilTurnCresExpire = ((_this2$client$getTurn = _this2.client.getTurnServersExpiry()) !== null && _this2$client$getTurn !== void 0 ? _this2$client$getTurn : 0) - Date.now();
-        logger.info("CallEventHandler handleCallEvent() current turn creds expire in " + timeUntilTurnCresExpire + " ms");
-        call = (_createNewMatrixCall = createNewMatrixCall(_this2.client, callRoomId, {
-          forceTURN: _this2.client.forceTURN,
-          opponentDeviceId,
-          groupCallId,
-          opponentSessionId: content.sender_session_id
-        })) !== null && _createNewMatrixCall !== void 0 ? _createNewMatrixCall : undefined;
-        if (!call) {
-          logger.log("CallEventHandler handleCallEvent() this client does not support WebRTC (callId=".concat(content.call_id, ")"));
-          // don't hang up the call: there could be other clients
-          // connected that do support WebRTC and declining the
-          // the call on their behalf would be really annoying.
-          return;
-        }
-        call.callId = content.call_id;
-        var stats = (_groupCall = groupCall) === null || _groupCall === void 0 ? void 0 : _groupCall.getGroupCallStats();
-        if (stats) {
-          call.initStats(stats);
-        }
-        try {
-          yield call.initWithInvite(event);
-        } catch (e) {
-          if (e instanceof CallError) {
-            if (e.code === GroupCallErrorCode.UnknownDevice) {
-              var _groupCall2;
-              (_groupCall2 = groupCall) === null || _groupCall2 === void 0 || _groupCall2.emit(GroupCallEvent.Error, e);
-            } else {
-              logger.error(e);
-            }
+      opponentDeviceId = content.device_id;
+      if (!opponentDeviceId) {
+        logger.warn(`CallEventHandler handleCallEvent() could not find a device id - ignoring event (senderId=${senderId})`);
+        groupCall.emit(GroupCallEvent.Error, new GroupCallUnknownDeviceError(senderId));
+        return;
+      }
+      if (content.dest_session_id !== this.client.getSessionId()) {
+        logger.warn("CallEventHandler handleCallEvent() call event does not match current session id - ignoring");
+        return;
+      }
+    }
+    const weSentTheEvent = senderId === this.client.credentials.userId && (opponentDeviceId === undefined || opponentDeviceId === this.client.getDeviceId());
+    if (!callRoomId) return;
+    if (type === EventType.CallInvite) {
+      // ignore invites you send
+      if (weSentTheEvent) return;
+      // expired call
+      if (event.getLocalAge() > content.lifetime - RING_GRACE_PERIOD) return;
+      // stale/old invite event
+      if (call && call.state === CallState.Ended) return;
+      if (call) {
+        logger.warn(`CallEventHandler handleCallEvent() already has a call but got an invite - clobbering (callId=${content.call_id})`);
+      }
+      if (content.invitee && content.invitee !== this.client.getUserId()) {
+        return; // This invite was meant for another user in the room
+      }
+      const timeUntilTurnCresExpire = (this.client.getTurnServersExpiry() ?? 0) - Date.now();
+      logger.info("CallEventHandler handleCallEvent() current turn creds expire in " + timeUntilTurnCresExpire + " ms");
+      call = createNewMatrixCall(this.client, callRoomId, {
+        forceTURN: this.client.forceTURN,
+        opponentDeviceId,
+        groupCallId,
+        opponentSessionId: content.sender_session_id
+      }) ?? undefined;
+      if (!call) {
+        logger.log(`CallEventHandler handleCallEvent() this client does not support WebRTC (callId=${content.call_id})`);
+        // don't hang up the call: there could be other clients
+        // connected that do support WebRTC and declining the
+        // the call on their behalf would be really annoying.
+        return;
+      }
+      call.callId = content.call_id;
+      const stats = groupCall?.getGroupCallStats();
+      if (stats) {
+        call.initStats(stats);
+      }
+      try {
+        await call.initWithInvite(event);
+      } catch (e) {
+        if (e instanceof CallError) {
+          if (e.code === GroupCallErrorCode.UnknownDevice) {
+            groupCall?.emit(GroupCallEvent.Error, e);
+          } else {
+            logger.error(e);
           }
         }
-        _this2.calls.set(call.callId, call);
+      }
+      this.calls.set(call.callId, call);
 
-        // if we stashed candidate events for that call ID, play them back now
-        if (_this2.candidateEventsByCall.get(call.callId)) {
-          for (var ev of _this2.candidateEventsByCall.get(call.callId)) {
-            call.onRemoteIceCandidatesReceived(ev);
-          }
+      // if we stashed candidate events for that call ID, play them back now
+      if (this.candidateEventsByCall.get(call.callId)) {
+        for (const ev of this.candidateEventsByCall.get(call.callId)) {
+          call.onRemoteIceCandidatesReceived(ev);
         }
+      }
 
-        // Were we trying to call that user (room)?
-        var existingCall;
-        for (var thisCall of _this2.calls.values()) {
-          var _call$getOpponentMemb;
-          var isCalling = [CallState.WaitLocalMedia, CallState.CreateOffer, CallState.InviteSent].includes(thisCall.state);
-          if (call.roomId === thisCall.roomId && thisCall.direction === CallDirection.Outbound && ((_call$getOpponentMemb = call.getOpponentMember()) === null || _call$getOpponentMemb === void 0 ? void 0 : _call$getOpponentMemb.userId) === thisCall.invitee && isCalling) {
-            existingCall = thisCall;
-            break;
-          }
+      // Were we trying to call that user (room)?
+      let existingCall;
+      for (const thisCall of this.calls.values()) {
+        const isCalling = [CallState.WaitLocalMedia, CallState.CreateOffer, CallState.InviteSent].includes(thisCall.state);
+        if (call.roomId === thisCall.roomId && thisCall.direction === CallDirection.Outbound && call.getOpponentMember()?.userId === thisCall.invitee && isCalling) {
+          existingCall = thisCall;
+          break;
         }
-        if (existingCall) {
-          if (existingCall.callId > call.callId) {
-            logger.log("CallEventHandler handleCallEvent() detected glare - answering incoming call and canceling outgoing call (incomingId=".concat(call.callId, ", outgoingId=").concat(existingCall.callId, ")"));
-            existingCall.replacedBy(call);
-          } else {
-            logger.log("CallEventHandler handleCallEvent() detected glare - hanging up incoming call (incomingId=".concat(call.callId, ", outgoingId=").concat(existingCall.callId, ")"));
-            call.hangup(CallErrorCode.Replaced, true);
-          }
+      }
+      if (existingCall) {
+        if (existingCall.callId > call.callId) {
+          logger.log(`CallEventHandler handleCallEvent() detected glare - answering incoming call and canceling outgoing call (incomingId=${call.callId}, outgoingId=${existingCall.callId})`);
+          existingCall.replacedBy(call);
         } else {
-          _this2.client.emit(CallEventHandlerEvent.Incoming, call);
+          logger.log(`CallEventHandler handleCallEvent() detected glare - hanging up incoming call (incomingId=${call.callId}, outgoingId=${existingCall.callId})`);
+          call.hangup(CallErrorCode.Replaced, true);
         }
-        return;
-      } else if (type === EventType.CallCandidates) {
-        if (weSentTheEvent) return;
-        if (!call) {
-          // store the candidates; we may get a call eventually.
-          if (!_this2.candidateEventsByCall.has(content.call_id)) {
-            _this2.candidateEventsByCall.set(content.call_id, []);
-          }
-          _this2.candidateEventsByCall.get(content.call_id).push(event);
-        } else {
-          call.onRemoteIceCandidatesReceived(event);
+      } else {
+        this.client.emit(CallEventHandlerEvent.Incoming, call);
+      }
+      return;
+    } else if (type === EventType.CallCandidates) {
+      if (weSentTheEvent) return;
+      if (!call) {
+        // store the candidates; we may get a call eventually.
+        if (!this.candidateEventsByCall.has(content.call_id)) {
+          this.candidateEventsByCall.set(content.call_id, []);
         }
-        return;
-      } else if ([EventType.CallHangup, EventType.CallReject].includes(type)) {
-        // Note that we also observe our own hangups here so we can see
-        // if we've already rejected a call that would otherwise be valid
-        if (!call) {
-          var _createNewMatrixCall2;
-          // if not live, store the fact that the call has ended because
-          // we're probably getting events backwards so
-          // the hangup will come before the invite
-          call = (_createNewMatrixCall2 = createNewMatrixCall(_this2.client, callRoomId, {
-            opponentDeviceId,
-            opponentSessionId: content.sender_session_id
-          })) !== null && _createNewMatrixCall2 !== void 0 ? _createNewMatrixCall2 : undefined;
-          if (call) {
-            call.callId = content.call_id;
-            call.initWithHangup(event);
-            _this2.calls.set(content.call_id, call);
+        this.candidateEventsByCall.get(content.call_id).push(event);
+      } else {
+        call.onRemoteIceCandidatesReceived(event);
+      }
+      return;
+    } else if ([EventType.CallHangup, EventType.CallReject].includes(type)) {
+      // Note that we also observe our own hangups here so we can see
+      // if we've already rejected a call that would otherwise be valid
+      if (!call) {
+        // if not live, store the fact that the call has ended because
+        // we're probably getting events backwards so
+        // the hangup will come before the invite
+        call = createNewMatrixCall(this.client, callRoomId, {
+          opponentDeviceId,
+          opponentSessionId: content.sender_session_id
+        }) ?? undefined;
+        if (call) {
+          call.callId = content.call_id;
+          call.initWithHangup(event);
+          this.calls.set(content.call_id, call);
+        }
+      } else {
+        if (call.state !== CallState.Ended) {
+          if (type === EventType.CallHangup) {
+            call.onHangupReceived(content);
+          } else {
+            call.onRejectReceived(content);
           }
-        } else {
-          if (call.state !== CallState.Ended) {
-            if (type === EventType.CallHangup) {
-              call.onHangupReceived(content);
-            } else {
-              call.onRejectReceived(content);
-            }
 
-            // @ts-expect-error typescript thinks the state can't be 'ended' because we're
-            // inside the if block where it wasn't, but it could have changed because
-            // on[Hangup|Reject]Received are side-effecty.
-            if (call.state === CallState.Ended) _this2.calls.delete(content.call_id);
-          }
+          // @ts-expect-error typescript thinks the state can't be 'ended' because we're
+          // inside the if block where it wasn't, but it could have changed because
+          // on[Hangup|Reject]Received are side-effecty.
+          if (call.state === CallState.Ended) this.calls.delete(content.call_id);
         }
-        return;
       }
+      return;
+    }
 
-      // The following events need a call and a peer connection
-      if (!call || !call.hasPeerConnection) {
-        logger.info("CallEventHandler handleCallEvent() discarding possible call event as we don't have a call (type=".concat(type, ")"));
-        return;
-      }
-      // Ignore remote echo
-      if (event.getContent().party_id === call.ourPartyId) return;
-      switch (type) {
-        case EventType.CallAnswer:
-          if (weSentTheEvent) {
-            if (call.state === CallState.Ringing) {
-              call.onAnsweredElsewhere(content);
-            }
-          } else {
-            call.onAnswerReceived(event);
+    // The following events need a call and a peer connection
+    if (!call || !call.hasPeerConnection) {
+      logger.info(`CallEventHandler handleCallEvent() discarding possible call event as we don't have a call (type=${type})`);
+      return;
+    }
+    // Ignore remote echo
+    if (event.getContent().party_id === call.ourPartyId) return;
+    switch (type) {
+      case EventType.CallAnswer:
+        if (weSentTheEvent) {
+          if (call.state === CallState.Ringing) {
+            call.onAnsweredElsewhere(content);
           }
-          break;
-        case EventType.CallSelectAnswer:
-          call.onSelectAnswerReceived(event);
-          break;
-        case EventType.CallNegotiate:
-          call.onNegotiateReceived(event);
-          break;
-        case EventType.CallAssertedIdentity:
-        case EventType.CallAssertedIdentityPrefix:
-          call.onAssertedIdentityReceived(event);
-          break;
-        case EventType.CallSDPStreamMetadataChanged:
-        case EventType.CallSDPStreamMetadataChangedPrefix:
-          call.onSDPStreamMetadataChangedReceived(event);
-          break;
-      }
-    })();
+        } else {
+          call.onAnswerReceived(event);
+        }
+        break;
+      case EventType.CallSelectAnswer:
+        call.onSelectAnswerReceived(event);
+        break;
+      case EventType.CallNegotiate:
+        call.onNegotiateReceived(event);
+        break;
+      case EventType.CallAssertedIdentity:
+      case EventType.CallAssertedIdentityPrefix:
+        call.onAssertedIdentityReceived(event);
+        break;
+      case EventType.CallSDPStreamMetadataChanged:
+      case EventType.CallSDPStreamMetadataChangedPrefix:
+        call.onSDPStreamMetadataChangedReceived(event);
+        break;
+    }
   }
 }
 //# sourceMappingURL=callEventHandler.js.map