livekit-client 1.15.5 → 1.15.7

package/src/room/Room.ts

@@ -4,7 +4,7 @@ import type TypedEmitter from 'typed-emitter';
 import 'webrtc-adapter';
 import { EncryptionEvent } from '../e2ee';
 import { E2EEManager } from '../e2ee/E2eeManager';
-import log from '../logger';
+import log, { LoggerNames, getLogger } from '../logger';
 import type {
   InternalRoomConnectOptions,
   InternalRoomOptions,
@@ -151,6 +151,8 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
 
   private isVideoPlaybackBlocked: boolean = false;
 
+  private log = log;
+
   /**
    * Creates a new Room, the primary construct for a LiveKit session.
    * @param options
@@ -163,6 +165,8 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     this.identityToSid = new Map();
     this.options = { ...roomOptionDefaults, ...options };
 
+    this.log = getLogger(this.options.loggerName ?? LoggerNames.Room);
+
     this.options.audioCaptureDefaults = {
       ...audioDefaults,
       ...options?.audioCaptureDefaults,
@@ -198,7 +202,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       this.switchActiveDevice(
         'audiooutput',
         unwrapConstraint(this.options.audioOutput.deviceId),
-      ).catch((e) => log.warn(`Could not set audio output: ${e.message}`));
+      ).catch((e) => this.log.warn(`Could not set audio output: ${e.message}`, this.logContext));
     }
 
     if (this.options.e2ee) {
@@ -239,6 +243,14 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     }
   }
 
+  private get logContext() {
+    return {
+      room: this.name,
+      roomSid: this.sid,
+      identity: this.localParticipant.identity,
+    };
+  }
+
   /**
    * if the current room has a participant with `recorder: true` in its JWT grant
    **/
@@ -362,7 +374,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     if (this.state !== ConnectionState.Disconnected) {
       return;
     }
-    log.debug(`prepareConnection to ${url}`);
+    this.log.debug(`prepareConnection to ${url}`, this.logContext);
     try {
       if (isCloud(new URL(url)) && token) {
         this.regionUrlProvider = new RegionUrlProvider(url, token);
@@ -372,13 +384,13 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         if (regionUrl && this.state === ConnectionState.Disconnected) {
           this.regionUrl = regionUrl;
           await fetch(toHttpUrl(regionUrl), { method: 'HEAD' });
-          log.debug(`prepared connection to ${regionUrl}`);
+          this.log.debug(`prepared connection to ${regionUrl}`, this.logContext);
         }
       } else {
         await fetch(toHttpUrl(url), { method: 'HEAD' });
       }
     } catch (e) {
-      log.warn('could not prepare connection', { error: e });
+      this.log.warn('could not prepare connection', { ...this.logContext, error: e });
     }
   }
 
@@ -388,7 +400,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
 
     if (this.state === ConnectionState.Connected) {
       // when the state is reconnecting or connected, this function returns immediately
-      log.info(`already connected to room ${this.name}`);
+      this.log.info(`already connected to room ${this.name}`, this.logContext);
       unlockDisconnect();
       return Promise.resolve();
     }
@@ -413,7 +425,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       // if initial connection fails, this will speed up picking regional url
       // on subsequent runs
       this.regionUrlProvider.fetchRegionSettings().catch((e) => {
-        log.warn('could not fetch region settings', { error: e });
+        this.log.warn('could not fetch region settings', { ...this.logContext, error: e });
       });
     }
 
