livekit-client 1.6.6 → 1.6.7

package/dist/livekit-client.esm.mjs

@@ -13800,7 +13800,7 @@ var uaParser = {
 })(uaParser, uaParserExports);
 var UAParser = uaParserExports;
 
-var version$1 = "1.6.6";
+var version$1 = "1.6.7";
 
 const version = version$1;
 const protocolVersion = 8;
@@ -14781,7 +14781,8 @@ class Track extends eventsExports.EventEmitter {
     this.attachedElements = [];
     this.isMuted = false;
     /**
-     * indicates current state of stream
+     * indicates current state of stream, it'll indicate `paused` if the track
+     * has been paused by congestion controller
      */
     this.streamState = Track.StreamState.Active;
     this._currentBitrate = 0;
@@ -16115,9 +16116,6 @@ class RemoteVideoTrack extends RemoteTrack {
       this.updateDimensions();
     }, REACTION_DELAY);
     this.adaptiveStreamSettings = adaptiveStreamSettings;
-    if (this.isAdaptiveStream) {
-      this.streamState = Track.StreamState.Paused;
-    }
   }
   get isAdaptiveStream() {
     return this.adaptiveStreamSettings !== undefined;
@@ -17023,8 +17021,8 @@ function sortPresets(presets) {
 }
 
 class RemoteTrackPublication extends TrackPublication {
-  constructor(kind, id, name, autoSubscribe) {
-    super(kind, id, name);
+  constructor(kind, ti, autoSubscribe) {
+    super(kind, ti.sid, ti.name);
     this.track = undefined;
     /** @internal */
     this.allowed = true;
@@ -17049,6 +17047,7 @@ class RemoteTrackPublication extends TrackPublication {
       this.emitTrackUpdate();
     };
     this.subscribed = autoSubscribe;
+    this.updateInfo(ti);
   }
   /**
    * Subscribe or unsubscribe to this remote track
@@ -17415,12 +17414,12 @@ class RemoteParticipant extends Participant {
         if (!kind) {
           return;
         }
-        publication = new RemoteTrackPublication(kind, ti.sid, ti.name, (_a = this.signalClient.connectOptions) === null || _a === void 0 ? void 0 : _a.autoSubscribe);
+        publication = new RemoteTrackPublication(kind, ti, (_a = this.signalClient.connectOptions) === null || _a === void 0 ? void 0 : _a.autoSubscribe);
         publication.updateInfo(ti);
         newTracks.set(ti.sid, publication);
         const existingTrackOfSource = Array.from(this.tracks.values()).find(publishedTrack => publishedTrack.source === (publication === null || publication === void 0 ? void 0 : publication.source));
         if (existingTrackOfSource && publication.source !== Track.Source.Unknown) {
-          livekitLogger.warn("received a second track publication for ".concat(this.identity, " with the same source: ").concat(publication.source), {
+          livekitLogger.debug("received a second track publication for ".concat(this.identity, " with the same source: ").concat(publication.source), {
             oldTrack: existingTrackOfSource,
             newTrack: publication,
             participant: this,
@@ -17928,7 +17927,7 @@ class LocalParticipant extends Participant {
    * @param options
    */
   async publishTrack(track, options) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     // convert raw media track into audio or video track
     if (track instanceof MediaStreamTrack) {
       switch (track.kind) {
@@ -17953,7 +17952,11 @@ class LocalParticipant extends Participant {
       if (options.dtx === undefined) {
         livekitLogger.info("Opus DTX will be disabled for stereo tracks by default. Enable them explicitly to make it work.");
       }
+      if (options.red === undefined) {
+        livekitLogger.info("Opus RED will be disabled for stereo tracks by default. Enable them explicitly to make it work.");
+      }
       (_a = options.dtx) !== null && _a !== void 0 ? _a : options.dtx = false;
+      (_b = options.red) !== null && _b !== void 0 ? _b : options.red = false;
     }
     const opts = _objectSpread2(_objectSpread2({}, this.roomOptions.publishDefaults), options);
     // is it already published? if so skip
@@ -18011,9 +18014,9 @@ class LocalParticipant extends Participant {
       type: Track.kindToProto(track.kind),
       muted: track.isMuted,
       source: Track.sourceToProto(track.source),
-      disableDtx: !((_b = opts.dtx) !== null && _b !== void 0 ? _b : true),
+      disableDtx: !((_c = opts.dtx) !== null && _c !== void 0 ? _c : true),
       stereo: isStereo,
-      disableRed: !((_c = opts.red) !== null && _c !== void 0 ? _c : true)
+      disableRed: !((_d = opts.red) !== null && _d !== void 0 ? _d : true)
     });
     // compute encodings and layers for video
     let encodings;
@@ -18036,7 +18039,7 @@ class LocalParticipant extends Participant {
       if (track instanceof LocalVideoTrack) {
         if ((opts === null || opts === void 0 ? void 0 : opts.videoCodec) === 'av1') {
           // set scalabilityMode to 'L3T3' by default
-          opts.scalabilityMode = (_d = opts.scalabilityMode) !== null && _d !== void 0 ? _d : 'L3T3';
+          opts.scalabilityMode = (_e = opts.scalabilityMode) !== null && _e !== void 0 ? _e : 'L3T3';
         }
         // set up backup
         if (opts.videoCodec && opts.backupCodec && opts.videoCodec !== opts.backupCodec.codec) {
@@ -18078,7 +18081,7 @@ class LocalParticipant extends Participant {
     });
     // store RTPSender
     track.sender = await this.engine.createSender(track, opts, encodings);
-    if (track.codec === 'av1' && encodings && ((_e = encodings[0]) === null || _e === void 0 ? void 0 : _e.maxBitrate)) {
+    if (track.codec === 'av1' && encodings && ((_f = encodings[0]) === null || _f === void 0 ? void 0 : _f.maxBitrate)) {
       this.engine.publisher.setTrackCodecBitrate(req.cid, track.codec, encodings[0].maxBitrate / 1000);
     }
     this.engine.negotiate();
@@ -18174,13 +18177,20 @@ class LocalParticipant extends Participant {
     if (stopOnUnpublish) {
       track.stop();
     }
-    if (this.engine.publisher && this.engine.publisher.pc.connectionState !== 'closed' && track.sender) {
+    let negotiationNeeded = false;
+    const trackSender = track.sender;
+    track.sender = undefined;
+    if (this.engine.publisher && this.engine.publisher.pc.connectionState !== 'closed' && trackSender) {
       try {
-        this.engine.removeTrack(track.sender);
+        if (this.engine.removeTrack(trackSender)) {
+          negotiationNeeded = true;
+        }
         if (track instanceof LocalVideoTrack) {
           for (const [, trackInfo] of track.simulcastCodecs) {
             if (trackInfo.sender) {
-              this.engine.removeTrack(trackInfo.sender);
+              if (this.engine.removeTrack(trackInfo.sender)) {
+                negotiationNeeded = true;
+              }
               trackInfo.sender = undefined;
             }
           }
@@ -18191,11 +18201,8 @@ class LocalParticipant extends Participant {
           error: e,
           method: 'unpublishTrack'
         });
-      } finally {
-        await this.engine.negotiate();
       }
     }
-    track.sender = undefined;
     // remove from our maps
     this.tracks.delete(publication.trackSid);
     switch (publication.kind) {
@@ -18208,6 +18215,9 @@ class LocalParticipant extends Participant {
     }
     this.emit(ParticipantEvent.LocalTrackUnpublished, publication);
     publication.setTrack(undefined);
+    if (negotiationNeeded) {
+      await this.engine.negotiate();
+    }
     return publication;
   }
   async unpublishTracks(tracks) {
@@ -19757,6 +19767,8 @@ class PCTransport extends eventsExports {
     });
   }
   close() {
+    this.pc.onconnectionstatechange = null;
+    this.pc.oniceconnectionstatechange = null;
     this.pc.close();
   }
   async setMungedLocalDescription(sd, munged) {
@@ -19875,9 +19887,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     return this._isClosed;
   }
   constructor(options) {
-    var _this;
     super();
-    _this = this;
     this.options = options;
     this.rtcConfig = {};
     this.peerConnectionTimeout = roomConnectOptionDefaults.peerConnectionTimeout;
@@ -19896,6 +19906,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     this.joinAttempts = 0;
     /** specifies how often an initial join connection is allowed to retry */
     this.maxJoinAttempts = 1;
+    this.shouldFailNext = false;
     this.handleDataChannel = async _ref => {
       let {
         channel
@@ -19948,26 +19959,24 @@ class RTCEngine extends eventsExports.EventEmitter {
     // websocket reconnect behavior. if websocket is interrupted, and the PeerConnection
     // continues to work, we can reconnect to websocket to continue the session
     // after a number of retries, we'll close and give up permanently
-    this.handleDisconnect = function (connection) {
-      let signalEvents = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-      let disconnectReason = arguments.length > 2 ? arguments[2] : undefined;
-      if (_this._isClosed) {
+    this.handleDisconnect = (connection, disconnectReason) => {
+      if (this._isClosed) {
         return;
       }
       livekitLogger.warn("".concat(connection, " disconnected"));
-      if (_this.reconnectAttempts === 0) {
+      if (this.reconnectAttempts === 0) {
         // only reset start time on the first try
-        _this.reconnectStart = Date.now();
+        this.reconnectStart = Date.now();
       }
       const disconnect = duration => {
-        livekitLogger.warn("could not recover connection after ".concat(_this.reconnectAttempts, " attempts, ").concat(duration, "ms. giving up"));
-        _this.emit(EngineEvent.Disconnected);
-        _this.close();
+        livekitLogger.warn("could not recover connection after ".concat(this.reconnectAttempts, " attempts, ").concat(duration, "ms. giving up"));
+        this.emit(EngineEvent.Disconnected);
+        this.close();
       };
-      const duration = Date.now() - _this.reconnectStart;
-      let delay = _this.getNextRetryDelay({
+      const duration = Date.now() - this.reconnectStart;
+      let delay = this.getNextRetryDelay({
         elapsedMs: duration,
-        retryCount: _this.reconnectAttempts
+        retryCount: this.reconnectAttempts
       });
       if (delay === null) {
         disconnect(duration);
@@ -19977,14 +19986,14 @@ class RTCEngine extends eventsExports.EventEmitter {
         delay = 0;
       }
       livekitLogger.debug("reconnecting in ".concat(delay, "ms"));
-      _this.clearReconnectTimeout();
-      _this.reconnectTimeout = CriticalTimers.setTimeout(() => _this.attemptReconnect(signalEvents, disconnectReason), delay);
+      this.clearReconnectTimeout();
+      this.reconnectTimeout = CriticalTimers.setTimeout(() => this.attemptReconnect(disconnectReason), delay);
     };
     this.handleBrowserOnLine = () => {
       // in case the engine is currently reconnecting, attempt a reconnect immediately after the browser state has changed to 'onLine'
       if (this.client.isReconnecting) {
         this.clearReconnectTimeout();
-        this.attemptReconnect(true, ReconnectReason.REASON_SIGNAL_DISCONNECTED);
+        this.attemptReconnect(ReconnectReason.REASON_SIGNAL_DISCONNECTED);
       }
     };
     this.client = new SignalClient();
@@ -20083,6 +20092,12 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.client.sendAddTrack(req);
     });
   }
+  /**
+   * Removes sender from PeerConnection, returning true if it was removed successfully
+   * and a negotiation is necessary
+   * @param sender
+   * @returns
+   */
   removeTrack(sender) {
     var _a;
     if (sender.track && this.pendingTrackResolvers[sender.track.id]) {
@@ -20096,12 +20111,14 @@ class RTCEngine extends eventsExports.EventEmitter {
     }
     try {
       (_a = this.publisher) === null || _a === void 0 ? void 0 : _a.pc.removeTrack(sender);
+      return true;
     } catch (e) {
       livekitLogger.warn('failed to remove track', {
         error: e,
         method: 'removeTrack'
       });
     }
+    return false;
   }
   updateMuteStatus(trackSid, muted) {
     this.client.sendMuteTrack(trackSid, muted);
@@ -20110,8 +20127,11 @@ class RTCEngine extends eventsExports.EventEmitter {
     var _a;
     return (_a = this.reliableDCSub) === null || _a === void 0 ? void 0 : _a.readyState;
   }
-  get connectedServerAddress() {
-    return this.connectedServerAddr;
+  async getConnectedServerAddress() {
+    if (this.primaryPC === undefined) {
+      return undefined;
+    }
+    return getConnectedAddress(this.primaryPC);
   }
   configure(joinResponse) {
     var _a;
@@ -20149,13 +20169,6 @@ class RTCEngine extends eventsExports.EventEmitter {
     primaryPC.onconnectionstatechange = async () => {
       livekitLogger.debug("primary PC state changed ".concat(primaryPC.connectionState));
       if (primaryPC.connectionState === 'connected') {
-        try {
-          this.connectedServerAddr = await getConnectedAddress(primaryPC);
-        } catch (e) {
-          livekitLogger.warn('could not get connected server address', {
-            error: e
-          });
-        }
         const shouldEmit = this.pcState === PCState.New;
         this.pcState = PCState.Connected;
         if (shouldEmit) {
@@ -20165,7 +20178,7 @@ class RTCEngine extends eventsExports.EventEmitter {
         // on Safari, PeerConnection will switch to 'disconnected' during renegotiation
         if (this.pcState === PCState.Connected) {
           this.pcState = PCState.Disconnected;
-          this.handleDisconnect('primary peerconnection', false, subscriberPrimary ? ReconnectReason.REASON_SUBSCRIBER_FAILED : ReconnectReason.REASON_PUBLISHER_FAILED);
+          this.handleDisconnect('primary peerconnection', subscriberPrimary ? ReconnectReason.REASON_SUBSCRIBER_FAILED : ReconnectReason.REASON_PUBLISHER_FAILED);
         }
       }
     };
@@ -20173,7 +20186,7 @@ class RTCEngine extends eventsExports.EventEmitter {
       livekitLogger.debug("secondary PC state changed ".concat(secondaryPC.connectionState));
       // also reconnect if secondary peerconnection fails
       if (secondaryPC.connectionState === 'failed') {
-        this.handleDisconnect('secondary peerconnection', false, subscriberPrimary ? ReconnectReason.REASON_PUBLISHER_FAILED : ReconnectReason.REASON_SUBSCRIBER_FAILED);
+        this.handleDisconnect('secondary peerconnection', subscriberPrimary ? ReconnectReason.REASON_PUBLISHER_FAILED : ReconnectReason.REASON_SUBSCRIBER_FAILED);
       }
     };
     this.subscriber.pc.ontrack = ev => {
@@ -20236,7 +20249,7 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.token = token;
     };
     this.client.onClose = () => {
-      this.handleDisconnect('signal', false, ReconnectReason.REASON_SIGNAL_DISCONNECTED);
+      this.handleDisconnect('signal', ReconnectReason.REASON_SIGNAL_DISCONNECTED);
     };
     this.client.onLeave = leave => {
       if (leave === null || leave === void 0 ? void 0 : leave.canReconnect) {
@@ -20410,9 +20423,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     }
     return this.publisher.pc.addTrack(track);
   }
-  async attemptReconnect() {
-    let signalEvents = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
-    let reason = arguments.length > 1 ? arguments[1] : undefined;
+  async attemptReconnect(reason) {
     var _a, _b, _c;
     if (this._isClosed) {
       return;
@@ -20430,17 +20441,15 @@ class RTCEngine extends eventsExports.EventEmitter {
     try {
       this.attemptingReconnect = true;
       if (this.fullReconnectOnNext) {
-        await this.restartConnection(signalEvents);
+        await this.restartConnection();
       } else {
-        await this.resumeConnection(signalEvents, reason);
+        await this.resumeConnection(reason);
       }
       this.clearPendingReconnect();
       this.fullReconnectOnNext = false;
     } catch (e) {
       this.reconnectAttempts += 1;
-      let reconnectRequired = false;
       let recoverable = true;
-      let requireSignalEvents = false;
       if (e instanceof UnexpectedConnectionState) {
         livekitLogger.debug('received unrecoverable error', {
           error: e
@@ -20449,16 +20458,10 @@ class RTCEngine extends eventsExports.EventEmitter {
         recoverable = false;
       } else if (!(e instanceof SignalReconnectError)) {
         // cannot resume
-        reconnectRequired = true;
-      }
-      // when we flip from resume to reconnect
-      // we need to fire the right reconnecting events
-      if (reconnectRequired && !this.fullReconnectOnNext) {
         this.fullReconnectOnNext = true;
-        requireSignalEvents = true;
       }
       if (recoverable) {
-        this.handleDisconnect('reconnect', requireSignalEvents, ReconnectReason.REASON_UNKOWN);
+        this.handleDisconnect('reconnect', ReconnectReason.REASON_UNKOWN);
       } else {
         livekitLogger.info("could not recover connection after ".concat(this.reconnectAttempts, " attempts, ").concat(Date.now() - this.reconnectStart, "ms. giving up"));
         this.emit(EngineEvent.Disconnected);
@@ -20480,16 +20483,13 @@ class RTCEngine extends eventsExports.EventEmitter {
     return null;
   }
   async restartConnection() {
-    let emitRestarting = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     var _a, _b;
     if (!this.url || !this.token) {
       // permanent failure, don't attempt reconnection
       throw new UnexpectedConnectionState('could not reconnect, url or token not saved');
     }
     livekitLogger.info("reconnecting, attempt: ".concat(this.reconnectAttempts));
-    if (emitRestarting || this.reconnectAttempts === 0) {
-      this.emit(EngineEvent.Restarting);
-    }
+    this.emit(EngineEvent.Restarting);
     if (this.client.isConnected) {
       await this.client.sendLeave();
     }
@@ -20509,14 +20509,16 @@ class RTCEngine extends eventsExports.EventEmitter {
     } catch (e) {
       throw new SignalReconnectError();
     }
+    if (this.shouldFailNext) {
+      this.shouldFailNext = false;
+      throw new Error('simulated failure');
+    }
     await this.waitForPCConnected();
     this.client.setReconnected();
     // reconnect success
     this.emit(EngineEvent.Restarted, joinResponse);
   }
-  async resumeConnection() {
-    let emitResuming = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
-    let reason = arguments.length > 1 ? arguments[1] : undefined;
+  async resumeConnection(reason) {
     var _a;
     if (!this.url || !this.token) {
       // permanent failure, don't attempt reconnection
@@ -20527,9 +20529,7 @@ class RTCEngine extends eventsExports.EventEmitter {
       throw new UnexpectedConnectionState('publisher and subscriber connections unset');
     }
     livekitLogger.info("resuming signal connection, attempt ".concat(this.reconnectAttempts));
-    if (emitResuming || this.reconnectAttempts === 0) {
-      this.emit(EngineEvent.Resuming);
-    }
+    this.emit(EngineEvent.Resuming);
     try {
       const res = await this.client.reconnect(this.url, this.token, this.participantSid, reason);
       if (res) {
@@ -20545,6 +20545,10 @@ class RTCEngine extends eventsExports.EventEmitter {
       throw new SignalReconnectError(message);
     }
     this.emit(EngineEvent.SignalResumed);
+    if (this.shouldFailNext) {
+      this.shouldFailNext = false;
+      throw new Error('simulated failure');
+    }
     this.subscriber.restartingIce = true;
     // only restart publisher if it's needed
     if (this.hasPublished) {
@@ -20578,13 +20582,6 @@ class RTCEngine extends eventsExports.EventEmitter {
       // manually
       now - startTime > minReconnectWait && ((_a = this.primaryPC) === null || _a === void 0 ? void 0 : _a.connectionState) === 'connected') {
         this.pcState = PCState.Connected;
-        try {
-          this.connectedServerAddr = await getConnectedAddress(this.primaryPC);
-        } catch (e) {
-          livekitLogger.warn('could not get connected server address', {
-            error: e
-          });
-        }
       }
       if (this.pcState === PCState.Connected) {
         return;
@@ -20656,7 +20653,7 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.on(EngineEvent.Closing, handleClosed);
       const negotiationTimeout = setTimeout(() => {
         reject('negotiation timed out');
-        this.handleDisconnect('negotiation', false, ReconnectReason.REASON_SIGNAL_DISCONNECTED);
+        this.handleDisconnect('negotiation', ReconnectReason.REASON_SIGNAL_DISCONNECTED);
       }, this.peerConnectionTimeout);
       const cleanup = () => {
         clearTimeout(negotiationTimeout);
@@ -20675,7 +20672,7 @@ class RTCEngine extends eventsExports.EventEmitter {
         if (e instanceof NegotiationError) {
           this.fullReconnectOnNext = true;
         }
-        this.handleDisconnect('negotiation', false, ReconnectReason.REASON_UNKOWN);
+        this.handleDisconnect('negotiation', ReconnectReason.REASON_UNKOWN);
       });
     });
   }
@@ -20696,6 +20693,11 @@ class RTCEngine extends eventsExports.EventEmitter {
       }
     }
   }
+  /* @internal */
+  failNext() {
+    // debugging method to fail the next reconnect/resume attempt
+    this.shouldFailNext = true;
+  }
   clearReconnectTimeout() {
     if (this.reconnectTimeout) {
       CriticalTimers.clearTimeout(this.reconnectTimeout);
@@ -21015,6 +21017,9 @@ class Room extends eventsExports.EventEmitter {
             });
             await track.restartTrack();
           }
+          livekitLogger.debug('publishing new track', {
+            track: pub.trackSid
+          });
           await this.localParticipant.publishTrack(track, pub.options);
         }
       }));
@@ -21337,6 +21342,13 @@ class Room extends eventsExports.EventEmitter {
           }
         });
         break;
+      case 'resume-reconnect':
+        this.engine.failNext();
+        await this.engine.client.close();
+        if (this.engine.client.onClose) {
+          this.engine.client.onClose('simulate resume-reconnect');
+        }
+        break;
       case 'force-tcp':
       case 'force-tls':
         req = SimulateScenario.fromPartial({
@@ -21571,7 +21583,7 @@ class Room extends eventsExports.EventEmitter {
     participant.tracks.forEach(publication => {
       participant.unpublishTrack(publication.trackSid, true);
     });
-    this.emitWhenConnected(RoomEvent.ParticipantDisconnected, participant);
+    this.emit(RoomEvent.ParticipantDisconnected, participant);
   }
   async acquireAudioContext() {
     var _a, _b;
@@ -21632,7 +21644,7 @@ class Room extends eventsExports.EventEmitter {
       }
       this.emit(RoomEvent.TrackSubscribed, track, publication, participant);
     }).on(ParticipantEvent.TrackUnpublished, publication => {
-      this.emitWhenConnected(RoomEvent.TrackUnpublished, publication, participant);
+      this.emit(RoomEvent.TrackUnpublished, publication, participant);
     }).on(ParticipantEvent.TrackUnsubscribed, (track, publication) => {
       this.emit(RoomEvent.TrackUnsubscribed, track, publication, participant);
     }).on(ParticipantEvent.TrackSubscriptionFailed, sid => {