livekit-client 2.18.7 → 2.18.9

package/src/room/RTCEngine.ts

@@ -254,7 +254,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
   constructor(private options: InternalRoomOptions) {
     super();
-    this.log = getLogger(options.loggerName ?? LoggerNames.Engine);
+    this.log = getLogger(options.loggerName ?? LoggerNames.Engine, () => this.logContext);
     this.loggerOptions = {
       loggerName: options.loggerName,
       loggerContextCb: () => this.logContext,
@@ -364,7 +364,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         // create offer
         if (!this.subscriberPrimary || joinResponse.fastPublish) {
           this.negotiate().catch((err) => {
-            log.error(err, this.logContext);
+            this.log.error(err);
           });
         }
       }
@@ -377,15 +377,10 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       if (!serverInfo) {
         serverInfo = { version: joinResponse.serverVersion, region: joinResponse.serverRegion };
       }
-      this.log.debug(
+      this.log.info(
         `connected to Livekit Server ${Object.entries(serverInfo)
           .map(([key, value]) => `${key}: ${value}`)
           .join(', ')}`,
-        {
-          room: joinResponse.room?.name,
-          roomSid: joinResponse.room?.sid,
-          identity: joinResponse.participant?.identity,
-        },
       );
 
       return { joinResponse, serverInfo };
@@ -394,7 +389,6 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         if (e.reason === ConnectionErrorReason.ServerUnreachable) {
           this.log.warn(
             `Couldn't connect to server, attempt ${this.joinAttempts} of ${this.maxJoinAttempts}`,
-            this.logContext,
           );
           if (this.joinAttempts < this.maxJoinAttempts) {
             return this.join(url, token, opts, abortSignal, useV0Path);
@@ -531,7 +525,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.pcManager!.removeTrack(sender);
       return true;
     } catch (e: unknown) {
-      this.log.warn('failed to remove track', { ...this.logContext, error: e });
+      this.log.warn('failed to remove track', { error: e });
     }
     return false;
   }
@@ -588,7 +582,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
     this.pcManager.onDataChannel = this.handleDataChannel;
     this.pcManager.onStateChange = async (connectionState, publisherState, subscriberState) => {
-      this.log.debug(`primary PC state changed ${connectionState}`, this.logContext);
+      this.log.debug(`primary PC state changed ${connectionState}`);
 
       if (['closed', 'disconnected', 'failed'].includes(publisherState)) {
         // reset publisher connection promise
@@ -642,7 +636,6 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         return;
       }
       this.log.debug('received server answer', {
-        ...this.logContext,
         RTCSdpType: sd.type,
         sdp: sd.sdp,
         midToTrackId,
@@ -656,7 +649,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       if (!this.pcManager) {
         return;
       }
-      this.log.debug('got ICE candidate from peer', { ...this.logContext, candidate, target });
+      this.log.debug('got ICE candidate from peer', { candidate, target });
       this.pcManager.addIceCandidate(candidate, target);
     };
 
@@ -675,15 +668,11 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
     this.client.onLocalTrackPublished = (res: TrackPublishedResponse) => {
       this.log.debug('received trackPublishedResponse', {
-        ...this.logContext,
         cid: res.cid,
         track: res.track?.sid,
       });
       if (!this.pendingTrackResolvers[res.cid]) {
-        this.log.error(`missing track resolver for ${res.cid}`, {
-          ...this.logContext,
-          cid: res.cid,
-        });
+        this.log.error(`missing track resolver for ${res.cid}`, { cid: res.cid });
         return;
       }
       const { resolve } = this.pendingTrackResolvers[res.cid];
@@ -742,9 +731,11 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     };
 
     this.client.onLeave = (leave: LeaveRequest) => {
-      this.log.debug('client leave request', { ...this.logContext, reason: leave?.reason });
+      this.log.info(`client leave request received (action=${leave?.action})`, {
+        reason: leave?.reason,
+      });
       if (leave.regions) {
-        this.log.debug('updating regions', this.logContext);
+        this.log.debug('updating regions');
         this.emit(EngineEvent.ServerRegionsReported, leave.regions);
       }
       switch (leave.action) {
@@ -772,7 +763,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     const rtcConfig = { ...this.rtcConfig };
 
     if (this.signalOpts?.e2eeEnabled) {
-      this.log.debug('E2EE - setting up transports with insertable streams', this.logContext);
+      this.log.debug('E2EE - setting up transports with insertable streams');
       //  this makes sure that no data is sent before the transforms are ready
       // @ts-ignore
       rtcConfig.encodedInsertableStreams = true;
@@ -911,7 +902,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     } else {
       return;
     }
-    this.log.debug(`on data channel ${channel.id}, ${channel.label}`, this.logContext);
+    this.log.debug(`on data channel ${channel.id}, ${channel.label}`);
     channel.onmessage = handler;
   };
 
@@ -926,7 +917,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       } else if (message.data instanceof Blob) {
         buffer = await message.data.arrayBuffer();
       } else {
-        this.log.error('unsupported data type', { ...this.logContext, data: message.data });
+        this.log.error('unsupported data type', { data: message.data });
         return;
       }
       const dp = DataPacket.fromBinary(new Uint8Array(buffer));
@@ -945,7 +936,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         this.emit(EngineEvent.ActiveSpeakersUpdate, dp.value.value.speakers);
       } else if (dp.value?.case === 'encryptedPacket') {
         if (!this.e2eeManager) {
-          this.log.error('Received encrypted packet but E2EE not set up', this.logContext);
+          this.log.error('Received encrypted packet but E2EE not set up');
           return;
         }
         const decryptedData = await this.e2eeManager?.handleEncryptedData(
@@ -985,7 +976,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     } else if (message.data instanceof Blob) {
       buffer = await message.data.arrayBuffer();
     } else {
-      this.log.error('unsupported data type', { ...this.logContext, data: message.data });
+      this.log.error('unsupported data type', { data: message.data });
       return;
     }
 
@@ -998,12 +989,9 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
     if (event instanceof ErrorEvent && event.error) {
       const { error } = event.error;
-      this.log.error(`DataChannel error on ${channelKind}: ${event.message}`, {
-        ...this.logContext,
-        error,
-      });
+      this.log.error(`DataChannel error on ${channelKind}: ${event.message}`, { error });
     } else {
-      this.log.error(`Unknown DataChannel error on ${channelKind}`, { ...this.logContext, event });
+      this.log.error(`Unknown DataChannel error on ${channelKind}`, { event });
     }
   };
 
@@ -1021,7 +1009,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       return sender;
     }
     if (supportsAddTrack()) {
-      this.log.warn('using add-track fallback', this.logContext);
+      this.log.warn('using add-track fallback');
       const sender = await this.createRTCRtpSender(track.mediaStreamTrack);
       return sender;
     }
@@ -1039,7 +1027,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       return this.createSimulcastTransceiverSender(track, simulcastTrack, opts, encodings);
     }
     if (supportsAddTrack()) {
-      this.log.debug('using add-track fallback', this.logContext);
+      this.log.debug('using add-track fallback');
       return this.createRTCRtpSender(track.mediaStreamTrack);
     }
 
@@ -1118,7 +1106,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       return;
     }
 