@@ -460,8 +472,9 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
             }
           }
           if (nextUrl) {
-            log.info(
+            this.log.info(
               `Initial connection failed with ConnectionError: ${e.message}. Retrying with another region: ${nextUrl}`,
+              this.logContext,
             );
             await connectFn(resolve, reject, nextUrl);
           } else {
@@ -517,10 +530,15 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       serverInfo = { version: joinResponse.serverVersion, region: joinResponse.serverRegion };
     }
 
-    log.debug(
+    this.log.debug(
       `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,
+      },
     );
 
     if (!joinResponse.serverVersion) {
@@ -528,7 +546,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     }
 
     if (joinResponse.serverVersion === '0.15.1' && this.options.dynacast) {
-      log.debug('disabling dynacast due to server version');
+      this.log.debug('disabling dynacast due to server version', this.logContext);
       // dynacast has a bug in 0.15.1, so we cannot use it then
       roomOptions.dynacast = false;
     }
@@ -561,7 +579,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     abortController: AbortController,
   ) => {
     if (this.state === ConnectionState.Reconnecting) {
-      log.info('Reconnection attempt replaced by new connection attempt');
+      this.log.info('Reconnection attempt replaced by new connection attempt', this.logContext);
       // make sure we close and recreate the existing engine in order to get rid of any potentially ongoing reconnection attempts
       this.recreateEngine();
     } else {
@@ -608,7 +626,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         resultingError.reason = err.reason;
         resultingError.status = err.status;
       }
-      log.debug(`error trying to establish signal connection`, { error: err });
+      this.log.debug(`error trying to establish signal connection`, {
+        ...this.logContext,
+        error: err,
+      });
       throw resultingError;
     }
 
@@ -651,16 +672,18 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     const unlock = await this.disconnectLock.lock();
     try {
       if (this.state === ConnectionState.Disconnected) {
-        log.debug('already disconnected');
+        this.log.debug('already disconnected', this.logContext);
         return;
       }
-      log.info('disconnect from room', { identity: this.localParticipant.identity });
+      this.log.info('disconnect from room', {
+        ...this.logContext,
+      });
       if (
         this.state === ConnectionState.Connecting ||
         this.state === ConnectionState.Reconnecting
       ) {
         // try aborting pending connection attempt
-        log.warn('abort connection attempt');
+        this.log.warn('abort connection attempt', this.logContext);
         this.abortController?.abort();
         // in case the abort controller didn't manage to cancel the connection attempt, reject the connect promise explicitly
         this.connectFuture?.reject?.(new ConnectionError('Client initiated disconnect'));
@@ -886,8 +909,9 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         if (e.name === 'NotAllowedError') {
           this.handleVideoPlaybackFailed();
         } else {
-          log.warn(
+          this.log.warn(
             'Resuming video playback failed, make sure you call `startVideo` directly in a user gesture handler',
+            this.logContext,
           );
         }
       });
@@ -1052,7 +1076,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       return;
     }
     if (this.state === ConnectionState.Disconnected) {
-      log.warn('skipping incoming track after Room disconnected');
+      this.log.warn('skipping incoming track after Room disconnected', this.logContext);
       return;
     }
     const parts = unpackStreamId(stream.id);
@@ -1064,15 +1088,16 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     if (streamId && streamId.startsWith('TR')) trackId = streamId;
 
     if (participantId === this.localParticipant.sid) {
-      log.warn('tried to create RemoteParticipant for local participant');
+      this.log.warn('tried to create RemoteParticipant for local participant', this.logContext);
       return;
     }
 
     const participant = this.participants.get(participantId) as RemoteParticipant | undefined;
 
     if (!participant) {
-      log.error(
+      this.log.error(
         `Tried to add a track for a participant, that's not present. Sid: ${participantId}`,
+        this.logContext,
       );
       return;
     }
@@ -1107,7 +1132,8 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   };
 
   private handleSignalRestarted = async (joinResponse: JoinResponse) => {
-    log.debug(`signal reconnected to server`, {
+    this.log.debug(`signal reconnected to server, region ${joinResponse.serverRegion}`, {
+      ...this.logContext,
       region: joinResponse.serverRegion,
     });
 
@@ -1136,12 +1162,14 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
             ) {
               // we need to restart the track before publishing, often a full reconnect
               // is necessary because computer had gone to sleep.
-              log.debug('restarting existing track', {
+              this.log.debug('restarting existing track', {
+                ...this.logContext,
                 track: pub.trackSid,
               });
               await track.restartTrack();
             }
-            log.debug('publishing new track', {
+            this.log.debug('publishing new track', {
+              ...this.logContext,
               track: pub.trackSid,
             });
             await this.localParticipant.publishTrack(track, pub.options);
@@ -1149,12 +1177,16 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         }),
       );
     } catch (error) {
-      log.error('error trying to re-publish tracks after reconnection', { error });
+      this.log.error('error trying to re-publish tracks after reconnection', {
+        ...this.logContext,
+        error,
+      });
     }
 
     try {
       await this.engine.waitForRestarted();
-      log.debug(`fully reconnected to server`, {
+      this.log.debug(`fully reconnected to server`, {
+        ...this.logContext,
         region: joinResponse.serverRegion,
       });
     } catch {
@@ -1411,7 +1443,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   };
 
   private handleAudioPlaybackFailed = (e: any) => {
-    log.warn('could not playback audio', e);
+    this.log.warn('could not playback audio', { ...this.logContext, error: e });
     if (!this.canPlaybackAudio) {
       return;
     }
@@ -1480,7 +1512,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       try {
         await this.audioContext.resume();
       } catch (e: any) {
-        log.warn(e);
+        this.log.warn('Could not resume audio context', { ...this.logContext, error: e });
       }
     }
 
@@ -1502,7 +1534,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     if (info) {
       participant = RemoteParticipant.fromParticipantInfo(this.engine.client, info);
     } else {
-      participant = new RemoteParticipant(this.engine.client, id, '', undefined, undefined);
+      participant = new RemoteParticipant(this.engine.client, id, '', undefined, undefined, {
+        loggerContextCb: () => this.logContext,
+        loggerName: this.options.loggerName,
+      });
     }
     if (this.options.expWebAudioMix) {
       participant.setAudioContext(this.audioContext);
@@ -1510,7 +1545,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     if (this.options.audioOutput?.deviceId) {
       participant
         .setAudioOutput(this.options.audioOutput)
-        .catch((e) => log.warn(`Could not set audio output: ${e.message}`));
+        .catch((e) => this.log.warn(`Could not set audio output: ${e.message}`, this.logContext));
     }
     return participant;
   }
@@ -1643,7 +1678,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         !this.engine.verifyTransport()
       ) {
         consecutiveFailures++;
-        log.warn('detected connection state mismatch', { numFailures: consecutiveFailures });
+        this.log.warn('detected connection state mismatch', {
+          ...this.logContext,
+          numFailures: consecutiveFailures,
+        });
         if (consecutiveFailures >= 3) {
           this.recreateEngine();
           this.handleDisconnect(
@@ -1799,7 +1837,11 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
                 true,
                 true,
               ),
+          undefined,
+          false,
+          { loggerName: this.options.loggerName, loggerContextCb: () => this.logContext },
         ),
+        { loggerName: this.options.loggerName, loggerContextCb: () => this.logContext },
       );
       // @ts-ignore
       this.localParticipant.addTrackPublication(camPub);
@@ -1817,7 +1859,12 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
           publishOptions.useRealTracks
             ? (await navigator.mediaDevices.getUserMedia({ audio: true })).getAudioTracks()[0]
             : getEmptyAudioStreamTrack(),
+          undefined,
+          false,
+          this.audioContext,
+          { loggerName: this.options.loggerName, loggerContextCb: () => this.logContext },
         ),
+        { loggerName: this.options.loggerName, loggerContextCb: () => this.logContext },
       );
       // @ts-ignore
       this.localParticipant.addTrackPublication(audioPub);
@@ -1870,12 +1917,29 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   ): boolean {
     // active speaker updates are too spammy
     if (event !== RoomEvent.ActiveSpeakersChanged) {
-      log.debug(`room event ${event}`, { event, args });
+      // only extract logContext from arguments in order to avoid logging the whole object tree
+      const minimizedArgs = mapArgs(args).filter((arg: unknown) => arg !== undefined);
+      this.log.debug(`room event ${event}`, { ...this.logContext, event, args: minimizedArgs });
     }
     return super.emit(event, ...args);
   }
 }
 
+function mapArgs(args: unknown[]): any {
+  return args.map((arg: unknown) => {
+    if (!arg) {
+      return;
+    }
+    if (Array.isArray(arg)) {
+      return mapArgs(arg);
+    }
+    if (typeof arg === 'object') {
+      return 'logContext' in arg && arg.logContext;
+    }
+    return arg;
+  });
+}
+
 export default Room;
 
 export type RoomEventCallbacks = {