livekit-client 1.6.2 → 1.6.4

package/src/room/Room.ts

@@ -44,6 +44,7 @@ import type Participant from './participant/Participant';
 import type { ConnectionQuality } from './participant/Participant';
 import RemoteParticipant from './participant/RemoteParticipant';
 import RTCEngine from './RTCEngine';
+import CriticalTimers from './timers';
 import LocalAudioTrack from './track/LocalAudioTrack';
 import LocalTrackPublication from './track/LocalTrackPublication';
 import LocalVideoTrack from './track/LocalVideoTrack';
@@ -364,7 +365,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       }
 
       // don't return until ICE connected
-      const connectTimeout = setTimeout(() => {
+      const connectTimeout = CriticalTimers.setTimeout(() => {
         // timeout
         this.recreateEngine();
         this.handleDisconnect(this.options.stopLocalTrackOnUnpublish);
@@ -372,7 +373,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       }, this.connOptions.peerConnectionTimeout);
       const abortHandler = () => {
         log.warn('closing engine');
-        clearTimeout(connectTimeout);
+        CriticalTimers.clearTimeout(connectTimeout);
         this.recreateEngine();
         this.handleDisconnect(this.options.stopLocalTrackOnUnpublish);
         reject(new ConnectionError('room connection has been cancelled'));
@@ -383,7 +384,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       this.abortController?.signal.addEventListener('abort', abortHandler);
 
       this.engine.once(EngineEvent.Connected, () => {
-        clearTimeout(connectTimeout);
+        CriticalTimers.clearTimeout(connectTimeout);
         this.abortController?.signal.removeEventListener('abort', abortHandler);
         // also hook unload event
         if (isWeb()) {
@@ -842,10 +843,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   private handleParticipantUpdates = (participantInfos: ParticipantInfo[]) => {
     // handle changes to participant state, and send events
     participantInfos.forEach((info) => {
-      if (
-        info.sid === this.localParticipant.sid ||
-        info.identity === this.localParticipant.identity
-      ) {
+      if (info.identity === this.localParticipant.identity) {
         this.localParticipant.updateInfo(info);
         return;
       }
@@ -1137,7 +1135,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       })
       .on(
         ParticipantEvent.ParticipantPermissionsChanged,
-        (prevPermissions: ParticipantPermission) => {
+        (prevPermissions?: ParticipantPermission) => {
           this.emitWhenConnected(
             RoomEvent.ParticipantPermissionsChanged,
             prevPermissions,
@@ -1272,7 +1270,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     this.emit(RoomEvent.MediaDevicesError, e);
   };
 
-  private onLocalParticipantPermissionsChanged = (prevPermissions: ParticipantPermission) => {
+  private onLocalParticipantPermissionsChanged = (prevPermissions?: ParticipantPermission) => {
     this.emit(RoomEvent.ParticipantPermissionsChanged, prevPermissions, this.localParticipant);
   };
 
@@ -1441,7 +1439,7 @@ export type RoomEventCallbacks = {
     participant: RemoteParticipant | LocalParticipant,
   ) => void;
   participantPermissionsChanged: (
-    prevPermissions: ParticipantPermission,
+    prevPermissions: ParticipantPermission | undefined,
     participant: RemoteParticipant | LocalParticipant,
   ) => void;
   activeSpeakersChanged: (speakers: Array<Participant>) => void;

package/src/room/errors.ts

@@ -25,6 +25,12 @@ export class ConnectionError extends LivekitError {
   }
 }
 
+export class DeviceUnsupportedError extends LivekitError {
+  constructor(message?: string) {
+    super(21, message ?? 'device is unsupported');
+  }
+}
+
 export class TrackInvalidError extends LivekitError {
   constructor(message?: string) {
     super(20, message ?? 'track is invalid');

package/src/room/participant/LocalParticipant.ts

@@ -1,12 +1,7 @@
 import 'webrtc-adapter';
 import log from '../../logger';
 import type { InternalRoomOptions } from '../../options';
-import {
-  DataPacket,
-  DataPacket_Kind,
-  ParticipantInfo,
-  ParticipantPermission,
-} from '../../proto/livekit_models';
+import { DataPacket, DataPacket_Kind, ParticipantInfo } from '../../proto/livekit_models';
 import {
   AddTrackRequest,
   DataChannelInfo,
@@ -15,7 +10,7 @@ import {
   TrackPublishedResponse,
   TrackUnpublishedResponse,
 } from '../../proto/livekit_rtc';
-import { TrackInvalidError, UnexpectedConnectionState } from '../errors';
+import { DeviceUnsupportedError, TrackInvalidError, UnexpectedConnectionState } from '../errors';
 import { EngineEvent, ParticipantEvent, TrackEvent } from '../events';
 import type RTCEngine from '../RTCEngine';
 import LocalAudioTrack from '../track/LocalAudioTrack';
@@ -168,16 +163,6 @@ export default class LocalParticipant extends Participant {
     return this.setTrackEnabled(Track.Source.ScreenShare, enabled, options, publishOptions);
   }
 
-  /** @internal */
-  setPermissions(permissions: ParticipantPermission): boolean {
-    const prevPermissions = this.permissions;
-    const changed = super.setPermissions(permissions);
-    if (changed && prevPermissions) {
-      this.emit(ParticipantEvent.ParticipantPermissionsChanged, prevPermissions);
-    }
-    return changed;
-  }
-
   /**
    * Enable or disable publishing for a track by source. This serves as a simple
    * way to manage the common tracks (camera, mic, or screen share).
@@ -389,6 +374,11 @@ export default class LocalParticipant extends Participant {
         };
       }
     }
+
+    if (navigator.mediaDevices.getDisplayMedia === undefined) {
+      throw new DeviceUnsupportedError('getDisplayMedia not supported');
+    }
+
     const stream: MediaStream = await navigator.mediaDevices.getDisplayMedia({
       audio: options.audio ?? false,
       video: videoConstraints,
@@ -876,6 +866,11 @@ export default class LocalParticipant extends Participant {
 
   /** @internal */
   updateInfo(info: ParticipantInfo) {
+    if (info.sid !== this.sid) {
+      // drop updates that specify a wrong sid.
+      // the sid for local participant is only explicitly set on join and full reconnect
+      return;
+    }
     super.updateInfo(info);
 
     // reconcile track mute status.

package/src/room/participant/Participant.ts

@@ -173,14 +173,22 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
 
   /** @internal */
   setPermissions(permissions: ParticipantPermission): boolean {
+    const prevPermissions = this.permissions;
     const changed =
       permissions.canPublish !== this.permissions?.canPublish ||
       permissions.canSubscribe !== this.permissions?.canSubscribe ||
       permissions.canPublishData !== this.permissions?.canPublishData ||
       permissions.hidden !== this.permissions?.hidden ||
-      permissions.recorder !== this.permissions?.recorder;
+      permissions.recorder !== this.permissions?.recorder ||
+      permissions.canPublishSources.length !== this.permissions.canPublishSources.length ||
+      permissions.canPublishSources.some(
+        (value, index) => value !== this.permissions?.canPublishSources[index],
+      );
     this.permissions = permissions;
 
+    if (changed) {
+      this.emit(ParticipantEvent.ParticipantPermissionsChanged, prevPermissions);
+    }
     return changed;
   }
 
@@ -257,7 +265,7 @@ export type ParticipantEventCallbacks = {
     status: TrackPublication.PermissionStatus,
   ) => void;
   mediaDevicesError: (error: Error) => void;
-  participantPermissionsChanged: (prevPermissions: ParticipantPermission) => void;
+  participantPermissionsChanged: (prevPermissions?: ParticipantPermission) => void;
   trackSubscriptionStatusChanged: (
     publication: RemoteTrackPublication,
     status: TrackPublication.SubscriptionStatus,

package/src/room/timers.ts

@@ -0,0 +1,16 @@
+/**
+ * Timers that can be overridden with platform specific implementations
+ * that ensure that they are fired. These should be used when it is critical
+ * that the timer fires on time.
+ */
+export default class CriticalTimers {
+  // eslint-disable-next-line @typescript-eslint/no-implied-eval
+  static setTimeout = (...args: Parameters<typeof setTimeout>) => setTimeout(...args);
+
+  // eslint-disable-next-line @typescript-eslint/no-implied-eval
+  static setInterval = (...args: Parameters<typeof setInterval>) => setInterval(...args);
+
+  static clearTimeout = (...args: Parameters<typeof clearTimeout>) => clearTimeout(...args);
+
+  static clearInterval = (...args: Parameters<typeof clearInterval>) => clearInterval(...args);
+}

package/src/room/track/RemoteVideoTrack.ts

@@ -2,6 +2,7 @@ import { debounce } from 'ts-debounce';
 import log from '../../logger';
 import { TrackEvent } from '../events';
 import { computeBitrate, VideoReceiverStats } from '../stats';
+import CriticalTimers from '../timers';
 import { getIntersectionObserver, getResizeObserver, ObservableMediaElement } from '../utils';
 import RemoteTrack from './RemoteTrack';
 import { attachToElement, detachTrack, Track } from './Track';
@@ -233,7 +234,7 @@ export default class RemoteVideoTrack extends RemoteTrack {
 
     if (!isVisible && Date.now() - lastVisibilityChange < REACTION_DELAY) {
       // delay hidden events
-      setTimeout(() => {
+      CriticalTimers.setTimeout(() => {
         this.updateVisibility();
       }, REACTION_DELAY);
       return;

package/src/room/track/create.ts

@@ -1,5 +1,5 @@
 import DeviceManager from '../DeviceManager';
-import { TrackInvalidError } from '../errors';
+import { DeviceUnsupportedError, TrackInvalidError } from '../errors';
 import { mediaTrackToLocalTrack } from '../participant/publishUtils';
 import { audioDefaults, videoDefaults } from '../defaults';
 import LocalAudioTrack from './LocalAudioTrack';
@@ -114,6 +114,11 @@ export async function createLocalScreenTracks(
       height: options.resolution.height,
     };
   }
+
+  if (navigator.mediaDevices.getDisplayMedia === undefined) {
+    throw new DeviceUnsupportedError('getDisplayMedia not supported');
+  }
+
   // typescript definition is missing getDisplayMedia: https://github.com/microsoft/TypeScript/issues/33232
   // @ts-ignore
   const stream: MediaStream = await navigator.mediaDevices.getDisplayMedia({

package/src/room/track/options.ts

@@ -232,9 +232,9 @@ export interface AudioPreset {
 const codecs = ['vp8', 'h264', 'av1'] as const;
 const backupCodecs = ['vp8', 'h264'] as const;
 
-export type VideoCodec = typeof codecs[number];
+export type VideoCodec = (typeof codecs)[number];
 
-export type BackupVideoCodec = typeof backupCodecs[number];
+export type BackupVideoCodec = (typeof backupCodecs)[number];
 
 export function isBackupCodec(codec: string): codec is BackupVideoCodec {
   return !!backupCodecs.find((backup) => backup === codec);