-    this.log.warn(`${connection} disconnected`, this.logContext);
+    this.log.warn(`${connection} disconnected`);
     if (this.reconnectAttempts === 0) {
       // only reset start time on the first try
       this.reconnectStart = Date.now();
@@ -1127,7 +1115,6 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     const disconnect = (duration: number) => {
       this.log.warn(
         `could not recover connection after ${this.reconnectAttempts} attempts, ${duration}ms. giving up`,
-        this.logContext,
       );
       this.emit(EngineEvent.Disconnected);
       this.close();
@@ -1147,7 +1134,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       delay = 0;
     }
 
-    this.log.debug(`reconnecting in ${delay}ms`, this.logContext);
+    this.log.debug(`reconnecting in ${delay}ms`);
 
     this.clearReconnectTimeout();
     if (this.token) {
@@ -1168,7 +1155,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     }
     // guard for attempting reconnection multiple times while one attempt is still not finished
     if (this.attemptingReconnect) {
-      log.warn('already attempting reconnect, returning early', this.logContext);
+      this.log.warn('already attempting reconnect, returning early');
       return;
     }
     if (
@@ -1193,7 +1180,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.reconnectAttempts += 1;
       let recoverable = true;
       if (e instanceof UnexpectedConnectionState) {
-        this.log.debug('received unrecoverable error', { ...this.logContext, error: e });
+        this.log.debug('received unrecoverable error', { error: e });
         // unrecoverable
         recoverable = false;
       } else if (!(e instanceof SignalReconnectError)) {
@@ -1208,7 +1195,6 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
           `could not recover connection after ${this.reconnectAttempts} attempts, ${
             Date.now() - this.reconnectStart
           }ms. giving up`,
-          this.logContext,
         );
         this.emit(EngineEvent.Disconnected);
         await this.close();
@@ -1222,7 +1208,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     try {
       return this.reconnectPolicy.nextRetryDelayInMs(context);
     } catch (e) {
-      this.log.warn('encountered error in reconnect policy', { ...this.logContext, error: e });
+      this.log.warn('encountered error in reconnect policy', { error: e });
     }
 
     // error in user code with provided reconnect policy, stop reconnecting
@@ -1236,7 +1222,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         throw new UnexpectedConnectionState('could not reconnect, url or token not saved');
       }
 
-      this.log.info(`reconnecting, attempt: ${this.reconnectAttempts}`, this.logContext);
+      this.log.info(`reconnecting, attempt: ${this.reconnectAttempts}`);
       this.emit(EngineEvent.Restarting);
 
       if (!this.client.isDisconnected) {
@@ -1248,10 +1234,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       let joinResponse: JoinResponse;
       try {
         if (!this.signalOpts) {
-          this.log.warn(
-            'attempted connection restart, without signal options present',
-            this.logContext,
-          );
+          this.log.warn('attempted connection restart, without signal options present');
           throw new SignalReconnectError();
         }
         // in case a regionUrl is passed, the region URL takes precedence
@@ -1312,7 +1295,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       throw new UnexpectedConnectionState('publisher and subscriber connections unset');
     }
 
-    this.log.info(`resuming signal connection, attempt ${this.reconnectAttempts}`, this.logContext);
+    this.log.info(`resuming signal connection, attempt ${this.reconnectAttempts}`);
     this.emit(EngineEvent.Resuming);
     let res: ReconnectResponse | undefined;
     try {
@@ -1322,7 +1305,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       let message = '';
       if (error instanceof Error) {
         message = error.message;
-        this.log.error(error.message, { ...this.logContext, error });
+        this.log.error(error.message, { error });
       }
       if (error instanceof ConnectionError && error.reason === ConnectionErrorReason.NotAllowed) {
         throw new UnexpectedConnectionState('could not reconnect, token might be expired');
@@ -1341,7 +1324,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         this.latestJoinResponse.serverInfo = res.serverInfo;
       }
     } else {
-      this.log.warn('Did not receive reconnect response', this.logContext);
+      this.log.warn('Did not receive reconnect response');
     }
 
     if (this.shouldFailNext) {
@@ -1384,7 +1367,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
   private async waitForPCReconnected() {
     this.pcState = PCState.Reconnecting;
 
-    this.log.debug('waiting for peer connection to reconnect', this.logContext);
+    this.log.debug('waiting for peer connection to reconnect');
     try {
       await sleep(minReconnectWait); // FIXME setTimeout again not ideal for a connection critical path
       if (!this.pcManager) {
@@ -1531,7 +1514,6 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
             if (this.lossyDataDropCount % 100 === 0) {
               this.log.warn(
                 `dropping lossy data channel messages, total dropped: ${this.lossyDataDropCount}`,
-                this.logContext,
               );
             }
             return;
@@ -1637,7 +1619,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     if (needNegotiation) {
       // start negotiation
       this.negotiate().catch((err) => {
-        log.error(err, this.logContext);
+        this.log.error(err);
       });
     }
 
@@ -1714,7 +1696,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
       const handleClosed = () => {
         abortController.abort();
-        this.log.debug('engine disconnected while negotiation was ongoing', this.logContext);
+        this.log.debug('engine disconnected while negotiation was ongoing');
         resolve();
         return;
       };
@@ -1795,7 +1777,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     localDataTrackInfos: Array<DataTrackInfo>,
   ) {
     if (!this.pcManager) {
-      this.log.warn('sync state cannot be sent without peer connection setup', this.logContext);
+      this.log.warn('sync state cannot be sent without peer connection setup');
       return;
     }
     const previousPublisherOffer = this.pcManager.publisher.getLocalDescription();